获取直播列表2.0
| 拥有此API的权限集 |
|---|
| 直播管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.alive.list.get/2.0.0 - 频率限制：
10秒500次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| access_token | 是 | string | 专属token | ... |
| alive_play_state | 否 | int | 直播状态：-1全部，0=未开始，1=直播中，2=已结束；默认-0=未开始 | ... |
| search_alive_type | 否 | int | 直播模式：-1=全部，10=横屏直播，11竖屏直播，12语音直播，13录播直播；默认-0 | ... |
| search_content | 否 | string | 直播名称关键字 | ... |
| create_mode | 否 | int | 创建类型 -1=全部 0=店铺课程 1=转播课程；默认-0=店铺课程 | ... |
| state | 否 | int | 上架状态: -1=全部, 0=已上架，1=已下架，2=待上架；默认- 0=已上架 | ... |
| zb_start_at_min | 否 | string | 直播开始时间-最小值 | ... |
| zb_start_at_max | 否 | string | 直播开始时间-最大值 | ... |
| tag_ids | 否 | array | 商品分组ID数组 | ... |
| page | 是 | int | 页码，表示第几页，从1开始；默认1 | ... |
| page_size | 是 | int | 每页条数，最大50条；默认10 | ... |
请求示例
{
"access_token" : "xe_xxxxx",
"search_content" : "测试",
"create_mode" : 0
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| msg | string | 错误描述 |
| data | Object | 返回值 |
| data.total_count | int | 总数 |
| data.live_list | Array | 直播信息列表 |
直播信息列表live_list
| 参数名 | 类型 | 说明 |
|---|---|---|
| app_id | string | 店铺ID |
| id | string | 直播ID |
| room_id | string | 房间ID |
| title | string | 直播标题 |
| img_url | string | 直播封面图 |
| page_url | string | 页面url |
| img_url_compressed | string | 封面压缩后的路径 |
| comment_count | int | 评论数量 |
| is_takegoods | int | 带货开关：1=开，0=关 |
| takegoods | string | 带货商品分组ID |
| payment_type | int | 付费类型：1-免费、2-单笔、3-付费产品包 |
| is_public | int | 是否公开售卖，1公开，0不公开 |
| is_stop_sell | int | 是否停售,0-否、1-是 |
| is_transcode | int | 视频是否转码，0-表示未转码，1-表示已转码,2-转码失败 |
| piece_price | int | payment_type为2时，单笔价格（分）;payment_type为3时，专栏价格（分） |
| line_price | int | 划线价 |
| have_password | int | 该资源是否需要密码 |
| alive_type | int | 直播类型：0-语音直播,1-视频直播,2-推流直播,3-ppt直播 |
| purchase_count | int | 订阅量 |
| reward_sum | int | 打赏金额 |
| is_ban | int | 强制封禁：0-否 1-是 |
| on_shelf | int | 强制下架：0-否 1-是 |
| recycle_bin_state | int | 上下架状态：0-上架，1-下架 |
| push_state | int | 推流状态，0断流，1推流中，2推流未开始 |
| state | int | 直播状态：0-可见，1-关闭，2-删除 |
| start_at | string | 上架时间 |
| zb_start_at | string | 直播开始时间 |
| manual_stop_at | string | 手动结束直播时间 |
| source_shop_name | string | 转播店铺名称 |
| material_state | int | 素材状态 |
| video_length | int | 视频时长（s） |
| alive_state | int | 直播状态 |
| alive_mode | int | 直播模式：0.无；1竖屏直播 |
| create_mode | int | 创建类型：0-自创建，1-转播创建 |
| is_round_table_on | int | 圆桌会议功能是否开启 |
| query_package_list | string | 关联商品 |
| course_expire | object | 售卖有效期 |
| course_expire.period_type | int | 有效期类型：0=永久有效，1=固定有效期，2=自定义有效期 |
| course_expire.period_value | string | 自定义有效时长 |
| course_expire.is_allow_repeat_purchase | int | 是否允许重复购买：1=是，0=否 |
返回示例
{
"code": 0,
"msg": "ok",
"data": {
"live_list": [
{
"alive_mode": 0,
"alive_state": 0,
"alive_type": 2,
"alive_video_url": "",
"app_id": "appAKLWLitn7978",
"comment_count": 0,
"course_expire": {
"is_allow_repeat_purchase": 0,
"period_type": 0,
"period_value": ""
},
"create_mode": 0,
"have_password": 0,
"id": "l_6670ece9e4b0694c982b17a6",
"img_url": "https://commonresource-1252524126.cdn.xiaoeknow.com/image/l6nfw9120t1u.png",
"img_url_compressed": "http://wechatapppro-1252524126.file.myqcloud.com/appAKLWLitn7978/image/compress/400224802l6nfw9120t1u.png",
"is_ban": 0,
"is_public": 1,
"is_round_table_on": 0,
"is_stop_sell": 0,
"is_takegoods": 1,
"is_transcode": 1,
"line_price": 0,
"manual_stop_at": "",
"material_state": 0,
"on_shelf": 0,
"page_url": "",
"payment_type": 1,
"piece_price": 0,
"purchase_count": 0,
"push_state": 2,
"query_package_list": null,
"recycle_bin_state": 0,
"reward_sum": 0,
"room_id": "XET#28afcb33200cab398",
"source_shop_name": "",
"start_at": "2024-06-18 10:11:53",
"state": 0,
"takegoods": "18565657",
"title": "bz-ig",
"video_length": 0,
"zb_start_at": "2024-06-18 11:00:00",
"zb_stop_at": "2024-06-18 12:00:00"
},
],
"total_count": 67
}
}