撤回单聊消息

POST

https://zim-api.zego.im/

调用此接口，您可以撤回 2 分钟内的单聊会话消息。如需撤回更早之前的消息，请联系 ZEGO 技术支持，最多可撤回 24 小时内发出的消息。

消息撤回后，消息接收用户将通过以下 ZIM SDK 的回调接口，接收消息已被撤回的通知。

iOS	Android	macOS	Windows
messageRevokeReceived	onMessageRevokeReceived	messageRevokeReceived	onMessageRevokeReceived

Web	小程序	Flutter	React Native
messageRevokeReceived	messageRevokeReceived	onMessageRevokeReceived	messageRevokeReceived

Unity3D	uni-app \| uni-app x	HarmonyOS
OnMessageRevokeReceived	messageRevokeReceived	messageRevokeReceived

说明

参数 FromUserId 和 ToUserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或开发者已调用服务端 API 注册相关的 userID。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [RevokePeerMessage]

接口原型参数

https://zim-api.zego.im/?Action=RevokePeerMessage

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

消息发送者的用户 ID。

ToUserId string必填

可选值: <= 32 characters

消息接收方的用户 ID。

MsgSeq number必填

消息 seq。获取方式：

若需要撤回由客户端发出的单聊消息，通过消息发送后回调获取 MsgSeq。
若需要撤回由服务端 API SendPeerMessage 发出的单聊消息，通过接口响应数据获取 MsgSeq。

Payload string

可选值: <= 200 characters

撤回操作附加的信息，最大 200 字节。

OfflinePush object

离线推送配置。如配置开启则在设备切换至后台时以离线推送形式通知消息被撤回，详情请参考 OfflinePush 说明。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

返回码。

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
660000002	参数错误。	请参考 Request 输入正确参数。
660000022	未找到消息，可能是消息已经被删除或者消息不存在。	请检查消息是否被删除，以及 MsgSeq 是否正确。
660000023	消息已被撤回。	请确认消息是否已被撤回。如经确认，消息已被撤回，则无需处理。如经确认，消息未被撤回，请联系 ZEGO 技术支持排查问题。
660000024	已超过撤回时间。	如需撤回更长时间内的消息，请联系 ZEGO 技术支持进行配置。
660000026	待撤回消息与 FromUserId 不匹配。	请检查 FromUserId 字段是否正确。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试，或参考相关文档了解调用频率。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782"
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782"
}