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

DeleteConv

2026-05-19
POST

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

调用此接口,删除指定用户的某个会话,不影响其他人。

说明
调用频率限制:20 次/秒
说明

删除会话后,该用户的客户端可通过 onConversationChanged 回调收到会话被删除的通知(eventdeleted)。各平台回调接口如下:

Request

Query Parameters

    Action string必填

    可选值: [DeleteConv]

    接口原型参数

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

    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。

    ConvId string必填

    可选值: <= 32 characters

    会话 ID。

    • 对于单聊,会话 ID 就是另一名用户的 ID。
    • 对于群聊,会话 ID 就是 GroupId。
    ConvType number必填

    可选值: [0, 2]

    会话类型:

    • 0:单聊。
    • 2:群聊。

Responses

OK
Schema
    Code number

    返回码。

    返回码说明处理建议
    660000002输入参数错误。请检查输入的参数。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。

上一篇

清除单个会话消息未读数

下一篇

注册机器人

当前页

返回到顶部