实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考历史数据查询获取离线用户通话详情 ListUserInfo
复制全文
下载 pdf获取离线用户通话详情 ListUserInfo
文档反馈
问问助手调用 ListUserInfo 接口，查询指定房间在特定时间段内的用户列表及其通话详情，包括用户的进出房记录、在线时长、设备信息、SDK 版本等。
注意事项
- 最大请求次数：10 次/秒
- 最远可查询时间：14 天
- 最大单次查询时间跨度：6 小时（若查询时间超过 6 小时，结束时间自动调整为开始时间 + 6 小时）
- 数据延迟：100 秒
- 该接口请求接入地址仅支持 rtc.volcengineapi.com。
请求说明
- 请求方式：GET
- 请求地址：https://rtc.volcengineapi.com?Action=ListUserInfo&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：ListUserInfo
接口名称。当前 API 的名称为 ListUserInfo。
Version String 必选 示例值：2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId String 必选 示例值：66****3cf
RoomId String 可选 示例值：Your_RoomId
房间 ID。
StartTime String 必选 示例值：2022-05-22T12:00:00 08:00
查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime String 必选 示例值：2022-05-22T12:59:00 08:00
查询结束时间戳，格式为 RFC3339，单位为秒。
PageNum Long 可选 示例值：1
分页序号，默认值为1。
PageSize Long 可选 示例值：20
每页用户数，最大不能超过 100。默认为 20。如果指定值超过 100，每页的用户数为 100。
UserId String 可选 示例值：Your_UserId
查询的用户 ID 列表，多个用户 ID 用逗号隔开，最多可以指定 10 个。值不合法时默认剔除。为空时，查询房间内全部用户信息。
ExcludeServerUser Boolean 可选 示例值：true
是否排除 Linux 用户。默认为 true，表示排除 Linux 用户
返回参数
Total Long 示例值：2
查询到的用户总数，若同一用户有多次通话记为多个用户。
PageNum Long 示例值：1
分页序号。
PageSize Long 示例值：20
每页用户数，若同一用户有多次通话记为多个用户。
UserList Object[] 示例值：-
用户信息。
OS String 示例值：ios
CallId下用户最后一次进房对应的设备平台。枚举值：android、ios、linux、mac、windows、web、unknown。
Pub Boolean 示例值：true
CallId下用户是否发布过流。
Access String 示例值：wifi
CallId下用户最后一次进房对应的网络类型。枚举值：2g、3g、4g、5g、wifi、unknown。
CallId String 示例值：6432551232142
通话 Id，是通话的唯一标识。
Record Object[] 示例值：-
CallId下用户在通话内全部进退房记录。
Time String 示例值：2022-10-31T19:22:57+08:00
用户进房/退房时间，格式为 RFC3339，单位秒。
Type String 示例值：join_room
用户进房/退房类型，取值为 join_room或 leave_room。
RoomId String 示例值：Room1
查询房间 Id。
UserId String 示例值：user1
查询用户 Id。
LeaveAt String 示例值：2006-01-02T15:04:05+08:00
CallId下用户最后一次退出通话时间，格式为 RFC3339，单位秒。如果此时用户在线，返回为空。
Duration Long 示例值：100
CallId下用户从第一次进房到最后一次离开房间的时间范围内真实在线时长（多次进出房时间间隔累加），单位为秒。
Finished Boolean 示例值：true
CallId下用户是否离开房间。
CreatedAt String 示例值：2006-01-02T15:04:05+08:00
CallId下用户第一次进入通话时间，格式为 RFC3339，单位秒。
DeviceType String 示例值：iPhone 11
CallId下用户最后一次进房对应的设备型号。
SdkVersion String 示例值：3.30.101
CallId下用户最后一次进房使用 sdk 版本号。
请求示例
GET https://rtc.volcengineapi.com?Action=ListUserInfo&Version=2023-11-01&AppId=66****3cf&StartTime=2022-05-22T12:00:00 08:00&EndTime=2022-05-22T12:59:00 08:00&RoomId=Room1&PageNum=1&PageSize=20&UserId=user1&ExcludeServerUser=true
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "ListUserInfo",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"Total": 1,
"PageNum": 1,
"PageSize": 20,
"UserList": [
{
"CallId": "test_call1",
"RoomId": "Room1",
"UserId": "user1",
"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"
}
]
}
]
}
}
错误码
最近更新时间：2026.03.13 10:26:40
这个页面对您有帮助吗？
有用
有用
无用
无用