文档中心
即时通讯
服务端 API
房间相关
查询用户是否在房间内

查询用户是否在房间内

更新时间：2024-02-27 16:39

描述

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

接口原型

请求方法：GET
请求地址： https://zim-api.zego.im/?Action=QueryRoomMembers
传输协议：HTTPS
调用频率限制：5 次/秒，房间级别限制。

请求参数

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

参数	类型	是否必选	描述
UserId[]	Array of String	是	需要查询的用户 ID 列表，默认最多可查询 10 个用户 ID。示例：UserId[]=a&UserId[]=b&UserId[]=c&UserId[]=d
RoomId	String	是	房间 ID。

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

请求示例

https://zim-api.zego.im/?Action=QueryRoomMembers
&UserId[]=a&UserId[]=b&UserId[]=c&UserId[]=d&RoomId=roomid
&<公共请求参数>

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
UserList	Object	查询结果，即在指定房间的用户列表。
UserId	String	在指定房间的用户的 ID。
UserName	String	在指定房间的用户的名称。
ErrorUser	Object	不在指定房间的用户列表。 Code 为 0： ErrorUser 为空，全部用户都在指定房间。 ErrorUser 不为空，表示部分用户不在指定房间，请参考 SubCode 处理。 Code 不为 0： ErrorUser 为空，表示参数错误、接口频率限制、系统错误。 ErrorUser 不为空，表示全部用户都不在指定房间。
UserId	String	不在指定房间的用户的 ID。
SubCode	Number	不在指定房间原因的返回码。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "UserList": [
        {
            "UserId": "a",
            "UserName": "UserNamea"
        },
        {
            "UserId": "b",
            "UserName": "UserNameb"
        }
    ],
     "ErrorUser": [
        {
            "UserId": "c",
            "SubCode": 660300012
        },
        {
            "UserId": "d",
            "SubCode": 660200001
        }
    ]
}

返回码

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

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