查询指定页面配置

收藏
我的收藏

接口说明

根据页面URL(PATH + 指定Query参数 )查询讲解卡配置,可指定UID查询用户专属的讲解卡配置。

使用限制

频率限制:单个 appID 调用上限为 50 次/秒。

重复设置时,查询将仅返回当前审核中的讲解卡。

注意:

只返回页面PATH + 指定Query参数全匹配的讲解卡配置。

基本信息

名称描述
HTTP URL
https://webcast.bytedance.com/api/card/get
HTTP Method
POST
Scope
live.stamp.card
权限要求
  • 需要申请权限
    • 申请路径:能力-挂载-直播挂载页面配置能力
  • 不需要用户授权

请求参数

请求头
content-type必填String
示例:application/json

必须为:application/json

X-Token必填String
示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
Body
url必填String
示例:pages/order/detail?order_id=123&key=abc

小程序页面对应的url,为onShareAppMessage返回的path&query格式。

user_idStruct

用户ID,查询指定用户的讲解卡配置

请求示例
curl -v -X POST https://webcast.bytedance.com/api/card/get -d "{\"url\":\"pages/good/detail?good_id=aaabbb\"}" -H "Content-Type: application/json" -H "X-Token: xxxxxxxxxx"

响应参数

Body
card_type必填Enum
示例:1

讲解卡类型。

可选值如下:1-标准讲解卡

status必填Enum
示例:2

讲解卡审核状态。

可选值:1-审核中;2-审核成功;3-审核失败;4-审核异常

value必填String

讲解卡内容。格式为JSON格式

audit_opinionString
示例:""

审核意见

errcodeInt32
示例:40004
错误码
errmsgString
示例:"access token is expired"
错误描述
响应示例
正常响应示例异常响应示例
{ "audit_opinion": "", "card_type": 1, "status": 2, "value": { "btn": { "btn_type": 100 }, "image_id": "123456", "title": { "main_title": "商品A" } } }