メニュー

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: 利用可能電話番号

The subresources of the AvailablePhoneNumbers resource let you search for local, toll-free and mobile phone numbers that are available for you to purchase. You can search for phone numbers that match a pattern, are in a certain country, are in certain area code (NPA) or exchange (NXX) or are in a specific geography.

購入したい番号が見つかったら、HTTP POST リクエストを IncomingPhoneNumbers リスト リソース に発行し、番号を PhoneNumber パラメーターとして渡します。

Twilio は、豊富な種類の番号をストックしています。 国別の購入可能な番号については、 料金ページ を参照してください。

AvailablePhoneNumber 国内番号 インスタンス リソース

リソースURI

AvailablePhoneNumber はURLをもちません。AvailablePhoneNumber インスタンスリソースに直接リクエストを送信することはできません。その代わりに、ローカルリストサブリソースへリクエストをう送信し、リストから電話番号を選択してください。

リソースのプロパティ

The following properties are available for all available phone number resources:

Names in REST API format
friendly_name
phone_number Not PII

電話番号のわかりやすい表記です。

phone_number
phone_number Not PII

E.164 (「+国番号」付き) フォーマットの電話番号です。

lata
文字列 Not PII

The LATA of this phone number. Available for phone numbers from the US and Canada.

locality
文字列 Not PII

この電話番号の地域/都市です。

rate_center
文字列 Not PII

The rate center of this phone number. Available for phone numbers from the US and Canada.

latitude
decimal Not PII

The latitude coordinate of this phone number. Available for phone numbers from the US and Canada.

longitude
decimal Not PII

The longitude coordinate of this phone number. Available for phone numbers from the US and Canada.

region
文字列 Not PII

The two-letter state or province abbreviation of this phone number. Available for phone numbers from the US and Canada.

postal_code
文字列 Not PII

The postal (zip) code of this phone number. Available for phone numbers from the US and Canada.

iso_country
iso_country_code Not PII

この電話番号の ISO 国コード です。

address_requirements
文字列 Not PII

意味することは、電話番号があなた、もしくはあなたのお客様が住所をTwilioに登録する必要かあるかどうかを示します。取りうる値はnoneanylocalもしくはforeignです。

beta
boolean Not PII

ベータステータスの電話番号フラグ取りうる値は true もしくは false.

capabilities
phone_number_capabilities Not PII

ブール型のプロパティで、この番号で音声通話・SMSの受信可否を示します。 Voice, SMS, MMS, Fax にそれぞれ truefalse の組み合わせです。

Address Requirements Values

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

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

AvailablePhoneNumber 無料電話番号インスタンス リソース

Twilio has a range of available toll-free numbers across different countries that you can purchase.

リソースURI

An AvailablePhoneNumber Toll-Free instance resource has no URI. You cannot make requests directly to AvailablePhoneNumber instance resources. Instead, make a request to the toll-free list subresource and then choose a number from the list.

リソースのプロパティ

Names in REST API format
friendly_name
phone_number Not PII

電話番号のわかりやすい表記です。

phone_number
phone_number Not PII

E.164 (「+国番号」付き) フォーマットの電話番号です。

lata
文字列 Not PII

The LATA of this phone number. Available for phone numbers from the US and Canada.

locality
文字列 Not PII

この電話番号の地域/都市です。

rate_center
文字列 Not PII

The rate center of this phone number. Available for phone numbers from the US and Canada.

latitude
decimal Not PII

The latitude coordinate of this phone number. Available for phone numbers from the US and Canada.

longitude
decimal Not PII

The longitude coordinate of this phone number. Available for phone numbers from the US and Canada.

region
文字列 Not PII

The two-letter state or province abbreviation of this phone number. Available for phone numbers from the US and Canada.

postal_code
文字列 Not PII

The postal (zip) code of this phone number. Available for phone numbers from the US and Canada.

iso_country
iso_country_code Not PII

この電話番号の ISO 国コード です。

address_requirements
文字列 Not PII

意味することは、電話番号があなた、もしくはあなたのお客様が住所をTwilioに登録する必要かあるかどうかを示します。取りうる値はnoneanylocalもしくはforeignです。

beta
boolean Not PII

ベータステータスの電話番号フラグ取りうる値は true もしくは false.

capabilities
phone_number_capabilities Not PII

