抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

创建/更新对话卡片交互组件

收藏
我的收藏

接口说明

  • 更新对话卡片交互组件需要传入全量参数
  • 目前仅支持应用于自定义用户信息收集卡,用作创建自定义用户信息收集卡接口中的components 参数
  • 创建选择器组件(滚轮/级联/分项)需要审核通过后才可使用
  • 各种选择器图例:
    • 滚轮选择器,对应 picker_content 字段
    • 级联选择器,对应 cascader_mode & cascader_content 字段
    • 分项选择器,对应 item_selector_title item_selector_mode & item_selector_content 字段

基本信息

名称描述
HTTP URL
https://open.douyin.com/im/save/retain_information_card_row_template/
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
content-type必填String
示例:application/json
固定值"application/json"
Body展开全部子属性
cascader_contentList

级联选择器内容,能够配置二级/三级级联选择器,级联选择器最大数量为 1000

展开子属性
cascader_modeString

级联选择器单/复选

  • single
  • multiple
form_requiredBool
示例:true
是否为表单必填项
information_typeString
示例:"101"

交互组件类型,必填:

  • "101": 单行文本输入框
  • "102": 多行文本输入框
  • "103": 滚轮选择器
  • "104": 级联选择器
  • "105": 分项选择器
input_keyString
示例:"auto_design"

信息收集key,必填,不可填写为:

  • gender
  • age
  • name
  • address
  • phone_num

用户填写信息后,会以 KV 对的形式进行存储,其中 key 为此处设置的值,value 为用户提交的值;如果组件是单行/多行文本输入框,input_key 也为预填充 prefill 字段的 key

item_selector_contentList

分项选择器内容,最多支持三个分项块,每个分项最多支持配置 6 个具体内容

展开子属性
item_selector_modeString

分项选择器单/复选

  • single
  • multiple
item_selector_titleString
分项选择器标题
min_lengthInt64
示例:5

单/多行文本输入框最少字数限制:

  • 单行文本输入框,最多 12 字
  • 多行文本输入框,最多 500 字
picker_contentArray<String>

滚轮选择器内容,最多配置 100 个具体内容,每个具体内容长度不超过 12 字符

place_textString
示例:"请输入地址"

底纹词,最长 12 字

row_idString
示例:"140966400514"

交互组件id

text_typeString
示例:"text"

交互组件具体类型,仅用于单行/多行文本输入框,用户点击弹出键盘类型:

  • "text": 普通文本
  • "number": 数字
toast_textString
示例:"最少输入五个字"

不满足情况toast文案,最多 12 字

请求示例
curl --location 'https://open.douyin.com/im/save/retain_information_card_row_template/' \ --header 'access-token: clt.de2f4d78cdea021779982dbc5ac9c3c0rdShtc9QSgKgc0rMRJ3m0fLz5P5R_lf' \ --header 'Content-Type: application/json' \ --data '{ "information_type": "102", "input_key": "auto_design", "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": { "row_id": "140966400514" } }
切换单列布局

错误码

HTTP 状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001016
当前应用已被封禁或下线
clientKey被封禁或者下线
20028001006
网络调用错误,请重试
重试即可
20028001014
应用未授权任何能力
确认应用是否授权能力
20028001018
应用未获得该能力
开通相关能力
20028003017
quota已用完
联系平台处理
20028001019
应用该能力已被封禁
该能力被封禁,联系平台处理
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常