GetOnlineSeatInformation
Obtain online agent information data under real-time monitoring. Support 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 specify agent or department information, refer to the guidance in the Request Parameters section.
Queries per second (QPS) limits
Per-user invocation frequency: 100 times per second.
API-wide invocation frequency: 100 times 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 |
AICCS instance ID. |
ccc_xp_pre-cn-*** |
| StartDate |
integer |
No |
Start date UNIX timestamp. Unit: milliseconds. |
1615083365000 |
| EndDate |
integer |
No |
End date 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 |
| AgentIds |
array |
No |
List of agent IDs. |
|
|
integer |
No |
Agent ID. You can invoke the GetAgent API and view the AgentId in the response parameters to obtain the agent ID. |
111 |
|
| DepIds |
array |
No |
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 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Request ID. |
EE338D98-9BD3-4413-B165 |
| Message |
string |
Status code description. |
successful |
| 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","max_service_num":"3","servicer_id":"36****","tenant_name":"非单元测试化BU","record_gmt_modified":"2021-04-01 23:20:03","pk_id":"3690012021****","record_gmt_create":"2021-04-01 23:19:55","department_id":"10****"} |
| Code |
string |
Status code. A return value of 200 indicates that the request succeeded. |
200 |
| Success |
string |
Indicates whether the API call succeeded. Valid values:
|
true |
Parameter Guide for the returned Rows parameter:
department_id: Department ID
tenant_id: Tenant ID
tenant_name: Tenant name
current_service_num: Current service capacity
max_service_num: Maximum service capacity
max_speci_ability_num: Whale 吞 Plus 1—current maximum usable capacity
current_speci_ability_num: Whale 吞 Plus 1—currently used capacity
speci_ability_status: Whale 吞 Plus 1—current status; n0: assignment paused, n1: assignable
servicer_status_name: Hotline agent name
fst_login_time: Earliest logon time of the day
lst_login_time: Latest logon time of the day
servicer_rest_cnt: Number of short breaks
Examples
Success response
JSON format
{
"RequestId": "EE338D98-9BD3-4413-B165",
"Message": "successful",
"Data": {
"TotalNum": 4,
"PageNum": 1,
"PageSize": 2000,
"Rows": "{\"tenant_id\":\"905\",\"max_service_num\":\"3\",\"servicer_id\":\"36****\",\"tenant_name\":\"非单元测试化BU\",\"record_gmt_modified\":\"2021-04-01 23:20:03\",\"pk_id\":\"3690012021****\",\"record_gmt_create\":\"2021-04-01 23:19:55\",\"department_id\":\"10****\"}"
},
"Code": "200",
"Success": "true"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.