Skip to contentSkip to navigationSkip to topbar
On this page

REST API: Available Numbers


(warning)

Warning

Available Numbers API is currently in closed private Developer Preview. Please use the generally available Available Phone Numbers API if you do not have access.

The Available Numbers endpoint provides a rich view into Twilio's inventory of phone numbers available for purchase. As we've worked with operators across the globe to offer numbers that cover over 100 countries, we've learned that not all numbers are created equal. Phone numbers differ broadly in characteristics and regulatory requirements. Through the /AvailableNumbers endpoint, every number is described by a set of attributes, grouped in four categories: capabilities (voice, sms, mms), geography, regulatory requirements, and pricing. With granular search filters to select numbers with the right attributes for your application, you can narrow down search results to find the perfect number for your use case.

For number pricing and availability please refer to the Support Number Catalog(link takes you to an external page).

You can also search for numbers based on what you're building. To do this, pass your use case as a search parameter and we'll return numbers that have the right characteristics for your application.

Once you've found an available number you want to purchase, make an HTTP POST request to the /ActiveNumbers list resource passing the number as the PhoneNumber parameter.


AvailableNumbers Instance Resource

available-numbers-instance page anchor

Resource URI

available-instance-uri page anchor

You can make a request directly to AvailableNumbers instance resource and choose from any of the numbers that appear in the search as a result of the filters you've specified.

1
https://preview.twilio.com/AvailableNumbers
2

Basic Capability Properties

basic-capability-properties page anchor

The table below states basic properties of the phone number that associate the number to a unique group within Twilio's inventory system.

PropertyDescription
PhoneNumberThe phone number, in E.164(link takes you to an external page) (i.e. "+1") format.
TypeThe type of phone number (i.e., local, mobile, tollfree, shortcode, etc.).
LifecycleThe lifecycle the number is in (i.e., developer-preview, beta, generally-available, exhausted).
BaseRecurringPriceBase recurring price for a number. (i.e., $1.00). This price will be recurring until the number is released. Please note this does not take into account PricingModels.
BaseSetupPriceBase setup price for a number. (i.e., $1.00). This price is charged to your account one time when the number is first purchased.

Voice Capability Properties

voice-capability-properties page anchor

Voice calling is provided by utilizing the Public Switch Telephone Network (PSTN)(link takes you to an external page), the aggregate of the world's circuit-switched telephone networks that are operated by national, regional, or local telephony operators, providing infrastructure and services for public telecommunication.

PropertyDescription
Capabilities.Voice.InboundConnectivityIndicates whether a number has inbound voice connectivity in to Twilio.
Capabilities.Voice.OutboundConnectivityIndicates whether a number has outbound voice connectivity out of Twilio.
Capabilities.Voice.E911[Emergency 911][e911] connectivity capable number.
Capabilities.Voice.Fax[Fax][fax] capable number.
Capabilities.Voice.SipTrunkingSip Trunking(link takes you to an external page) capable number.
Capabilities.Voice.CallsPerSecondInteger stating how many calls can be initiated per second. Please refer to Twilio's CPS Support article(link takes you to an external page) for more information.
Capabilities.Voice.ConcurrentCallsLimitInteger stating how many calls can be active at one time.
Capabilities.Voice.InboundCalledDtmfDual-Tone Multi Frequency(link takes you to an external page) with inbound called party.
Capabilities.Voice.InboundCallerDtmfDual-Tone Multi Frequency(link takes you to an external page) with inbound caller party.
Capabilities.Voice.InboundCallerIdPreservationInbound voice Caller ID (+E.164 format)(link takes you to an external page) preservation of a number. Can be - International, Domestic, or None.
Capabilities.Voice.InboundReachabilityInbound Voice reachability of a number. Can be - Domestic, Foreign, or Global.
Capabilities.Voice.LongRecordLengthThe length in seconds that a number can record a voicemail.

Sms Capability Properties

sms-capability-properties page anchor

