设置指定页面配置_抖音开放平台

设置小程序指定页面的讲解卡配置。我们根据页面URL（PATH + 指定Query参数 ）的方式，映射当前页面配置的讲解卡信息。

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

注意
指定Query参数和“API-转发”的回调方法onShareAppMessage返回的path的query的 key-value参数要全匹配。​

请求地址

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

请求参数

请求 Headers

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

请求 Body

属性	数据类型	必填	说明
url	string	是	小程序页面对应的url，为onShareAppMessage返回的path&query格式。例：pages/order/detail?order_id=123&key=abc
card_type	number	是	讲解卡类型。可选值如下：1-标准讲解卡
value	string	是	讲解卡内容。格式为 JSON 格式

下面介绍value每个可选字段的使用方式：

属性	数据类型	必填	适用讲解卡类型	说明
status_tag	object	否	1	状态标签。
property_tag	object	否	1	属性标签。
image_id	string	是	1	图片ID。
title	object	是	1	讲解卡标题。
btn	object	否	1	讲解卡按钮。

其中status_tag的字段如下：

属性	数据类型	必填	说明
tag_type	number	否	标签类型。可选值：1；讲解中；2-同城；3-秒杀；4-截拍
start_timestamp	string	否	活动开始时间戳。秒杀和截拍标签下使用。
stop_timestamp	string	否	活动结束时间戳。秒杀和截拍标签下使用。

其中property_tag的字段如下：

属性	数据类型	必填	说明
store_logo_id	string	否	店铺logo图片ID
store_name	string	否	店铺名称，字数不超过 5 个

其中title的字段如下：

属性	数据类型	必填	说明
main_title	string	是	主标题
sub_title	string	否	副标题

其中btn的字段如下：

属性	数据类型	必填	说明
btn_type	number	否	按钮类型。可选值： 100-详情按钮； 200-留咨按钮； 301-团购按钮之“¥1988 抢”
price	string	否	价格。仅在btn_type为301时生效，且此时为必填项。
color	string	否	按钮底色。采用16进制编码，例：#A19F00。考虑到文本的可见性，我们会调整按钮的颜色值以突出按钮文本，因此最后显示的颜色应以实际为准。具体规则转换为：转换成HSV颜色后，色相H在50°～190°时，饱和度S固定为80%，亮度V固定为90%；其余色相H时，饱和度S固定为100%，亮度V固定为80%。

返回值

正确返回的 JSON 数据包：

属性	数据类型	说明
status	number	讲解卡审核状态。可选值：1-审核中；2-审核成功；3-审核失败；4-审核异常
feedback	string	当设置的讲解卡存在某些字段格式有误时，返回不符合的字段与具体有误的规则。

异常返回的 JSON 数据包：

	数据类型	说明
errcode	number	错误码
errmsg	string	错误信息

请求示例

curl -v -X POST https://webcast.bytedance.com/api/card/set -d "{\"url\":\"pages/good/detail?good_id=aaabbb\",\"card_type\":1, \"value\":\"{\\\"image_id\\\":\\\"123456\\\",\\\"title\\\":{\\\"main_title\\\":\\\"商品A\\\"}}\"}" -H "X-Token: xxxxxxxxxx" -H "Content-Type: application/json"

返回示例

正常返回

{
    "status": 2,
    "feedback":"" 
}

错误返回

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

设置指定页面配置在线调试

​请求地址​

​请求参数​

​请求 Headers​

​请求 Body​

​返回值​

​请求示例​

​返回示例​

设置指定页面配置