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

删除指定单聊用户全部消息

POST

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

调用此接口,您可以在服务端删除单聊会话中某一用户的全部消息。

说明
示例:用户 A 与 B 对话,若需要删除用户 A 的全部单聊消息,则 FromUserId 为 A,ToUserId 为 B;若需要删除用户 B 的全部单聊消息,则 FromUserId 为 B,ToUserId 为 A。
说明
调用频率限制:20 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [ClearPeerMessage]

    接口原型参数

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

    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

    删除此用户向 ToUserId 发送过的所有单聊消息。

    ToUserId string必填

    可选值: <= 32 characters

    消息接收用户。

Responses

OK
Schema
    Code number

    返回码。
    返回码请参考 全局返回码

    Message string

    操作结果描述。

    RequestId string

    请求 ID。

Previous

查询消息

Next

删除指定群聊用户全部消息

当前页

返回到顶部