Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Real-Time Data Query/ Real-Time Interfaces for VDNs/ Querying Information About Calls of a Specified Access Code
Updated on 2023-12-19 GMT+08:00
View PDF
Share

Querying Information About Calls of a Specified Access Code

Description

This interface is invoked to query information about calls of a specified access code. (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 interface: /ccbms/ws/monitor/querycallstatbyinno

Request URL

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

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

Yes

ID of a call center.

The value ranges from 1 to 65535.

2

vdn

Integer

Yes

ID of a VDN.

The value ranges from 1 to 5000.

3

innoIds

Array

Yes

Array of access code IDs on the WAS. The maximum length of the array is 500.

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

innoId

Integer

Access code ID.

2.2

allCallCount

Long

Total number of online customers using the access code.

2.3

ivrCallCount

Long

Total number of online customers using the access code in the IVR.

2.4

agentCallCount

Long

Total number of online customers who are handled by agents and use the access code.

2.5

queueCallCount

Long

Total number of online customers who are in a queue and use the access code.

2.6

longestWaitTime

Long

Maximum call waiting duration among the calls using the access code, in seconds.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "ccId":1, 
    "vdn":170,
    "innoIds":[1,2]
}
  • Response parameters 
    {
    "resultCode":"0100000",
    "resultDesc":[
        {
            "innoId": 1,
            "allCallCount": 1,
            "ivrCallCount": 0,
            "agentCallCount": 1,
            "queueCallCount": 0,
            "longestWaitTime": 0
        },
        {
            "innoId": 2,
            "allCallCount": 1,
            "ivrCallCount": 1,
            "agentCallCount": 0,
            "queueCallCount": 0,
            "longestWaitTime": 0
        }
    ]
}