接口说明

开发者可指定嘉宾云启动玩法。嘉宾启动玩法成功的必要条件：

1. 当前玩法支持云启动；

2. 当前用户已在麦上；

3. 当前用户的宿主和版本支持云启动。如不满足以上任一条件，则本次请求会被拦截并返回启动失败。

使用限制

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

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

基本信息

名称	描述
HTTP URL	https://webcast.bytedance.com/api/audience/join_game
HTTP Method	POST
Scope	game_audience_coplay

请求参数

请求头

content-type必填String

示例：application/json

固定值"application/json"

x-token必填String

示例：08011218462b6b4b5054626e426e50685a7554643144644449413d3d

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

Body

app_idString

小玩法 app_id

open_idString

用户 open_id

room_idInt64

房间 Id

请求示例
curl --location --request POST 'https://webcast.bytedance.com/api/audience/join_game' \
--header 'Content-Type: application/json' \
--header 'X-Token: 08011218462f4f516b5333xxx' \
--data-raw '{"room_id":740769665344184xxxx,"app_id":"tt50f82645cfcxxxxxxx","open_id":"xxx"}'

响应参数

Body

dataStruct

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

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	40001	参数错误
200	40007	请求过于频繁
200	40004	access_token过期
200	50041	玩法同玩场景未准备好	请检查当前直播间是否在观众连麦/聊天室连麦中
200	50042	玩法同玩场景未准备好	请检查当前玩法是否支持云启动
200	50047	当前用户不在连麦中	当前传入的用户已经不在连麦中
200	50048	观众一键同玩能力繁忙	观众一键同玩能力繁忙，暂停使用

嘉宾云启动玩法在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

嘉宾云启动玩法