Short Messaging Service (SMS)(link takes you to an external page) is a text messaging service component of most telephone, World Wide Web, and mobile telephony systems.

PropertyDescription
Capabilities.Sms.InboundConnectivityIndicates whether a number has inbound sms connectivity in to Twilio.
Capabilities.Sms.OutboundConnectivityIndicates whether a number has outbound sms connectivity out of Twilio.
Capabilities.Sms.Gsm7GSM-7 is a character encoding standard which packs the most commonly used letters and symbols in many languages into 7 bits each for usage on GSM networks. See What is GSM-7 Character Encoding(link takes you to an external page).
Capabilities.Sms.Ucs2UCS-2 is a character encoding standard in which characters are represented by a fixed-length 16 bits (2 bytes). See What is UCS-2 Character Encoding?(link takes you to an external page).
Capabilities.Sms.Gsm7ConcatenationConcatenated short message service (or concatenated SMS)(link takes you to an external page) is used overcome the limitation on the number of characters that can be sent in a single SMS text message transmission (which is usually 160), and split the sms into smaller messages by the sending device and recombined at the receiving end.
Capabilities.Sms.Ucs2ConcatenationConcatenated short message service (or concatenated SMS)(link takes you to an external page) is used overcome the limitation on the number of characters that can be sent in a single SMS text message transmission (which is usually 160), and split the sms into smaller messages by the sending device and recombined at the receiving end.
Capabilities.Sms.InboundSenderIdPreservationInbound voice Sender ID (+E.164 format)(link takes you to an external page) preservation of a number. Can be - International, Domestic, or None.
Capabilities.Sms.InboundReachabilityInbound SMS reachability of a number. Can be - Domestic, Foreign, or Global.
Capabilities.Sms.InboundMpsInteger showing the SMS inbound message per second limit. Please refer to Twilio's MPS Support article(link takes you to an external page) for more information.

Mms Capability Properties

mms-capability-properties page anchor

Multimedia Messaging Service (MMS)(link takes you to an external page) is a standard way to send messages that include multimedia content to and from a mobile phone over a cellular network.

PropertyDescription
Capabilities.Mms.InboundconnectivityIndicates whether a number has inbound MMS connectivity into Twilio.
Capabilities.Mms.OutboundconnectivityIndicates whether a number has outbound MMS connectivity into Twilio.
Capabilities.Mms.InboundReachabilityInbound MMS reachability of a number. Can be - Domestic, Foreign, or Global.
Capabilities.Mms.InboundMpsInteger showing the MMS inbound message per second limit. Please refer to Twilio's MPS Support article(link takes you to an external page) for more information.

Regulations that pertain to this specific number that may deal with Addresses and/or Identities to be required and completed as a pre-request before purchasing.

PropertyDescription
Regulatory.AddressRequirementsThis indicates whether the phone number requires you or your customer to have an Address(link takes you to an external page) registered with Twilio. Possible values are listed below.

Address Requirement Values

address-requirement-values page anchor

The following are the possible values for the address_required property.

StatusDescription
noneAn Address(link takes you to an external page) is not required for this phone number.
anyYour account must have an Address(link takes you to an external page), but it can be anywhere in the world.
localYour account must have an Address(link takes you to an external page) within the phone number's country.
foreignYour account must have an Address(link takes you to an external page) outside the phone number's country.

A phone number's specific geography associated with a number. Some numbers are country level only, and others have specific latitude and longitude associated with them. To understand more, please visit List of Country Codes(link takes you to an external page).

