抖音开放平台Logo
控制台

查询指定页面配置

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

根据页面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-typeString是application/json

必须为：application/json

X-TokenString是08011218462b6b4b5054626e426e50685a7554643144644449413d3d
调用https://developer.toutiao.com/api/apps/v2/token生成的token

请求参数

Body

名称字段类型是否必填示例描述
urlString是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_typeEnum是1

讲解卡类型。

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

statusEnum是2

讲解卡审核状态。

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

valueString是

讲解卡内容。格式为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"
    }
  }
}

异常响应示例

{
  "errcode": -1,
  "errmsg": "system error"
}