弹幕数据上报

我的收藏

数据上报接口

弹幕玩法对局结束后后，上报本轮游戏相关数据。

频率限制：单个 appID 调用上限为 30 次/秒。

请求地址

POST https://webcast.bytedance.com/api/live_data/game/info

请求参数

•

请求Headers

属性	数据类型	必填	说明
Byte-Authorization	string	是	详情可参考：「签名及验签指南」
Content-Type	string	是	必须包含 application/json

•

请求Body

Body 需要以 JSON 格式填充

属性	数据类型	必填	说明
app_id	string	是	玩法appID
round_id	string	是	一轮游戏的唯一标识，注意每轮ID标识需要递增
anchor_open_id	string	是	主播openID
room_id	string	是	房间ID
start_time	int64	是	游戏开始时间戳
end_time	int64	是	游戏结束时间戳
end_status	int64	是	结束状态，1-正常 2-非正常
rank_lists	list	是	对局信息列表

rank_lists 的长度不能大于 100，其 item 的结构为:

属性	数据类型	必填	说明
rank_result	int64	是	排名列表结果，1-胜利 2-失败，其余值可自定义
rank_result_comment	string	是	排名列表备注，开发者自定义
rank_users	list	否	排名玩家列表

rank_users 的长度不能大于 100，其 item 结构为:

属性	数据类型	必填	说明
open_id	string	是	用户openID
rank	int64	是	用户排名
scores	int64	是	对局积分

返回值

建议开发者对返回内容进行验签，验签详情可参考：「签名及验签指南」

•

正确返回的 JSON 数据包

属性	数据类型	说明
code	int64	状态码 1-成功非1-失败

•

异常返回的JSON数据包

属性	数据类型	说明
errcode	number	错误码
errmsg	string	错误信息

errcode 的合法值

错误码	错误信息	描述
-1	system error	服务内部异常
40001	request params are invalid	参数有误
40002	you don't have permission	通常为小程序没有该项能力
40007	over frequency control	调用频率过高
40014	required param not found	缺少必要的参数
50002	invalid params of signature	签名参数有误
50003	out-dated signed timestamp	签名参数上的时间戳距离当前时间过久
50004	verify signature fail	验签失败
50012	data does not exist	数据不存在

返回数据示例

•

请求

curl --location --request POST 'https://webcast.bytedance.com/api/live_data/game/info' \
--header 'Byte-Authorization: SHA256-RSA2048 appid="ttdce2aa5f43de489910",nonce_str="F9E89D3CFBCE90B02901DDE1F81C039D",timestamp="1687167723",key_version="1",signature="rLpJfXHA0CdRiZx91FAavfonckYN50EFprdA0rKItU8WMrtnydHg6gzmOo0iT7m5FgRdUMxtDJBAppHO/UZBHP2LrHXwnwAKMFBI59+6Kj0jHNukecB8o0cunx+AcKCdiwM4D4ygjsUsK7KWOcOkp+SZ8b5SRWLc1PYyus1gTVWkMhCDLFUKpoOHkhuEuT1OInk6OdnJ22FTH+1JElH7hHpGQK3twKwa59x4qzorrM1oUNowwiySHvCzkS8wTXgLugWu9GcC4fEMRxTm7qe6A5il2KOGCzRnVivYm/pKbINjZFZp3dmqbiGHwPPsv/71HJ9Z71Yj4cK0UUnBc2m2pg=="' \
--header 'Content-Type: application/json' \
--data-raw '{"app_id":"ttdce2aa5f43de489910","round_id":"1234564332","anchor_open_id":"_000tyrmt1SD9i0cCrnxgl9Pke60ZEaaRgkk","room_id":"1111122222","start_time":10,"end_time":10,"end_status":2,"rank_lists":[{"rank_result":2,"rank_result_comment":"成功排行榜","rank_users":[{"open_id":"_0002XQ1T9j5_SUTeBy1zlSXkX7zPr1tz5ct","rank":10,"scores":110}]}]}'

•

正常返回

{ "code": 1 }

•

错误返回

{ "errcode": 400, "errmsg": "invalid params", "message": "" }