撤回单聊消息

描述

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

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

接口原型

• 请求方法：POST
• 请求地址： https://zim-api.zego.im/?Action=RevokePeerMessage
• 传输协议：HTTPS
• 调用频率限制：20 次/秒。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 调用方式 - 公共请求参数。

请求示例

• 请求地址 URL：

  https://zim-api.zego.im/?Action=RevokePeerMessage
  &<公共请求参数>

• 请求消息体：

  {
      "FromUserId": "u1",
      "ToUserId": "u2",
      "MsgSeq": 10,
      "Payload": "payload",
      "OfflinePush" :{
          "Enable":1,
          "Title":"title",
          "Content":"content",
          "Payload":"payload"
      }
  }

响应参数

响应示例

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

返回码

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