Get Details for a Call Queue
Retrieve Call Queue details.
Call queues temporarily hold calls in the cloud when all agents, which can be users or agents, assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent when not on an active call. Each call queue is assigned a Lead Number, which is a telephone number outside callers can dial to reach users assigned to the call queue. Call queues are also assigned anvinternal extension, which can be dialed internally to reach users assigned to the call queue.
Retrieving call queue details requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve settings for a call queue in this location.
Retrieve settings for the call queue with this identifier.
Query Parameters
Retrieve call queue settings from this organization.
Response Properties
A unique identifier for the call queue.
Unique name for the call queue.
Whether or not the call queue is enabled.
Language for call queue.
Language code.
First name to be shown when calls are forwarded out of this call queue. Defaults to ".".
Last name to be shown when calls are forwarded out of this call queue. Defaults to the phone number if set, otherwise defaults to call group name.
Time zone for the call queue.
Primary phone number of the call queue.
Extension of the call queue.
The alternate numbers feature allows you to assign multiple phone numbers or extensions to a call queue. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the call queue.
Distinctive Ringing selected for the alternate numbers in the call queue overrides the normal ringing patterns set for Alternate Number.
Specifies up to 10 numbers which can each have an overriden distinctive ring setting.
Alternate phone number for the hunt group.
Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the hunt group.
Normal incoming ring pattern.
Incoming ring pattern of two long rings.
Incoming ring pattern of two short rings, followed by a short ring.
Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.
Language for call queue.
Language code for call queue.
Time zone for the call queue.
Policy controlling how calls are routed to agents.
Call routing policy to use to dispatch calls to agents.
(Max 1,000 agents) This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent.
(Max 1,000 agents) Send the call through the queue of agents in order, starting from the top each time.
(Max 50 agents) Sends calls to all agents at once
(Max 1,000 agents) Sends calls to the agent that has been idle the longest. If they don't answer, proceed to the next agent who has been idle the second longest, and so on until the call is answered.
(Max 100 agents) Sends call to idle agents based on percentages you assign to each agent (up to 100%).
Settings for when the call into the call queue is not answered.
If enabled, bounce calls after the set number of rings.
Number of rings after which to bounce call, if call bounce is enabled.
Bounce if agent becomes unavailable.
Alert agent if call on hold more than alertAgentMaxSeconds.
Number of second after which to alert agent if alertAgentEnabled.
Bounce if call on hold more than callBounceMaxSeconds.
Number of second after which to bounce if callBounceEnabled.
Whether or not the call queue has the distinctive ring option enabled.
Whether or not the distinctive ring is enabled.
Ring pattern for when this callqueue is called. Only available when distinctiveRing is enabled for the call queue.
Normal incoming ring pattern.
Incoming ring pattern of two long rings.
Incoming ring pattern of two short rings, followed by a short ring.
Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.
People, including workspaces, that are eligible to receive calls.
ID of person or workspace.
First name of person or workspace.
First name of person or workspace.
Phone number of person or workspace.
Extension of person or workspace.
Weight of person or workspace. Only applied when call policy is WEIGHTED.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Retrieve call queue settings from this organization.
{
"id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"name": "CallQueue-1",
"enabled": true,
"language": "English",
"languageCode": "en-US",
"firstName": "Hakim",
"lastName": "Smith",
"timeZone": "Central/Chicago",
"alternateNumberSettings": {
"distinctiveRingEnabled": true,
"alternateNumbers": [
{"phoneNumber": "9725554726","ringPattern": "NORMAL"},
{"phoneNumber": "9725554729","ringPattern": "NORMAL"}, ]
},
"callPolicies": {
"policy": "REGULAR",
"callBounce": {
"callBounceEnabled": true,
"callBounceMaxRings": 8,
"agentUnavailableEnabled": false,
"alertAgentEnabled": false,
"alertAgentMaxSeconds": 30,
"callBounceOnHoldEnabled": false,
"callBounceOnHoldMaxSeconds": 60},
"distinctiveRing": {"enabled": false,"ringPattern": "NORMAL"}},
"queueSettings": {
"queueSize": 10,
"callOfferToneEnabled": false,
"resetCallStatisticsEnabled": false,
"overflow": {
"action": "PERFORM_BUSY_TREATMENT",
"sendToVoicemail": false,
"overflowAfterWaitEnabled": false,
"overflowAfterWaitTime": 30,
"playOverflowGreetingEnabled": false,
"greeting": "DEFAULT",
"isTransferNumberSet": false},
"waitMessage": {
"enabled": false,
"waitMode": "TIME",
"handlingTime": 100,
"queuePosition": 100,
"highVolumeMessageEnabled": true,
"defaultHandlingTime": 5},
"welcomeMessage": {
"enabled": true,
"alwaysEnabled": false,
"greeting": "DEFAULT"},
"comfortMessage": {
"enabled": true,
"timeBetweenMessages": 10,
"greeting": "DEFAULT"},
"mohMessage": {
"normalSource": {
"enabled": false,
"greeting": "DEFAULT"},
"alternateSource": {"enabled": false,"greeting": "DEFAULT"}}},
"agents": []}