Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Skill Queue Management/ Modifying a Skill Queue (modifySkill)
Updated on 2023-09-27 GMT+08:00
View PDF

Modifying a Skill Queue (modifySkill)

Scenario

Modify a skill queue.

Method

POST

URI

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

Request Description

Table 1 Request header parameters

No.

Parameter

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 information. The format is Bearer +AccessToken returned by the tokenByAKSK interface. (A space is required next to Bearer.)
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

description

String

No

Skill short name or description. The value can contain a maximum of 50 characters, including Chinese characters, letters, and digits.

1.2

maxWaitTime

Number

No

Maximum queuing duration, in seconds. The maximum value is 60000.

1.3

maxWaitNum

Number

No

Maximum number of users waiting in a queue. The maximum value is 10000.

1.4

maxAgentWrapupTime

Number

No

Duration of the wrap-up state, in seconds. The maximum value is 3600.

1.5

skillParam

Object

No

Skill queue parameter information. When the media type is 53, 2, or 18, only noAgents, busy, and timeOut are available. When the media type is 53, deviceType must be set to 1. When the media type is 5 or 19, the noAgents, busy, timeOut, answerFunction, and waitVoice parameters are mandatory.

1.5.1

noAgents

Object

Yes

Absence of on-duty agents.

1.5.1.1

deviceType

String

No

Device type.

3: IVR

1: skill queue

1.5.1.2

transferType

String

Yes

Handling policy.

Release: If the parameter is set to this value, other parameters at the same level are left blank.

Transfer: If the parameter is set to this value, other parameters at the same level are mandatory.

1.5.1.3

value

Number

No

For a skill queue, the value of this parameter is the skill queue ID. For an IVR flow, the value of this parameter is the IVR flow ID.

1.5.2

busy

Object

Yes

A queue is busy or overflows.

1.5.2.1

deviceType

String

No

Device type.

3: IVR

1: skill queue

1.5.2.2

transferType

String

Yes

Handling policy.

Release: If the parameter is set to this value, other parameters at the same level are left blank.

Transfer: If the parameter is set to this value, other parameters at the same level are mandatory.

1.5.2.3

value

Number

No

For a skill queue, the value of this parameter is the skill queue ID. For an IVR flow, the value of this parameter is the IVR flow ID.

1.5.3

answerFunction

String

No

Agent answer mode. The options are 0 (report the agent ID) and 2 (reporting no voice).

1.5.4

timeOut

Object

Yes

Queuing timeout configuration.

1.5.4.1

deviceType

String

No

Device type.

3: IVR

1: skill queue

1.5.4.2

transferType

String

Yes

Handling policy.

Release: If the parameter is set to this value, other parameters at the same level are left blank.

Transfer: If the parameter is set to this value, other parameters at the same level are mandatory.

1.5.4.3

value

Number

No

For a skill queue, the value of this parameter is the skill queue ID. For an IVR flow, the value of this parameter is the IVR flow ID.

1.5.5

waitVoice

Object

No

Queuing and waiting configuration.

1.5.5.1

parameterType

String

Yes

Voice: If the parameter is set to this value, other parameters at the same level are left blank.

IVR: If the parameter is set to this value, other parameters at the same level are mandatory.

1.5.5.2

id

String

No

For an IVR flow, the value of this parameter is the IVR flow ID.

1.6

skillId

Integer

Yes

Skill queue ID.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1.1

    returnCode

    String

    No

    Operation result. The options are as follows: 0: success; other values: failure.

    1.2

    description

    String

    No

    Description.
  • 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:

{"skillId":3,"description":"2021ok","maxWaitTime":60}

Response parameters:

{
    "returnCode": "0",
    "description": "Update Skill successfully"
}

Parent topic: Skill Queue Management