Announcement

What's New

Cloud Contact Center Terminology Update

What is Tencent Cloud Contact Center

Overview

Feature List

Terms Introduction

Handling Firewall Restrictions

AI Voicebot

Billing Guide

Voice Call Billing Overview

Desk Billing Overview

View Billing

Refund Policy

New User Guide

Voice Guide

Desk Guide

Use Case

Inbound: Customer Experience

Outbound: Telemarketing

Auto Dialer: Voice Notification

Integration Use Case (SDK）

Administrator Guide

Voice Guide

Desk Guide

Member Guide

Voice Guide

Desk Guide

AI Voice Agent Guide

Introducing AI Voice Agent

AI Voice Agent Practical Tutorial

Set Up Your AI Voice Agent

Activate AI Voice Agent Call

AI Voice Agent Call Logs

Developer Guide

SDK Development Guide

Data Push

Voice API Reference

History

Introduction

API Category

Making API Requests

Agent APIs

Skill Group APIs

Number APIs

Dual Call APIs

Predictive Outbound Call APIs

SIP Phone APIs

Call Service Record APIs

Billing APIs

Other APIs

Outbound Call APIs

Speech Intelligent Agent APIs

Data Types

Error Codes

Desk API Reference

API Reference

Callback Configuration

FAQs

Data Deletion Guide

Legal

Data Processing And Security Agreement

Service Level Agreements

TENCENT CLOUD CONTACT CENTRE TERMS OF USE

Glossary

Query Live Agent Analysis Data

Focus Mode

Font Size

Last updated: 2025-03-31 20:38:32

API Call Instructions
Through this API, query the analysis data of live agent.
Sample Request URL
https://console.tim.qq.com/v4/desk_http_svc/describe_agent_statistics?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table only lists the parameters involved in modification when calling this API and their descriptions. For more parameter details, please see REST API Introduction.
Parameter
Description
v4/desk_http_svc/describe_agent_statistics
Request API.
sdkappid
Assigned SDKAppID in the IM console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Signature generated by the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of [0,4294967295].
contenttype
The request format has a fixed value of json.
Sample Request Packet
{
    "From": 1736697600,
    "To": 1736870399,
    "AgentIds": [
        "1289316652@qq.com"
    ],
    "Limit": 10,
    "Offset": 0
}
Request Packet Fields
Field
Type
Required
Description
From
Integer
Required
Start time, Unix second-level timestamp.
Currently only support daily data statistics, start time is the timestamp at 00:00 on the day.
To
Integer
Required
End time, Unix second-level timestamp.
Currently only support daily data statistics. End time is the timestamp of 23:59:59 on the day.
Limit
Integer
Optional.
Number of returned entries, the maximum is 100, the default is 100.
Example value: 100.
Offset
Integer
Optional.
Returned record offset, default is 0.
Example value: 0.
AgentIds
String
Optional.
Specify the customer service list to be queried.
Response Package Example
{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "TotalCount": 5,
    "Data": [
        {
            "AgentId": "1289316652@qq.com",
            "AgentNickName": "Meimei"
            "FirstLoginTimestamp": 1738923814,
            "LastLogoutTimestamp": 1738934235,
            "FreeTime": 3600,
            "BusyTime": 300,
            "RestTime": 600,
            "TotalSessionCnt": 12,
            "TransferSessionCnt": 0,
            "EffectiveSessionCnt": 8,
            "AgentEndCnt": 10,
            "ServeUserCnt": 10,
            "TotalAcceptTime": 1527,
            "TotalMsgCnt": 450,
            "AgentMsgCnt": 200,
            "UserMsgCnt": 150,
            "NotRespSessionCnt": 2,
            "AvgFirstRespTime": 10,
            "FirstRespUnder30sCnt": 9,
            "AvgRespTime": 25,
            "AvgRespUnder30sCnt": 8,
            "AvgAcceptTime": 300,
            "SatisfactionSelectedCnt": 8,
            "SatisfiedCnt": 6
        }
    ]
}
Response Packet Fields
Field
Type
Description
ErrorCode
Integer
Error Code:
0: success.
Non-zero: failure.
ErrorInfo
String
Error message.
ActionStatus
String
Result of request processing.
TotalCount
Integer
Total record count.
Data
Array
Customer service statistical data list.
AgentId
String
Human customer service ID.
AgentNickName
String
Customer service nickname.
FirstLoginTimestamp
Integer
First login time, in seconds.
LastLogoutTimestamp
Integer
Last offline time, in seconds.
FreeTime
Integer
Idle duration, in seconds.
BusyTime
Integer
Busy duration, in seconds.
RestTime
Integer
Break duration, in seconds.
TotalSessionCnt
Integer
Total number of sessions recepted by live agent.
TransferSessionCnt
Integer
Number of transferred sessions.
EffectiveSessionCnt
Integer
Number of valid sessions.
AgentEndCnt
Integer
Number of sessions ended by live agent.
ServeUserCnt
Integer
Number of users served.
TotalAcceptTime
Integer
Total session duration, in seconds.
TotalMsgCnt
Integer
Total message count.
AgentMsgCnt
Integer
Agent message count.
UserMsgCnt
Integer
User message count.
NotRespSessionCnt
Integer
Number of unreplied sessions.
AvgFirstRespTime
Integer
Average first response time, in seconds.
FirstRespUnder30sCnt
Integer
Number of sessions with first response time within 30 seconds.
AvgRespTime
Integer
Average response time, in seconds.
AvgRespUnder30sCnt
Integer
Number of sessions with average response time within 30 seconds.
AvgAcceptTime
Integer
Average session duration, in seconds.
SatisfactionSelectedCnt
Integer
Number of evaluation sessions.
SatisfiedCnt
Integer
Number of satisfied evaluation sessions (number of 4 - and 5 - star ratings).
Error Code Description
Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is always 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The private error codes of this API are as follows:
Error Code
Description
141000
This application is not a smart customer service application.
141002
Internal error, please retry.
141004
Invalid parameter.
141009
API rate limiting.
API Debugging Tools
Debug this interface using the REST API online debugging tool.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

Parameter	Description
v4/desk_http_svc/describe_agent_statistics	Request API.
sdkappid	Assigned SDKAppID in the IM console when creating an application.
identifier	Must be an App administrator account. For more details, see App Administrator.
usersig	Signature generated by the App administrator account. For specific operations, see Generate UserSig.
random	Enter a random 32-bit unsigned integer in the range of [0,4294967295].
contenttype	The request format has a fixed value of `json`.

Field	Type	Required	Description
From	Integer	Required	Start time, Unix second-level timestamp. Currently only support daily data statistics, start time is the timestamp at 00:00 on the day.
To	Integer	Required	End time, Unix second-level timestamp. Currently only support daily data statistics. End time is the timestamp of 23:59:59 on the day.
Limit	Integer	Optional.	Number of returned entries, the maximum is 100, the default is 100. Example value: 100.
Offset	Integer	Optional.	Returned record offset, default is 0. Example value: 0.
AgentIds	String	Optional.	Specify the customer service list to be queried.

Error Code	Description
141000	This application is not a smart customer service application.
141002	Internal error, please retry.
141004	Invalid parameter.
141009	API rate limiting.

tencent cloud

Cloud Contact Center

Query Live Agent Analysis Data

API Call Instructions

Sample Request URL

Request Parameters

Sample Request Packet

Request Packet Fields

Response Package Example

Response Packet Fields

Error Code Description

API Debugging Tools

Help and Support