# 获取直播大屏直播列表
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getlivelist
只返回电商直播间的直播列表
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/livedashboard/getlivelist?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：176
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ds | number | 是 | 日期。目前参数 ds 不得早于 20240101。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| trace_id | string | 追踪ID，报bug带 |
| live_items | objarray | 直播信息 |
| has_more | boolean | 是否还有更多的直播 |
# Res.live_items(Array) Object Payload
直播信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| live_items[].export_id | string | 直播唯一ID |
| live_items[].create_time | number | 直播创建时间 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"ds": 20240612
}
返回示例
无
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 1 | 请求得参数错误 |
| 5 | 查询的日期过早 |
| 48001 | 接口权限未开启，需前往视频号助手- 开放能力-开放场景 打开开关 |
# 7. 适用范围
本接口支持「视频号助手」账号类型调用。其他账号类型如无特殊说明，均不可调用。