查询会话列表

POST

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

调用此接口，分页拉取指定用户的全量会话列表，最多返回 1000 个最新会话（单聊与群聊）。

说明

即便用户被踢出会话，本接口返回结果仍包含该会话；但是如果会话解散，则无法通过本接口获取该会话相关信息。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [QueryConversationList]

接口原型参数

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

AppId uint32必填

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

SignatureNonce string必填

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

Timestamp int64必填

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

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

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

Signature string必填

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

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

查询此 UserID（已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册）的会话列表。

说明

FromUserId 仅支持数字，英文字符和 {"'!'，'#'，'$'，'%'，'&'，'('，')'，'+'，''，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'"}。

Limit number

可选值: >= 1 and <= 500

默认值: 100

单次获取会话的数量，默认为 100，取值范围为 (0, 500]。

当值 ≤ 0 时，修正为 100。
当值 > 500，修正为 500。

Next number

分页拉取标志，第一次填 0 ，之后填上一次返回的 Next 值。当返回的 Next 为 0 时，代表好友列表获取完毕。

例如，FromUserId 有 250 个会话，调用本接口查询时：

第一次调用本接口，Limit 填 100，Next 传 0，查询第 1 ～100 个会话；返回结果中的 Next 值为 num1。
第二次调用本接口，Limit 填 100，Next 填 num1，查询第 101 ～ 200 个会话；返回结果中 Next 值为 num2。
第三次调用本接口，Limit 填 100，Next 填 num2，查询第 201 ～ 250 个会话；查询完毕，返回结果中的 Next 为 0。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

返回码。

返回码	说明	处理建议
660000002	输入参数错误。	请检查输入的参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660500002	FromUserId 未注册。	请检查 FromUserId 是否正确。
660800053	查询会话列表失败。	请联系 ZEGO 技术支持。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

TotalCount number

当前的会话总数。

Next number

分页拉取标志。

非 0：表示还有会话信息未返回，需要将该字段设置到请求参数 Next 中拉取更多会话信息。
为 0：表示已经返回完整会话列表。

说明

除上述说明之外，此字段与列表信息无任何关联，请勿基于此做任何其他逻辑。

List object[]

会话列表。按 UpdateTime 升序返回结果。

Array[

ConvId string

会话 ID。

单聊会话：会话 ID 为对端用户的 ID。
群聊会话：会话 ID 为群组 ID。

ConvType number

会话类型。

0 或没有返回此字段：单聊会话。
2：群聊会话。

UpdateTime number

会话最后修改时间，毫秒时间戳。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 500,
  "Next": 1000,
  "List": [
    {
      "ConvId": "conv1",
      "ConvType": 2,
      "UpdateTime": 1708254395000
    },
    {
      "ConvId": "conv2",
      "ConvType": 0,
      "UpdateTime": 1708254395000
    },
    {
      "ConvId": "conv3",
      "UpdateTime": 1708254395000
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 500,
  "Next": 1000,
  "List": [
    {
      "ConvId": "conv1",
      "ConvType": 2,
      "UpdateTime": 1708254395000
    },
    {
      "ConvId": "conv2",
      "ConvType": 0,
      "UpdateTime": 1708254395000
    },
    {
      "ConvId": "conv3",
      "UpdateTime": 1708254395000
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。