Querying Skill Queues (querySkills)

Scenario

Query skill queues.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/skill/querySkills. For example, the domain name is service.besclouds.com.

Request Description

**Table 1** Request header parameters
No.	Name	Type	Mandatory or Not	Description
1	X-APP-KEY	String	No	App key field, which is the user ID. Contact the operation personnel to obtain the app key.
2	Authorization	String	Yes	Authentication field. The format is Bearer {Value of AccessToken* returned by the tokenByAkSk interface}. (A space is required after Bearer*.)

**Table 2** Request body parameters
No.	Name	Type	Mandatory or Not	Description
1.1	name	String	No	Name of a skill queue. The value contains a maximum of 20 characters. The following special characters are not allowed: [ `~!#$%^&()+=\|{}':;',<>/?~#%……&+\|{}]\|\n\|\r\|\t
1.2	mediaTypeId	String	No	Media type. The options are as follows: 5: voice 53: multimedia 19: video 2: voice click-to-dial 18: video click-to-dial
1.3	limit	String	No	Number of records on each page. The value is a positive integer and the maximum value is 100.
1.4	offset	String	No	Parameter for determining the start page of the query. The value range of offset is as follows: Value of offset = Value of limit x (Page – 1). "Page" indicates the start page for query.
1.5	skillIds	Array	No	Parameter for querying skill queues. Multiple values can be transferred. The value is an array of the string type. An empty array can be transferred. A maximum of 100 values can be returned when all the skill queues are queried.

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Name	Type	Mandatory or Not	Description
1.1	returnCode	String	No	Operation result. The value 0 indicates success, and other values indicates failure.
1.2	description	String	No	Description.
1.3	total	Number	No	Total number of data records.
1.4	data	Array [Object]	No	Data information.
1.4.1	skillId	Number	No	Skill queue ID.
1.4.2	name	String	No	Name of a skill queue. The value contains a maximum of 20 characters. The following special characters are not allowed: [ `~!#$%^&()+=\|{}':;',<>/?~#%……&+\|{}]\|\n\|\r\|\t
1.4.3	description	String	No	Skill short name or description. The value can contain a maximum of 50 characters, including Chinese characters, letters, and digits.
1.4.4	mediaTypeId	Number	No	Media type. The options are as follows: 5: voice 53: multimedia 19: video 2: voice click-to-dial 18: video click-to-dial
1.4.5	maxWaitTime	Number	No	Maximum queuing duration, in seconds. The maximum value is 60000.
1.4.6	maxWaitNum	Number	No	Maximum number of users waiting in a queue. The maximum value is 10000.
1.4.7	maxAgentWrapupTime	Number	No	Duration of the wrap-up state, in seconds. The maximum value is 3600.
1.4.8	skillParam	Object	No	Skill queue parameter information. When the media type is 53, 2, or 18, only the noAgents, busy, and timeOut parameters need to be set. When the media type is 53, the value of deviceType must be 1.
1.4.8.1	noAgents	Object	No	Configuration when no agent is on-duty.
1.4.8.1.1	deviceType	String	No	Device type. The options are 3 (IVR) and 1 (skill queue).
1.4.8.1.2	transferType	String	No	Processing policy. The options are Release and Transfer.
1.4.8.1.3	value	Number	No	For a skill queue, the value is the skill queue ID (skillId). For an IVR flow, the value is the IVR flow ID.
1.4.8.2	busy	Object	No	Configuration when the queue is busy or overflows.
1.4.8.2.1	deviceType	String	No	Device type. The options are 3 (IVR) and 1 (skill queue).
1.4.8.2.2	transferType	String	No	Processing policy. The options are Release and Transfer.
1.4.8.2.3	value	Number	No	For a skill queue, the value is the skill queue ID (skillId). For an IVR flow, the value is the IVR flow ID.
1.4.8.3	answerFunction	String	No	Agent answering mode. 0: reporting the agent ID 2: reporting no voice
1.4.8.4	timeOut	Object	No	Queuing timeout configuration.
1.4.8.4.1	deviceType	String	No	Device type. The options are 3 (IVR) and 1 (skill queue).
1.4.8.4.2	transferType	String	No	Processing policy. The options are Release and Transfer.
1.4.8.4.3	value	Number	No	For a skill queue, the value is the skill queue ID (skillId). For an IVR flow, the value is the IVR flow ID.
1.4.8.5	waitVoice	Object	No	Queuing configuration.
1.4.8.5.1	parameterType	String	No	Parameter type. Voice: default waiting tone. If this value is used, leave other parameters at the same level empty. IVR: If this value is used, other parameters at the same level are mandatory.
1.4.8.5.2	value	String	No	For an IVR flow, the value is the same as that of accessCode.
1.4.8.5.3	id	String	No	For an IVR flow, the value is the IVR flow ID.

Status code: 401
Authentication fails.
Status code: 404
The requested resource does not exist.
Status code: 500
An exception occurs on the server.

Error Codes

None

Example

Request header:

Content-Type:application/json
X-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXX
Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX

Request parameters:

{
    "limit": "10",
    "offset": 0
}

Response parameters:

{
    "returnCode": "0",
    "total": 1,
    "data": [
        {
            "skillId": 1,
            "maxAgentWrapupTime": 5,
            "maxWaitTime": 60,
            "name": "defaultVideoSkill",
            "mediaTypeId": 19,
            "description": "2021ok",
            "maxWaitNum": 100,
            "skillParam": {
                "noAgents": {
                    "transferType": "Release"
                },
                "busy": {
                    "transferType": "Release"
                },
                "answerFunction": "0",
                "timeOut": {
                    "transferType": "Release"
                },
                "waitVoice": {
                    "parameterType": "Voice"
                }
            }
        }
    ],
    "description": "success"
}

Parent topic: Skill Queue Management

Previous topic: Modifying a Skill Queue (modifySkill)

Next topic: Obtaining the Total Number of Users in a Configured Skill Queue