Querying Information About IVR Flow Access Codes in a Specified VDN

Scenario

This interface is invoked to query information about IVR flow access codes in a specified VDN.

Interface Method

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

Internal Encapsulation Interface

BMS interface: /ccbms/ws/monitor/queryivrInfo

Request URL

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

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

**Table 2** Parameters in the request message body
No.	Parameter	Value 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.

Response Description

**Table 3** 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 4. NOTE: This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.
3	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 4.

**Table 4** Parameters of resultDesc/resultDatas
No.	Parameter	Value Type	Description
2.1	id	Integer	IVR flow ID.
2.2	serviceNo	Integer	Business type ID.
2.3	realFlag	Integer	Virtual or real queue. The options are 1 (real queue) and 2 (virtual queue).
2.4	accessNo	String	Access code.
2.5	description	String	Access code function description.

Message Example

Request header

Content-Type: application/json;charset=UTF-8
Authorization: ******************

Request parameters
```
{
    "ccId":1, 
    "vdn":170
}
```

Response parameters

{
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "id": 1,
            "serviceNo": 1,
            "realFlag": 1,
            "accessNo": "85000",
            "description": "Exception handling flow"
        },
        {
            "id": 2,
            "serviceNo": 1,
            "realFlag": 1,
            "accessNo": "85001",
            "description": "Main flow"
        }
    ],
    "resultDesc": [
        {
            "id": 1,
            "serviceNo": 1,
            "realFlag": 1,
            "accessNo": "85000",
            "description": "Exception handling flow"
        },
        {
            "id": 2,
            "serviceNo": 1,
            "realFlag": 1,
            "accessNo": "85001",
            "description": "Main flow"
        }
    ]
}

Parent topic: Real-Time Interfaces for VDNs

Previous topic: Querying IVR Status Details in a Specified VDN

Next topic: Querying Information about Each Skill Queue in a Specified VDN