互动数据履约上报
开发者接入数据推送能力后,收到互动消息(点赞、评论、送礼、粉丝团)的推送时,会自行处理这些消息,我们强烈建议开发者在收到推送和完成对推送数据的处理后进行履约上报。如果开发者进行上报,平台将统计玩法的互动消息的处理是否正常,是否超时。如果有异常,将收到告警消息,及时联系开发者定位问题,解决异常。
使用限制
小玩法 app_id 纬度上报。
接口说明
开发者需要做的履约上报方案如下:
- 1.开发者服务器在确认开发者客户端收到推送数据时进行第一次履约上报
- 2.开发者服务器在确认开发者客户端处理推送数据完成后进行第二次履约上报
基本信息
名称 | 描述 |
HTTP URL | |
HTTP Method | POST |
请求头
名称 | 字段类型 | 是否必填 | 描述 |
content-type | String | 是 | 固定值"application/json" |
access-token | String | 是 |
请求参数
字段 | 数据类型 | 必填 | 说明 |
room_id | string | 是 | 直播间id |
app_id | string | 是 | 玩法id |
ack_type | int | 是 | 上报类型,1:收到推送;2:完成处理 |
data | string | 是 | 上报数据,json字符串
|
请求示例
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 }]" }'
响应参数
字段 | 数据类型 | 说明 |
err_no | int | 请求错误码,0表示成功,非0表示失败 |
err_msg | string | 非0错误码时,携带额外的错误提示信息 |
logid | string | 请求链路id, 用于出问题时提供给开平具体定位 |
响应示例
正常示例
{ "err_msg": "", "err_no": 0, "logid": "xxxxx" }
异常示例
{ "err_msg": "status=10011 message=Request params error", "err_no": 1, "logid": "xxxx" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
200 | 1 | 上报错误 | 请根据err_msg的信息排查错误 |