- 动态与公告
- 产品简介
- 购买指南
- 开发指引
- Demo 专区
- 下载中心
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 推送功能
- 智能客服
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 开发指引
- Demo 专区
- 下载中心
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 推送功能
- 智能客服
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
功能说明
管理员撤回公众号消息。
该接口可以撤回所有漫游有效期内的公众号消息，包括客户端发出的公众号消息，由 REST API 接口发出的公众号消息。
若需要撤回由客户端发出的公众号消息，您可以开通 发公众号消息之后回调 ，通过该回调接口记录每条公众号消息的 MsgKey，然后填在本接口的 MsgKeyList 参数里进行撤回。您也可以通过 拉取公众号用户历史消息 查询出待撤回的公众号消息的相关信息后，使用本接口进行撤回。
若需要撤回由 REST API 公众号用户发送广播消息 接口发出的公众号消息，需要记录这些接口回包里的 MsgKey 字段以进行撤回。
调用该接口撤回消息后，该条消息的接收方的客户端的本地缓存都会被撤回。
该接口可撤回的公众号消息没有时间限制，即可以撤回任何时间的公众号消息，但是公众号消息的漫游时间需要在有效期内。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/official_account_open_http_svc/official_account_msg_recall?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/official_account_open_http_svc/official_account_msg_recall | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
消息撤回之后将无法恢复，请谨慎调用该接口。
{"Official_Account": "@TOA#_2J4SZEAEL","MsgKeyList":["71_1_1698741698","72_1_1698741698"],"Reason":"撤回原因"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
Official_Account | String | 必填 | 操作的公众号用户 ID |
MsgKeyList | Array | 必填 | 被撤回的消息 MsgKey 列表，一次请求最多可以撤回10条消息 |
Reason | String | 选填 | 撤回消息的原因，长度限制最大100字节 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RecallRetList":[{"MsgKey":"71_1_1698741698","RetCode":10030},{"MsgKey":"72_1_1698741699","RetCode":0}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK：表示处理成功 FAIL：表示失败 |
ErrorCode | Integer | 错误码： 0：表示成功 非0：表示失败 |
ErrorInfo | String | 错误信息 |
RecallRetList | Array | 消息撤回请求的详细结果 |
MsgKey | String | 单个被撤回消息的 MsgKey |
RetCode | Integer | 单个消息的被撤回结果：0表示成功；其它表示失败，参考下文错误码说明 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 描述 |
10002 | 服务器内部错误，请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法，请根据错误描述检查请求是否正确 |
10007 | 操作权限不足 |
10010 | 公众号用户不存在，或者曾经存在过，但是目前已经被解散 |
10015 | 公众号用户 ID 非法，请检查公众号用户 ID 是否填写正确 |
10030 | 请求撤回的消息不存在 |
10031 | 请求撤回的消息超出时间限制 |
10032 | 请求撤回的消息不支持撤回操作 |
接口调试工具
是
否
本页内容是否解决了您的问题？