撤回群消息

我的收藏

该接口用于撤回群消息。

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

使用限制

•

当前开放用户范围：认证企业号及其员工号和小程序品牌号及员工号；后续将基于抖音经营者实际诉求逐步拓展开放用户范围

•

该能力需要用户进行 web 扫码授权，当前仅支持一个用户授权一个应用，详见授权概述

•

仅限群主可撤回群消息

接口说明

•

若与群消息webhook配合使用，开发者应先订阅并接收群消息事件：

基本信息

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

请求头

名称	类型	必填	描述
Content-Type	string	是	固定值 "application/json"
access-token	string	是	调用 /oauth/access_token/生成的 token，此 token需要用户授权。示例：act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1g73fg

请求示例

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
}'

响应参数

名称	类型	描述	示例
err_msg	string	错误描述	""
err_no	int	错误码	0
log_id	string	请求唯一标识	20128YGFWGKKKHE

响应示例

正常示例

{
  "err_msg": "",
  "err_no": 0,
  "log_id": "202302021924599A4FB64DA382950444C7"
}

异常示例

{
  "err_msg": "参数异常",
  "err_no": 28003036,
  "log_id": "20230202192209192B1185C6C1408E4EDB"
}

撤回群消息在线调试

​使用限制​

​接口说明​

​基本信息​

​请求头​

​请求示例​

​响应参数​

​响应示例​

​正常示例​

​异常示例​