阶段	接口名称	接口描述
对局开始前	查询直播间麦位信息(可选)	1.接口作用：支持查询单个主播直播间麦位信息，方便后续主播选择在麦位嘉宾进主主连线、开嘉宾玩法 2.调用时机：建议在对局开始前拉取麦位，邀进对局。
对局开始前	主播连线前置准备	1.接口作用：支持开发者前置判断目标主播是否可参与连线，并做前置准备 2.调用时机：在创建主播连线前，每个直播间都需调用一次
对局开始	创建主播连线	1.接口作用：建立多主播直播间连线，最多9人，返回连线ID 2.调用时机：建议在主播完成匹配后，到玩法开局前创建连线
对局进行中	查询主播连线麦位信息	1.接口作用：支持开发者根据连线ID查询连线麦位信息 2.调用时机：建议在创建主播连线后定时轮询，感知中途嘉宾/主播上下麦
	中途单主播离线(可选)	1.接口作用：支持单个主播直播间离开所在的连线，对应同直播间的嘉宾会离线 2.调用时机：建议主播在玩法内操作「离开对局」时调用
	附近语音(可选)	1.接口作用：实现连线主播间，仅能听到特定用户声音的设计，支持控制用户能听到声源的音量，默认每个用户可听见所有在连线内的用户 2.调用时机：开发者可依据玩法设计来判断是否调用。若需调用，可在玩法开始时初始化音量控制，并根据玩法进程实时更新各主播的语音接收范围
	积分上报(可选)	1.接口作用：支持玩法上报连麦对局内用户积分，同步展示在直播间麦位上 2.调用时机：在对局开始、对局结束上报一次，对局期间定时上报
对局结束	结束主播连线	1.接口作用：解除多主播直播间连线 2.调用时机：建议在每局结束后，预留一段时间给主播交流、查看排行榜后，再结束连线

接入时序

备注：厂商接入同局主播连线能力需要接入红色箭头API

对局前置流程

备注：【主播邀嘉宾进入玩法】流程仅在同时接入【观众一键同玩能力】时才需关注

对局流程

备注：
【中途嘉宾进入玩法】仅在同时接入【观众一键同玩能力】时才需关注

接口明细

查询直播间麦位信息

接口说明

可获取直播间麦位信息，获取在麦位上用户的 open_id、用户的宿主版本是否支持云启动。

使用限制

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

基本信息

名称	描述
HTTP URL	https://webcast.bytedance.com/api/linkmic/query
HTTP Method	POST

请求头

名称	字段类型	是否必填	描述
Content-Type	String	是	固定值"application/json"
X-Token	String	是	通过接口获取的 access_token

请求参数

•

Body

字段	数据类型	必填	说明
app_id	String	是	应用 ID
room_id	String	是	直播间 ID

请求示例

curl --location --request POST 'https://webcast.bytedance.com/api/linkmic/query' \
--header 'X-Token: 08011218462f4f49645946664c6f3466473' \
--header 'Content-Type: application/json' \
--data-raw '{"app_id":"tt50f82645cfcxxxxxxx","room_id":"741145185683402xxxx"}'

响应参数

•

Body

名称			字段类型	描述
errmsg			String	错误描述
errcode			Int64	错误码，0代表成功
base_info			Struct	麦位基本信息
	linker_id		String	本次连麦唯一 ID
	total_count		Int32	麦位总数
	free_count		Int32	麦位剩余数量
user_list			[Array Item]	麦上用户基本信息列表，元素结构为struct
	open_id		String	麦上用户的 openId
	avatar_url		String	麦上用户的头像
	nick_name		String	麦上用户的昵称
	app_info		Struct	麦上用户玩法相关信息
		host_app_start_app_available	Bool	麦上用户宿主是否支持云启动玩法

响应示例

正常响应示例

{"errcode": 0,"errmsg": ""}

异常响应示例

{"errcode": 40001,"errmsg": "request params are invalid"}

错误码

http状态码	错误码	错误码描述	排查建议
200	40001	参数错误	请求体中的必传参数是否都上传、请求的小玩法app_id是否与请求时access_token相匹配
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量
200	40004	access_token过期	重新生成access_token
200	50034	未开启聊天室	无

主播连线前置准备

接口说明

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

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

•

主播已挂载当前玩法；

•

主播抖音端版本不低于 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

请求头

名称	字段类型	是否必填	描述
content-type	String	是	固定值"application/json"
X-Token	String	是	getAccessToken

