抖音开放平台Logo
控制台

撤回群消息

更新时间 2024-07-24 02:58:49
收藏
我的收藏

​接口说明​

    •​该接口用于撤回群聊消息​
    •​与接收群消息事件配合使用，开发者应先订阅群消息 webhook 事件​

​使用限制​

    •​当前仅支持一个用户授权一个应用;​
    •​可撤回内容、时间限制与抖音端内保持一致​

​基本信息​

​名称​
​描述​
​HTTP URL​
​https://open.douyin.com/im/recall/msg/​
​HTTP Method​
​POST​
​Scope​
​im.recall_message​
​权限要求​
​需要申请权限 在开发者后台-设置-关联设置-抖音号管理为小程序经营者申请小程序群管理能力​

​请求头​

​名称​
​字段类型​
​是否必填​
​示例​
​描述​
​access-token​
​String​
​是​
​​
​通过 BusinessToken 进行调用，示例：bus_act.3c2f5cc363d5c464e509c066*********oDYf3Fmzl6ztOYr​
​content-type​
​String​
​是​
​application/json​
​固定值"application/json"​

​请求参数​

​Query​

​名称​
​字段类型​
​是否必填​
​示例​
​描述​
​open_id​
​String​
​是​
​ba253642-0590-40bc-9bdf-9a1334b94059​
​经营者唯一标识，​
​可以通过：​
    •​通过控制台-能力-私信和群聊-群聊管理授权用户详情页中获取​
    •​其他OpenID获取方式获取​
​示例：ba253642-0590-40bc-9bdf-9a1334b94059​

​Body​

​名称​
​字段类型​
​是否必填​
​示例​
​描述​
​conversation_id​
​String​
​是​
​@72MqHzC5kqIEgB56A10333ntucyQ/A1Wn33333Vk9xDdDQrU9MpJSYEVV6/2hKHKVaRbE67Vx7Jd6yxgnq/g==​
​会话 ID：​
    •​来源于群消息 webhook 群消息事件，对应接受或发送群消息事件 content 里的 conversation_short_id 字段​
​conversation_type​
​Int32​
​是​
​2​
​会话类型 1- 单聊 2- 群聊​
​msg_id​
​String​
​是​
​@7211MqHzC5kqIEgB56229n1ntu80T/MxUH6Wfj32VkdzCNbYrU9MpJSYEVV6/2hKL3r7seeHSYoexQTg/Prp5A==​
​消息 id：来源于群消息 webhook 群消息事件，对应 接收或发送群消息webhook 事件 content 里的 server_message_id 字段​

​请求示例​

Bash
复制
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​

​响应示例​

​正常响应示例​

JSON
复制
{"err_msg": "","err_no": 0,"log_id": "202302021924599A4FB64DA382950444C7"}

​异常响应示例​

JSON
复制
{"err_msg": "消息发出已超过时间无法撤回","err_no": 28003036,"log_id": "20230202192209192B1185C6C1408E4EDB"}