Updated on 2023-12-19 GMT+08:00

Obtaining Real-Time Monitoring Indicators by VDN

Description

This interface is invoked to obtain real-time monitoring indicators by VDN. (CTI 3.6 does not support this interface.)

Interface Method

The request method must be set to POST. This interface supports only the POST method.

Internal Encapsulation Interfaces

BMS interfaces:

  • /ccbms/ws/monitor/rindexSkill
  • /ccbms/ws/monitor/queryivrInfo
  • /ccbms/ws/monitor/queryivrdevicestatus
  • /ccbms/ws/monitor/teamagentstatusinfobyvdns

Request URL

https://ip:port/rest/cmsapp/v1/openapi/rindex/vdn

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 request message body

No.

Parameter

Type

Mandatory

Description

1

ccId

Integer

No

ID of a call center.

  • 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.

2

vdnIds

Array

Yes

Array of VDN IDs. The maximum length of the array is 100. The VDN ID is of the integer type.

The value of vdn ranges from 1 to 5000.

3

indexIds

Array

Yes

Array of VDN real-time monitoring indicators. The indicator is of the string type.

For details, see Table 2.

Response Message

Table 3 Parameters in the response message body

No.

Parameter

Type

Description

1

resultCode

string

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

For details about the failure causes, see Error Code Reference.

2

resultDesc

Array

Object array in the returned result after a successful query.

For details about the parameters of this object in the array, see Table 4.

Table 4 Parameters of resultDesc

No.

Parameter

Type

Description

2.1

id

string

ID of a VDN.

2.2

idxs

List< JSONObject>

Group of indicators.

For details about the parameters of this object, see Table 5.

Table 5 Parameters of idx

No.

Parameter

Type

Description

2.2.1

id

string

Indicator ID.

2.2.2

val

object

Indicator result.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • Request parameters
     {
               "ccId":1,
               "vdnIds":[170,185],
               "indexIds":["IDX_COUNT_REAL_VDN_CONNECT","IDX_COUNT_REAL_VDN_CALL"]
      }
  • Response parameters
    {
        "resultCode":"0100000",
        "resultDesc":[
            {
                "idxs":[
                    {
                        "val":0,
                        "id":"IDX_COUNT_REAL_VDN_CONNECT"
                    },
                    {
                        "val":0,
                        "id":"IDX_COUNT_REAL_VDN_CALL"
                    }
                ],
                "id":"170"
            },
            {
                "idxs":[
                    {
                        "val":0,
                        "id":"IDX_COUNT_REAL_VDN_CONNECT"
                    },
                    {
                        "val":0,
                        "id":"IDX_COUNT_REAL_VDN_CALL"
                    }
                ],
                "id":"185"
            }
        ]
    }