logo
当前页

删除会话


描述

调用此接口,您可以在服务端删除一个会话。

接口原型

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

请求参数

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

参数类型是否必选描述
FromUserIdString
  • 单聊会话:传入 1 名单聊用户的 UserId。
  • 群聊会话:传入 1 名群聊成员的 UserId。
ConvIdString
  • 单聊会话:传入另 1 名单聊用户的 UserId。
  • 群聊会话:传入群聊会话的 GroupId。
ConvTypeConvType会话类型:
  • 0:单聊。
  • 2:群聊。

请求示例

  • 请求地址 URL:

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

    Untitled
    {
        "ConvId": "userB",
        "ConvType": 0,
        "FromUserId": "userA"   
    }
    
    1
    Copied!

响应参数

参数类型描述
CodeNumber返回码。
MessageString操作结果描述。
RequestIdString请求 ID。

响应示例

Untitled
{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}
1
Copied!

返回码

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

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

Previous

清除单个会话消息未读数

Next

注册机器人