Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Querying Outbound Call Task Lists/ Querying the Real-Time Statistics of a Specified Task
Updated on 2023-12-19 GMT+08:00
View PDF
Share

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

Table 1 Parameters in the request header

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.
Table 2 Parameters in the message body

Parameter

Type

Mandatory

Description

ccId

Integer

No

Call center ID. The value ranges from 1 to 65535.

  • In the integration environment, the default value is the value of Call Center ID on the Configuration Center > System Management > CMS System Configuration page after a system administrator signs in to the AICC. If this parameter is empty, the data whose sys_key is default_cc_id and sys_type is cms_system_config in the t_cms_sysparam database table is used.
  • In the independent deployment environment, the default value is the value of Default Call Center ID on the Configuration Center > System Management > Parameter Settings page after a system administrator signs in to the AICC.

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

Table 3 Parameters in the message body

Parameter

Type

Description

resultCode

string

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

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.
Table 4 Parameters in the response message body

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"
  }