tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCallInMetrics

Last updated: 2024-03-27 16:13:42

1. API Description

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

This API is used to access the inbound real-time data statistical metrics.

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: DescribeCallInMetrics.
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.
SdkAppId Yes Integer Application ID (required) can be found at https://console.tencentcloud.com/ccc.
EnabledSkillGroup No Boolean Whether to return skill group dimension information or not (the default is "Yes").
EnabledNumber No Boolean Whether to return line dimension information or not (the default is "No").
GroupIdList.N No Array of Integer Filter skill group list.

3. Output Parameters

Parameter Name Type Description
Timestamp Integer Timestamp.
TotalMetrics CallInMetrics Overall metrics.
NumberMetrics Array of CallInNumberMetrics Circuit dimension metrics.
Note: this field may return null, indicating that no valid values can be obtained.
SkillGroupMetrics Array of CallInSkillGroupMetrics Skill group dimension metrics
Note: this field may return null, indicating that no valid values can be obtained.
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 Inbound Real-time Data Statistical Metric

This example shows you how to access inbound real-time data statistical metrics.

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCallInMetrics
<Common request parameters>
{
    "EnabledNumber": true,
    "EnabledSkillGroup": true,
    "SdkAppId": 0
}

Output Example

{
    "Response": {
        "Timestamp": 0,
        "TotalMetrics": {
            "IvrCount": 0,
            "QueueCount": 0,
            "RingCount": 0,
            "AcceptCount": 0,
            "TransferOuterCount": 0,
            "MaxQueueDuration": 0,
            "AvgQueueDuration": 0,
            "MaxRingDuration": 0,
            "AvgRingDuration": 0,
            "MaxAcceptDuration": 0,
            "AvgAcceptDuration": 0
        },
        "NumberMetrics": [
            {
                "Number": "abc",
                "Metrics": {
                    "IvrCount": 0,
                    "QueueCount": 0,
                    "RingCount": 0,
                    "AcceptCount": 0,
                    "TransferOuterCount": 0,
                    "MaxQueueDuration": 0,
                    "AvgQueueDuration": 0,
                    "MaxRingDuration": 0,
                    "AvgRingDuration": 0,
                    "MaxAcceptDuration": 0,
                    "AvgAcceptDuration": 0
                },
                "SkillGroupMetrics": [
                    {
                        "SkillGroupId": 0,
                        "Metrics": {
                            "IvrCount": 0,
                            "QueueCount": 0,
                            "RingCount": 0,
                            "AcceptCount": 0,
                            "TransferOuterCount": 0,
                            "MaxQueueDuration": 0,
                            "AvgQueueDuration": 0,
                            "MaxRingDuration": 0,
                            "AvgRingDuration": 0,
                            "MaxAcceptDuration": 0,
                            "AvgAcceptDuration": 0
                        },
                        "Name": "abc"
                    }
                ]
            }
        ],
        "SkillGroupMetrics": [
            {
                "SkillGroupId": 0,
                "Name": "abc"
            }
        ],
        "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
InternalError An internal error occurs.
InternalError.DBError Internal database access failure.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotExist The instance does not exist.
InvalidParameterValue.InstanceNotExist The instance does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy