tencent cloud

1. API Description

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

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.
Note:

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: https://trtc.io/document/54481?product=pricing.

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

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.

3. Output Parameters

4. Example

Example1 Querying the user list and call metrics

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCallDetailInfo
<Common request parameters>

{
    "DataType": [
        "bigvCapFps"
    ],
    "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": "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. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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