查询群成员列表

POST

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

根据群组 ID 获取群组中的用户列表。

说明

群组 ID 可通过查询 App 下的群组列表获取。

说明

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

Request

Query Parameters

Action string必填

可选值: [QueryGroupMemberList]

接口原型参数

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

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

GroupId string必填

可选值: <= 32 characters

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

Limit number

可选值: >= 0 and <= 1000

单次获取成员的数量，取值范围为 [0, 1000]，即调用本接口一次最多返回 1000 个成员。

当群组内成员超过 Limit 时，需调用多次本接口且 Limit 需保持一致。

如果传空或大于 1000，则默认取值为 1000。

Next number

分页拉取标志，第一次 0，之后填上一次返回的 Next。

例如，群组内有 2500 个成员，调用本接口查询群成员列表时：

第一次调用本接口，Limit 填 1000，Next 填 0，查询第 1 ～ 1000 名成员；返回结果中的 Next 值为 1。
第二次调用本接口，Limit 填 1000，Next 填 1，查询第 1001 ～ 2000 名成员；返回结果中 Next 值为 2。
第三次调用本接口，Limit 填 1000，Next 填 2，查询第 2001 ～ 2500 名成员；查询完毕，返回结果中的 Next 为 0。

Responses

application/json

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

Schema

Code number

返回码。

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

返回码	说明	处理建议
660000002	参数错误。	请参考 Request 输入正确参数。
660600001	群不存在。	请确认 GroupId 是否正确。
660600003	查询群成员列表出错。	请联系 ZEGO 技术支持。
660600004	调用频率超出限制。	调用频率为 20 次/秒，请勿超出限制。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

TotalCount number

服务端开始查询时的群成员总数。

Next number

分页拉取的标志。非 0 时表示列表获取未完。

说明

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

MemberList object[]

群成员信息集合。

Array[

UserId string

群成员 ID。

UserName string

群成员名称。

UserNickName string

用户在群组内的昵称。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 168,
  "MemberList": [
    {
      "UserId": "u1",
      "UserName": "userName1",
      "UserNickName": "userNickName1"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 168,
  "MemberList": [
    {
      "UserId": "u1",
      "UserName": "userName1",
      "UserNickName": "userNickName1"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 168,
  "MemberList": [
    {
      "UserId": "u1",
      "UserName": "userName1",
      "UserNickName": "userNickName1"
    },
    {
      "UserId": "u2",
      "UserName": "userName2",
      "UserNickName": "userNickName2"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 168,
  "MemberList": [
    {
      "UserId": "u1",
      "UserName": "userName1",
      "UserNickName": "userNickName1"
    },
    {
      "UserId": "u2",
      "UserName": "userName2",
      "UserNickName": "userNickName2"
    }
  ]
}