接口说明

注意：补偿数据的查询没有 ack 机制，需要开发者自行维护补偿状态，比如当前补偿到第几页了，下次该读取第几页

开发者可以定时请求 api 分页查询推送失败的数据，如果返回空则代表全部推送成功频率限制：单个 app_id 调用上限为 10 次/秒。

基本信息

名称	描述
HTTP URL	https://webcast.bytedance.com/api/live_data/task/fail_data/get
HTTP Method	GET
Scope	live_data_push

请求参数

请求头

access-token必填String

示例：08011218462b6b4b5054626e426e50685a7554643144644449413d3d

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

content-type必填String

示例：application/json

必须包含 application/json

Query

appid必填String

小玩法id

msg_type必填String

直播间消息类型，需要前置申请开通了对应类型直播间数据能力才可以调用。 1. 礼物：live_gift 2. 粉丝团：live_fansclub

page_num必填Int32

页码：注意，需要从1开始

page_size必填Int32

每页数据条数, 最大不超过100

roomid必填String

直播间id

请求示例
curl -X GET "https://webcast.bytedance.com/api/live_data/task/fail_data/get?roomid=123456&appid=tt1234567cac&msg_type=live_comment&page_num=1&page_size=10" -H "access-token:your_token" -H "content-type:application/json"

响应参数

Body展开全部子属性

err_msg必填String

非0错误码时，携带额外的错误提示信息

err_no必填Int32

请求错误码，0表示成功，非0表示失败

logid必填String

问题排查用

dataStruct

响应数据

展开子属性

响应示例
{ 
  "err_no": 0,
  "err_msg": "ok",
  "logid": "20220927122238291",
  "data": {
    "page_num": 1,
    "total_count": 100,
    "data_list": [
      // 当页的数据列表
      {
        "roomid": "12345", // string类型，消息的房间id
        "msg_type": "live_gift", // string类型，表示消息类型
        "payload": "[...]" // string类型， 对应推送协议中的payload字符串，需要unmarshal
      }
    ]
  }
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述
200	40023	缺少必要的请求参数
200	40022	无效的AccessToken
200	10001	请求的分页查询参数不合法

开发者文档

分页查询推送失败数据(仅支持礼物、粉丝团数据)

接口说明

基本信息

请求参数

响应参数

错误码

分页查询推送失败数据(仅支持礼物、粉丝团数据)在线调试

接口说明

基本信息

请求参数

响应参数

错误码

分页查询推送失败数据(仅支持礼物、粉丝团数据)