QueryRoomUserList
2026-05-29
GET
https://zim-api.zego.im/
根据房间 ID 获取房间成员的信息，包括房间用户数量、用户 ID 及名称。
说明
调用频率限制：20 次/秒
Request
Query Parameters
- 0: 按时间顺序（默认值）。
- 1: 按时间倒序。
- 第一次调用本接口，Limit 填 100，NextFlag 传空，查询第 1 ～ 100 名用户；返回结果中的 NextFlag 值为 1。
- 第二次调用本接口，Limit 填 100，NextFlag 填 1，查询第 101 ～ 200 名用户；返回结果中 NextFlag 值为 2。
- 第三次调用本接口，Limit 填 100，NextFlag 填 2，查询第 201 ～ 250 名用户；查询完毕，返回结果中的 NextFlag 为 0。
Action string必填
可选值: [QueryRoomUserList]
接口原型参数
https://zim-api.zego.im/?Action=QueryRoomUserList
AppId uint32必填
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
RoomId string必填
可选值: <= 32 characters
房间ID，长度上限为 32 字节，仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，'{'，'}'，'|'，'~'。
Mode number
可选值: [0, 1]
默认值: 0
按用户登录房间时间排序：
NextFlag string
分页拉取标志，第一次填空，之后填上一次返回的 NextFlag 值。当返回的 NextFlag 为 0 时，代表房间成员列表获取完毕。
例如，房间内有 250 个成员，调用本接口查询房间成员列表时：
Limit number
可选值: <= 500
单次查询用户的数量，取值范围为 [0, 500]，即调用本接口一次最多返回 500 个成员。
当房间内成员超过 Limit 时，需调用多次本接口且 Limit 需保持一致。
如果传空或大于 500，则默认取值为 500。
如需提高查询结果上限，请联系 ZEGO 技术支持进行配置。
Responses
- 200
OK
- application/json