抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 服务端 API 介绍
  • 接口调用凭证
  • 登录
  • 直播间能力
  • 查询任务状态

    收藏
    我的收藏

    接口说明

    抖音开放平台提供接口给开发者查询推送任务状态,只有响应“运行中”状态任务才是正常运行,响应:

    • 不存在:任务已经被删除,可能是因为主播取消挂载/已关播
    • 未启动:任务还未被启动,需要开发者调用启动任务接口

    使用限制

    频率限制:单个 app_id 调用上限为 10 次/秒。

    基本信息

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

    请求参数

    请求头
    access-token必填String
    示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
    content-type必填String
    示例:application/json

    必须包含 application/json

    Query
    appid必填String

    小玩法id

    msg_type必填String

    直播间消息类型,需要前置申请开通了对应类型直播间数据能力才可以调用。

    1. 评论:live_comment

    2. 礼物:live_gift

    3. 点赞:live_like

    4. 粉丝团:live_fansclub

    roomid必填String

    直播间id

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

    响应参数

    Body展开全部子属性
    err_msg必填String

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

    err_no必填Int32

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

    logid必填String

    请求链路id, 用于出问题时提供给开平具体定位

    dataStruct

    请求成功时的返回数据

    {

    "status": 1, // int, 取值:1 任务不存在 2任务未启动 3任务运行中

    }

    展开子属性
    响应示例
    { "err_no": 0, "err_msg": "ok", "logid": "20220927122238291", "data": { "status": 1 } }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    20040023

    缺少必要的请求参数

    20040022

    无效的AccessToken

    20010001

    服务内部逻辑错误