Obtaining Historical Monitoring Indicators by VDN
Scenario
This interface is invoked to obtain historical monitoring indicators by VDN.
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/vdn
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. |
No. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|---|
1 |
ccId |
Integer |
No |
ID of a call center.
|
2 |
vdnIds |
Array |
Yes |
Array of VDN IDs. The maximum length of the array is 100. The VDN ID is of the integer type. |
3 |
indexIds |
Array |
Yes |
Array of indicators. The indicator is of the string type. For details, see Table 1. |
4 |
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, statistics on the current day in the time zone where the VDN is located are collected. |
5 |
anonyCall |
Integer |
No |
Anonymous call identifier. This parameter is available only for inbound calls. The value 1 indicates anonymous calls, and the value 0 indicates non-anonymous calls. If this parameter is not passed, all anonymous calls and non-anonymous calls are queried. |
6 |
calleeNo |
String |
No |
Called number. |
7 |
mediaType |
Integer |
No |
Call media type. For details, see Table 1. |
8 |
subMediaType |
Integer |
No |
Submedia type. For details, see Table 3. |
9 |
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
No. |
Parameter |
Type |
Description |
---|---|---|---|
1 |
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. |
2 |
resultCode |
String |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference. |
3 |
resultDatas |
List <JSON object> |
Object array in the returned result after a successful query. For details about the parameters of the object in this array, see Table 5.
NOTE:
This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions. |
4 |
resultDesc |
List <JSON object> |
Object array in the returned result after a successful query. For details about the parameters of the object in this array, see Table 5. |
No. |
Parameter |
Type |
Description |
---|---|---|---|
2.1 |
id |
String |
ID of a VDN. |
2.2 |
idxs |
List <JSON object> |
Group of indicators. For details about the parameters of the object in this array, see Table 6. |
No. |
Parameter |
Type |
Description |
---|---|---|---|
2.1.1 |
id |
String |
Indicator ID. |
2.1.2 |
val |
Object |
Indicator result collected by minute. The UTC time zone is used. The value is in the format of "Time":"Indicator result", indicating the indicator result collected in a time range starting from Time. The time range is determined by the timeGrain parameter in the request. For example, "2020-11-11 09:15:00.0": "1" indicates that the indicator result is 1 from 09:15 to 09:30. In this example, the value of timeGrain in the request is 15. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId":1, "vdnIds":[29,30], "indexIds":["IDX_COUNT_TOTAL_CALL","IDX_COUNT_CONNECTED_CALL"], "timeGrain":"15MIN", "anonyCall":1, "calleeNo":"640001", "mediaType":53, "subMediaType":3 }
- Response parameters
{ "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "29" }, { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "30" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "29" }, { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "30" } ] }
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