Help Center/ Customer 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 Each Skill Queue in a Specified VDN
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Querying Information about Each Skill Queue in a Specified VDN

Description

This interface is invoked to query information about each skill queue in a specified VDN.

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

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

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 Message

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

id

Integer

Skill queue ID.

2.2

mediaType

Integer

Media type. For details, see Table 1.

2.3

name

String

Skill queue description.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "queryParam":{
       "ccId":1, 
       "vdn":1
    }
}
  • Response parameters 
    {
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "id": 1,
            "mediaType": 1,
            "name": "Text chat 1"
        },
        {
            "id": 10,
            "mediaType": 1,
            "name": "Text chat 2"
        }
    ],
    "resultDesc": [
        {
            "id": 1,
            "mediaType": 1,
            "name": "Text chat 1"
        },
        {
            "id": 10,
            "mediaType": 1,
            "name": "Text chat 2"
        }
    ]
}