Field Reference

Field Definitions

Fields that can be passed to the AvailableNumbers Resource

FieldDescriptionRequiredPossible Values
typeDetermines the type of number to be returned: Local or TollFreeYeslocal
tollfree
localtonumberUsed 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 suppliedA 6 or 10 digit phone number must be supplied. Ex: 212480 or 2134801212
cityUsed to locate a number by geographic areaMust be provided if a localtonumber value is not supplied. The state field is required in conjunction with this parameter.A valid city name
stateUsed to locate a number by geographic areaMust 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_codeUsed to filter search results to match a 3 digit Area Code (NPA).

Ex: (212) 323-2048
NoA 3 digit number
exchangeUsed to filter search results to match a 3 digit Exchange (NXX).

Ex: (212) 323-2048
NoA 3 digit number
sms_capableOnly return numbers that support SMSbooleanNo

The following fields will be returned in the response:

FieldDescription
sms_capableA flag indicating whether the number is capable of sending and receiving SMS
numberA 10 digit phone number
area_codeA 3 digit number representing the Area Code (NPA) of the phone number
exchangeA 3 digit number representing the Exchange (NXX) of the phone number
suffixA 4 digit number representing the final 4 digits of the phone number
cityThe rate center that the number belongs to
stateThe State/Province that the number belongs to