tencent cloud



Last updated: 2021-10-27 16:01:51

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

This API is used to query the user list and call quality data of a specified time range in the last 14 days. When DataType is not null, data of up to 6 users during a period of up to 1 hour can be queried each time, and the period can start on one day and end on the next. When DataType and UserIds are null, 6 users are queried by default, and data of up to 100 users can be displayed on each page (PageSize set to 100 or smaller). This API is used to query call quality and is not recommended for billing.
Note: You can use this API to query or check historical data, but not for real-time key business logic.

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 Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeCallDetail.
Version Yes String Common parameter. The value used for this API: 2019-07-22.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
CommId Yes String Unique ID of a call: sdkappid_roomgString_createTime. The roomgString refers to the room ID, and createTime refers to the creation time of a room in the format of UNIX timestamp in seconds, such as 1400353843_218695_1590065777. Its value can be obtained from the DescribeRoomInformation API (related document: https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1).
StartTime Yes Integer Query start time (s) in the format of Unix timestamp (e.g., 1590065777), which must be a time point in the last 14 days. The start and end time for query must not be more than 1 hour apart.
EndTime Yes Integer Query end time (s) in the format of Unix timestamp, e.g., 1590065877
SdkAppId Yes String SDKAppID of the users to query, e.g., 1400353843
UserIds.N No Array of String User array to query, which contains up to 6 users. If it is left empty, 6 users will be returned by default.
DataType.N No Array of String Metric to query. The user list will be returned if it is left empty; all metrics will be returned if its value is all.
appCpu: CPU utilization of the application;
sysCpu: CPU utilization of the system;
aBit: upstream/downstream audio bitrate;
aBlock: audio lag duration;
bigvBit: upstream/downstream video bitrate;
bigvCapFps: frame rate for capturing videos;
bigvEncFps: frame rate for sending videos;
bigvDecFps: rendering frame rate;
bigvBlock: video lag duration;
aLoss: upstream/downstream audio packet loss;
bigvLoss: upstream/downstream video packet loss;
bigvWidth: upstream/downstream resolution in width;
bigvHeight: upstream/downstream resolution in height.
PageNumber No String Page index starting from 0. If either PageNumber or PageSize is left empty, 6 data entries will be returned by default.
PageSize No String Number of entries per page. If either PageNumber or PageSize is left empty, 6 data entries will be returned by default. When either DataType or UserId is not null, PageSize is up to 6. When DataType and UserId are null, PageSize is up to 100.

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of returned users
UserList Array of UserInformation User information list
Data Array of QualityData Quality data
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying user list and call metrics

Input Example

&<Common request parameters>

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 Code Description
InternalError Internal error.
InternalError.DBError An error occurred while querying the database.
InternalError.EsQueryError An error occurred while querying ES.
InternalError.HttpParaseFalied Failed to parse the HTTP request.
InternalError.InterfaceErr API error.
InternalError.MethodErr Unsupported method.
InvalidParameter Invalid parameter.
InvalidParameter.BodyParamsError Failed to parse the body parameter.
InvalidParameter.EncodeParams Invalid EncodeParams.
InvalidParameter.PageSizeOversize The value of PageSize exceeds 100.
InvalidParameter.QueryScaleOversize The range for query exceeded the limit.
InvalidParameter.SdkAppId SdkAppId is incorrect.
InvalidParameter.StartTs Invalid StartTs.
InvalidParameter.StartTsOversize The start time for query exceeded the limit.
MissingParameter Missing parameter.
MissingParameter.CommId CommId is missing.
MissingParameter.CommIdOrSdkAppId SdkAppId or CommID missing.
MissingParameter.EndTs endTS_s is missing.
MissingParameter.SdkAppId SdkAppId is missing.
MissingParameter.StartTs startTS_s is missing.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support