查询直播间麦位信息
接口说明
玩法过程中,直播间麦位变化数据,平台不会主动推送,需要玩法服务端定时轮询获取直播间麦位信息,做玩法进程的动态调整。
使用限制
小玩法 app_id 维度,限流配置为 100/s。
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://webcast.bytedance.com/api/linkmic/query |
HTTP Method | POST |
Scope | linkmic |
请求参数
请求头
content-type必填String
示例:application/json
固定值"application/json"
x-token必填String
示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
Body
app_idString
开发者应用ID
room_idString
直播间ID
请求示例
curl --location --request POST 'https://webcast.bytedance.com/api/linkmic/query' \ --header 'content-type: application/json' \ --header 'x-token: 0801121846735352506a356a6' \ --data '{"room_id":"xx","app_id":"xxxx"}'
响应参数
Body展开全部子属性
base_infoStruct
麦位基础信息
展开子属性
user_listList
麦上用户信息
展开子属性
响应示例
{ "base_info": { "total_count": 8143159019799231000, "free_count": 5974157586047230000, "link_id": "jmcnB00ojX" }, "user_list": [ { "nick_name": "6yt4JYGe6q", "open_id": "fJGz6mktql", "disable_camera": 891658959878926300, "sec_avatar_url": "TkoGBF9LVZ", "avatar_url": "AAK002jodZ", "sec_nick_name": "8feHQ2AvHY", "camera_state": 8886605812247335000, "link_position": 1686207824254821400, "disable_microphone": 34274223951723856, "microphone_state": 3747149608751770600, "link_state": 5356215021558909000, "app_info": { "host_app_start_app_available": false } } ] }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 40023 | 缺少必要的请求参数 | 请求体中的必传参数是否都上传、请求的小玩法app_id是否与请求时access_token相匹配、请求头是否正确填写 |
200 | 40022 | 无效的AccessToken | token是否过期或无效 |
200 | 10001 | 服务内部逻辑错误 | 联系平台排查 |