接口说明

支持开发者前置判断目标主播是否可参与连线，并判断主播是否开启聊天室模式，如果主播未开启聊天室，会为主播开启聊天室，主播抖音端上会出现上麦入口，方便后续创建主播连线后，嘉宾可在抖音端上上下麦。

主播连线前置准备成功的必要条件：

主播已挂载当前玩法；
主播抖音端版本不低于 32.3.0 ，伴侣版本不低于 880；
主播直播间属于公开直播间(直播时设置公开可见且不设私密账号)，或者主播属于调试成员；
主播分成比满足大于 10%；

注意：执行当前接口后，会为主播开启聊天室，主播抖音端上会出现上麦入口，建议提醒主播准备动作即将开启连线模式，不要手动关闭

📌建议在创建主播连线 2-3s 前，每个要参加主播连线的直播间都需调用一次。

使用限制

小玩法app_id维度，限流配置为 200 次/s。

直播间room_id维度，限流配置为 1次/s。

基本信息

名称	描述
HTTP URL	https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/prepare
HTTP Method	POST
Scope	multi_anchor_linkmic

请求参数

请求头

content-type必填String

示例：application/json

固定值"application/json"

x-token必填String

示例：08011218462b6b4b5054626e426e50685a7554643144644449413d3d

调用https://developer.toutiao.com/api/apps/v2/token生成的token

Body

app_idString

玩法APPID，必填

room_idInt64

房间ID，必填

room_id_strString

请求示例
curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/prepare' \
--header 'X-Token: 08011218474169395a305953426c41386e514d4d362b38627767xxxx' \
--header 'Content-Type: application/json' \
--data-raw '{"room_id":743820458384064xxxx,"app_id":"ttb101c7bc2e30eexxxx"}'

响应参数

Body

errcodeInt64

错误码，0代表成功

errmsgString

错误描述

响应示例
正常响应示例异常响应示例
{
  "data": {},
  "errcode": 0,
  "errmsg": "",
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	-1	服务内部异常	服务内部异常
200	40001	参数有误	检查请求body、请求header参数是否缺漏、错误
200	40002	通常为玩法没有该项能力	需开通当前能力
200	40014	缺少必要的参数	检查请求body、请求header参数是否缺漏、错误
200	50036	token解析异常	检查生成 token 使用的参数、取得的 token是否正常
200	50038	token解析到的room_id对应房间不存在	检查生成 token 使用的参数、取得的 token是否正常
200	50039	token已过期	重新生成 token
200	50057	当前直播间场景不支持打开主主连线	检查主播开启的直播间场景，并更换直播间场景
200	50058	玩法/用户分成比异常	检查厂商为主播设置的分成比是否异常，并修正
200	50059	用户宿主不支持/版本过低	提示主播改用符合当前能力的宿主及版本：抖音端32.3.0 及以上、伴侣端 880 及以上
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量

主播连线前置准备在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

主播连线前置准备