GetDepartmentalLatitudeAgentStatus
Obtain department-level status metrics under hotline monitoring. Supports queries by instance, time range, and department group.
Operation description
Before invoking this API, ensure that you have activated the service and created an instance.
If you need to specify department information, refer to the guidance in the Request Parameters section.
Queries per second (QPS) limits
Per-user invocation frequency: 100 times/second.
API-wide invocation frequency: 100 times/second.
If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
AICCS instance ID. |
ccc_xp_pre-cn-*** |
| StartDate |
integer |
No |
Start date UNIX timestamp. Unit: milliseconds. |
1615083365000 |
| EndDate |
integer |
No |
End UNIX timestamp. Unit: milliseconds. |
1617761765000 |
| PageSize |
integer |
No |
Page size. The value must be greater than 0. Default value: 20. |
20 |
| CurrentPage |
integer |
No |
Current page number. The value must be greater than 0. Default value: 1. |
1 |
| DepIds |
array |
No |
List of department IDs. |
|
|
integer |
No |
Department ID. You can invoke the GetAllDepartment API and view the DepartmentId in the response parameters to obtain the department ID. |
100 |
|
| ExistDepartmentGrouping |
boolean |
No |
Indicates whether to query by department grouping. Valid values:
|
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
result |
||
| Message |
string |
Status code description. |
message |
| RequestId |
string |
Request ID. |
EE338D98-9BD3-4413-B165 |
| Data |
object |
Data list. |
|
| TotalNum |
integer |
Total number of pages. |
4 |
| PageNum |
integer |
Current page number. |
1 |
| PageSize |
integer |
Page size. |
2000 |
| Rows |
string |
The information is a JSON string of type List |
{"tenant_id":905,"n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"department_id":-1,"department_name":-1,"n_resttype98_now":0,"n_online_now":0,"date_id":20210329,"n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0} |
| 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 description for the returned parameter Rows:
n_idle_now: Current number of idle agents
n_resttype_now: Current number of agents on short breaks
n_resttype1_now: Current number of agents on regular short breaks
n_resttype2_now: Current number of agents on meal breaks
n_resttype3_now: Current number of agents in meetings
n_resttype4_now: Current number of agents receiving coaching
n_resttype5_now: Current number of agents in training
n_resttype98_now: Current number of agents on forced breaks
n_resttype99_now: Current number of agents signed in but on break
n_ack_now: Current number of agents in post-processing
n_online_now: Current number of online agents
n_busy_now: Current number of agents on calls
tenant_id: Tenant ID
tenant_name: Tenant name
department_id: Department ID
department_name: Department name
date_id: Date
n_inqueue_now: Current number of members in queue
n_inservice_now: Current number of members in service
time_value: UNIX timestamp
fst_assign_time: Earliest assignment time in this queue, indicating when queued members were assigned
Examples
Success response
JSON format
{
"Message": "message",
"RequestId": "EE338D98-9BD3-4413-B165",
"Data": {
"TotalNum": 4,
"PageNum": 1,
"PageSize": 2000,
"Rows": "{\"tenant_id\":905,\"n_resttype_now\":0,\"tenant_name\":\"非单元测试化BU\",\"n_resttype1_now\":0,\"department_id\":-1,\"department_name\":-1,\"n_resttype98_now\":0,\"n_online_now\":0,\"date_id\":20210329,\"n_resttype3_now\":0,\"n_resttype5_now\":0,\"n_busy_now\":0,\"n_resttype2_now\":0,\"n_idle_now\":0,\"n_resttype4_now\":0,\"n_ack_now\":0,\"n_resttype99_now\":0}"
},
"Code": "200",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.