logo
即时通讯
机器人
ZIM Audio
当前页

查询用户是否在房间内

GET

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

查询用户是否在指定房间内。默认支持批量查询至多 10 名用户,如需调整,请联系 ZEGO 技术支持。

说明
调用频率限制:5 次/秒,房间级别限制。

Request

Query Parameters

    Action string必填

    可选值: [QueryRoomMembers]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Signature string必填

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

    UserId string[]必填

    可选值: <= 10

    需要查询的用户 ID 列表,默认最多可查询 10 个用户 ID。

    说明

    UserId 长度上限为 32 字节,RoomID 长度上限为 128 字节,均仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'。

    示例:UserId[]=a&UserId[]=b&UserId[]=c&UserId[]=d

    RoomId string必填

    可选值: <= 32 characters

    房间 ID。

Responses

OK
Schema
    Code integer

    返回码。

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

    Code / SubCode说明处理建议
    660000002参数错误请检查输入的参数
    660000011用户个数超过限制。请检查输入的用户列表。
    660200001用户未注册请确认用户 ID 是否存在或用户是否已登出 ZIM 服务。
    660300006调用接口频率超出限制。请稍后再试。
    660300012用户不在房间内无需处理。
    Message string

    请求结果的说明信息。

    RequestId string

    请求 ID。

    UserList object[]
    查询结果,即在指定房间的用户列表。
  • Array[
  • user_id string

    在指定房间的用户的 ID。

    user_name string

    在指定房间的用户的名称。

    avatar stringnullable

    用户头像信息,可为 null。

    extra stringnullable

    扩展信息,可为 null。

  • ]
  • ErrorList object[]
    不在指定房间的用户列表。
    • Code 为 0:
    • ErrorList 为空,全部用户都在指定房间。
    • ErrorList 不为空,表示部分用户不在指定房间,请参考 SubCode 处理。
    • Code 不为 0:
    • ErrorList 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorList 不为空,表示全部用户都不在指定房间。
  • Array[
  • UserId string

    不在指定房间的用户的 ID。

    SubCode number

    不在指定房间原因的返回码,完整返回码请参考 Code 说明或者 全局返回码

  • ]

Previous

销毁房间

Next

创建群组

当前页

返回到顶部