Retrieve Agent's List of Available Caller IDs
Get the list of call queues and hunt groups available for caller ID use by this virtual line as an agent.
This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.
URI Parameters
Unique identifier for the Virtual Line.
Query Parameters
ID of the organization in which the Virtual Line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Response Properties
A list of call queues and hunt groups that the agent belongs to and are available to be selected as the Caller ID for outgoing calls. Call queues and hunt groups which have disabled using the phone number as Caller ID are not returned.
Call queue or hunt group's unique identifier.
Member is of type CALL_QUEUE or HUNT_GROUP.
A call queue has been selected for the agent's caller ID.
A hunt group has been selected for the agent's caller ID.
Call queue or hunt group's name.
When not null, it is call queue or hunt group's phone number.
When not null, it is call queue or hunt group's extension number.
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
- ID of the organization in which the Virtual Line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
{
"availableCallerIds": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYmRlNDE4NDAtNmVmYS00YTkzLTk5YmEtNDc5Y2QxYTFjZmI5",
"type": "CALL_QUEUE",
"name": "TestCallQueue",
"extension": "6001"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy",
"type": "HUNT_GROUP",
"name": "TestHuntGroup",
"phoneNumber": "+441234200090",
"extension": "6002"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZTY1NjgzOTMtZTQ5MC00OGQ2LTg3OTgtY2IyZmY3YzkwNzg0",
"type": "CALL_QUEUE",
"name": "TestCallQueueSecond",
"phoneNumber": "+441234200091",
"extension": "6003"
}
]
}