tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeStaffStatusMetrics

Last updated: 2024-09-09 17:58:08

1. API Description

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

This API is used to access the real-time status statistics metrics of the agent.

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: DescribeStaffStatusMetrics.
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.
StaffList.N No Array of String Filter agent list. By default, do not pass all returned agent information.
GroupIdList.N No Array of Integer Filter skill group ID list.
StatusList.N No Array of String Filter agent status list Agent status free Available | busy Busy | rest On Break | notReady Not Ready | afterCallWork Post-call Adjustment | offline Offline

3. Output Parameters

Parameter Name Type Description
Metrics Array of StaffStatusMetrics Real-time information on agent status.
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 Agent Real-Time Status Statistics Metrics

This example shows you how to access agent real-time status statistics metrics.

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStaffStatusMetrics
<Common request parameters>
{
    "SdkAppId": 0,
    "StaffList": [
        "aaa@abc.com"
    ],
    "GroupIdList": [
        0
    ],
    "StatusList": [
        "free"
    ]
}

Output Example

{
    "Response": {
        "Metrics": [
            {
                "Email": "aaa@abc.com",
                "Status": "free",
                "StatusExtra": {
                    "Type": "tel",
                    "Direct": "callin"
                },
                "OnlineDuration": 0,
                "FreeDuration": 0,
                "BusyDuration": 0,
                "NotReadyDuration": 0,
                "RestDuration": 0,
                "AfterCallWorkDuration": 0,
                "Reason": "abc",
                "ReserveRest": true,
                "ReserveNotReady": true,
                "UseMobileAccept": 0,
                "UseMobileCallOut": true,
                "LastOnlineTimestamp": 0,
                "LastStatusTimestamp": 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
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