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

Querying Skill Groups in a Specified VDN

Description

This interface is invoked to query the information about the skill groups in a specified VDN.

Note: This interface supports only the independent deployment environment and CTI 3.8.

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/skillgroups/{ccId}/{vdnId}

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.

No request body exists.

Response Message

Table 2 Parameters in the message body

No.

Parameter

Value 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 3.
Table 3 Parameters of resultDesc

No.

Parameter

Value Type

Description

2.1

id

Integer

Skill group ID.

2.2

skills

Array

Skill object array. The array contains skill objects. Table 4 describes the definition of a single skill object.

2.3

groupName

String

Skill group name.

The value contains a maximum of 64 bytes without any special characters.
Table 4 Parameters of skills

No.

Parameter

Value Type

Description

2.2.1

skillId

Integer

Skill queue ID.

The value is an integer. Enter an actual skill queue ID.

2.2.2

skillPower

Integer

Skill power corresponding to the skill queue.

The value is an integer ranging from 1 to 100.

2.2.3

agentPower

Integer

Agent power corresponding to the skill queue.

The value is an integer ranging from 1 to 300.

Message Example

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

    None

  • Response parameters
{
  "resultCode": "0100000",
  "resultDesc": [
    {
      "id": 2,
      "skills": [
        {
          "skillId": 2,
          "skillPower": 1,
          "agentPower": 1
        }
      ],
      "groupName": "skillgroup2"
    }
  ]
}
Parent topic: Configuration Data Query