tencent cloud

文档反馈

DescribeTelCallInfo

最后更新时间:2024-03-27 16:13:39

1. API Description

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

This API is used to access telephone consumption statistics by instance.

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 Params. The value used for this API: DescribeTelCallInfo.
Version Yes String Common Params. The value used for this API: 2020-02-10.
Region No String Common Params. This parameter is not required for this API.
StartTimeStamp Yes Integer Start timestamp Unix timestamp (supports only day dimension. For example, for querying May 1st, you should pass a timestamp from "2023-05-01 00:00:00" to "2023-05-01 23:59:59" and for querying both May 1st and 2nd, you should pass a timestamp from "2023-05-01 00:00:00" to "2023-05-02 23:59:59").
EndTimeStamp Yes Integer End timestamp. Unix timestamp and the maximum query time range is 90 days (supports only day dimension, for example, for querying May 1st, you should pass timestamp from "2023-05-01 00:00:00" to "2023-05-01 23:59:59" and for querying both May 1st and May 2nd, you should pass timestamp from "2023-05-01 00:00:00" to "2023-05-02 23:59:59").
SdkAppIdList.N Yes Array of Integer Application ID list, when having multiple IDs, the returned value is the sum of all the IDs.

3. Output Parameters

Parameter Name Type Description
TelCallOutCount Integer Number of minutes consumed by Outbound Package.
TelCallInCount Integer Number of minutes consumed by Inbound Package.
SeatUsedCount Integer Number of agent usage statistics.
VOIPCallInCount Integer Number of minutes consumed by Audio package.
AsrOfflineCount Integer Number of minutes consumed by Offline Speech-to-Text Package.
AsrRealtimeCount Integer Number of minutes consumed by Real-time Speech-to-Text Package.
RequestId String The 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 Accessing Phone Call Statistics

This example shows you how to access phone call statistics

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTelCallInfo
<Common request parameters>
{
    "StartTimeStamp": "0",
    "EndTimeStamp": "0",
    "SdkAppIdList": [
        "0"
    ]
}

Output Example

{
    "Response": {
        "TelCallOutCount": 0,
        "TelCallInCount": 0,
        "SeatUsedCount": 0,
        "VOIPCallInCount": 0,
        "AsrOfflineCount": 0,
        "AsrRealtimeCount": 0,
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

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
FailedOperation.DuplicatedAccount Duplicate account.
FailedOperation.PermissionDenied Insufficient permissions.
InternalError.DBError Internal database access failure.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotExist The instance does not exist.
InvalidParameterValue.InstanceNotExist The instance does not exist.