创建/更新小程序引导卡片模板
收藏Scope: im.microapp_card 需要申请权限 不需要用户授权
接口说明
- 模板创建好以后，无法再修改卡片类型 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
使用限制
- 同一小程序，可以配置最多 10 万张小程序引导卡片模板，调用限制为近 30 天可创建 / 更新小程序引导卡片模板 5000 次
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/douyin/v1/im/set_applet_template/ |
| HTTP Method | POST |
| Scope | im.microapp_card |
| 权限要求 |
|
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Body
app_idString
示例：tt5daf2b12c11da13910
小程序 AppID
card_template_idString
示例：@8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4NVe6qLIJW/V/x1w==
模板ID，修改模板时需要填写创建模板返回的模板ID
card_typeInt32
示例：1
卡片类型，创建模板时必传
- 1：小程序卡片
contentString
示例：点击加入
卡片内容，最长 30 字
media_idString
示例：@8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4NVe6qLIJW/V/x1w==
图片的 ID，调用图片上传接口获取。创建模板时必传
推荐比例16:9，尺寸840*474
titleString
示例：邀请你一起打荣耀巅峰匹配赛
卡片标题，创建模板时必传，最长 26 字
请求示例
curl -X POST 'https://open.douyin.com/api/douyin/v1/im/set_applet_template/' -H 'Content-Type:application/json' -H 'access-token:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1' --data '{"card_type":1,"title":"title测试","content":"content测试","media_id":"@9VwNxuKKBZ03MXG7M8ooWM6+iib0bqafYog16knsa1AUPKajyCbkeFIfvjDAhgpsWGXCimkBdNNS2dWASnfgCXqIi7Z6mT1hatJT3UhT8k963Osx4MrrU60NZwIlVg3j","name":"name测试","icon_media_id":"@9VwNxuKKBZ03MXG7M8ooWM6+iib0bqafYog16knsa1AUPKajyCbkeFIfvjDAhgpsWGXCimkBdNNS2dWASnfgCXqIi7Z6mT1hatJT3UhT8k963Osx4MrrU60NZwIlVg3j"}'
响应参数
Body展开全部子属性
dataStruct
展开子属性
extraStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "now": 1660109739, "logid": "20220810133539010174255181020C5143", "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "" }, "data": { "error_code": 0, "description": "", "card_template_id": "@72MqHzC5kqIEgB56A10R9n1psNsNe8gPbkeqQAHKbHqoQ5jL3za3OAGvMtWtnszA" } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28001005 | 系统内部错误，请重试 | 请求重试，若依然无解请向平台提交反馈 |
| 200 | 28001003 | access_token无效 | 重新请求生成access_token |
| 200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
| 200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
| 200 | 28001006 | 网络调用错误，请重试 | 重试即可 |
| 200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
| 200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
| 200 | 28003017 | quota已用完 | 联系平台处理 |
| 200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁，联系平台处理 |
| 200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
