创建主播连线
接口说明
支持开发者传入主播直播间和参与的嘉宾创建主播连线,设置单直播间最大人数限制,并返回连线id、直播间被过滤的信息列表和仅被过滤的嘉宾的直播间信息列表。
主播可参与主播连线的必要条件:
- 主播已挂载当前玩法;
- 主播抖音端版本不低于 32.3.0 ,伴侣版本不低于880;
- 主播直播间属于公开直播间(开启直播时设置公开可见且不设置私密账号),或者主播属调试成员;
- 主播分成比满足大于 10%;
- 主播所在直播间已完成前置准备,开启聊天室模式。
如不满足以上任一条件,则本次请求会过滤该主播,当人数不满足在[2,9]的区间时会拦截并返回创建失败。
嘉宾可参与主播连线的必要条件:
- 嘉宾在聊天室麦位上;
- 嘉宾抖音端版本不低于 32.3.0 ,伴侣版本不低于880;
- 嘉宾分成比满足大于 10%。
如不满足以上任一条件,则本次请求会过滤该嘉宾,当人数不满足在[2,9]的区间时会拦截并返回创建失败。
创建主播连线成功的必要条件:
- 按以上条件过滤后人数满足在[2,9]的区间;
- 所有主播均为调试成员/均为非调试成员。
使用限制
小玩法app_id维度,限流配置为 200 次/s。
小玩法app_id+直播间room_id维度,限流配置为 1 次/s。
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/create |
HTTP Method | POST |
Scope | multi_anchor_linkmic |
请求参数
请求头
content-type必填String
示例:application/json
固定值"application/json"
x-token必填String
示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
Body展开全部子属性
app_idString
玩法ID
max_link_num_per_roomInt64
单直播间最大连线人数,选填,不填写默认不限制
room_idInt64
发起开启连线的房间ID,必填
room_id_strString
roomsList
要加入主主连线的直播间list,必填
展开子属性
请求示例
curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/create' \ --header 'X-Token: 08011218474169395a305953426c41386e514d4d362b38627767xxxx' \ --header 'Content-Type: application/json' \ --data-raw '{"app_id":"ttb101c7bc2e30eexxxx","rooms":[{"room_id":743821583150889xxxx,"audience_open_ids":["xxxx"]},{"room_id":743821681514843xxxx,"audience_open_ids":["xxxx"]}],"room_id":743821583150889xxxx}'
响应参数
Body展开全部子属性
dataStruct
展开子属性
errcodeInt64
错误码,0代表成功
errmsgString
错误描述
响应示例
正常响应示例异常响应示例
{ "data": { "link_id_str": "Mk9Ig6mb1h", "link_id": 5979545945384468000, "filter_room_list": [ { "filter_audience_list": [ { "filterReason": 1861076429692679400, "open_id": "op5mgC6k3r" } ], "room_id_str": "4MxCvXuJdp", "room_id": 532824966374663500, "is_filter": false, "filterReason": 774315974933242400 } ], "just_filter_audience_room_list": [ { "is_filter": false, "filterReason": 942048377532581200, "filter_audience_list": [ { "open_id": "cCUF2Ydoos", "filterReason": 3975179929198183400 } ], "room_id_str": "FDq6ReB1cI", "room_id": 6798001982379012000 } ] }, "errcode": 8157578509165705000, "errmsg": "dtV3UUNv65" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 40001 | 参数错误 | 请求体中的必传参数是否都上传、请求的小玩法app_id是否与请求时access_token相匹配 |
200 | 40007 | 请求过于频繁 | 接口有频控限制,建议降低请求的并发量 |
200 | 40004 | access_token过期 | 重新生成access_token |
200 | 50055 | 房间非公开,设置了可见性/隐私直播间 | 检查并解除可见性/隐私直播间设置 |
200 | 50057 | 当前直播间场景不支持打开主主连线 | 检查主播开启的直播间场景,并更换直播间场景 |
200 | 50058 | 玩法/用户分成比异常 | 检查厂商为主播设置的分成比是否异常,并修正 |
200 | 50059 | 用户宿主不支持/版本过低 | 提示主播改用符合当前能力的宿主及版本:抖音端32.3.0、伴侣端880 |
200 | 50060 | 主播直播间不支持多环境(调试直播间与正式直播间不可共连) | 检查所有主播是否存在部分主播属于调试成员、部分主播属于非调试成员,并修正 |
200 | 50062 | 房间存在异常老的主主连线连麦 | 需要调用【主播连线前置准备】API,释放上一次的异常连麦 |
200 | 50049 | 连线人数超过限制 | 检查连线人数限制,要求连线总人数小于等于9,且单直播间连线人数小于等于max_link_num_per_room,若max_link_num_per_room为0则无限制 |
200 | 50050 | 过滤后(如有过滤)连线人数低于最小人数限制(要求连线总人数大于等于2)
检查被过滤的用户过滤原因,并提示解除相关配置
| 检查被过滤的用户过滤原因,并提示解除相关配置 |