请求参数

•

请求Headers

字段	数据类型	必填	说明
X-Token	String	是	通过接口获取的 access_token
Content-Type	String	是	必须包含 application/json

•

Body

字段	数据类型	必填	说明
app_id	String	是	应用ID
room_id	Int64	是	直播间ID

请求示例

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

字段	数据类型	说明
errcode	Int32	请求错误码，0表示成功，非0表示失败
errmsg	String	非0错误码时，携带额外的错误提示信息

响应示例

正常响应示例

{
  "data": {},
  "errcode": 0,
  "errmsg": "",
}

异常响应示例

{
    "errcode": 50008,
    "errmsg": "game not start",
    "logid": "2024111719540869341B552CEC897Exxxx"
}

错误码

http状态码	错误码	错误信息	描述
200	-1	服务内部异常	服务内部异常
200	40001	参数有误	检查请求body、请求header参数是否缺漏、错误
200	40002	通常为小程序没有该项能力	需开通当前能力
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量
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 及以上

创建主播连线

接口说明

支持开发者传入主播直播间和参与的嘉宾创建主播连线，设置单直播间最大人数限制，并返回连线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

请求头

名称	字段类型	是否必填	描述
Content-Type	String	是	固定值"application/json"
X-Token	String	是	通过接口获取的 access_token

请求参数

•

Body

字段		数据类型	必填	说明
app_id		String	是	应用ID
room_id		Int64	是	发起创建的直播间 ID
max_link_num_per_room		Int64	是	单直播间最大连线人数限制
rooms		[Array Item]	是	参与连线的直播间信息，元素结构为struct
	room_id	Int64	是	参与连线的直播间ID
	audience_open_ids	[Array Item]	否	当前连线直播间中参与连线的嘉宾open_id，元素结构为string

请求示例

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

字段名称				字段类型	描述
errmsg				String	错误描述
errcode				Int64	错误码，0代表成功
data				Struct	响应数据
	link_id			Int64	本次创建成功的连麦唯一 ID
	filter_room_list			[Array Item]	直播间被过滤的直播间列表，元素结构为struct
		room_id		Int64	直播间ID
		filter_reason		Int64	直播间被过滤的原因： 1:主播端版本过低； 2:分成比异常； 3.房间未开启聊天室/用户不在连线中； 4:玩法互斥，主播打开了互斥的场景，如K歌； 5: 隐私直播间； 6: open_id 无效，查不到用户； 7: 房间未开启玩法； 999: 未知；
	just_filter_audience_room_list			[Array Item]	只被过滤的嘉宾的直播间列表，元素结构为struct
		room_id		Int64	嘉宾所属的直播间ID
		filter_audience_list		[Array Item]	本直播间中被过滤嘉宾列表，元素结构为struct
			open_id	String	被过滤的嘉宾open_id
			filter_reason	Int64	嘉宾被过滤的原因： 1:主播端版本过低； 2:分成比异常； 3.房间未开启聊天室/用户不在连线中； 6: open_id 无效，查不到用户； 7: 房间未开启玩法； 999: 未知；

响应示例

正常响应示例

{
    "errcode":0,
    "errmsg":"",
    "data": {
        "link_id": 743848279244507xxxx,
        "just_filter_audience_room_list": [
            {
                "room_id": 743847635766490xxxx,
                "filter_audience_list": [
                    {
                        "open_id": "_000z9ZtO4WYmQkCEiX16ADKjsM6mH3Pxxxx",
                        "filterReason": 3
                    },
                    {
                        "open_id": "xxxx",
                        "filterReason": 6
                    }
                ]
            },
            {
                "room_id": 743848356398286xxxx,
                "filter_audience_list": [
                    {
                        "open_id": "xxxx",
                        "filterReason": 6
                    },
                    {
                        "open_id": "xxxx",
                        "filterReason": 6
                    },
                    {
                        "open_id": "xxxx",
                        "filterReason": 6
                    }
                ]
            }
        ]
    }
}

异常响应示例

{"errcode": 40001,"errmsg": "request params are invalid"}

错误码

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)	检查被过滤的用户过滤原因，并提示解除相关配置

结束主播连线

接口说明

开发者可结束指定连线 ID 的连线。

使用限制

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

小玩法 app_id +嘉宾 open_id +直播间 room_id 维度，启动和结束玩法 qps 限流配置为 1 次 /s。

基本信息

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

请求头

