Get the List of Phone Numbers Available for External Caller ID
Get the list of phone numbers available for external caller ID usage by a Webex Calling entity (such as a person, virtual line, or workspace) within the specified location.
Numbers from the specified location are returned and cross location numbers are returned as well where the number's location has the same country, PSTN provider, and zone (only applicable for India locations) as the specified location.
When personId is specified, and the person belongs to a cisco PSTN location, has a mobile number assigned as primary DN, and does not have a billing plan, only the assigned mobile number is returned as the available number for caller ID.
The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.
Retrieving this list requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve available external caller ID numbers for this location.
Query Parameters
List numbers for this organization.
Limit the number of phone numbers returned to this maximum count. The default is 2000.
Start at the zero-based offset in the list of matching phone numbers. The default is 0.
Filter phone numbers based on the provided list in the phoneNumber array.
Return the list of phone numbers that are owned by the given ownerName. Maximum length is 255.
Retrieve available external caller ID numbers for this person. If personId is not provided it may result in the unsuccessful assignment of the returned number. This parameter has no effect when workspace or virtual line ID is used.
Response Properties
Array of phone numbers.
A unique identifier for the PSTN phone number.
Defines whether the number is active or not.
The number is active.
The number is inactive.
Flag to indicate if the number is used as the location's main number.
Flag to indicate if the number is toll free.
If true, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free.
The details of this number's location.
Unique identifier of the location.
Name of the location.
ID of the owner to which the number is assigned.
Type of the PSTN phone number's owner.
PSTN phone number's owner is a workspace.
PSTN phone number's owner is a person.
PSTN phone number's owner is a Virtual Profile.
PSTN phone number's owner is an auto-attendant.
PSTN phone number's owner is a call queue.
PSTN phone number's owner is a group paging.
PSTN phone number's owner is a hunt group.
PSTN phone number's owner is a voice portal.
PSTN phone number's owner is a Single Number Reach.
PSTN phone number's owner is a Contact Center link.
PSTN phone number's owner is a Contact Center adapter.
PSTN phone number's owner is a route list.
PSTN phone number's owner is a voice mail group.
PSTN phone number's owner is a collaborate bridge.
First name of the PSTN phone number's owner and will only be returned when the owner type is PEOPLE or PLACE or VIRTUAL_PROFILE.
Last name of the PSTN phone number's owner and will only be returned when the owner type is PEOPLE or PLACE or VIRTUAL_PROFILE.
Display name of the PSTN phone number's owner. This field will be present except when the owner type is PEOPLE 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
- List numbers for this organization.
- Limit the number of phone numbers returned to this maximum count. The default is 2000.
- Start at the zero-based offset in the list of matching phone numbers. The default is 0.
- Filter phone numbers based on the provided list in the `phoneNumber` array.
- Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
- Retrieve available external caller ID numbers for this person. If `personId` is not provided it may result in the unsuccessful assignment of the returned number. This parameter has no effect when workspace or virtual line ID is used.
{
"phoneNumbers": [
{
"phoneNumber": "+12036390542",
"state": "ACTIVE",
"isMainNumber": false,
"tollFreeNumber": false,
"isServiceNumber": true,
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg",
"name": "Bangalore"
},
"owner": {
"id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWkhabFpuQjVhblY2WjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "HUNT_GROUP",
"displayName": "testingdemo"
}
},
{
"phoneNumber": "+447975777966",
"state": "ACTIVE",
"isMainNumber": false,
"tollFreeNumber": false,
"isServiceNumber": false,
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg",
"name": "Bangalore"
},
"owner": {
"id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWW04MWMyNTVjWFZ6Y1VBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "HUNT_GROUP",
"displayName": "CallertestingVeeresh9999te"
}
},
{
"phoneNumber": "+447975777969",
"state": "INACTIVE",
"isMainNumber": true,
"tollFreeNumber": false,
"isServiceNumber": false,
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg",
"name": "Bangalore"
},
"owner": {
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82MGQxZGJlMC02MmNjLTQxZTEtOWE2MC1mZWQ1YmJkODUxZGQ",
"type": "VIRTUAL_LINE",
"firstName": "testingssss",
"lastName": "dsdsd"
}
}
]
}