你可以使用此接口查询一段时间内,某个应用下进行音视频通话的指定房间内特定或全部用户信息。
你可以调用 ListUserInfo 接口,指定你所属的 AppId,RoomId 和查询时间段,查询该时间段内的该房间内指定或全部用户的相关信息。
| 限制类别 | 调用频率限制 |
|---|---|
| 最大请求次数 | 10 次/秒 |
| 最远可查询时间 | 14 天 |
| 最大单次查询时间跨度 | 6 小时(若查询时间超过 6 小时,结束时间自动调整为开始时间 + 6 小时) |
| 数据延迟 | 100 秒 |
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。
使用 GET 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListUserInfo | 接口名称,本接口取值:ListUserInfo |
| 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 用户 |
https://rtc.volcengineapi.com?Action=ListUserInfo&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 UserListItem | 用户信息 |
返回值
Result仅在请求成功时返回以上参数,失败时为空
{
"ResponseMetadata": {
"RequestId": "Your_RequestID",
"Action": "ListUserInfo",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"Total": 1,
"PageNum": 1,
"PageSize": 20,
"UserList": [
{
"CallId": "Your_CallId",
"RoomId": "Your_RoomId",
"UserId": "Your_UserId",
"CreatedAt": "2022-10-31T19:22:57+08:00",
"LeaveAt": "2022-10-31T19:23:29+08:00",
"Access": "wifi",
"OS": "linux",
"DeviceType": "iPhone 11",
"SdkVersion": "3.37.0517.1420",
"Pub": false,
"Duration": 22,
"Finished": true,
"Record": [
{
"Time": "2022-10-31T19:22:57+08:00",
"Type": "join_room"
},
{
"Time": "2022-10-31T19:23:08+08:00",
"Type": "leave_room"
},
{
"Time": "2022-10-31T19:23:18+08:00",
"Type": "join_room"
},
{
"Time": "2022-10-31T19:23:29+08:00",
"Type": "leave_room"
}
]
}
]
}
}
json