Starter Deal! First 3 month from only  $9.9 /month!
Starter Deal! First 3 month from only  $9.9 /month!
Grab It Now 
Features & Server APIs
  • On-Cloud Recording
  • Relay to CDN
  • RTMP Streaming with TRTC
  • Event Callbacks
    • Event Callbacks
    • Relay to CDN Callback
    • Verify Signature Example
  • Sending and Receiving Messages
  • Access Management
    • Overview
    • Manageable Resources and Actions
    • Preset Policies
    • Custom Policies
  • Enabling Advanced Permission Control
  • How to push stream to TRTC room with OBS WHIP
  • Server APIs
    • API Category
    • History
    • Making API Request
      • Request Structure
      • Common Params
      • Signature v3
      • Signature
      • Responses
    • Room Management APIs
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • Call Quality Monitoring APIs
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • Pull Stream Relay Related Interface
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • On-cloud Recording APIs
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • Stream Mixing and Relay APIs
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • Usage Statistics APIs
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • Data Types
    • Error Codes
    • Appendix
      • Event ID Mapping Table
Features & Server APIs


1. API Description

Domain name for API request:

This API (the old DescribeCallDetail) is used to query the user list and call quality data of a specified time range in the last 14 days. If DataType is not null, the data of up to six users during a period of up to one hour can be queried (the period can start and end on different days). If DataType is null, the data of up to 100 users can be returned per page (the value of PageSize cannot exceed 100). Six users are queried by default. The period queried cannot exceed four hours. This API is used to query call quality and is not recommended for billing purposes.

  1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.
  2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to:

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeCallDetailInfo.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionYesStringCommon Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-mumbai, ap-singapore, na-toronto.
CommIdYesStringThe unique ID of a call, whose format is SdkAppId_CreateTime, such as 1400xxxxxx_218695_1590065777. createTime is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the DescribeRoomInfo API.
StartTimeYesIntegerThe start time, which is a Unix timestamp (seconds) in local time, such as 1590065777.
Note: Only data in the last 14 days can be queried.
EndTimeYesIntegerThe end time, which is a Unix timestamp (seconds) in local time, such as 1590065877.
Note: If DataType is not null, the end time and start time cannot be more than one hour apart; if DataType is null, the end time and start time cannot be more than four hours apart.
SdkAppIdYesIntegerThe application ID, such as 1400xxxxxx.
UserIds.NNoArray of StringThe users to query. If you do not specify this, the data of six users will be returned.
DataType.NNoArray of StringThe metrics to query. If you do not specify this, only the user list will be returned. If you pass in all, all metrics will be returned.
appCpu: The CPU utilization of the application.
sysCpu: The CPU utilization of the system.
aBit: The upstream/downstream audio bitrate (bps).
aBlock: The audio stutter duration (ms).
bigvBit: The upstream/downstream video bitrate (bps).
bigvCapFps: The frame rate for capturing videos.
bigvEncFps: The frame rate for sending videos.
bigvDecFps: The rendering frame rate.
bigvBlock: The video stutter duration (ms).
aLoss: The upstream/downstream audio packet loss.
bigvLoss: The upstream/downstream video packet loss.
bigvWidth: The upstream/downstream resolution (width).
bigvHeight: The upstream/downstream resolution (height).
PageNumberNoIntegerThe page number. The default is 0.
Note: If PageNumber or PageSize is not specified, six records will be returned.
PageSizeNoIntegerThe number of records per page. The default is 6.
Value range: 1-100.
Note: If DataType is not null, the length of the array UserIds and the value of PageSize cannot exceed 6.
If DataType is null, the length of the array UserIds and the value of PageSize cannot exceed 100.

3. Output Parameters

Parameter NameTypeDescription
TotalIntegerThe number of records returned.
UserListArray of UserInformationThe user information.
Note: This field may return null, indicating that no valid values can be obtained.
DataArray of QualityDataThe call quality data.
Note: This field may return null, indicating that no valid values can be obtained.
RequestIdStringThe unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the user list and call metrics

Input Example

Content-Type: application/json
X-TC-Action: DescribeCallDetailInfo
<Common request parameters>

    "DataType": [
    "CommId": "1400188366_218695_1590065777",
    "EndTime": 1590065877,
    "SdkAppId": 1400188366,
    "StartTime": 1590065777

Output Example

    "Response": {
        "Total": 1,
        "UserList": [
                "RoomStr": "218695",
                "UserId": "1716",
                "JoinTs": 1590065777,
                "LeaveTs": 1590067658,
                "Finished": true,
                "DeviceType": "",
                "SdkVersion": "4.3.14",
                "ClientIp": ""
        "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. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error CodeDescription
InternalErrorInternal error.
InternalError.DBErrorAn error occurred while querying the database.
InternalError.EsQueryErrorAn error occurred during an ES query.
InternalError.HttpParaseFaliedFailed to parse the HTTP request.
InternalError.InterfaceErrAPI error.
InternalError.MethodErrUnsupported method.
InvalidParameterParameter error.
InvalidParameter.BodyParamsErrorFailed to parse body parameters.
InvalidParameter.EncodeParamsInvalid EncodeParams.
InvalidParameter.PageNumberInvalid PageNumber.
InvalidParameter.PageSizeInvalid PageSize.
InvalidParameter.PageSizeOversizeThe value of PageSize exceeds 100.
InvalidParameter.QueryScaleOversizeThe query period exceeds the limit.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameter.SdkAppidInoperable SdkAppid.
InvalidParameter.StartTimeOversizeThe query start time exceeds the range allowed by the current dashboard edition. For details, see
InvalidParameter.StartTsInvalid StartTs.
InvalidParameter.StartTsOversizeThe start time for query exceeded the limit.
InvalidParameter.UserIdsMorethanSixThe number of users exceeds 6.
MissingParameterMissing parameter.
MissingParameter.CommIdCommId is missing.
MissingParameter.CommIdOrSdkAppIdSdkAppId or CommID missing.
MissingParameter.EndTsendTS_s is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
MissingParameter.StartTsstartTS_s is missing.