创建/更新自定义用户信息收集卡模板
接口说明
- 更新时需要传入全量参数
- 当系统提供的公共组件不能满足收集诉求时,可提前调用创建对话卡片交互组件接口创建满足诉求的交互组件
- 自定义用户信息收集卡示例
- 仅添加系统提供的公共组件的卡片(components 传入 [PUB_3, PUB_4, PUB_5])
- 开发者添加了其他自定义交互组件(components 传入创建对话卡片交互组件接口创建的组件id)
- 创建好卡片后,可通过流式对话接口进行自定义用户信息收集卡发送,content 示例如下
"content": { "msg_type": 203, "retain_information_card": { "card_id": "102432325325" } }
- 支持下发包含预填充内容的自定义用户信息收集卡
// 仅支持单行/多行文本输入框 // "_key"为交互组件的 input_key(创建时指定) // "_value"为预填充的值 "prefill": {"_key": "_value", ...}
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/im/save/retain_information_card/ |
| HTTP Method | POST |
| Scope | im.template_card |
请求参数
请求头
access-token必填String
当AI 分身调用时,调用https://open.douyin.com/oauth/client_token/生成的token
当服务 商代调用时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
当服务 商代调用时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
content-type必填String
示例:application/json
固定值"application/json"
Body
card_idString
卡片id
componentsArray<String>
交互组件列表,可以添加 1-4 个,其中,下列几个交互组件为系统公共交互组件,开发者无需提前创建即可使用:
- PUB_3: 姓名,input_key = name
- PUB_4: 城市,input_key = address
- PUB_5: 手机号,input_key = phone_num
若开发者有其他信息收集诉求,需自行创建对话卡片交互组件后使用
middle_tittleString
副标题文本,最多 26 字
top_tittleString
标题文本,最多 26 字
请求示例
curl --location 'https://open.douyin.com/im/save/retain_information_card_row_template/' \ --header 'access-token: clt.7244d4903a25114d416a5fa4469d36c4JagB1SCBNaYFTGbVHQlzE14BAHyb_lq' \ --header 'Content-Type: application/json' \ --data '{ "information_type": "102", "input_key": "auto_design123", "place_text": "我是一个底纹词", "text_type": "text", "min_length": 5, "toast_text": "最少输入五个字", "form_required": true }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:"access_token无效"
错误描述
err_no必填Int32
示例:28001003
错误码
log_id必填String
示例:"202405291440576E078D8757B9"
日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "", "log_id": "20241216113647AE184AB19B0BDD02D4A7", "data": { "card_id": "140966400514" } }
错误码
| 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 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
