Get Call Queue Available Agents
List all available users, workspaces, or virtual lines that can be assigned as call queue agents.
Available agents are users (excluding users with Webex Calling Standard license), workspaces, or virtual lines that can be assigned to a call queue. Calls from the call queue are routed to assigned agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.
Retrieving this list requires a full, read-only or location administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
The location ID of the call queue. Temporary mandatory query parameter, used for performance reasons only and not a filter.
List available agents for this organization.
Limit the number of objects returned to this maximum count.
Start at the zero-based offset in the list of matching objects.
Search based on name (user first and last name combination).
Search based on number or extension.
Order the available agents according to the designated fields. Up to three comma-separated sort order fields may be specified. Available sort fields are: userId, fname, firstname, lname, lastname, dn, and extension. Sort order can be added together with each field using a hyphen, -. Available sort orders are: asc, and desc.
Response Properties
Array of available agents.
ID of a person, workspace or virtual line.
Last name of a person, workspace or virtual line.
First name of a person, workspace or virtual line.
Display name of a person, workspace or virtual line.
Type of the person, workspace or virtual line.
Object is a user.
Object is a place.
Object is a virtual line.
Email of a person, workspace or virtual line.
Person has the CX Essentials license.
List of phone numbers of a person, workspace or virtual line.
Phone number of a person, workspace or virtual line.
Extension of a person, workspace or virtual line.
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
- The location ID of the call queue. Temporary mandatory query parameter, used for performance reasons only and not a filter.
- List available agents for this organization.
- Limit the number of objects returned to this maximum count.
- Start at the zero-based offset in the list of matching objects.
- Search based on name (user first and last name combination).
- Search based on number or extension.
- Order the available agents according to the designated fields. Up to three comma-separated sort order fields may be specified. Available sort fields are: `userId`, `fname`, `firstname`, `lname`, `lastname`, `dn`, and `extension`. Sort order can be added together with each field using a hyphen, `-`. Available sort orders are: `asc`, and `desc`.
{
"agents": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE1NmE",
"lastName": "Brown",
"firstName": "John",
"displayName": "John Brown",
"type": "PEOPLE",
"email": "john.brown@example.com",
"hasCxEssentials": false,
"phoneNumbers": [
{
"external": "+19075552859",
"extension": "8080"
}
]
}
]
}