User Call Settings - Get Person Call Intercept Available Phone Numbers

Get Person Call Intercept Available Phone Numbers

List the service and standard PSTN numbers that are available to be assigned as a person's call intercept number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

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, read-only or location administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/people/{personId}/callIntercept/availableNumbers

URI Parameters

personId

stringrequired

Unique identifier for the person.

Query Parameters

orgId

string

List numbers for this organization.

max

number

Limit the number of phone numbers returned to this maximum count. The default is 2000.

start

number

Start at the zero-based offset in the list of matching phone numbers. The default is 0.

phoneNumber

array[string]

Filter phone numbers based on the comma-separated list provided in the phoneNumber array.

ownerName

string

Return the list of phone numbers that are owned by the given ownerName. Maximum length is 255.

extension

string

Returns the list of PSTN phone numbers with the given extension.

Response Properties

phoneNumbers

array[PersonCallInterceptAvailableNumberObject]

Array of phone numbers.

phoneNumber

string

A unique identifier for the PSTN phone number.

extension

string

Extension for a PSTN phone number.

state

STATE

Phone number's state.

ACTIVE

string

Phone number is in the active state.

INACTIVE

string

Phone number is in the inactive state.

isMainNumber

boolean

If true, the phone number is used as a location CLID.

tollFreeNumber

boolean

If true, the phone number is a toll-free number.

telephonyType

TelephonyType

The telephony type for the number.

PSTN_NUMBER

string

The object is a PSTN number.

isServiceNumber

boolean

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.

owner

object

string

Unique identifier of the owner to which PSTN Phone number is assigned.

type

NumberOwnerType

Type of the PSTN phone number's owner.

PLACE

string

PSTN phone number's owner is a workspace.

PEOPLE

string

PSTN phone number's owner is a person.

VIRTUAL_LINE

string

PSTN phone number's owner is a Virtual Profile.

AUTO_ATTENDANT

string

PSTN phone number's owner is an auto-attendant.

CALL_QUEUE

string

PSTN phone number's owner is a call queue.

GROUP_PAGING

string

PSTN phone number's owner is a group paging.

HUNT_GROUP

string

PSTN phone number's owner is a hunt group.

VOICE_MESSAGING

string

PSTN phone number's owner is a voice messaging.

OFFICE_ANYWHERE

string

PSTN phone number's owner is a Single Number Reach.

CONTACT_CENTER_LINK

string

PSTN phone number's owner is a Contact Center link.

CONTACT_CENTER_ADAPTER

string

PSTN phone number's owner is a Contact Center adapter.

ROUTE_LIST

string

PSTN phone number's owner is a route list.

VOICEMAIL_GROUP

string

PSTN phone number's owner is a voicemail group.

COLLABORATE_BRIDGE

string

PSTN phone number's owner is a collaborate bridge.

firstName

string

First name of the PSTN phone number's owner. This field will be present only when the owner type is PEOPLE or VIRTUAL_LINE.

lastName

string

Last name of the PSTN phone number's owner. This field will be present only when the owner type is PEOPLE or VIRTUAL_LINE.

displayName

string

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.

GET

/v1/telephony/config/people//callIntercept/availableNumbers{?orgId,max,start,phoneNumber,ownerName,extension}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
List numbers for this organization.
max
number
Limit the number of phone numbers returned to this maximum count. The default is 2000.
start
number
Start at the zero-based offset in the list of matching phone numbers. The default is 0.
phoneNumber
array[string]
Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
ownerName
string
Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
extension
string
Returns the list of PSTN phone numbers with the given `extension`.

https://webexapis.com/v1/telephony/config/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/callIntercept/availableNumbers?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&max=5&start=0&phoneNumber=+12056852221,+12056852222&ownerName=Test&extension=1234

200 / OK

{
    "phoneNumbers": [
        {
            "phoneNumber": "+12056350001",
            "state": "ACTIVE",
            "isMainNumber": false,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": false,
            "owner": {
                "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
                "type": "PEOPLE",
                "firstName": "Test",
                "lastName": "Person"
            }
        },
        {
            "phoneNumber": "+12056350002",
            "extension": "1235",
            "state": "ACTIVE",
            "isMainNumber": true,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": true,
            "owner": {
                "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA=",
                "type": "PLACE",
                "displayName": "TestWorkSpace"
            }                        
        },
        {
            "phoneNumber": "+12056350003",
            "extension": "1236",                        
            "state": "INACTIVE",
            "isMainNumber": false,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": true,
            "isServiceNumber": false,
            "owner": {
                "id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2RtbHRNWFV6WjJkaWRFQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09",
                "type": "AUTO_ATTENDANT",
                "displayName": "Test Autoattendant"
            }
        }
    ]
}