ブール型のプロパティで、この番号で音声通話・SMSの受信可否を示します。 Voice, SMS, MMS, Fax にそれぞれ truefalse の組み合わせです。


AvailablePhoneNumber 携帯電話インスタンスリソース

リソースURI

AvailablePhoneNumber 携帯電話インスタンスリソースはURLを持ちませんAvailablePhoneNumber インスタンスリソースに直接リクエストを送ることはできません。その代わりに、携帯電話リストサブリソースにリクエストを送り、そのリストの中から番号を選択します。

リソースのプロパティ

Names in REST API format
friendly_name
phone_number Not PII

電話番号のわかりやすい表記です。

phone_number
phone_number Not PII

E.164 (「+国番号」付き) フォーマットの電話番号です。

lata
文字列 Not PII

The LATA of this phone number. Available for phone numbers from the US and Canada.

locality
文字列 Not PII

この電話番号の地域/都市です。

rate_center
文字列 Not PII

The rate center of this phone number. Available for phone numbers from the US and Canada.

latitude
decimal Not PII

The latitude coordinate of this phone number. Available for phone numbers from the US and Canada.

longitude
decimal Not PII

The longitude coordinate of this phone number. Available for phone numbers from the US and Canada.

region
文字列 Not PII

The two-letter state or province abbreviation of this phone number. Available for phone numbers from the US and Canada.

postal_code
文字列 Not PII

The postal (zip) code of this phone number. Available for phone numbers from the US and Canada.

iso_country
iso_country_code Not PII

この電話番号の ISO 国コード です。

address_requirements
文字列 Not PII

意味することは、電話番号があなた、もしくはあなたのお客様が住所をTwilioに登録する必要かあるかどうかを示します。取りうる値はnoneanylocalもしくはforeignです。

beta
boolean Not PII

ベータステータスの電話番号フラグ取りうる値は true もしくは false.

capabilities
phone_number_capabilities Not PII

ブール型のプロパティで、この番号で音声通話・SMSの受信可否を示します。 Voice, SMS, MMS, Fax にそれぞれ truefalse の組み合わせです。

電話番号の検索と購入

Buy combining the AvailablePhoneNumbers lookup (examples below) with an IncomingPhoneNumbers purchase you can purchase any number based on a wide set of criteria. You can search for available numbers that match a specific pattern, are in a specific geographic area,or are near other numbers just to name a few. Once you've found a number you'd like to buy you simply POST the number to the IncomingPhoneNumbers resource.

AvailablePhoneNumbers 国内番号リスト サブリソース

リソースURI

/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Local

{IsoCountryCode} は ISO 3166-1 alpha-2 フォーマットの国コードです。たとえば、カナダの ISO 国コードは CA です。 サポート対象国 の国名と Twilio がサポートする IsoCountryCode の完全なリストを参照してください。

HTTP GET

指定したフィルターに一致する国内番号の AvailablePhoneNumber リソース表現のリストを返します。各項目は、ユーザーのアカウントで現在プロビジョニング可能な電話番号を表現します。

基本的なリスト フィルター

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

Names in REST API format
AccountSid
必須
GET sid<AC> Not PII

The 34 character string that uniquely identifies your account.

AreaCode
オプション
GET integer Not PII

指定のエリア コードの電話番号を検索します。

Contains
オプション
GET 文字列 Not PII

電話番号とマッチングさせるパターンです。 有効な文字は '*' および [0-9a-zA-Z] です。 '*' は任意の数字1文字とマッチします。 下記の例1および例2を参照してください。 メモ: パターン長は最低でも2文字である必要があります。

SmsEnabled
オプション
GET boolean Not PII

電話番号がSMSを受信できるかどうかを示します可能な場合はtrue、そうでない場合はfalse

MmsEnabled
オプション
GET boolean Not PII

電話番号がMMSを受信できるかどうかを示します可能な場合はtrue、そうでない場合はfalse

VoiceEnabled
オプション
GET boolean Not PII

電話番号が電話を受信できるかどうかを示します可能な場合はtrue、そうでない場合はfalse

ExcludeAllAddressRequired
オプション
GET boolean Not PII

住所が必要な電話番号を含むレスポンスが含まれているかどうか示します。取りうる値はtrueもしくはfalseです。値が指定されない場合デフォルトはfalseです。結果は住所が必要な電話番号を含みます。

ExcludeLocalAddressRequired
オプション
GET boolean Not PII