PropertyDescription
Geography.IsoCountryThe ISO country code(link takes you to an external page) of this phone number.
Geography.LataThe LATA(link takes you to an external page) of this phone number. Only available for countries in the North American Numbering Plan (NANPA)(link takes you to an external page).
Geography.RateCenterThe rate center(link takes you to an external page) of this phone number. Only available for countries in the North American Numbering Plan (NANPA)(link takes you to an external page).
Geography.LatitudeThe latitude coordinate of this phone number.
Geography.LongitudeThe longitude coordinate of this phone number.
Geography.RegionThe two-letter state or province abbreviation of this phone number.
Geography.LocalityThe locality/city of this phone number.
Geography.PostalCodeThe postal (zip) code of this phone number.
Search for Toll Free US numbersLink to code sample: Search for Toll Free US numbers
1
$ curl -G https://preview.twilio.com/Numbers/AvailableNumbers \
2
-d "Type=tollfree" \
3
-d "Geography.IsoCountry=US" \
4
-u '<ACCOUNT_SID:AUTH_TOKEN>'

Output

1
{
2
"items": [
3
{
4
"phone_number": "+18005559306",
5
"base_setup_price": "0.0",
6
"base_recurring_price": "2.0",
7
"capabilities": {
8
"voice": {
9
"inbound_connectivity": true,
10
"outbound_connectivity": true,
11
"e911": true,
12
"fax": true,
13
"sip_trunking": true,
14
"calls_per_second": 1,
15
"concurrent_calls_limit": 1,
16
"long_record_length": 30,
17
"inbound_called_dtmf": true,
18
"inbound_caller_dtmf": true,
19
"inbound_caller_id_preservation": "international",
20
"inbound_reachability": "global"
21
},
22
"sms": {
23
"inbound_connectivity": true,
24
"outbound_connectivity": true,
25
"gsm7": true,
26
"ucs2": true,
27
"gsm7_concatenation": true,
28
"ucs2_concatenation": true,
29
"inbound_sender_id_preservation": "international",
30
"inbound_reachability": "global",
31
"inbound_mps": -1
32
},
33
"mms": {
34
"inbound_connectivity": true,
35
"outbound_connectivity": true,
36
"inbound_reachability": "global",
37
"inbound_mps": -1
38
}
39
},
40
"regulatory": {
41
"address_requirements": "none"
42
},
43
"type": "tollfree",
44
"lifecycle": "generally-available",
45
"geography": {
46
"iso_country": "US",
47
"lata": null,
48
"rate_center": null,
49
"latitude": null,
50
"longitude": null,
51
"region": null,
52
"locality": null,
53
"postal_code": null
54
}
55
}
56
],
57
"meta": {
58
"page": 0,
59
"page_size": 50,
60
"first_page_url": "https://preview.twilio.com/Numbers/AvailableNumbers?Type=tollfree&PageSize=50&Page=0",
61
"previous_page_url": null,
62
"url": "https://preview.twilio.com/Numbers/AvailableNumbers?Type=tollfree&PageSize=50&Page=0",
63
"next_page_url": null,
64
"key": "items"
65
}
66
}

Returns a list of AvailableNumbers resource representations that match the specified filters, each representing a phone number that is currently available for provisioning to your account.

The following basic GET query string parameters allow you to filter the list of numbers returned by Twilio. Note, parameters are case-sensitive.

ParameterDescription
SavedSearchFind phone numbers that can support a specific Twilio use case, or a custom saved search that you've constructed. See below for a list of pre-defined use case saved searches. Ability to create and save custom searches is forthcoming.
MinBaseRecurringPriceMinimum base recurring price for a number. (i.e., >= $1.00). Combined with Maximum, this filter acts as a BETWEEN filter.
MaxBaseRecurringPriceMaximum base recurring price for a number. (i.e., <= $2.00). Combined with Minimum, this filter acts as a BETWEEN filter.
MinBaseSetupPriceMinimum base setup price for a number. (i.e., >= $1.00). Combined with Maximum, this filter acts as a BETWEEN filter.
MaxBaseSetupPriceMaximum base setup price for a number. (i.e., <= $2.00). Combined with Minimum, this filter acts as a BETWEEN filter.
1
$ curl -G https://preview.twilio.com/Numbers/AvailableNumbers \
2
-d "SavedSearch=twilio.use-case.conversations.voice" \
3
-d "SavedSearch=twilio.use-case.conversations.sms" \
4
-d "Geography.IsoCountry=US" \
5
-u '<ACCOUNT_SID:AUTH_TOKEN>'

