Querying Information about All VDNs in a Specified Call Center

Scenario

This interface is invoked to query information about all VDNs in a specified call center.

Note: This interface supports only the independent deployment environment and can be invoked only by the global AK and SK.

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/configures/vdns

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** Parameter in the request body
No.	Parameter	Value Type	Mandatory	Description
1	ccId	Integer	Yes	ID of a call center. The value ranges from 1 to 65535.

Response Description

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

**Table 4** Parameters of resultDesc/resultDatas
No.	Parameter	Value Type	Description
2.1	vdn	Integer	ID of a VDN.
2.2	vdnName	String	VDN name.

Message Example

Request header

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

Request parameters

{
    "queryParam":
    {
        "ccId":1 
     }
}

Response parameters

{
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "vdn": 1,
            "vdnName": "social cc"
        },
        {
            "vdn": 2,
            "vdnName": "Credit card"
        },
        {
            "vdn": 3,
            "vdnName": "95558_2"
        },
        {
            "vdn": 4,
            "vdnName": "VDN4"
        },
        {
            "vdn": 5,
            "vdnName": "Test VDN"
        }
    ],
    "resultDesc": [
        {
            "vdn": 1,
            "vdnName": "social cc"
        },
        {
            "vdn": 2,
            "vdnName": "Credit card"
        },
        {
            "vdn": 3,
            "vdnName": "95558_2"
        },
        {
            "vdn": 4,
            "vdnName": "VDN4"
        },
        {
            "vdn": 5,
            "vdnName": "Test VDN"
        }
    ]
}

Parent topic: Configuration Data Query

Previous topic: Configuration Data Query

Next topic: Querying Information About All Agents by VDN ID