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

接口行为

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

调用接口

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

接口限制
限制类别调用频率限制
最大请求次数60 次/秒
最远可查询时间14 天
最大单次查询时间跨度6 小时(若查询时间超过 6 小时,结束时间自动调整为开始时间 + 6 小时)
数据延迟100 秒
请求方式

使用 GET 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是ListUserInfo接口名称,本接口取值:ListUserInfo
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
AppIdString是Your_AppId应用的唯一标志
StartTimeString是2022-05-22T12:00:00 08:00查询起始时间戳,格式为 RFC3339,单位为秒
EndTimeString是2022-05-22T12:59:00 08:00查询结束时间戳,格式为 RFC3339,单位为秒
RoomIdString是Your_RoomId房间 ID,是房间的唯一标志
PageNumInt否1分页序号,默认值为1
PageSizeInt否20每页用户数,最大不能超过 100。默认为 20。如果指定值超过 100,每页的用户数为 100。
UserIdString否Your_UserId查询的用户 ID 列表,多个用户 ID 用逗号隔开,最多可以指定 10 个。值不合法时默认剔除。为空时,查询房间内全部用户信息。
ExcludeServerUserBool否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 的结构如下:

参数名类型示例值描述
TotalInt2查询到的用户总数,若同一用户有多次通话记为多个用户
PageNumInt1分页序号
PageSizeInt20每页用户数,若同一用户有多次通话记为多个用户
UserListArray 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