Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Interfaces for Querying System Indicators/ Querying Key Information About Control Blocks
Updated on 2023-12-19 GMT+08:00
View PDF

Querying Key Information About Control Blocks

The number of concurrent requests for invoking the interface cannot exceed 10. Otherwise, the interface invoking times out due to deteriorated performance.

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 the running states of specified control blocks.

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/dsppidkey

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

Parameter

Type

Mandatory

Description

MODTYP

String

Yes

It specifies the type of a module.

Currently, CCU and MSU are supported.

PID

String

Conditionally mandatory

CCU module ID.

This parameter is valid only when the module type is set to CCU. It specifies the module ID of a CCU.

PIDMSU

String

Conditionally mandatory

MSU module ID.

This parameter is valid only when the module type is set to MSU. It specifies the module ID of an MSU.

MN

String

Conditionally mandatory

CCU module number.

This parameter is valid only when the module type is set to CCU and the CCU module ID is specified. It specifies the module number of a CCU. You can run the LST APP command to query the module number of a CCU.

BICCTYPE

String

Conditionally mandatory

BICC type.

This parameter is valid only when the module type is set to CCU and the CCU module ID is set to BICC. It specifies the type of a BICC module.

MSUMN

String

Conditionally mandatory

MSU module number.

This parameter is valid only when the module type is set to MSU and the MSU module ID is specified. It specifies the module number of an MSU. You can run the LST APP command to query the module number of an MSU.

ccId

Integer

No

ID of a call center.

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

Response Message

Table 3 Parameters in the response 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

List

Object list in the returned result after a successful query.

For details about the parameters of the object, see the following table.

10.xx.xx.xx#0

String
  • 10.xx.xx.xx: UAP IP address.
  • #: fixed separator.
  • 0: UAP ID.
Table 4 Parameters of the resultDesc object (Set the module type to CCU, CCU module ID to CCB, and CCU module number to 57.)

Parameter

Type

Description

IDC switch index

String

Online indication.

Null CB number

String

Number of control blocks in the NULL state.

Booked CB number

String

Number of busy circuits.

Info receiving status number

String

Number of control blocks that are receiving information.

Wait overlap CB number

String

Number of control blocks in the WAITOVERLAP state.

Overlap transmit number

String

Number of control blocks in the Overlap transmit state.

Call proceeding number

String

Number of control blocks in the CALLPROCEEDIN state.

Alerting CB number

String

Number of control blocks in the ALERTING state.

Connection request CB number

String

Number of control blocks that are requesting connections.

Active CB number

String

Number of active control blocks.

Release guard CB number

String

Number of control blocks in the Release guard state.

Release waiting CB number

String

Number of control blocks that are waiting to be released.

Temply hold CB number

String

Number of control blocks in the Temply hold state.

Wait tone CB number

String

Number of control blocks that are in the waiting tone state.

Null after combine CB number

String

Number of control blocks in the NULLAFTERCOMBINE state.

Call park CB number

String

Number of control blocks in the Call park state.
Table 5 Parameters of the resultDesc object (Set the module type to CCU, CCU module ID to INTESS, and CCU module number to 56.)

Parameter

Type

Description

Last allocated INTESS number

String

ID of the INtess control block that was allocated last time.

Error stat flag

String

Error cause statistics switch.

Error stat interval

String

Error cause statistics period.

Message statistics flag

String

Message statistics switch.

Message statistics interval

String

Message statistics period.

Message statistics mask

String

Message statistics mask.

Idle CB number

String

Number of control blocks in the IDLE state.

Overlap CB number

String

Number of control blocks in the OVERLAP state.

Call delivered CB number

String

Number of control blocks in the CALLDELIVERED state.

Call present CB number

String

Number of control blocks in the CALLPRESENT state.

Call received

String

Number of control blocks in the CALLRECEIVED state.

Connection request CB number

String

Number of control blocks in the connection request state.

Active CB number

String

Number of control blocks in the ACTIVE state.

SPACTIVE CB number

String

Number of control blocks in the SPACTIVE state.

CB number in INTESS_spy state

String

Number of control blocks in the INTESS_SPY state.

Wait REL CB number

String

Number of control blocks in the WAITREL state.
Table 6 Parameters of the resultDesc object (Set the module type to MSU, PID to BSI, and MSUMN module number to 472.)

Parameter

Type

Description

Total number of connections

String

Total number of connections.

Total no of connection in IDLE state

String

Total number of idle connections.

Total no of connection in CREATE CONNECT state

String

Total number of connections that are being created.

Total no of connection in CONNECT state

String

Total number of connected connections.

Total no of connection in DELETE CONNECT state

String

Total number of deleted connections.

Total no of connection in MODIFY CONNECT state

String

Total number of modified connections.

Total no of connection having service type as IVR

String

Total number of IVR business connections.

Total no of connection having service type as CONF

String

Total number of conference site business connections.

Total no of connection having service type as CONF CHAN

String

Total number of business connections of conference site channels.

Total no of conf connection in IDLE state

String

Total number of idle conference site connections.

Total number of Conf connections

String

Total number of conference site connections.

Total no of conf connection in CREATE CONF state

String

Total number of conference site connections that are being created.

Total no of conf connection in CONF USING state

String

Total number of conference site connections in use.

Total no of conf connection in CONF DELETE state

String

Total number of deleted conference site connections.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters
    {
   "MODTYP":"CCU",
   "PID":"CCB",
   "MN":"56",
   "ccId":1
}
  • Response parameters
    {
    "resultCode": "0100000",
    "resultDesc": {
    "10.xx.xx.xx#0": {
        "Alerting CB number": "0",
        "Null after combine CB number": "0",
        "IDC switch index": "1",
        "Wait tone CB number": "0",
        "Release guard CB number": "0",
        "Release waiting CB number": "0",
        "Booked CB number": "0",
        "Temply hold CB number": "0",
        "Active CB number": "0",
        "Info receiving status number": "3",
        "Call park CB number": "0",
        "Null CB number": "9997",
        "Overlap transmit number": "0",
        "Call proceeding number": "0",
        "Wait overlap CB number": "0",
        "Connection request CB number": "0"
        }
    }
}