名称	字段类型	是否必填	描述
Content-Type	String	是	固定值"application/json"
X-Token	String	是	通过接口获取的 access_token

请求参数

•

Body

名称	字段类型	是否必填	描述
app_id	String	是	应用ID
link_id	Int64	是	需要结束的连线ID
room_id	Int64	是	发起结束的直播间ID

请求示例

curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/release' \
--header 'X-Token: 08011218474143394b647954536f4b664e63654a727a66355a41xxxx' \
--header 'Content-Type: application/json' \
--data-raw '{"app_id":"ttb101c7bc2e30eexxxx","link_id":740769305443176xxxx,"room_id":742475315370015xxxx}'

响应参数

请求响应都以http 200的形式返回，具体错误由响应字段中的错误码字段来标记。

名称	字段类型	是否必填	描述
errcode	Int64	是	错误码，0代表成功
errmsg	String	是	错误描述，成功为 success

响应示例

•

正常响应

{
        "errcode": 0,
        "errmsg": "success",
}

•

异常响应

{
    "errcode": 40004,
    "errmsg": "access token is expired"
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	40001	参数错误	房间id、小玩法app_id等入参解析失败，检查参数解析逻辑
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量
200	40004	access_token过期	重新生成access_token

查询主播连线麦位信息

接口说明

可获取主播连线麦位信息，获取在麦位上用户的open_id。

使用限制

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

基本信息

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

请求头

名称	字段类型	是否必填	描述
Content-Type	String	是	固定值"application/json"
X-Token	String	是	通过接口获取的 access_token

请求参数

•

Body

字段	数据类型	必填	说明
app_id	String	是	应用 ID
room_id	Int64	是	直播间 ID
link_id	Int64	是	连线 ID

请求示例

curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/query' \
--header 'Content-Type: application/json' \
--header 'X-Token: 0801121847416a31576a794a667163714a33414e393574323677xxxx' \
--data-raw '{"app_id":"ttb101c7bc2e30eexxxx","link_id":743848279242431xxxx,"room_id":742662870132624xxxx}'

响应参数

•

Body

名称				字段类型	描述
errmsg				String	错误描述
errcode				Int64	错误码，0代表成功
data				Struct	响应数据
	rooms			[Array Item]	参与主播连线的直播间列表，元素结构为struct
		room_id		Int64	参与主播连线的直播间 ID
		anchor		Struct	参与主播连线的直播间主播信息
			open_id	String	参与主播连线的直播间主播 open_id
			avatar_url	String	主播的头像
			nick_name	String	主播的昵称
		linked_audience_list		[Array Item]	当前直播间中参与主播连线的嘉宾列表
			open_id	String	嘉宾 open_id
			avatar_url	String	嘉宾的头像
			nick_name	String	嘉宾的昵称

响应示例

正常响应示例

{
    "data": {
        "rooms": [
            {
                "room_id": 743847635766490xxxx,
                "anchor": {
                    "open_id": "_000W1yLL_DXamNiC2041YYLxjxQHQUMxxxx",
                    "avatar_url": "https://p3.douyinpic.xxx/xxx",
                    "nick_name": "xxxx"
                }
                "linked_audience_list":[
                    {
                        "open_id": "_000W1yLL_DXamNiC2041YYLxjxQHQUMxxxx",
                        "avatar_url": "https://p3.douyinpic.xxx/xxx",
                        "nick_name": "xxxx"
                    },
                    {
                        "open_id": "_000W1yLL_DXamNiC2041YYLxjxQHQUMxxxx",
                        "avatar_url": "https://p3.douyinpic.xxx/xxx",
                        "nick_name": "xxxx"
                    }
                ]
            },
            {
                "room_id": 743848356398286xxxx,
                "anchor": {
                    "open_id": "_000z9ZtO4WYmQkCEiX16ADKjsM6mH3PDn4Y",
                    "avatar_url": "https://p3.douyinpic.xxx/xxx",
                    "nick_name": "xxx"
                }
            }
        ]
    }
}

异常响应示例

{
    "errcode": 40001,
    "errmsg": "request params are invalid"
}

错误码

http状态码	错误码	错误码描述	排查建议
200	40001	参数错误	请求体中的必传参数是否都上传、请求的小玩法app_id是否与请求时access_token相匹配
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量
200	40004	access_token过期	重新生成access_token

中途单主播离线

接口说明

开发者可指定某个主播中途离开主播连线，若该主播直播间存在其他参与主播连线的其他嘉宾，则其他嘉宾会一同离开主播连线。

使用限制

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

基本信息

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

请求头

名称	字段类型	是否必填	描述
Content-Type	String	是	固定值"application/json"
X-Token	String	是	通过接口获取的 access_token

请求参数

•

Body

名称	字段类型	是否必填	描述
app_id	String	是	应用 ID
link_id	Int64	是	要离开的连线 ID
room_id	Int64	是	要离开的直播间 ID

请求示例

curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/anchor_leave' \
--header 'X-Token: 08011218462f32614a5749694563723467426974475079632f41xxxx' \
--header 'Content-Type: application/json' \
--data-raw '{"app_id":"ttb101c7bc2e30eexxxx","link_id":742471707923830xxxx,"room_id":742475315370015xxxx}'

响应参数

请求响应都以http 200的形式返回，具体错误由响应字段中的错误码字段来标记。

名称	字段类型	是否必填	描述
errcode	Int64	是	错误码，0代表成功
errmsg	String	是	错误描述，成功为 success

响应示例

•

正常响应

{
    "errcode": 0,
    "errmsg": "success",
}

•

异常响应

{
    "errcode": 1,
    "errmsg": "参数不合法"
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	40001	参数错误	房间id、小玩法app_id等入参解析失败，检查参数解析逻辑
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量
200	40004	access_token过期	重新生成access_token
200	50047	当前用户不在连麦中	当前传入的用户已经不在连麦中

上报附近语音用户音量

接口说明

上报附近语音用户音量，对局期间定时上报，上报后会将用户的可听见音源设置为对应音量。

初始情况下，用户可听见的音源，包括所有在连线中的用户，默认音量为100。

接入当前API建议完成以下策略：

对局开始时，调节初始音量

•比如：当前参与主播连线的包括以下用户：A、A1、B、B1
◦设置以下音量设置：
▪用户A可听见的用户A1、B、B1的初始音量
▪用户A1可听见的用户A、B、B1的初始音量
▪用户B可听见的用户A、A1、B1的初始音量
▪用户B1可听见的用户A、A1、B的初始音量

用户中途上麦时，调节新增用户可听见的初始音量，调节其他用户的新增音源的音量

•比如：当前参与主播连线的包括以下用户：A、A1、B，此时新上麦用户B1
◦设置以下音量设置：
▪用户A可听见的用户B1的音量
▪用户A1可听见的用户B1的音量
▪用户B可听见的用户B1的音量
▪用户B1可听见的用户A、A1、B的音量

玩法中用户移动靠近/远离其他用户时，调大/调小音量

•比如：用户A靠近/远离用户A1、B
◦设置以下音量设置：
▪调高/调小用户A可听见的用户A1、B的音量
▪调高/调小用户A1可听见的用户A的音量
▪调高/调小用户B可听见的用户A的音量

使用限制

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

小玩法 app_id + 连线 ID 维度，qps 限流配置为 5 次 /s。

基本信息

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

请求头

名称	字段类型	是否必填	描述
content-type	String	是	固定值"application/json"
X-Token	String	是	getAccessToken

请求参数

•

Body

名称			字段类型	是否必填	描述
app_id			String	是	应用ID
link_id			Int64	是	连线ID
user_infos			[Array Item]	是	在连线中的用户列表，元素结构为struct
	open_id		String	是	用户open_id
	voice_infos		[Array Item]	是	可听到的用户音量列表，元素结构为struct
		neighbor_open_id	String	是	可听到的用户的open_id
		voice	Int64	是	可听到的用户的音量范围(0-100)

请求示例

curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/update_voice' \
--header 'Content-Type: application/json' \
--data-raw '{"app_id":"xxxx","link_id":740769305443176xxxx,"user_infos":[{"open_id":"_000NeUPmpLESCIEEzR4ocGY5OfG0jFfxxxx","voice_infos":[{"neighbor_open_id":"xxxx","voice":100}]}]}'

响应参数

•

Body

名称	字段类型	是否必填	描述
errmsg	String	是	错误描述
errcode	Int64	是	错误码，0代表成功

响应示例

正常响应示例

{
    "errcode": 0,
    "errmsg": ""
}

异常响应示例

{
    "errcode": 40001,
    "errmsg": "request params are invalid"
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	40001	参数错误	房间id、小玩法app_id等入参解析失败，检查参数解析逻辑
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量
200	40004	access_token过期	重新生成access_token

上报连麦对局内用户积分

接口说明

上报连麦对局内用户积分，在对局开始、对局结束上报一次，对局期间定时上报，上报后会将积分值展示在上报的直播间的麦位上。

底层以直播间维度覆盖存储最新的对局数据，因此每次调用会将主播连线上次的麦位积分完全覆盖。

•比如：直播间内嘉宾对局数据定时上报到开发平台，每30s上报一次
◦8:00:00：调用【上报连麦对局内用户积分】接口一次，一次性上报当前时刻的连麦对局内用户积分
◦8:00:30：调用【上报连麦对局内用户积分】接口一次，一次性上报当前时刻的连麦对局内用户积分，直播间内8:00:00上报的数据，将被8:00:30这次上报的数据完全覆盖

注意：如果嘉宾在麦位上，但不在上报用户集合中，则会被默认设置为观战中。

•比如：玩法内调用【上报连麦对局内用户积分】接口一次，一次性上报当前时刻的连麦对局内用户积分，包含三位用户，用户A，用户B，用户C；此时在主播连线麦位上的用户有用户A，用户B，用户C，用户D。
◦此时用户A，用户B，用户C的麦位上展示玩法上报的积分值，用户D的麦位上展示为观战中

建议 每 30s 调用一次，刷新最新的对局积分，保障麦位上对局积分时效

使用限制

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

基本信息

名称	描述
HTTP URL	https://webcast.bytedance.com/api/gaming_con/round/co_game_upload_user_data
HTTP Method	POST

请求头

名称	字段类型	是否必填	描述
content-type	String	是	固定值"application/json"
X-Token	String	是	getAccessToken

请求参数

•

Body

名称		字段类型	是否必填	描述
app_id		String	是	应用ID
round_id		Int64	是	对局Id
round_status		Int64	是	对局状态，枚举值：1开始；2结束；3进行中
anchor_infos		[Array Item]	是	对局关联的直播房间列表，元素结构为 struct，传入主播连线所有直播间
	anchor_open_id	String	是	主播的open_id
	room_id	String	是	房间ID
user_list		[Array Item]	是	用户对局数据列表，元素结构为 struct，传入主播连线中所有连线用户
	open_id	String	是	用户open_id
	score	Int64	是	核心数值,用户排名的依据

请求示例

curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/round/co_game_upload_user_data' \
--header 'X-Token: 08011218462f4f516b53xxx' \
--header 'Content-Type: application/json' \
--data-raw '{"app_id":"ttb101c7bc2e30xxxxxx","round_id":1,"round_status":1,"anchor_infos":[{"anchor_open_id":"xxxx","room_id":"741033347597639xxxx"}],"user_list":[{"open_id":"xxxx","score":396}]}'

响应参数

•

Body

名称	字段类型	是否必填	描述
errmsg	String	是	错误描述
errcode	Int64	是	错误码，0代表成功

响应示例

正常响应示例

{"errcode": 0,"errmsg": ""}

异常响应示例

{"errcode": 40001,"errmsg": "request params are invalid"}

错误码

HTTP 状态码	错误码	描述	排查建议
200	40001	参数错误	房间id、小玩法app_id等入参解析失败，检查参数解析逻辑
200	4014034	请求过于频繁	提高接口的处理能力（必要时可联系平台进行熔断）
200	40004	access_token过期	重新生成access_token

同局主播连线能力收藏我的收藏

更新记录

能力介绍

接入时序

对局前置流程

对局流程

接口明细

查询直播间麦位信息

接口说明

使用限制

基本信息

请求头

请求参数

请求示例

响应参数

响应示例

错误码

主播连线前置准备

接口说明

使用限制

基本信息

请求头

请求参数

请求示例

响应参数

响应示例

错误码

创建主播连线

接口说明

使用限制

基本信息

请求头

请求参数

请求示例

响应参数

响应示例

错误码

结束主播连线

接口说明

使用限制

基本信息

请求头

请求参数

请求示例

响应参数

响应示例

错误码

查询主播连线麦位信息

接口说明

使用限制

基本信息

请求头

请求参数

请求示例

响应参数

响应示例

错误码

中途单主播离线

接口说明

使用限制

基本信息

请求头

请求参数

请求示例

响应参数

响应示例

错误码

上报附近语音用户音量

接口说明

使用限制

基本信息

请求头

请求参数

请求示例

响应参数

响应示例

错误码

上报连麦对局内用户积分

接口说明

使用限制

同局主播连线能力
收藏
我的收藏