Output

1
{
2
"items": [
3
{
4
"phone_number": "+14155558143",
5
"base_setup_price": "0.0",
6
"base_recurring_price": "2.0",
7
"capabilities": {
8
"voice": {
9
"inbound_connectivity": true,
10
"outbound_connectivity": true,
11
"e911": true,
12
"fax": true,
13
"sip_trunking": true,
14
"calls_per_second": 1,
15
"concurrent_calls_limit": 1,
16
"long_record_length": 30,
17
"inbound_called_dtmf": true,
18
"inbound_caller_dtmf": true,
19
"inbound_caller_id_preservation": "international",
20
"inbound_reachability": "global"
21
},
22
"sms": {
23
"inbound_connectivity": true,
24
"outbound_connectivity": true,
25
"gsm7": true,
26
"ucs2": true,
27
"gsm7_concatenation": true,
28
"ucs2_concatenation": true,
29
"inbound_sender_id_preservation": "international",
30
"inbound_reachability": "global",
31
"inbound_mps": -1
32
},
33
"mms": {
34
"inbound_connectivity": true,
35
"outbound_connectivity": true,
36
"inbound_reachability": "global",
37
"inbound_mps": -1
38
}
39
},
40
"regulatory": {
41
"address_requirements": "none"
42
},
43
"type": "tollfree",
44
"lifecycle": "generally-available",
45
"geography": {
46
"iso_country": "US",
47
"lata": null,
48
"rate_center": null,
49
"latitude": null,
50
"longitude": null,
51
"region": null,
52
"locality": null,
53
"postal_code": null
54
}
55
}
56
],
57
"meta": {
58
"page": 0,
59
"page_size": 50,
60
"first_page_url": "https://preview.twilio.com/Numbers/AvailableNumbers?Type=tollfree&PageSize=50&Page=0",
61
"previous_page_url": null,
62
"url": "https://preview.twilio.com/Numbers/AvailableNumbers?Type=tollfree&PageSize=50&Page=0",
63
"next_page_url": null,
64
"key": "items"
65
}
66
}

Saved Search allows you to search for numbers that meet your application's or project's specific criteria. Twilio has pre-defined 7 distinct use case saved search macros for you. The capability (Voice or Sms) must be included, and to have both voice and sms, you can specify multiple Saved Search filters. To see the exact filters being used for the 7 default use case saved search macros, please refer to the Global Phone Numbers Catalog FAQ(link takes you to an external page).

SavedSearchDescription
twilio.use-case.conversations.(capability)The Conversations use case allows numbers to setup multi-tenant conversations, and is available for both Voice and Sms. Please refer to Proxy(link takes you to an external page) for more information.
twilio.use-case.marketing.(capability)The marketing use case ensures you purchase numbers that are designated for marketing traffic by local telecom regulators. The marketing saved search is available for both Voice and Sms. Please refer to Twilio's Marketing site(link takes you to an external page) for more information.
twilio.use-case.notifications.(capability)The Notifications use case allows numbers to be used to notification purposes, and is available for both Voice and Sms. Please refer to Twilio's Account Notifications site(link takes you to an external page) for more information.
twilio.use-case.verifications.(capability)The Verifications use case allows numbers to be used for security verification purposes, and is available for both Voice and Sms. Please refer to Twilio's Verification site(link takes you to an external page) for more information.
twilio.use-case.pbx-collaborations.VoiceThe PBX Collaborations(link takes you to an external page) use case allows numbers to be used for your private branch exchange network, and is available for Voice only. Please refer to Twilio's Elastic SIP Trunking site(link takes you to an external page) for more information.
twilio.use-case.contact-centers.(capability)The Contact Centers use case allows numbers to be used for information and communication exchange between the contact center and end users. The Contact Centers is available for both Voice and Sms. Please refer to Twilio's Contact Center site(link takes you to an external page) for more information.
twilio.use-case.call-tracking.(capability)The Call Tracking use case allows you to take control over how you track and route calls and texts from any traffic source. The Call Tracking use case is available for Voice only. Please refer to Twilio's Call Tracking site(link takes you to an external page) for more information.
1
$ curl -G https://preview.twilio.com/Numbers/AvailableNumbers \
2
-d "Geography.IsoCountry=US" \
3
-d "Capabilities.Voice.InboundConnectivity=true" \
4
-d "Capabilities.Voice.OutboundConnectivity=true" \
5
-d "Capabilities.Voice.InboundCallerIdPreservation=international" \
6
-u '<ACCOUNT_SID:AUTH_TOKEN>'

