查询自定义用户信息收集卡模板
接口说明
暂无
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/im/get/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
cursorString
分页游标,默认值为 "" 或 "0"
limitInt64
每页数量,最大值为 50
请求示例
curl --location 'https://open.douyin.com/im/get/retain_information_card/' \ --header 'access-token: clt.7244d4903a25114d416a5fa4469d36c4JagB1SCBNaYFTGbVHQlzE14BAHyb_lq' \ --header 'Content-Type: application/json' \ --data '{ "cursor": "", "limit": 10 }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:"access_token无效"
错误描述
err_no必填Int32
示例:28001003
错误码
log_id必填String
示例:"202405291440576E078D8757B9"
日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "", "log_id": "20241216114816D5C6096B1D85AF03B3C6", "data": { "card_list": [ { "card_id": "140484096002", "information_list": [ { "state": 1, "information_type": "PUB_3", "input_key": "name" }, { "information_type": "PUB_4", "input_key": "address", "state": 1 }, { "information_type": "PUB_5", "input_key": "phone_num", "state": 1 }, { "place_text": "请输入自定义信息", "form_required": true, "min_length": 5, "picker_content": "", "mode": "", "row_id": "140436480514", "state": 1, "text_type": "text", "toast_text": "最少输入五个字", "cascader_content": "null", "information_type": "102", "input_key": "auto_design" } ], "middle_tittle": "副标题-副标题", "top_image_id": "", "top_tittle": "主标题-主标题" } ], "has_more": false } }
错误码
| 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 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
