GetAgentBasisStatus
Obtain the agent-level status metrics under hotline monitoring. 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) limit
Per-user invocation frequency: 100 times per second.
API-wide invocation frequency: 100 times per 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 |
The Artificial Intelligence Cloud Call Service (AICCS) instance ID. |
ccc_xp_pre-cn-*** |
| StartDate |
integer |
No |
The UNIX timestamp of the start date. Unit: milliseconds. |
1615083365000 |
| EndDate |
integer |
No |
End Datetime 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 parameters to obtain the agent ID. |
["2256****","2257****"] |
|
| DepIds |
array |
No |
A list of department IDs. |
|
|
integer |
No |
The department ID. You can invoke the GetAllDepartment API and view the DepartmentId field in the response to obtain the department ID. |
["6083****","6084****"] |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Request ID. |
EE338D98-9BD3-4413-B165 |
| Message |
string |
Status code description. |
OK |
| Data |
object |
Data list. |
|
| TotalNum |
integer |
Total number of records. |
4 |
| PageNum |
integer |
Current page number. |
1 |
| PageSize |
integer |
Page size. |
2000 |
| Rows |
string |
The information is a JSON string of the List |
{"tenant_id":"905","servicer_id":"73****","tenant_name":"测试","recordgmtmodified":"2021-04-01 11:36:50","pk_id":"7320372021****","statusstarttime":"2021-04-01 11:36:50","recordgmtcreate":"2021-04-01 10:06:24","department_id":"94****","department_name":"测试技能组","lstlogintime":"2021-04-01 10:06:24","date_id":"20210401","triggerreason":"3","servicer_status":"D","assignstatus":"1","servicerreal_name":"xx","servicerstatusname":"签出","fstlogintime":"2021-04-01 10:06:24","servicer_name":"xx"} |
| Code |
string |
The status code. A return value of 200 indicates that the request succeeded. |
200 |
| Success |
string |
Indicates whether the API was invoked successfully. Valid values:
|
true |
Parameter Guide for the returned Rows parameter:
servicer_id: Agent ID
servicer_name: Agent name
servicer_real_name: Agent real name
department_id: Department ID
department_name: Department name
servicer_status: Hotline agent status
servicer_status_name: Hotline agent status name
status_start_time: Status start time
assign_status: Assignment status
rest_type: Break type
Examples
Success response
JSON format
{
"RequestId": "EE338D98-9BD3-4413-B165",
"Message": "OK",
"Data": {
"TotalNum": 4,
"PageNum": 1,
"PageSize": 2000,
"Rows": "{\"tenant_id\":\"905\",\"servicer_id\":\"73****\",\"tenant_name\":\"测试\",\"recordgmtmodified\":\"2021-04-01 11:36:50\",\"pk_id\":\"7320372021****\",\"statusstarttime\":\"2021-04-01 11:36:50\",\"recordgmtcreate\":\"2021-04-01 10:06:24\",\"department_id\":\"94****\",\"department_name\":\"测试技能组\",\"lstlogintime\":\"2021-04-01 10:06:24\",\"date_id\":\"20210401\",\"triggerreason\":\"3\",\"servicer_status\":\"D\",\"assignstatus\":\"1\",\"servicerreal_name\":\"xx\",\"servicerstatusname\":\"签出\",\"fstlogintime\":\"2021-04-01 10:06:24\",\"servicer_name\":\"xx\"}"
},
"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.