tencent cloud

DescribeStaffStatusHistory
Last updated: 2025-11-11 10:20:07
DescribeStaffStatusHistory
Last updated: 2025-11-11 10:20:07

1. API Description

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

This API is used to query agent status history.

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: DescribeStaffStatusHistory.
Version Yes String Common Params. The value used for this API: 2020-02-10.
Region No String Common Params. This parameter is not required.
SdkAppId Yes Integer App ID (required). can be used to view https://console.tencentcloud.com/ccc.
StaffUserId Yes String Agent account.
StartTimestamp Yes Integer Start timestamp. Unix second-level timestamp. supports up to nearly 180 days.
EndTimestamp Yes Integer End timestamp, Unix second-level timestamp. the interval range between end time and start time is less than 7 days.
Cursor No String Specifies the cursor used during paginated retrieval.
PageSize No Integer Specifies the pagination size.

3. Output Parameters

Parameter Name Type Description
Data Array of StaffStatus Specifies the agent status data.
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 Querying Agent Status History Example

This example shows you how to query agent status history.

Input Example

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

{
    "SdkAppId": 1400000000,
    "StaffUserId": "foo@tencent.com",
    "StartTimestamp": 1756297161,
    "EndTimestamp": 1756815561
}

Output Example

{
    "Response": {
        "Data": [
            {
                "Cursor": "MTc1NjgwMDU0ODI3NSx3ZWlqdW55aUB0ZW5jZW50LmNvbSww",
                "SessionId": "75d7fb65-878c-4db2-8b3a-4484f9e3b931",
                "Status": "busy",
                "Timestamp": 1756800548
            },
            {
                "Cursor": "MTc1NjgwMDU1NzE0OCx3ZWlqdW55aUB0ZW5jZW50LmNvbSwx",
                "SessionId": "",
                "Status": "notReady",
                "Timestamp": 1756800557
            },
            {
                "Cursor": "MTc1NjgwMjk1MzE4OSx3ZWlqdW55aUB0ZW5jZW50LmNvbSw1",
                "SessionId": "",
                "Status": "free",
                "Timestamp": 1756802953
            },
            {
                "Cursor": "MTc1NjgwMjk4MjM5MSx3ZWlqdW55aUB0ZW5jZW50LmNvbSw2",
                "SessionId": "",
                "Status": "afterCallWork",
                "Timestamp": 1756802982
            }
        ],
        "RequestId": "df0c7f16-1886-4b98-ae1d-6fb8ac3464b9"
    }
}

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.DBError Internal database access failure.
InvalidParameterValue Invalid Parameter
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback