创建/更新小程序引导卡片模板

Scope: im.microapp_card 需要申请权限不需要用户授权

使用限制

同一小程序，可以配置最多 10 万张小程序引导卡片模板，调用限制为近 30 天可创建 / 更新小程序引导卡片模板 5000 次

接口说明

模板好以后，无法再修改卡片类型 card_type

小程序引导卡片示例

创建好卡片后，可通过发送私信消息接口进行小程序引导卡片发送，content 示例如下

"content": {

"msg_type": 10,

"applet_card": {

"card_template_id": "@9VwNxuKKBZ03MXG7M8ooWM771FjUAMW/BqhMlDebEmyyzJD7cZENrR868oDbX9xx",

"schema":"https://z.douyin.com/ijBoQwF"

}

schema 获取方式

通过接口生成 Generate，通过 expire_time 参数控制过期时间，过期后需重新生成。

在小程序界面点击右上角 ... > 分享 > 复制链接，链接有效期为45天，过期后需重新生成。

接口存在防重复提交机制，应用多次调用接口传入相同的 content, media_id, title, app_id 参数创建小程序引导卡片，接口会返回相同的 card_template_id

权限要求

需要申请能力，开发者需要至控制台-小程序页面下，进入“能力-能力实验室-小程序能力”，申请能力下的对应scope。

需要用户授权

curl --location --request POST 'http://dev-cn.your-api-server.com/api/douyin/v1/im/set_applet_template/' \ --header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1' \ --header 'Content-Type: application/json' \ --data-raw '{"card_type":1,"title":"title测试","content":"content测试","media_id":"@9VwNxuKKBZ03MXG7M8ooWM6+iib0bqafYog16knsa1AUPKajyCbkeFIfvjDAhgpsWGXCimkBdNNS2dWASnfgCXqIi7Z6mT1hatJT3UhT8k963Osx4MrrU60NZwIlVg3j","name":"name测试","icon_media_id":"@9VwNxuKKBZ03MXG7M8ooWM6+iib0bqafYog16knsa1AUPKajyCbkeFIfvjDAhgpsWGXCimkBdNNS2dWASnfgCXqIi7Z6mT1hatJT3UhT8k963Osx4MrrU60NZwIlVg3j"}'

{ "extra": { "now": 1660109739, "logid": "20220810133539010174255181020C5143", "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "" }, "data": { "error_code": 0, "description": "", "card_template_id": "@72MqHzC5kqIEgB56A10R9n1psNsNe8gPbkeqQAHKbHqoQ5jL3za3OAGvMtWtnszA" } }

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

access-token

string

必需

示例值:

clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1

Body 参数application/json

card_type

integer

可选

卡片类型，创建模板时必传 1：小程序卡片

title

string

可选

卡片标题创建模板时必传，最长 30 字邀请你一起打荣耀巅峰匹配赛

content

string

可选

卡片内容，创建模板时必传，最长 30 字点击加入

media_id

string

可选

图片的 ID，调用图片上传接口获取。创建模板时必传推荐比例16:9，尺寸240*135 @8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4NVe6qLIJW/V/x1w==

name

string

可选

icon_media_id

string

可选

app_id

string

必需

小程序 AppID tt5daf2b12c11da13910

示例

返回响应

🟢200成功

application/json

Body

extra

object

必需

now

integer

必需

毫秒级时间戳 1597213176393

logid

string

必需

标识请求的唯一 id 202008121419360101980821035705926A

error_code

integer

错误码

必需

description

string

错误码描述

必需

sub_error_code

integer

子错误码

必需

sub_description

string

子错误码描述

必需

data

object

必需

error_code

integer

必需

description

string

必需

card_template_id

string

必需

模板 ID @8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4NVe6qLIJW/V/x1w==

🟠400请求有误

创建/更新小程序引导卡片模板

使用限制#

接口说明#

权限要求#

请求参数

返回响应

使用限制

接口说明

权限要求