1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
查询指定时间内的用户列表及用户通话质量数据,最大可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
注意:
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
方式一:通过订阅包月套餐「尊享版」(可查近7天)和「旗舰版」(可查近14天),前往订阅。
方式二:通过订阅监控仪表盘商业套餐包「基础版」(可查近7天)和「进阶版」(可查近14天),前往订阅。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCallDetailInfo。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-mumbai 。 |
CommId | 是 | String | 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取(查询历史房间列表)。 示例值:1400xxxxxx_218695_1590065777 |
StartTime | 是 | Integer | 查询开始时间,本地unix时间戳,单位为秒(如:1590065777), 注意:支持查询14天内的数据。 示例值:1590065777 |
EndTime | 是 | Integer | 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) 注意:查询起止时间需小于1小时,超过则返回null,即与StartTime间隔时间不超过1小时。 示例值:1590065877 |
SdkAppId | 是 | Integer | 用户SdkAppId(如:1400xxxxxx)。 示例值:1400xxxxxx |
UserIds.N | 否 | Array of String | 需查询的用户数组,默认不填返回6个用户。 示例值:["a","b"] |
DataType.N | 否 | Array of String | 需查询的指标,不填则只返回用户列表,填all则返回所有指标。 appCpu:APP CPU使用率; sysCpu:系统 CPU使用率; aBit:上/下行音频码率;单位:bps aBlock:音频卡顿时长;单位:ms bigvBit:上/下行视频码率;单位:bps bigvCapFps:视频采集帧率; bigvEncFps:视频发送帧率; bigvDecFps:渲染帧率; bigvBlock:视频卡顿时长;单位:ms aLoss:上/下行音频丢包率; bigvLoss:上/下行视频丢包率; bigvWidth:上/下行分辨率宽; bigvHeight:上/下行分辨率高; aCapEnergy:音频采集能量; aPlayEnergy:音频播放能量; rtt:SDK到云端的往返延时;单位: ms 示例值:["bigvCapFps"] |
PageNumber | 否 | Integer | 当前页数,默认为0, 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。 示例值:0 |
PageSize | 否 | Integer | 每页个数,默认为6, 范围:[1,100] 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6; DataType 为null,UserIds长度不超过100,PageSize最大不超过100。 示例值:6 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 返回的用户总条数 示例值:1 |
UserList | Array of UserInformation | 用户信息列表 注意:此字段可能返回 null,表示取不到有效值。 |
Data | Array of QualityData | 质量数据 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询历史用户列表与通话指标
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCallDetailInfo
<公共请求参数>
{
"DataType": [
"bigvCapFps"
],
"CommId": "1400188366_218695_1590065777",
"EndTime": 1590065877,
"SdkAppId": 1400188366,
"StartTime": 1590065777
}
输出示例
{
"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
}
],
"PeerId": "",
"UserId": "1716",
"DataType": "bigvCapFps"
}
],
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBError | 数据库查询异常。 |
InternalError.EsQueryError | ES查询异常。 |
InternalError.HttpParaseFalied | http请求解析失败。 |
InternalError.InterfaceErr | 接口错误。 |
InternalError.MethodErr | 不支持的方法。 |
InvalidParameter | 参数错误。 |
InvalidParameter.BodyParamsError | body 解析参数失败。 |
InvalidParameter.EncodeParams | EncodeParams参数错误。 |
InvalidParameter.PageNumber | PageNumber 参数错误。 |
InvalidParameter.PageSize | PageSize参数错误。 |
InvalidParameter.PageSizeOversize | PageSize超过100。 |
InvalidParameter.QueryScaleOversize | 查询范围超过文档限制。 |
InvalidParameter.SdkAppId | SdkAppId参数错误。 |
InvalidParameter.SdkAppid | 不能操作的SdkAppid。 |
InvalidParameter.StartTimeOversize | 查询起始时间超过当前监控仪表盘功能版本限制,详情请见:https://cloud.tencent.com/document/product/647/81331。 |
InvalidParameter.StartTs | StartTs参数错误。 |
InvalidParameter.StartTsOversize | 查询开始时间超过文档限制。 |
InvalidParameter.UserIdsMorethanSix | 用户数超过6个。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.CommId | 缺少CommId参数。 |
MissingParameter.CommIdOrSdkAppId | 缺少SdkAppId参数或CommID参数。 |
MissingParameter.EndTs | 缺少endTS_s参数。 |
MissingParameter.SdkAppId | 缺少SdkAppId参数。 |
MissingParameter.StartTs | 缺少startTS_s参数。 |