GetAgentServiceStatus
Obtain the agent service status metrics from online reports. Supports queries by instance, time range, agent, and department group.
Operation description
Before invoking this API, ensure that you have activated the service and created an instance.
If you need to provide agent or department information, refer to the guidance in the Request Parameters section.
Queries per second (QPS) limits
Per-user invocation frequency: 100 queries per second.
API-wide invocation frequency: 100 queries per second.
Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The Artificial Intelligence Cloud Call Service (AICCS) instance ID. |
ccc_xp_pre-cn-*** |
| StartDate |
integer |
No |
The start UNIX timestamp, in milliseconds. |
1615083365000 |
| EndDate |
integer |
No |
End UNIX timestamp. Unit: milliseconds. |
1617761765000 |
| PageSize |
integer |
No |
The number of entries per page. The value must be greater than 0. Default value: 20. |
20 |
| CurrentPage |
integer |
No |
The current page number. The value must be greater than 0. Default value: 1. |
1 |
| AgentIds |
array |
No |
A list of agent IDs. |
|
|
integer |
No |
Agent ID. You can invoke the GetAgent API and check the AgentId field in the response to obtain the agent ID. |
111 |
|
| DepIds |
array |
No |
A list of department IDs. |
|
|
integer |
No |
Department ID. You can invoke the GetAllDepartment API and check the DepartmentId field in the response to obtain the department ID. |
123 |
|
| TimeLatitudeType |
string |
No |
The time latitude type. Valid values:
|
minute |
| ExistDepartmentGrouping |
boolean |
No |
Whether to query by department group. Default Value: false. Valid values:
|
true |
| ExistAgentGrouping |
boolean |
No |
Whether to query by agent group. Default Value: false. Valid values:
|
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
result |
||
| Message |
string |
Status code description. |
successful |
| RequestId |
string |
Request ID. |
EE338D98-9BD3-4413-B165 |
| Data |
object |
Data list. |
|
| TotalNum |
integer |
Total number of records. |
4 |
| PageNum |
integer |
Current page number. |
1 |
| PageSize |
integer |
Page size. |
2000 |
| Rows |
string |
Information provided as a JSON string of type List |
{"online_40s_transfer_ready_cnt":81,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":-1,"service_pickup":"2086","total_waiting_time":"981","online_service_time_len":58208,"online_direct_give_up_len":0,"break_ratio":"2%"} |
| Code |
string |
Status code. A return value of 200 indicates that the request succeeded. |
200 |
| Success |
boolean |
Indicates whether the API call succeeded. Valid values:
|
true |
Parameter Guide for the returned Rows parameter:
date_id: Date
hour_id: Hour
minute_id: Minute—5-minute intervals, such as 05, 10, 00, 15
servicer_id: Agent ID
servicer_name: Agent Name
servicer_real_name: Agent Real Name
department_id: Department ID
department_name: Department Name
tenant_id: Tenant ID
tenant_name: Tenant Name
online_direct_ready_cnt: Service volume directly accepted by the agent (direct connection)
online_transfer_ready_cnt: Service volume accepted after transfer-in
online_transfer_in_give_up_cnt: User abandonment count after transfer (not accepted)
online_transfer_out_cnt: Total transfer-out count (it is recommended to obtain this metric directly via the mark action recorded in the product)
online_direct_give_up_cnt: Abandonment count (direct connection)—requests directly abandoned
online_transfer_give_up_cnt: Abandonment count (transfer-in)—abandoned after transfer-in
online_10s_direct_ready_cnt: Service volume accepted within 10 seconds (direct connection)
online_10s_transfer_ready_cnt: Service volume accepted within 10 seconds (transfer-in)
online_20s_direct_ready_cnt: Service volume accepted within 20 seconds (direct connection)
online_20s_transfer_ready_cnt: Service volume accepted within 20 seconds (transfer-in)
online_30s_direct_ready_cnt: Service volume accepted within 30 seconds (direct connection)
online_30s_transfer_ready_cnt: Service volume accepted within 30 seconds (transfer-in)
online_40s_direct_ready_cnt: Service volume accepted within 40 seconds (direct connection)
online_40s_transfer_ready_cnt: Service volume accepted within 40 seconds (transfer-in)
online_60s_direct_ready_cnt: Service volume accepted within 60 seconds (direct connection)
online_60s_transfer_ready_cnt: Service volume accepted within 60 seconds (transfer-in)
online_service_time_len: Total service duration—the time from when the agent started serving to when the service ended (if a change owner occurred, the service end time equals the transfer time), corresponding to the skill group
online_direct_wait_len: Total waiting duration (direct connection)—from queue entry to acceptance for direct connections
online_transfer_wait_len: Total waiting duration (transfer-in)—from queue entry to acceptance for transfer-ins
online_direct_give_up_len: Total abandonment duration (direct connection)—from queue entry to abandonment for direct connections
online_transfer_give_up_len: Total abandonment duration (transfer-in)—from queue entry to abandonment for transfer-ins (if abandonment occurs, its duration is counted under the last target skill group)
online_direct_response_len: Response duration (direct connection)—average Recency between the Membership’s message and the agent’s reply
online_transfer_response_len: Response duration (transfer-in)—average Recency between the Membership’s message and the agent’s reply
online_direct_response_times: Response Count (direct connection)—number of intervals between the Membership’s message and the agent’s reply
online_transfer_response_times: Response Count (transfer-in)—number of intervals between the Membership’s message and the agent’s reply
online_satis_cnt: Satisfied Count—based on touch evaluations
online_simple_cnt: Neutral Count—based on touch evaluations
online_unsatis_cnt: Dissatisfied Count—based on touch evaluations
t_login: Total logon duration
t_rest: Total break duration
Examples
Success response
JSON format
{
"Message": "successful",
"RequestId": "EE338D98-9BD3-4413-B165",
"Data": {
"TotalNum": 4,
"PageNum": 1,
"PageSize": 2000,
"Rows": "{\"online_40s_transfer_ready_cnt\":81,\"minute_id\":\"-1\",\"online_unsatis_cnt\":0,\"online_simple_cnt\":0,\"average_queue_time\":-1,\"service_pickup\":\"2086\",\"total_waiting_time\":\"981\",\"online_service_time_len\":58208,\"online_direct_give_up_len\":0,\"break_ratio\":\"2%\"}"
},
"Code": "200",
"Success": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | SystemError | A system error occurred. Please contact the administrator. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.