场景实践

有奖调研

查询历史用户列表

最近更新时间:2021-09-10 08:10:19

我的收藏

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。
注意:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUserInformation。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表
CommId String 通话 ID(唯一标识一次通话): sdkappid_roomgString(房间号createTime(房间创建时间,unix时间戳,单位为s)例:1400353843218695_1590065777。通过 DescribeRoomInformation(查询房间列表)接口获取(链接:https://cloud.tencent.com/document/product/647/44050)
StartTime Integer 查询开始时间,14天内。本地unix时间戳(1590065777)
EndTime Integer 查询结束时间,本地unix时间戳(1590065877)
SdkAppId String 用户SDKAppID(1400353843)
UserIds.N Array of String 需查询的用户数组,不填默认返回6个用户,最多可填6个用户
PageNumber String 设置分页index,从0开始(PageNumber和PageSize 其中一个不填均默认返回6条数据)
PageSize String 设置分页大小(PageNumber和PageSize 其中一个不填均默认返回6条数据,PageSize最大不超过100)

3. 输出参数

参数名称 类型 描述
Total Integer 返回的用户总条数
UserList Array of UserInformation 用户信息列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询用户列表与通话指标

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserInformation
<公共请求参数>

{
    "StartTime": 1590065777,
    "CommId": "1400353843_218695_1590065777",
    "UserIds": [
        "user1_54816741",
        "user2_2107025"
    ],
    "SdkAppId": "1400353843",
    "EndTime": 1590065877
}

输出示例

{
  "Response": {
    "Total": 1,
    "UserList": [
      {
        "RoomStr": "218695",
        "UserId": "user1_54816741",
        "JoinTs": 1590065777,
        "LeaveTs": 1590067658,
        "Finished": true,
        "DeviceType": "",
        "SdkVersion": "4.3.14",
        "ClientIp": "10.4.1.13"
      },
      {
        "RoomStr": "218695",
        "UserId": "user2_2107025",
        "JoinTs": 1590065700,
        "LeaveTs": 1590067693,
        "Finished": true,
        "DeviceType": "",
        "SdkVersion": "4.3.14",
        "ClientIp": "10.4.1.13"
      }
    ],
    "RequestId": "2e12e365-43e8-4efd-902d-906303e2ee4a"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.DBError 数据库查询异常。
InternalError.HttpParaseFalied http请求解析失败。
InternalError.InterfaceErr 接口错误。
InternalError.MethodErr 不支持的方法。
InvalidParameter 参数错误。
InvalidParameter.BodyParamsError body 解析参数失败。
InvalidParameter.EncodeParams EncodeParams参数错误。
InvalidParameter.PageSize PageSize参数错误。
InvalidParameter.QueryScaleOversize 查询范围超过文档限制。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameter.SdkAppid 不能操作的SdkAppid。
InvalidParameter.StartTs StartTs参数错误。
InvalidParameter.StartTsOversize 查询开始时间超过文档限制。
MissingParameter 缺少参数错误。
MissingParameter.CommId 缺少CommId参数。
MissingParameter.EndTs 缺少endTS_s参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.StartTs 缺少startTS_s参数。
目录