接口说明

Scope: im.recall_message 需要申请权限需要用户授权该接口用于撤回私聊消息。

与接收私信消息事件配合使用，开发者应先订阅相关 webhook 事件：订阅接收私信事件须先申请 im.direct_message 权限。

使用限制

当前开放用户范围：认证企业号及其员工号和小程序品牌号及员工号；后续将基于抖音经营者实际诉求逐步拓展开放用户范围
当前仅支持一个用户授权一个应用;
可撤回内容、时间限制与抖音端内保持一致

基本信息

名称	描述
HTTP URL	https://open.douyin.com/im/recall/msg/
HTTP Method	POST
Scope	im.recall_message
权限要求	新能力上线能力实验室后，经营者可在“控制台-能力管理-能力实验室”中申请。后期能力若转为正式开放能力，可在“控制台-能力管理-互动权限”中申请。

请求参数

请求头

access-token必填String

示例：act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/access_token/生成的token

content-type必填String

示例：application/json

固定值"application/json"

Query

open_id必填String

示例：ba253642-0590-40bc-9bdf-9a1334b94059

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

Body

conversation_id必填String

示例：@72MqHzC5kqIEgB56A10333ntucyQ/A1Wn33333Vk9xDdDQrU9MpJSYEVV6/2hKHKVaRbE67Vx7Jd6yxgnq/g==

会话 ID：来源于私信 webhook，接收私信消息事件，对应 webhook 的 content 里的conversation_short_id 字段

conversation_type必填Int32

示例：1

会话类型 1- 单聊 2- 群聊

msg_id必填String

示例：@7211MqHzC5kqIEgB56229n1ntu80T/MxUH6Wfj32VkdzCNbYrU9MpJSYEVV6/2hKL3r7seeHSYoexQTg/Prp5A==

消息 id：来源于私信 webhook 接收私信消息事件，对应 webhook 的 content 里的server_message_id 字段

请求示例
curl -X POST 'https://open.douyin.com/im/recall/msg/?open_id=abcd-abcd-abcd-21221' -H 'Content-Type:application/json' -H 'access-token:act.d2o2u8ogtuoi2io2ruio2r2'
  --data
  '{
    "msg_id":"@72MqHzC5kqIEgB56229n1ntu80T/MxUH6Wfj32VkdzCNbYrU9MpJSYEVV6/2hKL3r7seeHSYoexQTg/Prp5A==",
    "conversation_id":"@72MqHzC5kqIEgB56A10333ntucyQ/A1Wn33333Vk9xDdDQrU9MpJSYEVV6/2hKHKVaRbE67Vx7Jd6yxgnq/g==",
    "conversation_type":2
}'

响应参数

Body

err_msg必填String

示例：消息发出已超过72小时无法撤回

错误信息

err_no必填Int32

示例：0

错误信息

log_id必填String

示例：20230202192209192B1185C6C1408E4EDB

日志ID

响应示例
正常响应示例异常响应示例
{
  "err_msg": "",
  "err_no": 0,
  "log_id": "202302021924599A4FB64DA382950444C7"
}

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	28003035	无权限撤回此条消息	检查是否有撤回消息权限
200	28003036	消息发出已超过时间无法撤回	消息发出时间超过 3 分钟，无法撤回
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	参数不合法	根据错误信息检查请求参数是否填写正常

开发者文档

私信消息撤回

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

私信消息撤回在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

私信消息撤回