Output

1
{
2
"items": [
3
{
4
"phone_number": "+18005559306",
5
"base_setup_price": "0.0",
6
"base_recurring_price": "2.0",
7
"capabilities": {
8
"voice": {
9
"inbound_connectivity": true,
10
"outbound_connectivity": true,
11
"e911": true,
12
"fax": true,
13
"sip_trunking": true,
14
"calls_per_second": 1,
15
"concurrent_calls_limit": 1,
16
"long_record_length": 30,
17
"inbound_called_dtmf": true,
18
"inbound_caller_dtmf": true,
19
"inbound_caller_id_preservation": "international",
20
"inbound_reachability": "global"
21
},
22
"sms": {
23
"inbound_connectivity": true,
24
"outbound_connectivity": true,
25
"gsm7": true,
26
"ucs2": true,
27
"gsm7_concatenation": true,
28
"ucs2_concatenation": true,
29
"inbound_sender_id_preservation": "international",
30
"inbound_reachability": "global",
31
"inbound_mps": -1
32
},
33
"mms": {
34
"inbound_connectivity": true,
35
"outbound_connectivity": true,
36
"inbound_reachability": "global",
37
"inbound_mps": -1
38
}
39
},
40
"regulatory": {
41
"address_requirements": "none"
42
},
43
"type": "tollfree",
44
"lifecycle": "generally-available",
45
"geography": {
46
"iso_country": "US",
47
"lata": null,
48
"rate_center": null,
49
"latitude": null,
50
"longitude": null,
51
"region": null,
52
"locality": null,
53
"postal_code": null
54
}
55
}
56
],
57
"meta": {
58
"page": 0,
59
"page_size": 50,
60
"first_page_url": "https://preview.twilio.com/Numbers/AvailableNumbers?PageSize=50&Page=0",
61
"previous_page_url": null,
62
"url": "https://preview.twilio.com/Numbers/AvailableNumbers?PageSize=50&Page=0",
63
"next_page_url": null,
64
"key": "items"
65
}
66
}
1
$ curl -G https://preview.twilio.com/Numbers/AvailableNumbers \
2
-d "Geography.IsoCountry=US" \
3
-d "Capabilities.Sms.InboundConnectivity=true" \
4
-d "Capabilities.Sms.OutboundConnectivity=true" \
5
-d "Capabilities.Sms.InboundSenderIdPreservation=international" \
6
-u '<ACCOUNT_SID:AUTH_TOKEN>'

Output

