Obtaining Historical Monitoring Indicators by Agent
Scenario
This interface is invoked to query historical monitoring indicators by agent.
Interface Method
The request method must be set to POST. This interface supports only the POST method.
Request URL
https://ip:port/rest/cmsapp/v1/openapi/hisindex/agent
In the URL, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.
Request Description
No. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|---|
1 |
Content-Type |
String |
Yes |
The value is fixed at application/json; charset=UTF-8. |
2 |
Authorization |
String |
Yes |
For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
ccId |
Integer |
No |
Call center ID. The value ranges from 1 to 65535.
|
vdn |
Integer |
Yes |
VDN ID. The value ranges from 1 to 5000. |
agentIds |
List <Integer> |
Yes |
Array of agent IDs. The array can contain a maximum of 100 characters. The agent ID is of the integer type, and the value ranges from 0 to 99999. |
timeGrain |
String |
No |
This parameter can be used to collect statistics on historical monitoring indicators by minute. The options are 15MIN, 30MIN, and 60MIN. If this parameter is not passed or left empty, statistics on the current day in the time zone where the VDN is located are collected. Some historical monitoring indicators of the agent operation type cannot be queried by minute. For details, see Table 1. |
indexIds |
List <String> |
Yes |
Array of indicators. The indicator is of the string type. The maximum length of the array depends on the number of historical agent monitoring indicators. For details, see Table 1. |
mediaType |
Integer |
No |
Call media type. For details, see Table 1. |
subMediaType |
Integer |
No |
Submedia type. For details, see Table 1. |
enableOffset |
String |
No |
The options are Y and N. If Y is transferred, the data of the previous day is queried. If N is transferred, the data of the current day is queried. If no value is transferred, the default value N is used. |
Response Message
Parameter |
Type |
Description |
---|---|---|
result |
String |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference.
NOTE:
This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions. |
resultCode |
String |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference. |
resultDatas |
Array |
Object array in the returned result after a successful query. For details about the parameters of the object in this array, see Table 4.
NOTE:
This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions. |
resultDesc |
Array |
Object array in the returned result after a successful query. For details about the parameters of the object in this array, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Agent ID. |
idxs |
Array |
Group of indicators. For details about the parameters of the object in this array, see Table 5. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId":1, "vdn":22, "agentIds":[295], "timeGrain":"15MIN", "indexIds":["IDX_COUNT_AGENT_COLLATION","IDX_COUNT_AGENT_SET_BUSY","IDX_DURATION_AGENT_CALL_IN"], "mediaType":53, "subMediaType":3 }
- Response parameters
{ "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "11" }, { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "11" }, { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "12" } ] }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot