讲解卡动态更新

收藏
我的收藏
更新指定直播间的讲解卡信息。​
频率限制:单个 appID 调用上限为 50 次/秒。​

请求地址

POST https://webcast.bytedance.com/api/card/update

请求参数

请求 Headers​

属性​
数据类型​
必填​
说明​
X-Token​
string​
是​
通过接口获取的access_token。​
详情可参考:getAccessToken
Content-Type​
string​
是​
必须为:application/json​

请求 Body​

属性​
数据类型​
必填​
说明​
room_id​
string​
是​
直播房间ID​
card_type​
number​
是​
讲解卡类型。​
可选值如下:1-标准讲解卡​
value​
string​
是​
讲解卡内容。格式为 JSON 格式​
其中只允许更新value中的status_tagbtn字段。​
其中status_tag的可更新字段如下:​
属性​
数据类型​
必填​
说明​
tag_type​
number​
否​
标签类型。​
可选值:1;讲解中;2-同城;3-秒杀;4-截拍​
start_timestamp​
string​
否​
活动开始时间戳。秒杀和截拍标签下使用。​
stop_timestamp​
string​
否​
活动结束时间戳。秒杀和截拍标签下使用。​
其中btn的可更新字段如下:​
属性​
数据类型​
必填​
说明​
price​
string​
否​
价格。仅在btn_type为301时生效。​

返回值

正确返回的 JSON 数据包:​
属性​
数据类型​
必填​
说明​
status​
number​
是​
讲解卡更新状态。可选值如下:1-更新成功,2-更新失败​
audit_opinion​
string​
否​
审核意见​
异常返回的 JSON 数据包:​
属性​
数据类型​
说明​
errcode​
number​
错误码​
errmsg​
string​
错误信息​

请求示例​

curl -v -X POST https://webcast.bytedance.com/api/card/update -d "{\"room_id\":\"123321\",\"card_type\":1,\"value\":\"{\\\"btn\\\":{\\\"price\\\":\\\"100\\\"}}\"}" -H "X-Token: xxxxxxxxxx" -H "Content-Type: application/json"

返回示例​

正常返回​
{ "status": 1"audit_opinion": "" }
错误返回​
{ "errcode": -1, "errmsg": "system error" }