Query Queue Settings

Query detailed information of one or more queues， like queue number, queue name, static agents, dynamic agents, etc.

Endpoint

POST /api/v1.1.0/queue/query?token={token}&type={type}

Request Parameters

Name	Importance	Type	Description
queueid	Optional	String	The Queue number. Query a Queue: Set queueid to the Queue number. Example: “queueid”:”6700″ Query multiple Queues: Set queueid to the Queue number. Separate multiple Queues with ,. Example: “queueid”: “6700,6701,6702” Query all Queues: Do not send queueid parameter.

Response Parameters

Name	Type	Description
queues	Object	Object.
queuenumber	Int	The queue number.
queuename	String	The queue name.
password	String	The password to join dynamic agent.
ringstrategy	String	The ring strategy. Ring All Least Recent Fewest Calls Random Rrmemory Linear
agents	String	Static agents.
dynamicagents	String	Dynamic agents.
agenttimeout	String	The agent timeout.
agentannounce	String	The agent announcement.
wrapuptime	Int	The wrap-up time.
retry	Int	The number of seconds to wait before trying all the phones again.
musiconhold	String	The on-hold music.
maxwaittime	Int	The caller max wait time.
joinempty	String	Allow callers to join a queue that has no agents. on: enable off: disable
leavewhenempty	String	Callers already on hold will be forced out of a queue when no agents are available. on: enable off: disable
announcepos	String	Announce position of caller in the queue. on: enable off: disable
announcefreq	String	How often to announce queue position and estimated hold time.
announceholdtime	Int	Announce the hold time to the caller periodically.

Examples

Request Example

Query Queue 9999, 9998.

POST /api/v0.0.1/queue/query?token=813b621cfe8eecf445a2ce1f4a079ffe&type=json HTTP/1.1

Content-Type:application/json; charset=utf-8

Host: 172.16.6.150

{

“queueid”: “9999,9998”

}

POST /api/v0.0.1/queue/query?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>9999,9998</queueid>

</xml>

Query all Queues.

POST /api/v0.0.1/queue/query?token=813b621cfe8eecf445a2ce1f4a079ffe HTTP/1.1

Content-Type:application/json; charset=utf-8

Host: 172.16.6.150

Response Example

HTTP/1.1 200 OK

Access-control-allow-origin: *

Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{

“status”: “Success”,

“queues”: [

{

“queuenumber”: “9998”,

“queuename”: “queue_xiaoshao”,

“password”: “666666”,

“agents”: “101”,

“announcefreq”: “300”,

“announceholdtime”: “off”,

“announcepos”: “off”,

“joinempty”: “on”,

“leavewhenempty”: “off”,

“retry”: “10”,

“ringstrategy”: “Ring All”,

“agenttimeout”: “20”,

“wrapuptime”: “10”,

“dynamicagents”: “6000”,

“agentannounce”: “”,

“musiconhold”: “Inherit”,

“maxwaittime”: “600”

},

{

“queuenumber”: “9999”,

“queuename”: “queue_test”,

“password”: “123456”,

“agents”: “101,103,104”,

“announcefreq”: “0”,

“announceholdtime”: “off”,

“announcepos”: “off”,

“joinempty”: “on”,

“leavewhenempty”: “off”,

“retry”: “5”,

“ringstrategy”: “Ring All”,

“agenttimeout”: “15”,

“wrapuptime”: “60”,

“dynamicagents”: “”,

“agentannounce”: “”,

“musiconhold”: “Inherit”,

“maxwaittime”: “5”

}

]

}

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>

<queues>

<item id=”0″>

<queuenumber>9998</queuenumber>

<queuename>queue_xiaoshao</queuename>

<password>666666</password>

<agents>101</agents>

<announcefreq>300</announcefreq>

<announceholdtime>off</announceholdtime>

<announcepos>off</announcepos>

<joinempty>on</joinempty>

<leavewhenempty>off</leavewhenempty>

<retry>10</retry>

<ringstrategy>Ring All</ringstrategy>

<agenttimeout>20</agenttimeout>

<wrapuptime>10</wrapuptime>

<dynamicagents>6000</dynamicagents>

<agentannounce></agentannounce>

<musiconhold>Inherit</musiconhold>

<maxwaittime>600</maxwaittime>

</item>

<item id=”1″>

<queuenumber>9999</queuenumber>

<queuename>queue_test</queuename>

<password>123456</password>

<agents>101,103,104</agents>

<announcefreq>0</announcefreq>

<announceholdtime>off</announceholdtime>

<announcepos>off</announcepos>

<joinempty>on</joinempty>

<leavewhenempty>off</leavewhenempty>

<retry>5</retry>

<ringstrategy>Ring All</ringstrategy>

<agenttimeout>15</agenttimeout>

<wrapuptime>60</wrapuptime>

<dynamicagents></dynamicagents>

<agentannounce></agentannounce>

<musiconhold>Inherit</musiconhold>

<maxwaittime>5</maxwaittime>

</item>

</queues>

</xml>