QueryAppGroupList
2026-05-29
GET
https://zim-api.zego.im/
获取 App 中所有群组的 ID。
注意
获取的数据可能会存在最多 1 分钟 的延迟。
说明
调用频率限制:1 次/秒。
Request
Query Parameters
- 第一次调用本接口,Limit 填 10000,Next 填 0,查询第 1 ~ 10000 个群组;返回结果中的 Next 值为 1
- 第二次调用本接口,Limit 填 10000,Next 填 1,查询第 10001 ~ 20000 名群组;返回结果中 Next 值为 2。
- 第三次调用本接口,Limit 填 10000,Next 填 2,查询第 20001 ~ 25000 名群组;查询完毕,返回结果中的 Next 为 0。
Action string必填
可选值: [QueryAppGroupList]
接口原型参数
https://zim-api.zego.im/?Action=QueryAppGroupList
AppId uint32必填
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
Limit number
可选值: <= 10000
单次获取群组 ID 的数量,取值范围为 [0, 10000],即调用本接口一次最多返回 10000 个群组 ID。
当 App 内的群组数量存在超过 Limit 时,需调用多次本接口且 Limit 需保持一致。
如果传空或大于 10000,则默认取值为 10000。
Next number
分页拉取标志,第一次填 0,以后填上一次返回的值,返回的 Next 为 0 代表群列表获取完毕。
例如,App 内有 25000 个群组,调用本接口查询群列表时:
Responses
- 200
OK
- application/json
