查询全局默认配置

收藏
我的收藏
获取小程序全局讲解卡配置。
重复设置时,查询将仅返回当前审核中的讲解卡。
频率限制:单个 appID 调用上限为 1 次/秒。

请求地址

POST https://webcast.bytedance.com/api/card/default/get

请求参数

请求 Headers

属性
数据类型
必填
说明
X-Token
string
通过接口获取的access_token。
详情可参考:getAccessToken

返回值

正确返回的 JSON 数据包
属性
数据类型
必填
说明
card_type
number
讲解卡类型。
可选值如下:1-标准讲解卡
value
string
讲解卡内容。格式为 JSON 格式
status
number
讲解卡审核状态。
可选值:1-审核中;2-审核成功;3-审核失败;4-审核异常
audit_opinion
string
审核意见
异常返回的 JSON 数据包
属性
数据类型
说明
errcode
number
错误码
errmsg
string
错误信息

请求示例

curl -v -X POST https://webcast.bytedance.com/api/card/default/get -H "X-Token: xxxxxxxxxx"

返回示例

正常返回
{ "audit_opinion": "", "card_type": 1, "status": 2, "value": { "btn": { "btn_type": 100 }, "image_id": "123456", "title": { "main_title": "商品A" } } }
错误返回
{ "errcode": -1, "errmsg": "system error" }