List Incoming Numbers

get

https://www.freeclimb.com/apiserver/Accounts/{accountId}/IncomingPhoneNumbers

Path Params

accountId

string

required

ID of the account that owns this phone number.

Query Params

phoneNumber

string

Only show incoming phone number resources that match this PCRE-compatible regular expression.

alias

string

Only show incoming phone numbers with aliases that exactly match this value.

applicationId

string

Use this option to return numbers associated with a specific application ID.

hasApplication

boolean

Optionally filter numbers by whether or not they are associated with an application. Set this option to true to return results for numbers that have an associated application ID. Set this option to false to return results for numbers that are not associated with an application ID.

hasCampaign

boolean

country

string

The two character ISO country code associated with a phone number.

region

string

The two letter state abbreviation associated with a phone number. Available for US phone numbers only.

capabilities

object

Indicates whether the phone number is enabled for different features. Capabilities list: voice, sms, tollFree, tenDLC, shortcode. Each capability accepts a boolean value of true or false.

campaignId

string

The 10DLC campaign ID associated with the phone number, if applicable. Phone numbers with no associated campaign ID will be null.

offnet

boolean

The offnet registration nature of the phone number.

tfn.campainId

string

The TFN campaign ID associated with the phone number, if applicable. TollFree Phone numbers with no associated campaign ID will not have a tfn value.

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200