Edit a Queue
Edit basic settings of a queue, such as queue name, ring strategy, etc.
Request URL
{base_url}/{api_path}/queue/update?token={token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
number | Yes | String | Queue number. |
queuename | No | String | Queue name. |
password | No | String | The password to join dynamic agents. |
ringstrategy | No | String | Ring strategy. Valid values:
|
failoveraction | No | String | Failover destination. Valid values:
|
failoverdest | No | String | The specific failover destination. |
agents | No | String | Static agents. |
agenttimeout | No | String | Agent timeout in seconds. |
wrapuptime | No | Integer | The wrap-up time that an agent can have before the queue rings them with a new call. |
ringinuse | No | String | Ring the members whose device are known to be “in use”. Valid values:
|
retry | No | Integer | How many seconds to wait before trying to ring the next available
phone. Valid values:
|
maxwaittime | No | Integer | The maximum queue wait time. |
joinempty | No | String | Allow callers to join a queue where no agents are available. Note: If you set this
parameter, avoid configuring the disallow_to_join_when_empty parameter, as the two
parameters serve the same purpose.Valid values:
|
disallow_to_join_when_empty | No | String | Disallow callers to join a queue where no agents are available. Note: If you set this parameter, avoid configuring the
joinempty parameter, as the two parameters serve
the same purpose.Valid values:
|
empty_defined_for_disallow_to_join_when_empty | No | String | Define the scenario(s) in which the queue is considered to have no agents
available, and callers are NOT allowed to join. Valid values:
Note: If you don't configure this parameter, it will be
filled with the default value "1,2" . |
leavewhenempty | No | String | On-hold callers will be forced out of a queue if no agents are
available. Valid values:
|
empty_defined_for_leave_empty | No | String | Define the scenario(s) in which the queue will be considered to have no
agents available, and on-hold callers will be forced out of the queue. Valid values:
Note: If you don't configure this parameter, it will be
filled with the default value
"1,2" . |
announcepos | No | String | Announce the position of caller in a queue. Valid values:
|
announcefreq | No | String | Frequency of announcing queue position and estimated on-hold time. Valid values:
|
announceholdtime | No | Integer | Announce the on-hold time to the caller periodically. Valid values:
|
userannounce | No | String | Prompt of periodic announcements. |
userannouncefreq | No | Integer | Frequency of playing the prompt of periodic announcements. Valid
values:
|
breakoutkey | No | String | The breakout key. Valid values:
|
breakoutaction | No | String | The breakout action. Valid values:
|
breakoutdest | No | String | The specific breakout destination. |
satisfactionsurvey | No | String | The prompt name for customer satisfaction survey.
If the parameter is not specified, the prompt will not be played.
Default value: none. |
idannouncement | No | String | The file name of the prompt that announces the agent
ID. If the parameter is not specified, the prompt will not be played.
Default value: none. |
Response parameters
Parameter | Type | Description |
---|---|---|
status | String | Request result.
|
Examples
Request example
Set the ring strategy to "Ring All" for queue 6700.POST /api/v2.0.0/queue/update?token=1e3b3ebb6a974cb42ed31de5413df52d Content-Type:application/json; charset=utf-8 Host: 192.168.5.150 { "number": "6700", "ringstrategy": "Ring All" }
HTTP/1.1 200 OK Server: Boa/0.94.14rc21 Accept-Ranges: bytes Connection: close Content-Type: application/json Access-control-allow-origin: * Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE { "status": "Success" }