Skip to main content
Version: v3

List available phone numbers

GET 

/phone-system/numbers/location/:locationId/available

Search Twilio inventory for purchasable phone numbers in a country for the given location.

Request

locationId stringrequired

Location ID as string

firstPart stringrequired

firstPart is the beginning of the phone number

lastPart stringrequired

lastPart is the ending of the phone number

anywhere stringrequired

anywhere are the numbers required anywhere in phone number

numberTypes string[]required

comma separated types of phone number required

smsEnabled booleanrequired

requested phone numbers should have sms functionality

mmsEnabled booleanrequired

requested phone numbers should have mms functionality

voiceEnabled booleanrequired

requested phone numbers should have voice functionality

countryCode stringrequired

country for which the phone numbers are being requested

Available phone numbers matching the search criteria.