logo
即时通讯
机器人
ZIM Audio
当前页

RevokeRoomMessage

POST

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

说明

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

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

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

iOSAndroidmacOSWindows
messageRevokeReceivedonMessageRevokeReceivedmessageRevokeReceivedonMessageRevokeReceived
Web小程序FlutterReact Native
messageRevokeReceivedmessageRevokeReceivedonMessageRevokeReceivedmessageRevokeReceived
Unity3Duni-app | uni-app xHarmonyOS
OnMessageRevokeReceivedmessageRevokeReceivedmessageRevokeReceived
说明
调用频率限制:20 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [RevokeRoomMessage]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Signature string必填

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

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    消息发送者用户 ID(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册)。

    RoomId string必填

    可选值: <= 32 characters

    房间 ID。

    MsgSeq number必填

    消息 seq。获取方式:

    • 若需要撤回由客户端发出的房间消息,通过 消息发送后回调 获取 MsgSeq。
    • 若需要撤回由服务端 API SendRoomMessage 发出的房间消息,通过接口响应数据获取 MsgSeq。
    Payload string

    可选值: <= 200 characters

    撤回附加信息,最大 200 字节。

Responses

OK
Schema
    Code number

    返回码。

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

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

    请求结果的说明信息。

    RequestId string

    请求 ID。

上一篇

撤回群聊消息

下一篇

导入单聊消息

当前页

返回到顶部