获取直播房间数据
接口说明
获取小程序关联的直播间数据,基于获取的直播间数据,查询直播间交易分析数据。
使用限制
- 只能查询最近14天的直播间
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/platform/v2/data_analysis/query_live_room/ |
HTTP Method | GET |
权限要求 | 服务商代调用场景下,需商家授予数据分析权限集 |
请求参数
请求头
access-token必填String
当非服务商时,调用https://open.douyin.com/oauth/client_token/生成的token
当服务商时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
当服务商时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
Query
anchor_nameString
主播昵称
请求示例
curl --location --request GET 'https://open.douyin.com/api/platform/v2/data_analysis/query_live_room/?anchor_name=xxx' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
err_msg必填String
错误信息
err_no必填Int32
错误码
log_id必填String
排查错误的logId
dataStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "success", "log_id": "xxx", "data": { "current_live_room": [ { "anchor_name": "主播名称A", "live_room_id": 111, "live_room_name": "直播间名称A", "create_time": 1671620183 } ], "history_live_room": [ { "anchor_name": "主播名称A", "live_room_id": 222, "live_room_name": "直播间名称B", "create_time": 1671610183 } ] } }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | -1 | 系统错误 | 建议重试,若多次重试失败,可向平台反馈该问题 |
200 | 11009 | 参数不合法或缺少参数 | 检查参数合法性,注意参数类型以及是否缺少必要参数 |
200 | 28001003 | access_token无效 | 请检查access_token |
200 | 28001007 | 必填字段缺失 | 请检查必填字段 |
200 | 28001008 | access_token过期 | 请刷新或重新授权access_token |