Edit a Queue
Configure the settings of a queue, such as queue name, ring strategy, etc.
Endpoint
POST /api/v0.0.1/queue/update?token={token}&type={type}
Request Parameters
| Name | Importance | Type | Description |
| queueid | Required | Int | The requested queue number. |
| queuename | Optional | String | The queue name. |
| password | Optional | String | The password to join dynamic agent. |
| ringstrategy | Optional | String | The ring strategy.
|
| agents | Optional | String | Static agents. |
| dynamicagents | Optional | String | Dynamic agents. |
| agenttimeout | Optional | String | The agent timeout.
Options: 10, 20, 30, 40, 50 |
| wrapuptime | Optional | Int | The wrap-up time.
Options: 10, 20, 30, 40, 50 |
| retry | Optional | Int | The number of seconds to wait before trying all the phones again.
Options: 10, 20, 30, 40, 50 |
| maxwaittime | Optional | Int | The caller max wait time.
Options: 300, 600, 900, 1200, 1800 |
| joinempty | Optional | String | Allow callers to join a queue that has no agents.
|
| leavewhenempty | Optional | String | Callers already on hold will be forced out of a queue when no agents are available.
|
| announcepos | Optional | String | Announce position of caller in the queue.
|
| announcefreq | Optional | String | How often to announce queue position and estimated hold time.
Options: 0, 15, 30, 45, 60, 120, 180, 240, 300, 600, 1200 |
| announceholdtime | Optional | Int | Announce the hold time to the caller periodically.
|
Examples
Request Example
POST /api/v0.0.1/queue/update?token=813b621cfe8eecf445a2ce1f4a079ffe&type=json HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
{
“queueid”:”9998″,
“queuename”:”queue_xiaoshao”,
“password”:”666666″,
“ringstrategy”:”Ring All”,
“agents”:”101″,
“dynamicagents”:”6000″,
“agenttimeout”:”20″,
“wrapuptime”:”10″,
“retry”:”10″,
“maxwaittime”:”600″,
“joinempty”:”on”,
“leavewhenempty”:”off”,
“announcepos”:”off”,
“announcefreq”:”300″,
“announceholdtime”:”off”
}
POST /api/v0.0.1/queue/update?token=813b621cfe8eecf445a2ce1f4a079ffe&type=xml HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
<?xml version=”1.0″ encoding=”UTF-8″ ?>
<xml>
<queueid>9998</queueid>
<queuename>queue_xiaoshao</queuename>
<password>666666</password>
<ringstrategy>Ring All</ringstrategy>
<agents>101</agents>
<dynamicagents>6000</dynamicagents>
<agenttimeout>20</agenttimeout>
<wrapuptime>10</wrapuptime>
<retry>10</retry>
<maxwaittime>600</maxwaittime>
<joinempty>on</joinempty>
<leavewhenempty>off</leavewhenempty>
<announcepos>off</announcepos>
<announcefreq>300</announcefreq>
<announceholdtime>off</announceholdtime>
</xml>
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
“status”: “Success”
}
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
<?xml version=”1.0″ encoding=”utf-8″?>
<xml>
<status>Success</status>
</xml>