查询 App 下的群列表

描述

获取 App 中所有群组的 ID。

接口原型

请求方法：GET
请求地址：https://zim-api.zego.im/?Action=QueryAppGroupList
传输协议：HTTPS
调用频率限制：1 次/秒

请求参数

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

参数	类型	是否必选	描述
Limit	Number	否	单次获取群组 ID 的数量，取值范围为 [0, 10000]，即调用本接口一次最多返回 10000 个群组 ID。当 App 内的群组数量存在超过 Limit 时，需调用多次本接口且 Limit 需保持一致。如果传空或大于 10000，则默认取值为 10000。
Next	Number	否	分页拉取标志，第一次填 0，以后填上一次返回的值，返回的 Next 为 0 代表群列表获取完毕。例如，App 内有 25000 个群组，调用本接口查询群列表时：第一次调用本接口，Limit 填 10000，Next 填 0，查询第 1 ～ 10000 个群组；返回结果中的 Next 值为 1 第二次调用本接口，Limit 填 10000，Next 填 1，查询第 10001 ～ 20000 名群组；返回结果中 Next 值为 2。第三次调用本接口，Limit 填 10000，Next 填 2，查询第 20001 ～ 25000 名群组；查询完毕，返回结果中的 Next 为 0。

参数

类型

是否必选

描述

Limit

Number

否

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

当 App 内的群组数量存在超过 Limit 时，需调用多次本接口且 Limit 需保持一致。

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

Number

否

分页拉取标志，第一次填 0，以后填上一次返回的值，返回的 Next 为 0 代表群列表获取完毕。

例如，App 内有 25000 个群组，调用本接口查询群列表时：

第一次调用本接口，Limit 填 10000，Next 填 0，查询第 1 ～ 10000 个群组；返回结果中的 Next 值为 1
第二次调用本接口，Limit 填 10000，Next 填 1，查询第 10001 ～ 20000 名群组；返回结果中 Next 值为 2。
第三次调用本接口，Limit 填 10000，Next 填 2，查询第 20001 ～ 25000 名群组；查询完毕，返回结果中的 Next 为 0。

请求示例

Untitled

https://zim-api.zego.im/?Action=QueryAppGroupList
&Limit=1000
&Next=0
&<公共请求参数>

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
TotalCount	Number	App 当前的群组总数。
Next	Number	分页拉取的标志。
GroupIdList	Array of String	获取到的群组 ID 的集合。
└GroupId	String	群组的 ID。
└GroupName	String	群组名称。

响应示例

Untitled

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 168,
  "GroupIdList": [
    {
        "GroupId": "groupA",
        "GroupName": "groupNameA"
    },
    {
        "GroupId": "groupB",
        "GroupName": "groupNameB"
    }
  ]
}

Copied!

返回码

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

返回码	说明	处理建议
660000002	参数错误。	请参考请求参数输入正确参数。
660600006	查询群列表数据出错。	请联系 ZEGO 技术支持。
660600007	调用 QueryAppGroupList 接口的频率超出限制。	调用频率为 1 次/秒，请勿超出限制。