停止任务
收藏接口说明
停止直播间数据推送成功后，抖音平台会等停止前产生的存量数据推送完成，然后停止推送新数据
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://webcast.bytedance.com/api/live_data/task/stop |
| HTTP Method | POST |
| Scope | live_data_push |
请求参数
请求头
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
req_fromString
liveplays_sdk为开放SDK
请求示例
curl -X POST "https://webcast.bytedance.com/api/live_data/task/stop" -d '{"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
请求成功时的返回数据
{}
响应示例
{ "err_no": 0, "err_msg": "ok", "logid": "20220927122238291", "data": {} }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 40023 | 缺少必要的请求参数 | |
| 200 | 40022 | 无效的AccessToken | |
| 200 | 10001 | 服务内部逻辑错误 |
