撤回群消息
收藏接口说明
- •该接口用于撤回群聊消息
- •与接收群消息事件配合使用，开发者应先订阅群消息 webhook 事件
使用限制
- •当前开放用户范围：认证企业号及其员工号和小程序品牌号及员工号；后续将基于抖音经营者实际诉求逐步拓展开放用户范围
- •当前仅支持一个用户授权一个应用;
- •可撤回内容、时间限制与抖音端内保持一致
- •小程序需通过试运营期
基本信息
名称 | 描述 |
HTTP URL | |
HTTP Method | POST |
Scope | im.recall_message |
权限要求 |
请求头
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
access-token | String | 是 | | |
content-type | String | 是 | application/json | 固定值"application/json" |
请求参数
Query
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
open_id | String | 是 | ba253642-0590-40bc-9bdf-9a1334b94059 | 经营者唯一标识， 可以通过：
示例：ba253642-0590-40bc-9bdf-9a1334b94059 |
Body
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
conversation_id | String | 是 | @72MqHzC5kqIEgB56A10333ntucyQ/A1Wn33333Vk9xDdDQrU9MpJSYEVV6/2hKHKVaRbE67Vx7Jd6yxgnq/g== | 会话 ID：
|
conversation_type | Int32 | 是 | 2 | 会话类型 1- 单聊 2- 群聊 |
msg_id | String | 是 | @7211MqHzC5kqIEgB56229n1ntu80T/MxUH6Wfj32VkdzCNbYrU9MpJSYEVV6/2hKL3r7seeHSYoexQTg/Prp5A== |
请求示例
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"}
异常响应示例
{"err_msg": "消息发出已超过时间无法撤回","err_no": 28003036,"log_id": "20230202192209192B1185C6C1408E4EDB"}
