Interface for Querying UAP Performance Indicator Statistics
Prerequisites
This interface is invoked only for global AK/SK authentication.
Note: This interface supports only the independent deployment environment.
Description
This interface is invoked to query UAP performance indicator statistics.
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/uap/perfindex
In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, 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 to 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 |
ID of a call center.
|
uapIP |
String |
No |
IP address of the UAP. |
ofcNo |
Integer |
No |
Array of inbound call numbers. |
beginDate |
String |
Yes |
Query start time. The UTC time zone is used. The interval between the start time and end time cannot exceed 31 days (rounded up). |
endDate |
String |
Yes |
Query end time. The UTC time zone is used. |
limit |
Integer |
No |
This parameter is optional. The default value is 100. |
offset |
Integer |
No |
This parameter is optional. The default value is 0. |
Response Message
Parameter |
Type |
Description |
---|---|---|
resultCode |
string |
Query result. The options are as follows:
|
resultDesc |
List |
Object list in the returned result after a successful query. For details about the parameters of the object, see the following table. |
Parameter |
Type |
Description |
---|---|---|
beginTime |
String |
Statistics start time, which is a timestamp in milliseconds (start time of a 5-minute statistical period). |
ccId |
Integer |
ID of a call center. |
uapIp |
String |
IP address of the UAP. |
ofcNo |
Integer |
Array of inbound call numbers. |
systemInBound |
Integer |
Number of system inbound calls. |
systemInSucc |
Integer |
Number of system connected calls. |
systemCallRate |
Integer |
System call connection rate. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId":1, "uapIP":"1.1.1.1", "ofcNo":[0, 1], "beginDate":"2021-09-09 00:00:00", "endDate":"2021-09-11 23:00:00", "limit":"100", "offset":"0" }
- Response parameters
{ "resultCode": 0, "resultDesc": { "data": [ { "beginTime": "1631594100000", "ccId": 1, "uapIp": "1.1.1.1", "ofcNo": 1, "systemInBound": 1, "systemInSucc": 1, "systemCallRate": 1 } ], "count": 1 } }
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