List Available Agents with Customer Experience Essentials
Get list of available agents for an organization.
Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.
This operation requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
List of available agents in a supervisor's list 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.
Returns only the agents that match the given name.
Returns only the agents that match the phone number, extension, or ESN.
Sort results alphabetically by supervisor name, in ascending or descending order.
Returns only the list of available agents with Customer Experience Essentials license, when true. When ommited or set to false, will return the list of available agents with Customer Experience Basic license.
Response Properties
Array of agents assigned to a specific supervisor.
A unique identifier for the agent.
First name of the agent.
Last name of the agent.
(string, optional) - Display name of the agent.
Primary phone number of the agent.
Primary phone extension of the agent.
Routing prefix of location.
Routing prefix + extension of a person.
Type of the person, workspace or virtual line.
Associated type is a person.
Associated type is a workspace.
Associated type is a 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
- List of available agents in a supervisor's list 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.
- Returns only the agents that match the given name.
- Returns only the agents that match the phone number, extension, or ESN.
- Sort results alphabetically by supervisor name, in ascending or descending order.
- Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.
{
"agents": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jZGUzZWU0YS02ZDI5LTQ3OGItOGU5MC00MmE3YWFlNWIzNTE",
"lastName": "CP-WS",
"firstName": "CP-WS-1",
"displayName": "CP-WS-1 .",
"extension": "1248",
"esn": "1248",
"type": "PLACE"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hZWRlNmE0OS00NmNkLTQ4NWQtODQyZC1kY2ZmNTg4ZmQyMTU",
"lastName": "CP-WS",
"firstName": "CP-WS-6",
"displayName": "CP-WS-6 .",
"extension": "7539",
"esn": "7539",
"routingPrefix": "34543",
"phoneNumber": "+19729989982",
"type": "PEOPLE"
}
]
}