Querying the Real-Time Statistics of a Specified Task
Description
This interface is invoked to query the real-time statistics of a specified task and return the real-time statistics indicators.
Note: The iSales service module must be deployed for this interface.
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/fromisales/realstatistic
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 |
Call center ID. The value ranges from 1 to 65535.
|
vdn |
Integer |
Yes |
ID of a VDN. The value ranges from 1 to 5000. |
taskId |
Integer |
Yes |
Task ID. The value contains a maximum of 30 characters. |
Response Message
Parameter |
Type |
Description |
---|---|---|
resultCode |
string |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference. |
resultDesc |
Array |
Object array in the returned result after a successful query. Table 4 describes the parameters in the response message body of this interface. |
Parameter |
Type |
Description |
---|---|---|
totalCount |
Integer |
Number of daily outbound calls. |
succCount |
Integer |
Number of successful calls (number of connected calls). |
failCount |
Integer |
Number of failed calls. |
succRate |
String |
Success rate (call connection rate). |
compCount |
Integer |
Number of completed calls. |
waitCount |
Integer |
Number of waiting calls. |
execCount |
Integer |
Number of calls that are being processed. |
compRate |
String |
Completion rate. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId": "89", "vdn":92, "taskId":"1122104910" }
- Response parameters
{ "resultCode": "0100000", "resultDesc": { "compCount": "4", "failCount": "2", "compRate": "50%", "execCount": "0", "succCount": "2", "succRate": "50%", "totalCount": "4", "waitCount": "0" }
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