你可以使用此接口查询一段时间内，某个应用下进行音视频通话的指定房间内特定或全部用户信息。

接口行为

你可以调用 ListUserInformation 接口，指定你所属的 AppId，RoomId 和查询时间段，查询该时间段内的该房间内指定或全部用户的相关信息。

接口限制

限制类别	调用频率限制
最大请求次数	10 次/秒 10000 次/天
最远可查询时间	6 天
最大单次查询时间跨度	6 小时（若查询时间超过 6 小时，结束时间自动调整为开始时间 + 6 小时）
数据延迟	100 秒

调用接口

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

请求方式

使用 GET 方式发起请求。

请求参数

参数名	类型	必填	示例值	描述
Action	String	是	`ListUserInformation`	接口名称，本接口取值：`ListUserInformation`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`
AppId	String	是	`Your_AppId`	应用的唯一标志
StartTime	String	是	`2022-05-22T12:00:00 08:00`	查询起始时间戳，格式为 RFC3339，单位为秒
EndTime	String	是	`2022-05-22T12:59:00 08:00`	查询结束时间戳，格式为 RFC3339，单位为秒
RoomId	String	是	`Your_RoomId`	房间 ID，是房间的唯一标志
PageNum	Int	否	`1`	分页序号，默认值为`1`
PageSize	Int	否	`20`	每页房间数，最大不能超过 100。默认为 `20`。如果指定值超过 100，每页的房间数为 100。
UserId	String	否	`Your_UserId`	查询的用户 ID 列表，多个用户 ID 用逗号隔开，最多可以指定 10 个。值不合法时默认剔除。为空时，查询房间内全部用户信息。
ExcludeServerUser	Bool	否	`true`	是否排除 Linux 用户。默认为 `true`，表示排除 Linux 用户

请求示例

http://rtc.volcengineapi.com?Action=ListUserInformation&AppId=Your_AppId&StartTime=2022-05-22T12:00:00 08:00&EndTime=2022-05-22T12:59:00 08:00&RoomId=Your_RoomId&Version=2020-12-01
postscript

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	示例值	描述
Total	Int	`2`	查询到的用户总数
PageNum	Int	`1`	分页序号
PageSize	Int	`20`	每页用户数
UserList	Array of User		用户信息

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

请求返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "ListUserInformation",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 2,
        "PageNum": 1,
        "PageSize": 20,
        "UserList": [
            {
                "RoomId": "Your_RoomId",
                "UserId": "Your_UserId",
                "CreatedAt": "2022-09-09T10:00:34+08:00",
                "LeaveAt": "2022-09-09T10:05:12+08:00",
                "Access": "2g",
                "OS": "android",
                "DeviceType": "iPhone 11",
                "SdkVersion": "5.20.11",
                "Pub": true,
                "Finished": true,
                "Duration": 278
            },
            {
                "RoomId": "Your_RoomId",
                "UserId": "Your_UserId",
                "CreatedAt": "2022-09-09T10:00:56+08:00",
                "LeaveAt": "2022-09-09T10:05:12+08:00",
                "Access": "2g",
                "OS": "ios",
                "DeviceType": "iPhone 12",
                "SdkVersion": "5.20.11",
                "Pub": true,
                "Finished": true,
                "Duration": 256
            }
        ]
    }
}
json