Read the List of Call Queue Agents with Customer Experience Essentials
List all Call Queues Agents for the organization.
Agents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to 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 or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Note: The decoded value of the agent's id, and the type returned in the response, are always returned as PEOPLE, even when the agent is a workspace or virtual line. This will be addressed in a future release.
Query Parameters
List call queues agents in this organization.
Return only the call queue agents in this location.
Only return call queue agents with the matching queue ID.
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 list of call queue agents that match the given name.
Returns only the list of call queue agents that match the given phone number or extension.
Returns only the list of call queue agents that match the given joinEnabled value.
Returns only the list of call queues with Customer Experience Essentials license when true, otherwise returns the list of Customer Experience Basic call queues.
Sort results alphabetically by call queue agent's name, in ascending or descending order.
Response Properties
Array of call queue agents.
Unique call queue agent identifier.
First name for the call queue agent.
Last name for the call queue agent.
Primary phone number of the call queue agent.
Primary phone extension of the call queue agent.
Routing prefix of the call queue agent.
Routing prefix + extension of a agent.
Denotes the queue count for call queue agent.
Denotes the location count for call queue agent.
Denotes the join count for call queue agent.
Denotes unjoin count for call queue agent.
The location information.
The location name where the call queue agent resides.
ID of location for call queue agent.
The type of the call queue agent.
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 call queues agents in this organization.
- Return only the call queue agents in this location.
- Only return call queue agents with the matching queue ID.
- 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 list of call queue agents that match the given name.
- Returns only the list of call queue agents that match the given phone number or extension.
- Returns only the list of call queue agents that match the given `joinEnabled` value.
- Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.
- Sort results alphabetically by call queue agent's name, in ascending or descending order.
{
"agents": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81NzJjNWMwZS1jMDY4LTQ0NmItOWM0Ny04MjYwYTIzZTY0NmI",
"firstName": "Lobby",
"lastName": ".",
"phoneNumber": "+19458880334",
"routingPrefix": "8002",
"queueCount": 1,
"locationCount": 1,
"joinCount": 1,
"unjoinCount": 0,
"location": {
"name": "Location1",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA"
},
"type": "PEOPLE"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWYxNTg1YS03MWM2LTQyZGEtYmRkNC1iMzYzYzlhYzQwZGI",
"firstName": "Quiet Room",
"lastName": ".",
"phoneNumber": "+19458880338",
"routingPrefix": "8003",
"queueCount": 1,
"locationCount": 1,
"joinCount": 1,
"unjoinCount": 0,
"location": {
"name": "Location1",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA"
},
"type": "PEOPLE"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zYjY4Yjg2YS1hMTZiLTRmNzItOTlmZi01ZDlhZjgyZWNmNTE",
"firstName": "test_301_person_phone_extnsion",
"lastName": "last_name",
"phoneNumber": "+14084279811",
"extension": "4498",
"routingPrefix": "8004",
"esn": "4498",
"queueCount": 1,
"locationCount": 1,
"joinCount": 1,
"unjoinCount": 0,
"location": {
"name": "Location2",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDMzNy04MGViLWRjY2NiM2VlMDU1MA"
},
"type": "PEOPLE"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YjBmMWY2OS0wNWE3LTRkZDUtYTg2OS03Mzg5NjdjNTI2YWI",
"firstName": "test_essentials",
"lastName": "ES",
"extension": "23234",
"routingPrefix": "8005",
"esn": "23234",
"queueCount": 1,
"locationCount": 1,
"joinCount": 1,
"unjoinCount": 0,
"location": {
"name": "Location1",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA"
},
"type": "PEOPLE"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS84OTEyYTUwNi02ZDU2LTRiMjUtOTNiMC1lZGM5ZDFiYmQwNTU",
"firstName": "vl_t401cbn",
"lastName": "ecbn_01cbn",
"phoneNumber": "+14084269811",
"routingPrefix": "8007",
"queueCount": 2,
"locationCount": 2,
"joinCount": 2,
"unjoinCount": 0,
"location": {
"name": "Location1",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA"
},
"type": "PEOPLE"
}
]
}