1
{
2
"items": [
3
{
4
"phone_number": "+18005559306",
5
"base_setup_price": "0.0",
6
"base_recurring_price": "2.0",
7
"capabilities": {
8
"voice": {
9
"inbound_connectivity": true,
10
"outbound_connectivity": true,
11
"e911": true,
12
"fax": true,
13
"sip_trunking": true,
14
"calls_per_second": 1,
15
"concurrent_calls_limit": 1,
16
"long_record_length": 30,
17
"inbound_called_dtmf": true,
18
"inbound_caller_dtmf": true,
19
"inbound_caller_id_preservation": "international",
20
"inbound_reachability": "global"
21
},
22
"sms": {
23
"inbound_connectivity": true,
24
"outbound_connectivity": true,
25
"gsm7": true,
26
"ucs2": true,
27
"gsm7_concatenation": true,
28
"ucs2_concatenation": true,
29
"inbound_sender_id_preservation": "international",
30
"inbound_reachability": "global",
31
"inbound_mps": -1
32
},
33
"mms": {
34
"inbound_connectivity": true,
35
"outbound_connectivity": true,
36
"inbound_reachability": "global",
37
"inbound_mps": -1
38
}
39
},
40
"regulatory": {
41
"address_requirements": "none"
42
},
43
"type": "tollfree",
44
"lifecycle": "generally-available",
45
"geography": {
46
"iso_country": "US",
47
"lata": null,
48
"rate_center": null,
49
"latitude": null,
50
"longitude": null,
51
"region": null,
52
"locality": null,
53
"postal_code": null
54
}
55
}
56
],
57
"meta": {
58
"page": 0,
59
"page_size": 50,
60
"first_page_url": "https://preview.twilio.com/Numbers/AvailableNumbers?PageSize=50&Page=0",
61
"previous_page_url": null,
62
"url": "https://preview.twilio.com/Numbers/AvailableNumbers?PageSize=50&Page=0",
63
"next_page_url": null,
64
"key": "items"
65
}
66
}
1
$ curl -G https://preview.twilio.com/Numbers/AvailableNumbers \
2
-d "Type=local" \
3
-d "Capabilities.Mms.OutboundConnectivity=true" \
4
-d "Capabilities.Mms.InboundReachability=global" \
5
-u '<ACCOUNT_SID:AUTH_TOKEN>'

Output

1
{
2
"items": [
3
{
4
"phone_number": "+16315550000",
5
"capabilities": {
6
"voice": {
7
"inbound_connectivity": true,
8
"outbound_connectivity": true,
9
"e911": true,
10
"fax": true,
11
"sip_trunking": true,
12
"calls_per_second": 30,
13
"concurrent_calls_limit": 30,
14
"long_record_length": 30,
15
"inbound_called_dtmf": true,
16
"inbound_caller_dtmf": true,
17
"inbound_caller_id_preservation": "international",
18
"inbound_reachability": "global",
19
"codecs": [
20
"g711u"
21
]
22
},
23
"sms": {
24
"inbound_connectivity": true,
25
"outbound_connectivity": true,
26
"gsm7": true,
27
"ucs2": true,
28
"gsm7_concatenation": true,
29
"ucs2_concatenation": true,
30
"inbound_sender_id_preservation": "international",
31
"inbound_reachability": "global",
32
"inbound_mps": -1
33
},
34
"mms": {
35
"inbound_connectivity": true,
36
"outbound_connectivity": true,
37
"inbound_reachability": "global",
38
"inbound_mps": -1
39
}
40
},
41
"regulatory": {
42
"address_requirements": "none"
43
},
44
"type": "local",
45
"lifecycle": "generally-available",
46
"geography": {
47
"iso_country": "US",
48
"lata": 132,
49
"rate_center": "HUNTINGTON",
50
"latitude": 40.8719,
51
"longitude": -73.4347,
52
"region": "NY",
53
"locality": "HUNTINGTON",
54
"postal_code": "11743"
55
}
56
}
57
],
58
"meta": {
59
"page": 0,
60
"page_size": 50,
61
"first_page_url": "https://preview.twilio.com/Numbers/AvailableNumbers/US?Type=local&Capabilities.Mms.OutboundConnectivity=true&Capabilities.Mms.InboundReachability=global&PageSize=50&Page=0",
62
"previous_page_url": null,
63
"url": "https://preview.twilio.com/Numbers/AvailableNumbers/US?Type=local&Capabilities.Mms.OutboundConnectivity=true&Capabilities.Mms.InboundReachability=global&PageSize=50&Page=0",
64
"next_page_url": null,
65
"key": "items"
66
}
67
}

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.