Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: Available Numbers

Available Numbers API is currently in Developer Preview

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.

To keep things simple, we’re introducing the ability to search for numbers based on what you’re building - simply 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

リソースURI

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.

https://preview.twilio.com/AvailableNumbers

リソースのプロパティ

Basic Capability Properties

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

プロパティ 概要
PhoneNumber E.164 (「+国番号」付き) フォーマットの電話番号です。
Type The type of phone number (i.e., local, mobile, tollfree, shortcode, etc.)
Lifecycle The lifecycle the number is in (i.e., developer-preview, beta, generally-available, exhausted).
BaseRecurringPrice Base 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.
BaseSetupPrice Base 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 calling is provided by utilizing the Public Switch Telephone Network (PSTN) , 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.

プロパティ 概要
Capabilities.Voice.InboundConnectivity Indicates whether a number has inbound voice connectivity in to Twilio
Capabilities.Voice.OutboundConnectivity Indicates 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.SipTrunking Sip Trunking capable number
Capabilities.Voice.CallsPerSecond Integer stating how many calls can be initiated per second. Please refer to Twilio's CPS Support article for more information.
Capabilities.Voice.ConcurrentCallsLimit Integer stating how many calls can be active at one time
Capabilities.Voice.InboundCalledDtmf Dual-Tone Multi Frequency with inbound called party
Capabilities.Voice.InboundCallerDtmf Dual-Tone Multi Frequency with inbound caller party
Capabilities.Voice.InboundCallerIdPreservation Inbound voice Caller ID (+E.164 format) preservation of a number. Can be - International, Domestic, or None.
Capabilities.Voice.InboundReachability Inbound Voice reachability of a number. Can be - Domestic, Foreign, or Global
Capabilities.Voice.LongRecordLength The length in seconds that a number can record a voicemail

Sms Capability Properties

Short Messaging Service (SMS) is a text messaging service component of most telephone, World Wide Web, and mobile telephony systems.

プロパティ 概要
Capabilities.Sms.InboundConnectivity Indicates whether a number has inbound sms connectivity in to Twilio
Capabilities.Sms.OutboundConnectivity Indicates whether a number has outbound sms connectivity out of Twilio
Capabilities.Sms.Gsm7 GSM-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
Capabilities.Sms.Ucs2 UCS-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?
Capabilities.Sms.Gsm7Concatenation Concatenated short message service (or concatenated SMS) 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.Ucs2Concatenation Concatenated short message service (or concatenated SMS) 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.InboundSenderIdPreservation Inbound voice Sender ID (+E.164 format) preservation of a number. Can be - International, Domestic, or None
Capabilities.Sms.InboundReachability Inbound SMS reachability of a number. Can be - Domestic, Foreign, or Global.
Capabilities.Sms.InboundMps Integer showing the SMS inbound message per second limit. Please refer to Twilio's MPS Support article for more information.

Mms Capability Properties

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

プロパティ 概要
Capabilities.Mms.Inboundconnectivity Indicates whether a number has inbound MMS connectivity into Twilio
Capabilities.Mms.Outboundconnectivity Indicates whether a number has outbound MMS connectivity into Twilio
Capabilities.Mms.InboundReachability Inbound MMS reachability of a number. Can be - Domestic, Foreign, or Global.
Capabilities.Mms.InboundMps Integer showing the MMS inbound message per second limit. Please refer to Twilio's MPS Support article for more information.

Regulatory Properties

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.

プロパティ 概要
Regulatory.AddressRequirements This indicates whether the phone number requires you or your customer to have an Address registered with Twilio. Possible values are listed below.
アドレス要件値

下記は address_required プロパティ として取りうる値です。

Status 概要
none このアドレスは電話番号に必要ではありません。
any このアカウントは住所を必要としています。しかし、世界中のどこでもご利用いただけます。
local このアカウントは電話番号の国の住所が必要です。
foreign あなたのアカウントは電話番号の国ではない住所が必要です。

Geography Properties

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.

プロパティ 概要
Geography.IsoCountry この電話番号の ISO 国コード です。
Geography.Lata The LATA of this phone number. Only available for countries in the North American Numbering Plan (NANPA).
Geography.RateCenter The rate center of this phone number. Only available for countries in the North American Numbering Plan (NANPA).
Geography.Latitude この電話番号の緯度座標です。
Geography.Longitude この電話番号の経度座標です。
Geography.Region この電話番号の州名コード (2 文字) です。
Geography.Locality この電話番号の地域/都市です。
Geography.PostalCode この電話番号の郵便番号 (ZIP コード) です。
        
        
        
        

        HTTP GET

        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.

        Optional List Filters

        次の基本的な GET クエリ パラメーターを使って、Twilio が返却する番号リストをフィルタリングできます。 パラメーターの大文字と小文字は区別されます。

        パラメーター 概要
        SavedSearch Find 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.
        MinBaseRecurringPrice Minimum base recurring price for a number. (i.e., >= $1.00). Combined with Maximum, this filter acts as a BETWEEN filter
        MaxBaseRecurringPrice Maximum base recurring price for a number. (i.e., <= $2.00). Combined with Minimum, this filter acts as a BETWEEN filter
        MinBaseSetupPrice Minimum base setup price for a number. (i.e., >= $1.00). Combined with Maximum, this filter acts as a BETWEEN filter
        MaxBaseSetupPrice Maximum base setup price for a number. (i.e., <= $2.00). Combined with Minimum, this filter acts as a BETWEEN filter
              
              
              
              
              Saved Search

              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.

              SavedSearch 概要
              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 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 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 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 for more information.
              twilio.use-case.pbx-collaborations.Voice The PBX Collaborations 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 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 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 for more information.
                    
                    
                    
                    
                          
                          
                          
                          
                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

                                誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。