Appearance
获取直播详情2.0
| 拥有此API的权限集 |
|---|
| 直播管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.alive.detail.get/2.0.0 - 频率限制：
1秒10次
接口调试
请求参数
响应结果
暂无响应数据
请求参数
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| access_token | 是 | string | 专属token | ... |
| id | 是 | string | 直播ID | ... |
请求示例
{
"access_token":"xxxxxxx",
"id":"l_61ce67cde4b0469a4fxxxxxx"
}返回参数说明
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| code | 是 | int | 错误码 | 0 |
| msg | 是 | string | 错误描述 | ok |
| data | 是 | Object | 返回值 | ... |
| data.resource_info | 是 | Object | 资源信息 | ... |
| data.module_info | 是 | Object | 配置信息 | ... |
| data.goods_info | 是 | Object | 商品信息 | ... |
| data.relation_info | 是 | Object | 关联信息 | ... |
| data.role_info | 是 | array | 讲师信息 | ... |
资源信息resource_info
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| app_id | 是 | string | 店铺id | ... |
| id | 是 | string | 直播ID | ... |
| title | 是 | string | 直播标题 | ... |
| summary | 是 | string | 直播简介 | ... |
| descrb | 是 | string | 直播详情（仅允许纯文本） | ... |
| alive_type | 是 | int | 直播类型：0-语音，1-录播直播，2-推流直播 | ... |
| alive_state | 是 | int | 直播状态：0-未开始，1-直播中，2-已结束 | 1 |
| state | 是 | int | 直播删除状态: 0-可见 1-关闭 2-删除 | 1 |
| push_state | 是 | int | 推流状态，0-断流，1-推流中，2-推流未开始 | 1 |
| is_transcode | 是 | int | 直播视频转码状态：0-转码中，1-转码完成，2-转码失败 | 1 |
| manual_stop_at | 是 | string | 手动结束时间 | 2023-05-31 18:00:00 |
| zb_start_at | 是 | string | 预设直播开始时间 | 2023-05-31 18:00:00 |
| zb_stop_at | 是 | int | 预设直播时长，单位：秒 | 3600 |
| img_material_id | 是 | string | 详情封面图素材ID | `` |
| alive_img_material_id | 是 | string | 宣传封面图素材ID | `` |
| aliveroom_img_material_id | 是 | string | 暖场封面图素材ID | `` |
| warm_up_video_cover_material_id | 是 | string | 暖场视频封面图素材ID | `` |
| warm_up_video_material_id | 是 | string | 暖场视频素材ID | `` |
| alive_video_material_id | 是 | string | 录播视频素材ID | `` |
| ios_applet_desc | 是 | object | 苹果端小程序信息调整 | `` |
| ios_applet_desc.title | 是 | string | 直播标题 | ... |
| ios_applet_desc.summary | 是 | string | 直播简介 | ... |
| ios_applet_desc.descrb | 是 | string | 直播详情 | ... |
| ios_applet_desc.state | 是 | int | 显示设置：0-在苹果小程序内显示该直播，1-在苹果小程序内不显示 | ... |
| ios_applet_desc.img_material_id | 是 | string | 直播封面链接素材ID | ... |
| ios_applet_desc.alive_img_material_id | 是 | string | 宣传封面图素材ID | ... |
配置信息module_info
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| is_lookback | 是 | int | 是否开启回放：0-开启，1-关闭 | ... |
| play_fast_state_switch | 是 | int | 回放是否允许倍速播放或快进：0-允许，1-禁止 | ... |
| alive_mode | 是 | int | 直播模式：0-横屏直播，1-竖屏直播 | ... |
| expire_type | 是 | int | 回放有效期设置：1-永久，2-限时 | ... |
| expire | 是 | string | 回放过期时间 | 2023-06-30 |
| warm_up | 是 | int | 暖场设置：1-暖场图，2-暖场视频 | ... |
| is_open_complete_time | 是 | int | 是否开启完成条件：0-关闭，1-开启 | ... |
| complete_time | 是 | int | 设置最短学习时间（单位：分钟） | ... |
| is_contact_on | 是 | int | 是否开启联系学员：0-关闭，1-开启 | ... |
商品信息goods_info
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| sale_type | 是 | int | 售卖类型：1-单独售卖、2-关联售卖 | ... |
| payment_type | 是 | int | 支付类型：1-免费，2-收费，3-加密，4-指定学员可用，5-仅关联上级资源 | ... |
| piece_price | 是 | int | 价格（单位：分） | 0 |
| line_price | 是 | int | 划线价格（单位：分） | 0 |
| resource_password | 是 | string | 密码 | ... |
| recycle_bin_state | 是 | int | 上下架：1-下架，0-上架 | ... |
| start_at | 是 | string | 定时上架时间 | 2023-05-31 17:19:26 |
| is_stop_sell | 是 | int | 是否停售：0-否，1-是 | ... |
| goods_sn | 是 | string | 商品编码 | ... |
| state | 是 | int | 商品状态：0-可见，1-隐藏，2-删除 | ... |
关联信息relation_info
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| package | 是 | array | 资源id | ... |
| attach_goods | 是 | array | 预留字段，暂未支持 | ... |
| tags | 是 | array | 预留字段，暂未支持 | ... |
讲师信息列表role_info
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| role_name | 是 | string | 自定义身份标签 | 讲师 |
| user_id | 是 | string | 用户id | u_6688888888889999999 |
| nickname | 是 | string | 用户昵称 | 测试 |
| avator | 是 | string | 用户头像 | ... |
| is_can_exceptional | 是 | int | 是否接受打赏：1-接受打赏，0-不接受打赏 | ... |
返回示例
{
"code": 0,
"msg": "ok",
"data": {
"goods_info": {
"goods_sn": "",
"is_stop_sell": 0,
"line_price": 0,
"payment_type": 1,
"piece_price": 0,
"recycle_bin_state": 1,
"resource_password": "",
"sale_type": 1,
"start_at": "2023-05-31 17:19:26",
"state": 2
},
"module_info": {
"alive_mode": 0,
"complete_time": 33,
"expire": "2023-06-30",
"expire_type": 2,
"is_contact_on": 0,
"is_lookback": 1,
"is_open_complete_time": 1,
"play_fast_state_switch": "0",
"warm_up": 1
},
"relation_info": {
"attach_goods": [],
"package": [],
"tags": []
},
"resource_info": {
"alive_img_material_id": "xxxxxxx",
"alive_type": 2,
"alive_video_material_id": "",
"aliveroom_img_material_id": "xxxxxxx",
"app_id": "apprnDA0ZDw4581",
"descrb": "[{\"type\":0,\"value\":\"直播详情243\"}]",
"id": "l_649a5d06e4b064a8136cb5b1",
"img_material_id": "xxxxxxx",
"ios_applet_desc": {
"alive_img_material_id": "",
"descrb": "",
"img_material_id": "",
"state": 2,
"summary": null,
"title": ""
},
"summary": "直播简介2432",
"title": "直播名称123223",
"warm_up_video_cover_material_id": "",
"warm_up_video_material_id": "",
"zb_start_at": "2023-05-31 18:00:00",
"zb_stop_at": 3600
},
"role_info": [{
"role_name": "讲师",
"user_id": "u_6688888888889999999",
"nickname": "测试",
"avator": "",
"is_can_exceptional": 1
}]
}
}