Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Configuration Data Query/ Obtaining All Called Routes in a VDN
Updated on 2023-12-19 GMT+08:00
View PDF

Obtaining All Called Routes in a VDN

Scenario

This interface is invoked to obtain all called routes in a VDN.

Interface Method

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

Request URL

https://ip:port/rest/cmsapp/v1/openapi/configures/calledconfigs/{ccId}/{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. {ccId} indicates the call center ID and ranges from 1 to 65535; and {vdn} indicates the VDN ID and ranges from 1 to 5000.

Request Description

Table 1 Parameters in the request header

No.

Parameter

Value Type

Mandatory

Description

1

Content-Type

String

Yes

The value is fixed at 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.

Response Description

Table 2 Parameters in the response message body

No.

Parameter

Value Type

Description

1

result

String

Query result. The options are as follows:

  • 0: success
  • Other values: failure

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

NOTE:

This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.

2

resultCode

String

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

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

3

resultDatas

Array

Object array in the returned result after a successful query.

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

NOTE:

This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.

4

resultDesc

Array

Object array in the returned result after a successful query.

For details about the parameters of the object in this array, see Table 3.
Table 3 Parameters of resultDesc/resultDatas

No.

Parameter

Value Type

Description

2.1

ccId

Integer

ID of a call center.

2.2

vdnId

Integer

VDN ID.

2.3

accessCode

String

Access code.

2.4

subCode

String

Subsequent access code.

The value contains a maximum of 100 characters.

The value can contain 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, asterisks (*), and number signs (#).

2.5

deviceType

String

Device type. For details, see Table 1.

The returned value is a 4-byte integer.

2.6

deviceName

String

Device name. When the value of deviceType is 1 (skill queue), the device name is the skill queue name. When the value of deviceType is 3 (IVR flow), the device name is the flow description.

2.7

deviceNo

String

Device ID.

2.8

dnid

String

Configuration ID.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters

    None

  • Response parameters
    {
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "ccId": 1,
            "vdnId": 1,
            "accessCode": "6045",
            "subCode": "1110",
            "deviceType": "1",
            "deviceName": "test",
            "deviceNo": "22",
            "dnid": "22"
        }
    ],
    "resultDesc": [
        {
            "ccId": 1,
            "vdnId": 1,
            "accessCode": "6045",
            "subCode": "1110",
            "deviceType": "1",
            "deviceName": "test",
            "deviceNo": "22",
            "dnid": "22"
        }
    ]
}
Parent topic: Configuration Data Query