查询用户状态

1 描述

调用本接口，可以查询某一房间内的用户的基本状态，包括用户是否在房间、用户的角色、登录房间的时间等。

2 接口原型

• 请求方法：GET
• 请求地址：https://rtc-api.zego.im/?Action=DescribeUsers
• 传输协议：HTTPS
• 调用频率限制（同一个 AppID 下所有房间）：10 次/秒

3 请求参数

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

4 请求示例

https://rtc-api.zego.im/?Action=DescribeUsers
&RoomId=room1
&UserId[]=a&UserId[]=b
&<公共请求参数>

5 响应参数

6 响应示例

{
    "Code": 0,
    "Data": {
        "UserStatusList": [
            {
                "UserId": "a",
                "Status": 1,
                "LoginTime": 1675674019365,
                "UserRole": 1
            },
            {
                "UserId": "b",
                "Status": 1,
                "LoginTime": 1675674019455,
                "UserRole": 1
            }
        ]
    },
    "Message": "success",
    "RequestId": "TestRequestId1675674022729915000"
}

7 返回码

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