查询用户列表与通话指标

最近更新时间:2020-07-03 08:20:53

1. 接口描述

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

查询指定时间内的用户列表及用户通话质量数据。可查询5天内数据,查询起止时间不超过1个小时,查询用户不超过6个,不支持跨天查询。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCallDetail。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou
CommId String 通话 ID(唯一标识一次通话): sdkappid_roomgString(房间号_createTime(房间创建时间,unix时间戳,单位为s)例:1400353843_218695_1590065777。通过 DescribeRoomInformation(查询房间列表)接口获取(链接:https://cloud.tencent.com/document/product/647/44050
StartTime Integer 查询开始时间,5天内。本地unix时间戳(1588031999s)
EndTime Integer 查询结束时间,本地unix时间戳(1588031999s)
SdkAppId String 用户sdkappid(1400188366)
UserIds.N Array of String 需查询的用户数组,不填默认返回6个用户,最多可填6个用户
DataType.N Array of String 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
appCpu:APP CPU使用率;
sysCpu:系统 CPU使用率;
aBit:上/下行音频码率;
aBlock:音频卡顿时长;
bigvBit:上/下行视频码率;
bigvCapFps:视频采集帧率;
bigvEncFps:视频发送帧率;
bigvDecFps:渲染帧率;
bigvBlock:视频卡顿时长;
aLoss:上/下行音频丢包;
bigvLoss:上/下行视频丢包;
bigvWidth:上/下行分辨率宽;
bigvHeight:上/下行分辨率高

3. 输出参数

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

4. 示例

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

输入示例

https://trtc.tencentcloudapi.com/?Action=DescribeCallDetail
&CommId=1400353843_218695_1590065777
&StartTime=1590065777
&EndTime=1590065877
&SdkAppId=1400353843
&DataType.0=bigvCapFps
&<公共请求参数>

输出示例

{
  "Response": {
    "Total": 1,
    "UserList": [
      {
        "RoomStr": "218695",
        "UserId": "1716",
        "JoinTs": 1590065777,
        "LeaveTs": 1590067658,
        "Finished": true,
        "DeviceType": "",
        "SdkVersion": "4.3.14",
        "ClientIp": "10.4.1.13"
      }
    ],
    "Data": [
      {
        "Content": [
          {
            "Time": 1590065779,
            "Value": 0
          },
          {
            "Time": 1590065781,
            "Value": 0
          },
          {
            "Time": 1590065783,
            "Value": 0
          },
          {
            "Time": 1590065785,
            "Value": 0
          },
          {
            "Time": 1590065787,
            "Value": 0
          },
          {
            "Time": 1590065789,
            "Value": 0
          },
          {
            "Time": 1590065791,
            "Value": 0
          },
          {
            "Time": 1590065793,
            "Value": 0
          },
          {
            "Time": 1590065795,
            "Value": 0
          },
          {
            "Time": 1590065797,
            "Value": 0
          },
          {
            "Time": 1590065799,
            "Value": 0
          },
          {
            "Time": 1590065801,
            "Value": 0
          },
          {
            "Time": 1590065803,
            "Value": 0
          },
          {
            "Time": 1590065805,
            "Value": 0
          },
          {
            "Time": 1590065807,
            "Value": 0
          },
          {
            "Time": 1590065809,
            "Value": 0
          },
          {
            "Time": 1590065811,
            "Value": 0
          },
          {
            "Time": 1590065813,
            "Value": 0
          },
          {
            "Time": 1590065815,
            "Value": 0
          },
          {
            "Time": 1590065817,
            "Value": 0
          },
          {
            "Time": 1590065819,
            "Value": 0
          },
          {
            "Time": 1590065821,
            "Value": 0
          },
          {
            "Time": 1590065823,
            "Value": 0
          },
          {
            "Time": 1590065825,
            "Value": 0
          },
          {
            "Time": 1590065827,
            "Value": 0
          },
          {
            "Time": 1590065829,
            "Value": 0
          },
          {
            "Time": 1590065831,
            "Value": 0
          },
          {
            "Time": 1590065833,
            "Value": 0
          },
          {
            "Time": 1590065835,
            "Value": 0
          },
          {
            "Time": 1590065837,
            "Value": 0
          },
          {
            "Time": 1590065839,
            "Value": 0
          },
          {
            "Time": 1590065841,
            "Value": 0
          },
          {
            "Time": 1590065843,
            "Value": 0
          },
          {
            "Time": 1590065845,
            "Value": 0
          },
          {
            "Time": 1590065847,
            "Value": 0
          },
          {
            "Time": 1590065849,
            "Value": 0
          },
          {
            "Time": 1590065851,
            "Value": 0
          },
          {
            "Time": 1590065853,
            "Value": 0
          },
          {
            "Time": 1590065855,
            "Value": 0
          },
          {
            "Time": 1590065857,
            "Value": 0
          },
          {
            "Time": 1590065859,
            "Value": 0
          },
          {
            "Time": 1590065861,
            "Value": 0
          },
          {
            "Time": 1590065863,
            "Value": 0
          },
          {
            "Time": 1590065865,
            "Value": 0
          },
          {
            "Time": 1590065867,
            "Value": 0
          },
          {
            "Time": 1590065869,
            "Value": 0
          },
          {
            "Time": 1590065871,
            "Value": 0
          },
          {
            "Time": 1590065873,
            "Value": 0
          },
          {
            "Time": 1590065875,
            "Value": 0
          },
          {
            "Time": 1590065877,
            "Value": 0
          }
        ],
        "PeerId": "",
        "UserId": "1716",
        "DataType": "bigvCapFps"
      }
    ],
    "RequestId": "2e12e365-43e8-4efd-902d-906303e2ee4a"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DBError 数据库查询异常。
InternalError.EsQueryError ES查询异常。
InternalError.HttpParaseFalied http请求解析失败。
InternalError.InterfaceErr 接口错误。
InternalError.MethodErr 不支持的方法。
InvalidParameter 参数错误。
InvalidParameter.BodyParamsError body 解析参数失败。
InvalidParameter.EncodeParams EncodeParams参数错误。
InvalidParameter.QueryScaleOversize 查询范围超过1个小时。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameter.StartTs StartTs参数错误。
InvalidParameter.StartTsOversize 查询开始时间不在5天内。
MissingParameter 缺少参数错误。
MissingParameter.CommId 缺少CommId参数。
MissingParameter.EndTs 缺少endTS_s参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.StartTs 缺少startTS_s参数。
目录