You need to enable JavaScript to run this app.
导航

获取离线用户通话详情 ListUserInfo

最近更新时间2024.01.12 16:39:44

首次发布时间2022.11.15 18:43:12

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

使用说明

接口行为

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListUserInfo接口名称。当前 API 的名称为 ListUserInfo
VersionString2020-12-01接口版本。当前 API 的版本为 2020-12-01
AppIdStringYour_AppId应用的唯一标志
StartTimeString2022-05-22T12:00:00 08:00查询起始时间戳,格式为 RFC3339,单位为秒
EndTimeString2022-05-22T12:59:00 08:00查询结束时间戳,格式为 RFC3339,单位为秒
RoomIdStringYour_RoomId房间 ID,是房间的唯一标志
PageNumInteger1分页序号,默认值为1
PageSizeInteger20每页用户数,最大不能超过 100。默认为 20。如果指定值超过 100,每页的用户数为 100。
UserIdStringYour_UserId查询的用户 ID 列表,多个用户 ID 用逗号隔开,最多可以指定 10 个。值不合法时默认剔除。为空时,查询房间内全部用户信息。
ExcludeServerUserBooleantrue是否排除 Linux 用户。默认为 true,表示排除 Linux 用户

返回参数

下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构

参数类型示例值描述
TotalInteger2查询到的用户总数,若同一用户有多次通话记为多个用户
PageNumInteger1分页序号
PageSizeInteger20每页用户数,若同一用户有多次通话记为多个用户
UserListArray of UserListItem用户信息

UserListItem

参数类型示例值描述
CallIdStringYour_CallId通话 Id,是通话的唯一标识。
RoomIdStringYour_RoomId查询房间 Id
UserIdStringYour_UserId查询用户 Id
CreatedAtString2006-01-02T15:04:05+08:00CallId下用户第一次进入通话时间,格式为 RFC3339,单位秒
LeaveAtString2006-01-02T15:04:05+08:00CallId下用户最后一次退出通话时间,格式为 RFC3339,单位秒。如果此时用户在线,返回为空。
AccessStringwifiCallId下用户最后一次进房对应的网络类型。枚举值:2g3g4g5gwifiunknown
OSStringiosCallId下用户最后一次进房对应的设备平台。枚举值:androidioslinuxmacwindowswebunknown
DeviceTypeStringiPhone 11CallId下用户最后一次进房对应的设备型号
SdkVersionString3.30.101CallId下用户最后一次进房使用 sdk 版本号
PubBooleantrueCallId下用户是否发布过流
FinishedBooleantrueCallId下用户是否离开房间
DurationInteger100CallId下用户从第一次进房到最后一次离开房间的时间范围内真实在线时长(多次进出房时间间隔累加),单位为秒
RecordArray of RecordCallId下用户在通话内全部进退房记录

Record

参数类型示例值描述
TimeString2022-10-31T19:22:57+08:00用户进房/退房时间,格式为 RFC3339,单位秒。
TypeStringjoin_room用户进房/退房类型,取值为 join_roomleave_room

请求示例

GET https://rtc.volcengineapi.com?Action=ListUserInfo&Version=2020-12-01&AppId=Your_AppId&StartTime=2022-05-22T12:00:00 08:00&EndTime=2022-05-22T12:59:00 08:00&RoomId=Your_RoomId&PageNum=1&PageSize=20&UserId=Your_UserId&ExcludeServerUser=true

返回示例

{
    "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"
                    }
                ]
            }
        ]
    }
}

错误码

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