ローカルな住所が必要な電話番号を含むレスポンスが含まれているかどうか示します。取りうる値はtrueもしくはfalseです。値が指定されない場合デフォルトはfalseです。結果はローカルの住所が必要な電話番号を含みます。

ExcludeForeignAddressRequired
オプション
GET boolean Not PII

外国の住所が必要な電話番号を含むレスポンスが含まれているかどうか示します。取りうる値は、trueもしくはfalseです。値が指定されない場合デフォルトはfalseです。結果は外国の住所が必要な電話番号を含みます。

Beta
オプション
GET boolean Not PII

提供されたばかりのベータの電話番号を含める取りうる値は true もしくは false。デフォルトは true.

NearNumber
オプション
GET phone_number<e164> Not PII

Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles. Limited to US and Canadian phone numbers.

NearLatLong
オプション
GET 文字列 Not PII

Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles. Limited to US and Canadian phone numbers.

Distance
オプション
GET integer Not PII

Specifies the search radius for a Near- query in miles. If not specified this defaults to 25 miles. Maximum searchable distance is 500 miles. Limited to US and Canadian phone numbers.

InPostalCode
オプション
GET 文字列 Not PII

Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Limited to US and Canadian phone numbers.

InRegion
オプション
GET 文字列 Not PII

Limit results to a particular region (i.e. State/Province). Given a phone number, search within the same Region as that number. Limited to US and Canadian phone numbers.

InRateCenter
オプション
GET 文字列 Not PII

Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires InLata to be set as well. Limited to US and Canadian phone numbers.

InLata
オプション
GET 文字列 Not PII

Limit results to a specific Local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Limited to US and Canadian phone numbers.

InLocality
オプション
GET 文字列 Not PII

Limit results to a particular locality (i.e. City). Given a phone number, search within the same Locality as that number. Limited to US and Canadian phone numbers.

FaxEnabled
オプション
GET boolean Not PII

FAX受信に対応するかを示します。 true または false

購入可能な市内電話番号の検索

