撤回房间消息

更新时间：2024-10-15 23:28

如需使用本功能，请开通 ZIM 旗舰版服务，以确保您的 App ID 已设置为启用保存房间消息。

描述

调用此接口，您可以撤回房间会话消息。

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

iOS	Android	macOS	Windows	Web
messageRevokeReceived	onMessageRevokeReceived	messageRevokeReceived	onMessageRevokeReceived	messageRevokeReceived
小程序	Flutter	Unity3D	uni-app	React Native
messageRevokeReceived	onMessageRevokeReceived	OnMessageRevokeReceived	messageRevokeReceived	messageRevokeReceived

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

参数	类型	是否必选	描述
FromUserId	String	是	消息发送者用户 ID。
RoomId	String	是	房间 ID。
MsgSeq	Number	是	消息 seq。获取方式：若需要撤回由客户端发出的房间消息，通过消息发送后回调获取 MsgSeq。若需要撤回由服务端 API `SendRoomMessage` 发出的房间消息，通过接口响应数据获取 MsgSeq。
Payload	String	否	撤回附加信息，最大 200 字节。

请求地址 URL：

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

请求消息体：

  {
      "FromUserId": "u1",
      "GroupId": "room1",
      "MsgSeq": 10,
      "Payload": "hello world"
  }

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

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

返回码	说明	处理建议
660000001	业务类通用错误。	请重试，或联系 ZEGO 技术支持。
660000002	参数错误。	请参考请求参数输入正确参数。
660000022	未找到消息，可能是消息已经被删除或者消息不存在。	请检查消息是否被删除，以及 MsgSeq 是否正确。
660000023	消息已被撤回。	请确认消息是否已被撤回。如经确认，消息已被撤回，则无需处理。如经确认，消息未被撤回，请联系 ZEGO 技术支持排查问题。
660000027	未启用保存房间消息配置，无法撤回消息。	请开通 ZIM 旗舰版服务。
660300001	房间不存在。	请确认输入的 RoomId 是否正确或房间是否已被销毁。
660300002	用户不在此房间内。	请确认输入的 UserId 是否正确。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试，或参考相关文档了解调用频率。