Field Reference

Field Definitions

Fields that can be passed to the AvailableNumbers Resource

Field

Description

Required

Possible Values

type

Determines the type of number to be returned: Local or TollFree

Yes

local
tollfree

localtonumber

Used to locate a number local to another number (Ex. find a number local to an Advertiser's local number)

Must be provided if a Geographical Match is not supplied

A 6 or 10 digit phone number must be supplied. Ex: 212480 or 2134801212

city

Used to locate a number by geographic area

Must be provided if a localtonumber value is not supplied. The state field is required in conjunction with this parameter.

A valid city name

state

Used to locate a number by geographic area

Must be provided if a localtonumber value is not supplied. The city field is required in conjunction with this parameter.

A valid US state or Canadian province

area_code

Used to filter search results to match a 3 digit Area Code (NPA).

Ex: (212) 323-2048

No

A 3 digit number

exchange

Used to filter search results to match a 3 digit Exchange (NXX).

Ex: (212) 323-2048

No

A 3 digit number

sms_capable

Only return numbers that support SMS

boolean

No

The following fields will be returned in the response:

Field

Description

sms_capable

A flag indicating whether the number is capable of sending and receiving SMS

number

A 10 digit phone number

area_code

A 3 digit number representing the Area Code (NPA) of the phone number

exchange

A 3 digit number representing the Exchange (NXX) of the phone number

suffix

A 4 digit number representing the final 4 digits of the phone number

city

The rate center that the number belongs to

state

The State/Province that the number belongs to