文档中心
IM 即时通讯
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 即时通讯
  • 服务端 API
  • 消息相关
  • 撤回群聊消息

撤回群聊消息

更新时间:2024-02-27 17:53

描述

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

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

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

接口原型

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

请求参数

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

参数 类型 是否必选 描述
FromUserId
String
是
消息发送者用户 ID。
GroupId
String
是
群组 ID。
MsgSeq
Number
是
消息 seq。获取方式:

  • 若需要撤回由客户端发出的群聊消息,通过 消息发送后回调 获取 MsgSeq。
  • 若需要撤回由 服务端 API SendGroupMessage 发出的群聊消息,通过接口响应数据获取 MsgSeq。
Payload
String
否
撤回附加信息,最大 200 字节。
OfflinePush
Object
否
离线推送配置,详情请参考 OfflinePush 说明。

请求示例

  • 请求地址 URL:

    https://zim-api.zego.im/?Action=RevokeGroupMessage
    &<公共请求参数>
  • 请求消息体:

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

响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
请求结果的说明信息。
RequestId
String
请求 ID。

响应示例

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

返回码

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

返回码 说明 处理建议
660000002
参数错误。
请参考 请求参数 输入正确参数。
660000022
未找到消息,可能是消息已经被删除或者消息不存在。
请检查消息是否被删除,以及 MsgSeq 是否正确。
660000023
消息已被撤回。
请确认消息是否已被撤回。
  • 如经确认,消息已被撤回,则无需处理。
  • 如经确认,消息未被撤回,请联系 ZEGO 技术支持排查问题。
660000024
已超过撤回时间。
如需撤回更长时间内的消息,请联系 ZEGO 技术支持进行配置。
660000026
待撤回消息与 FromUserId 不匹配。
请检查 FromUserId 字段是否正确。
660300005
调用接口的频率超出了 AppID 级别限制。
请稍后再试,或参考相关文档了解调用频率。
660600001
群组不存在。
请确认输入的 GroupId 是否正确。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