アメリカ国内の、エリア コード 510 で購入可能な番号を検索します。

        
        
        
        

        番号パターンによる電話番号の検索

        アメリカ国内の、510555 で始まる購入可能な番号を検索します。

              
              
              
              

              パターンによる電話番号の検索

              パターン「STORM」に一致する国内電話番号を検索します。

                    
                    
                    
                    

                    州による購入可能な電話番号の検索

                    アーカンソー州の購入可能な電話番号を検索します。

                          
                          
                          
                          

                          購入可能な市内電話番号の検索

                          SMSが有効なロンドンの電話番号(プレフィックスが+4420)を探してみましょう

                                
                                
                                
                                

                                機能を指定した地域電話番号の検索

                                イギリスの音声、SMSが有効な電話番号を探してみましょう

                                      
                                      
                                      
                                      
                                            
                                            
                                            
                                            
                                                  
                                                  
                                                  
                                                  

                                                  Advanced List Filter Example

                                                  These features are limited to US and Canadian phone numbers. Find local phone numbers within 50 miles of San Francisco, CA (37.840699,-122.461853) that contain the digits '555'.

                                                        
                                                        
                                                        
                                                        

                                                        HTTP POST

                                                        サポートしません。

                                                        HTTP PUT

                                                        サポートしません。

                                                        HTTP DELETE

                                                        サポートしません。

                                                        AvailablePhoneNumbers 無料電話番号リスト サブリソース

                                                        リソースURI

                                                        /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/TollFree
                                                        

                                                        {IsoCountryCode} は ISO 3166-1 alpha-2 フォーマット の国コードです (US はアメリカ、CA はカナダ、GB はイギリス)。

                                                        HTTP GET

                                                        指定したフィルターに一致する無料電話番号の AvailablePhoneNumber 要素のリストを返します。各項目は、ユーザーのアカウントで現在プロビジョニング可能な電話番号を表現します。 電話番号をプロビジョニングするには、電話番号を IncomingPhoneNumber リソースに POST します。

                                                        リストフィルター

                                                        下記のGETのクエリー文字列パラメーターを使用すると、返される一覧を制限することができます。 パラメーターは大文字と小文字を区別することに注意してください:

                                                        Names in REST API format
                                                        AreaCode
                                                        オプション
                                                        GET integer Not PII

                                                        指定のエリア コードの電話番号を検索します。

                                                        Contains
                                                        オプション
                                                        GET 文字列 Not PII

                                                        電話番号とマッチングさせるパターンです。 有効な文字は '*' および [0-9a-zA-Z] です。 '*' は任意の数字1文字とマッチします。 下記の例1および例2を参照してください。 メモ: パターン長は最低でも2文字である必要があります。

                                                        SmsEnabled
                                                        オプション
                                                        GET boolean Not PII

                                                        電話番号がSMSを受信できるかどうかを示します可能な場合はtrue、そうでない場合はfalse

                                                        MmsEnabled
                                                        オプション
                                                        GET boolean Not PII

                                                        電話番号がMMSを受信できるかどうかを示します可能な場合はtrue、そうでない場合はfalse

                                                        VoiceEnabled
                                                        オプション
                                                        GET boolean Not PII

                                                        電話番号が電話を受信できるかどうかを示します可能な場合はtrue、そうでない場合はfalse

                                                        ExcludeAllAddressRequired
                                                        オプション
                                                        GET boolean Not PII

                                                        住所が必要な電話番号を含むレスポンスが含まれているかどうか示します。取りうる値はtrueもしくはfalseです。値が指定されない場合デフォルトはfalseです。結果は住所が必要な電話番号を含みます。

                                                        ExcludeLocalAddressRequired
                                                        オプション
                                                        GET boolean Not PII

                                                        ローカルな住所が必要な電話番号を含むレスポンスが含まれているかどうか示します。取りうる値はtrueもしくはfalseです。値が指定されない場合デフォルトはfalseです。結果はローカルの住所が必要な電話番号を含みます。

                                                        ExcludeForeignAddressRequired
                                                        オプション
                                                        GET boolean Not PII

                                                        外国の住所が必要な電話番号を含むレスポンスが含まれているかどうか示します。取りうる値は、trueもしくはfalseです。値が指定されない場合デフォルトはfalseです。結果は外国の住所が必要な電話番号を含みます。

                                                        Beta
                                                        オプション
                                                        GET boolean Not PII

                                                        提供されたばかりのベータの電話番号を含める取りうる値は true もしくは false。デフォルトは true.

                                                        NearNumber
                                                        オプション
                                                        GET phone_number<e164> Not PII

                                                        Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles. Limited to US and Canadian phone numbers.

                                                        NearLatLong
                                                        オプション
                                                        GET 文字列 Not PII

                                                        Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles. Limited to US and Canadian phone numbers.

                                                        Distance
                                                        オプション
                                                        GET integer Not PII

                                                        Specifies the search radius for a Near- query in miles. If not specified this defaults to 25 miles. Maximum searchable distance is 500 miles. Limited to US and Canadian phone numbers.

                                                        InPostalCode
                                                        オプション
                                                        GET 文字列 Not PII

                                                        Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Limited to US and Canadian phone numbers.

                                                        InRegion
                                                        オプション
                                                        GET 文字列 Not PII

                                                        Limit results to a particular region (i.e. State/Province). Given a phone number, search within the same Region as that number. Limited to US and Canadian phone numbers.

                                                        InRateCenter
                                                        オプション
                                                        GET 文字列 Not PII

                                                        Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires InLata to be set as well. Limited to US and Canadian phone numbers.

                                                        InLata
                                                        オプション
                                                        GET 文字列 Not PII

                                                        Limit results to a specific Local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Limited to US and Canadian phone numbers.

                                                        InLocality
                                                        オプション
                                                        GET 文字列 Not PII

                                                        結果を特定の地域(つまり都市)に限定します。 電話番号を指定すると、その番号と同一地域内を検索対象とします。

                                                        FaxEnabled
                                                        オプション
                                                        GET boolean Not PII

                                                        FAX受信に対応するかを示します。 true または false

                                                              
                                                              
                                                              
                                                              

                                                              文字列を指定した着課金方式電話番号の検索

                                                              指定した数字列を含む電話番号を検索します。Contains=866 とすると、数字の 866 を含む着課金方式電話番号がマッチします。866-555-3455 や 888-866-0555 などです。Contains=866***EPIC とすると、数字の 866 で始まり、その後に任意の 3 桁の数字、さらに数字の 3742 (「EPIC」) が続く番号がマッチします。 パターン「STORM」にマッチする着課金方式電話番号を検索する場合は、次のリクエストを発行します。