Query Queue Settings

Request URL

{base_url}/{api_path}/queue/query?token={token}

Request parameters

Response parameters

QueueInfo

Parameter	Type	Description
number	String	Queue number.
password	String	The password to join dynamic agents.
queuename	String	Queue name.
ringstrategy	String	Ring strategy. Ring All Least Recent Fewest Calls Random Rrmemory Linear
failoveraction	String	Failover destination. Hang up Extension Voicemail IVR Ring Group Queue Conference Fax to Email Dial by name
failoverdest	String	The specific failover destination.
agents	String	Static agents.
dynamicagents	String	Dynamic agents.
agenttimeout	String	Agent timeout.
agentannounce	String	Agent announcement.
wrapuptime	Integer	The wrap-up time that an agent can have before the queue rings them with a new call.
ringinuse	String	Ring the members whose device are known to be “in use”. on: enable off: disable
retry	Integer	How many seconds to wait before trying to ring the next available phone.
musiconhold	String	The on-hold music.
maxwaittime	Integer	The maximum queue wait time.
joinempty	String	Allow callers to join a queue where no agents are available. on: enable off: disable
disallow_to_join_when_empty	String	Disallow callers to join a queue where no agents are available. on: disallow callers to join a queue where no agents are available. off: allow callers to join a queue where no agents are available.
empty_defined_for_disallow_to_join_when_empty	String	The scenario(s) in which the queue is considered to have no agents available, and callers are NOT allowed to join. Note: When all agents are logged out, the queue is defined as Empty by default. 1: Unavailable (Off Line) 2: Paused 3: Busy
leavewhenempty	String	On-hold callers will be forced out of a queue if no agents are available. on: enable off: disable
empty_defined_for_leave_empty	String	The scenario(s) in which the queue is considered to have no agents available, and on-hold callers will be forced out of the queue. Note: When all agents are logged out, the queue is defined as Empty by default. 1: Unavailable (Off Line) 2: Paused 3: Busy
joinannounce	String	Announcement that will be played to callers before they join the queue.
announcepos	String	Announce the position of caller in a queue. on: enable off: disable
announcefreq	String	Frequency of announcing queue position and estimated on-hold time.
announceholdtime	String	Announce the on-hold time to the caller periodically. on: enable off: disable
userannounce	String	Prompt of periodic announcements.
userannouncefreq	Integer	Frequency of playing the prompt of periodic announcements.
breakoutkey	String	The breakout key.
breakoutaction	String	The breakout action. Hang up Extension Voicemail IVR Ring Group Queue Conference Fax to Email Dial by Name
breakoutdest	String	The specific breakout destination.
satisfactionsurvey	String	The prompt name for customer satisfaction survey. If the parameter is not specified, the prompt will not be played. Default value: none.
idannouncement	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.

Examples

Request example

Query detailed settings of queue 6700.

POST /api/v2.0.0/queue/query?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6700"
}

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", 
    "queues": [
        {
            "number": "6700", 
            "password": "", 
            "queuename": "Support", 
            "ringstrategy": "Ring All", 
            "failoveraction": "Extension", 
            "failoverdest": "1000", 
            "agents": "1000,1001,", 
            "agenttimeout": "30", 
            "agentannounce": "[None]", 
            "wrapuptime": "30", 
            "ringinuse": "off", 
            "retry": "30", 
            "musiconhold": "[None]", 
            "maxwaittime": "1800", 
            "joinempty": "on", 
            "disallow_to_join_when_empty": "off", 
            "empty_defined_for_disallow_to_join_when_empty": "1,2,3",     
            "leavewhenempty": "off", 
            "empty_defined_for_leave_empty": "1,2", 
            "joinannounce": "[None]", 
            "announcepos": "on", 
            "announcefreq": "30", 
            "announceholdtime": "on", 
            "userannounce": "[None]", 
            "userannouncefreq": "60", 
            "breakoutkey": "None", 
            "satisfactionsurvey": "None", 
            "idannouncement": "None"
        }
    ]
}