互动数据履约上报接口
收藏开发者接入数据推送能力后，收到互动消息（点赞、评论、送礼、粉丝团）的推送时，会自行处理这些消息，我们强烈建议开发者在收到推送和完成对推送数据的处理后进行履约上报。如果开发者进行上报，平台将统计玩法的互动消息的处理是否正常，是否超时。如果有异常，将收到告警消息，及时联系开发者定位问题，解决异常。
接入说明
开发者需要做的履约上报方案如下：
- 1.开发者服务器在确认开发者客户端收到推送数据时进行第一次履约上报
- 2.开发者服务器在确认开发者客户端处理推送数据完成后进行第二次履约上报
接口说明
开发者数据履约情况上报
使用限制
小玩法 app_id 纬度上报。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://webcast.bytedance.com/api/live_data/ack |
| HTTP Method | POST |
| Scope | live_data_ack |
请求参数
请求头
access-token必填String
示例：08011218462b6b4b5054626e426e50685a7554643144644449413d3d
content-type必填String
示例：application/json
固定值"application/json"
Body
ack_type必填Int64
上报类型，1：收到推送；2：完成处理
app_id必填String
玩法id
data必填String
上报数据，json字符串 [{ "msg_id": "xxxx", // 唯一标识，平台推送payload数据里的msg_id "msg_type": "xxx", // 消息类型，live_gift：礼物消息，live_comment：评论消息，live_like：点赞消息 "client_time": 1705989099973 // 客户端毫秒级时间戳，当ack_type为1时即为指令收到后的时间，当ack_type为2时即为渲染成功后的时间 }]
room_id必填String
直播间id
请求示例
curl --location --request POST 'https://webcast.bytedance.com/api/live_data/ack' \--header 'content-type: application/json' \--header 'access-token: 0801121846735352506a356a6' \--data '{ "room_id": "78273162632", "app_id": "tt411d37a0dxxxxx", "ack_type": 1, "data": "[{\"msg_id\": \"32412314314\", \"msg_type\": \"live_comment\", \"client_time\": 1705989099973 }]" }'
响应参数
Body
err_msg必填String
错误内容
err_no必填Int32
错误码，非0为失败
logid必填String
问题排查用
响应示例
{ "err_no": 6909389480539722000, "err_msg": "1MhIzGq3r2", "logid": "ByfzIYYspu" }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 1 | 上报错误 | 请根据err_msg的信息排查错误 |
| 200 | 0 | 上报成功 | |
| 20 | 4001015 | 参数错误 |
