抖音开放平台Logo
开发者文档
控制台

删除留资卡片

收藏
我的收藏

接口说明

该接口用于删除留资卡片

该接口涉及 scope 在用户点击授权,开发者获取到 code 调用 /oauth/access_token/ 接口时,返回的 scope 参数中将不再包含该 scope;授权(authorize), 取消授权(unauthorize) Webhook 事件中 scope 参数同样不会包含该 scope,开发者仍可以使用该 access_token 调用本接口。授权用户可以在设置-账号与安全-授权管理-经营授权中查看 / 取消 已授权的 im 能力。抖音开放平台将于近期补齐 access_token 返回该 scope 的能力。

使用限制

  • 该能力需要用户进行 web 扫码授权,当前仅支持一个用户授权一个应用,详见 授权概述
  • 当前开放用户范围:认证企业号及其员工号;后续将基于抖音经营者实际诉求逐步拓展开放用户范围

基本信息

名称描述
HTTP URL
https://open.douyin.com/im/del/retain_consult_card/
HTTP Method
GET
Scope
im.message_card
权限要求

新能力上线能力实验室后,经营者可在“控制台-能力管理-能力实验室”中申请。后期能力若转为正式开放能力,可在“控制台-能力管理-互动管理”中申请。

请求参数

请求头
access-token必填String
示例:act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Query
card_id必填String
示例:@8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4NVe6qLIJW/V/x1w==

留资卡片ID

该字段通过 /im/save/retain_consult_card/ 接口返回的 card_id 字段获取

open_id必填String
示例:ba253642-0590-40bc-9bdf-9a1334b94059

调用 /oauth/access_token/ 获取,用户唯一标志

请求示例
curl -X GET 'https://open.douyin.com/im/del/retain_consult_card/?card_id=%409VwNxuKKBZ03MXG7M8ooWM7802HVAcS%2BB6lNlTaaE225Qkh7xyVjzaxOJtft2M19&open_id=9a1334b94059' -H 'Content-Type:application/json' -H 'access-token:act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy11da' --data ''

响应参数

Body展开全部子属性
data必填Struct
展开子属性
extraStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "logid": "2022081013405301017425518105798161", "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "now": 1660110053 }, "data": { "error_code": 0, "description": "" } }

错误码

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