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

    收藏
    我的收藏

    接口说明

    注意:不同类型的数据需要启动不同的任务单独监听,比如礼物数据单独启动一个,评论数据单独启动一个 启动直播间数据推送,启动成功后,直播间数据才会同步推送给开发者服务器

    使用限制

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

    基本信息

    名称描述
    HTTP URL
    https://webcast.bytedance.com/api/live_data/task/start
    HTTP Method
    POST
    Scope
    live_data_push
    权限要求

    该接口用于获取开放能力接口的调用凭证 access_token。

    请求参数

    请求头
    access-token必填String
    示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
    content-type必填String
    示例:application/json
    固定值"application/json"
    Body
    appid必填String
    直播玩法id
    msg_type必填String
    直播间消息类型,需要前置申请开通了对应类型直播间数据能力才可以调用。 1. 评论:live_comment 2. 礼物:live_gift 3. 点赞:live_like 4. 粉丝团:live_fansclub
    roomid必填String
    直播间id
    请求示例
    curl -X POST "https://webcast.bytedance.com/api/live_data/task/start" -d '{"roomid":"123456","appid":"tt1234567cac","msg_type":"live_comment"}' -H "access-token:your_token" -H "content-type:application/json"

    响应参数

    Body展开全部子属性
    err_msg必填String
    错误内容
    err_no必填Int32
    错误码,非0为失败
    logid必填String
    问题排查用
    dataStruct
    响应数据
    展开子属性
    响应示例
    { "err_no": 0, "err_msg": "ok", "logid": "20220927122238291", "data": { "task_id": "763535353" } }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    20040023
    缺少必要的请求参数
    检查必填参数是否齐全
    20040022
    无效的AccessToken
    检查token是否错误或者失效
    20010001
    服务内部错误,调用下游服务失败
    oncall联系平台排查
    2005003019
    推送任务不符合开启的限制条件