在你的音视频应用中，你可能会需要获取一个房间内全部用户的信息，可以使用 ListUsers。

说明：
OpenAPI 版本是 2020-12-01。
你需要在接入该功能前先获取 APPID，且每个 AppID 每秒钟的请求数（QPS）限制默认为 20 次。

接口行为

你可以调用 ListUsers 接口，指定所属的 RoomId，获取其中所有用户的信息。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

请求方式

使用 Get 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	必填	示例值	描述
Action	String	是	`ListUsers`
Version	String	是	`2020-12-01`	OpenAPI 版本
AppId	String	是		指定进行查询的应用的 `AppId`
RoomId	String	是		指定进行查询的房间
Reverse	Int	否	`1`	默认按照用户进房时间升序返回设置为 `1` 时，降序返回。
Offset	Int	否	`50`	偏移量，单位为条。因单次查询返回结果数量有限，如果您需要大量查询，需要借助偏移量实现分页查询。
Limit	Int	否	`100`	返回条目数的限制，默认为 `50`，最大为 `100`。
State	Int	否		用户状态，默认为在房用户。设置为 `0`，查询已退房用户设置为 `1`，查询仍在房用户设置为 `2`，查询全量用户
StartTime	String	否	`2022-04-17T22%3A38%3A13%2B08%3A00`	经过URL编码的开始时间戳，格式为RFC3339，单位秒，为空时，默认为全量用户数据。
EndTime	String	否	`2022-04-17T22%3A38%3A13%2B08%3A00`	经过URL编码的结束时间戳，格式为RFC3339，单位秒，为空时，默认为全量用户数据。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=ListUsers&Version=2020-12-01&AppId=yourAppId&RoomId=yourRoomId
postscript

返回调用结果

返回参数说明

参数名	类型	描述
Total	Int	房间内用户总数
Offset	Int	偏移量，单位为条。
Limit	Int	返回条目数的限制
Users	Array of User	用户信息

返回值 Result 仅在请求成功时返回以上参数, 失败时为空。

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "ListUsers",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 3,
        "Offset": 0,
        "Limit": 10,
        "Users": [
            {
                "AppId": "your_AppId", 
                "Name": "CronJobInspection_user2",
                "Role": "normalUser",
                "IP": "fdbd:dc02:ff:1:1:225:96:222",
                "OS": "linux",
                "SDKVersion": "2.8.0",
                "PubStreamIds": null,
                "SubStreamIds": null,
                "CreatedAt": "2021-03-09T17:00:36+08:00",
                "UpdatedAt": "2021-03-09T17:00:37+08:00",
                "State": 1
            },
            {
                "AppId": "your_AppId", 
                "Name": "CronJobInspection_user1",
                "Role": "normalUser",
                "IP": "fdbd:dc02:ff:1:1:225:96:222",
                "OS": "linux",
                "SDKVersion": "2.8.0",
                "PubStreamIds": null,
                "SubStreamIds": null,
                "CreatedAt": "2021-03-09T17:00:31+08:00",
                "UpdatedAt": "2021-03-09T17:00:33+08:00",
                "State": 1
            }
        ]
    }
}
json