Read the List of Call Queues with Customer Experience Essentials
List all Call Queues for the organization.
Call queues temporarily hold calls in the cloud, when all 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 that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension, which can be dialed internally to reach the users assigned to the call queue.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
Returns the list of call queues in this organization.
Returns the list of call queues in this location.
Limit the number of objects returned to this maximum count.
Start at the zero-based offset in the list of matching objects.
Returns only the call queues matching the given name.
Returns only the call queues matching the given primary phone number or extension.
Returns only call queues matching the given department ID.
Returns only call queues matching the given department name.
Returns only the list of call queues with Customer Experience Essentials license when true, otherwise returns the list of Customer Experience Basic call queues.
Response Properties
Array of call queues.
A unique identifier for the call queue.
Unique name for the call queue.
Denotes if the call queue has Customer Experience Essentials license.
Name of location for call queue.
ID of location for call queue.
Primary phone number of the call queue.
Primary phone extension of the call queue.
Whether or not the call queue is enabled.
The department information.
Unique identifier of the department.
Name of the department.
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. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 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
- Returns the list of call queues in this organization.
- Returns the list of call queues in this location.
- Limit the number of objects returned to this maximum count.
- Start at the zero-based offset in the list of matching objects.
- Returns only the call queues matching the given name.
- Returns only the call queues matching the given primary phone number or extension.
- Returns only call queues matching the given department ID.
- Returns only call queues matching the given department name.
- Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.
{
"queues": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTg0Y2Y0Y2QtZWVhNy00YzhjLTgzZWUtNjdkODhmYzZlYWE1",
"name": "5714328359",
"hasCxEssentials": "true",
"locationName": "WXCSIVDKCPAPIC4S1",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"enabled": true,
"extension": "8000",
"department": {
"id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ",
"name": "HR"
}
},
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc0",
"name": "bram",
"hasCxEssentials": "true",
"locationName": "Brampton",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQwMjgw",
"phoneNumber": "+15558675309",
"enabled": true
}
]
}