Get Details for a Call Queue Agent with Customer Experience Essentials
Retrieve details of a particular Call queue agent based on the agent ID.
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 a call queue agent's details require a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Note: The agent's type returned in the response and in the decoded value of the agent's id, is always of type PEOPLE, even if the agent is a workspace or virtual line. This` will be corrected in a future release.
URI Parameters
Retrieve call queue agents with this identifier.
Query Parameters
Retrieve call queue agents from this organization.
Must be set to true to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to false.
Limit the number of objects returned to this maximum count.
Start at the zero-based offset in the list of matching objects.
Response Properties
A unique identifier for the call queue agent.
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 + extension of a agent.
The location information.
The location name where the call queue agent resides.
ID of location for call queue agent.
TIMEhe type of the call queue agent.
Unique identifier of the call queue.
Unique name for the call queue.
Primary phone number of the call queue.
The routing prefix for the call queue.
The location identifier of the call queue.
The location name where the call queue resides.
Whether or not the call queue is enabled.
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
- Retrieve call queue agents from this organization.
- Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.
- Limit the number of objects returned to this maximum count.
- Start at the zero-based offset in the list of matching objects.
{
"agent": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZmNiMjczZS0wYzdmLTQ1ZGUtYmNlOC0yMWE3YzFlYjVjYmY",
"firstName": "Arthur",
"lastName": "Murray",
"phoneNumber": "+19728881234",
"extension": "180",
"routingPrefix": "34543",
"esn": "34543180",
"location": {
"name": "RCDN",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw"
},
"type": "PEOPLE"
},
"queues": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZjM4NDIxZGYtN2MxOC00NGI1LThlNmQtNDFmZTEyMTFlZDFk",
"name": "YU7",
"phoneNumber": "+12144184002",
"routingPrefix": "34543",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw",
"locationName": "RCDN",
"joinEnabled": true
}
]
}