上报连麦对局内用户积分
接口说明
上报连麦对局内用户积分,在对局开始、对局结束上报一次,对局期间定时上报,上报后会将积分值展示在麦位上。
底层以直播间维度覆盖存储最新的对局数据,因此每次调用会将直播间上次的麦位积分完全覆盖。
• 比如:直播间内嘉宾对局数据定时上报到开发平台,每 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 |
Scope | game_audience_coplay |
请求参数
请求头
content-type必填String
示例:application/json
固定值"application/json"
x-token必填String
示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
Body展开全部子属性
anchor_infosList
对局关联的直播房间列表,目前仅支持传入 1 个
展开子属性
app_idString
小玩法 app_id
round_idInt64
一轮游戏的唯一标识
round_statusInt64
对局状态,枚举值:1 开始;2 结束;3 进行中
user_listList
参与游戏的用户列表
展开子属性
请求示例
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展开全部子属性
err_codeInt64
错误码,0代表成功
err_msgString
错误描述
fail_room_listList
失败的房间信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "errcode": 0, "errmsg": "" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 40001 | 参数错误 | 房间 id、小玩法 app_id 等入参解析失败,检查参数解析逻辑 |
200 | 40007 | 请求过于频繁 | 接口有频控限制,建议降低请求的并发量 |
200 | 40004 | access_token 过期 | 重新生成 access_token |
200 | 50048 | 观众一键同玩能力繁忙 | 观众一键同玩能力繁忙,暂停使用 |