You need to enable JavaScript to run this app.
导航
获取离线用户通话详情 ListUserInfo
最近更新时间:2024.06.21 15:36:08首次发布时间:2023.12.27 19:58:10

本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本

在实时音视频通话场景中,你可以通过调用此接口查询指定时间段内某个房间内的特定或全部用户信息。

注意事项

  • 最大请求次数:60 次/秒
  • 最远可查询时间:14 天
  • 最大单次查询时间跨度:6 小时(若查询时间超过 6 小时,结束时间自动调整为开始时间 + 6 小时)
  • 数据延迟:100 秒

请求说明

  • 请求方式:GET
  • 请求地址:https://rtc.volcengineapi.com?Action=ListUserInfo&Version=2023-11-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必选
示例值
描述
Action
String
ListUserInfo
接口名称。当前 API 的名称为 ListUserInfo
Version
String
2023-11-01
接口版本。当前 API 的版本为 2023-11-01
AppId
String
You****pId
应用的唯一标志
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_roomleave_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=661e****543cf&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": "20230****10420",
        "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"
                    }
                ]
            }
        ]
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。