Find toll-free numbers.

Search for toll-free AvailablePhoneNumbers.

Permissions

The API token must include the following scopes: Numbers.

Path Parameters
`AccountSid` uuid — REQUIRED The Project ID that uniquely identifies the Account to retrieve.
`IsoCountry` string — REQUIRED The ISO country code of the number.

Query Parameters
`AreaCode` string Find numbers in the provided area code. Only available for numbers in US and Canada.
`Beta` boolean New numbers on SignalWire are marked as `beta`. Possible values are `true` or `false`.
`Contains` string Find numbers based off of a pattern. Valid characters are `[0-9a-zA-Z]`. It is recommended to search for a pattern of at least three numbers for best results.
`ExcludeAllAddressRequired` boolean Whether or not to exclude numbers that require an address anywhere in the world. Possible values are `true` or `false`, default is `false`.
`ExcludeForeignAddressRequired` boolean Whether or not to exclude numbers that require a foreign address. Possible values are `true` or `false`, default is `false`.
`ExcludeLocalAddressRequired` boolean Whether or not to exclude numbers that require a local address. Possible values are `true` or `false`, default is `false`.
`FaxEnabled` boolean Whether or not a number can receive faxes. Possible values are `true` or `false`.
`InRegion` string Limits search to same region as number.
`MmsEnabled` boolean Whether or not a number can receive MMS messages. Possible values are `true` or `false`.
`SmsEnabled` boolean Whether or not a number can receive SMS messages. Possible values are `true` or `false`.
`VoiceEnabled` boolean Whether or not a number can receive calls. Possible values are `true` or `false`.

Responses

200

Schema — OPTIONAL

uri string — OPTIONAL

The URI for the API call.

available_phone_numbers object[] — OPTIONAL

beta boolean — OPTIONAL

New numbers on SignalWire are marked as beta. Possible values are true or false.

capabilities object — OPTIONAL

Whether or not a number can receive calls and messages. Possible values are voice, SMS, MMS, and Fax. Each of these values have a boolean value of true or false.

voice boolean — OPTIONAL

Whether or not voice is enabled on the number.

SMS boolean — OPTIONAL

Whether or not SMS is enabled on the number.

MMS boolean — OPTIONAL

Whether or not MMS is enabled on the number.

fax boolean — OPTIONAL

Whether or not fax is enabled on the number.

friendly_name string — OPTIONAL

A formatted version of the number.

iso_country string — OPTIONAL

The ISO country code of the number.

lata string — OPTIONAL

The LATA of the number. Only available for numbers in US and Canada.

latitude string — OPTIONAL

The latitude of the number. Only available for numbers in US and Canada.

longitude string — OPTIONAL

The longitude of the number. Only available for numbers in US and Canada.

phone_number string — OPTIONAL

The number in E.164 format.

postal_code string — OPTIONAL

The postal/zip code of the number. Only available for numbers in US and Canada.

rate_center string — OPTIONAL

The rate center of the number. Only available for numbers in US and Canada.

region string — OPTIONAL

The state or province abbreviation of the number. Only available for numbers in US and Canada.

Find toll-free numbers.

Permissions​

Permissions