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: アドレス

Addressインスタンスリソースは、お客様またはエンドユーザーの国内における実際の所在地です。 電話番号を購入および所有するにあたってTwilioにユーザーの名称と住所を届け出ることが、一部の地域の当局において義務付けられています。 Addressの要件については、AvailablePhoneNumberリソースのプロパティーとして公開されています。

Addressには、所在地情報およびオプションで分かりやすい名前に加え、所在地お客様またはエンドユーザーの会社名が含まれます。 アカウント、またはサブアカウント上で作成された各Addressはそのアカウントで購入される電話番号に使用されます。 Addressの作成後は、複数の電話番号およびIncomingPhoneNumberリソースを使用して購入可能なAddressの要件を持つ電話番号の要件を満たすために使用されます。

In some countries, to comply with local regulation, addresses are validated to ensure the integrity and accuracy of the data provided. In those countries, if the address you provide does not pass validation, it is not accepted as an Address and error code 21628 is returned. If the address submitted is not an exact match but is similar to a valid address, we’ll create the Address using the valid address we found, unless you include the AutoCorrectAddress=false parameter in the request. In that case, we’ll provide it as a suggested address in error code 21629. If the suggested address is indeed the address of your company or your customer’s company, then use the suggested format to create a valid Address.

アドレスリストリソースはTwilioアカウントに作成されたすべてのアドレスのリストを表します。Addresses に POSTすることにより、新しい住所を作成・現存の住所を修正できます。

Address properties

Names in PHP format
accountSid
sid<AC> Not PII

The SID of the Account that is responsible for the Address resource.

city
文字列 Not PII

The city in which the address is located.

customerName
文字列 PII MTL: 30 DAYS

The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.

dateCreated
date_time<rfc2822> Not PII

The date and time in GMT that the resource was created specified in RFC 2822 format.

dateUpdated
date_time<rfc2822> Not PII

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

friendlyName
文字列 PII MTL: 30 DAYS

The string that you assigned to describe the resource.

isoCountry
iso_country_code Not PII

The ISO country code of the address.

postalCode
文字列 PII MTL: 30 DAYS

The postal code of the address.

region
文字列 Not PII

The state or region of the address.

sid
sid<AD> Not PII

The unique string that that we created to identify the Address resource.

street
文字列 PII MTL: 30 DAYS

The number and street address of the address.

uri
uri Not PII

The URI of the resource, relative to https://api.twilio.com.

emergencyEnabled
boolean Not PII

Whether emergency calling has been enabled on this number.

validated
boolean Not PII

Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been validated. false indicate the country doesn't require validation or the Address is not valid.

verified
boolean Not PII

Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been verified. false indicate the country doesn't require verified or the Address is not valid.

Create an Address resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses.json

新しいアドレスを作成します

パラメーター
Names in None format
account_sid
必須
post sid<AC> Not PII

The SID of the Account that will be responsible for the new Address resource.

customer_name
必須
post 文字列 PII MTL: 30 DAYS

The name to associate with the new address.

street
必須
post 文字列 PII MTL: 30 DAYS

The number and street address of the new address.

city
必須
post 文字列 Not PII

The city of the new address.

region
必須
post 文字列 Not PII

The state or region of the new address.

postal_code
必須
post 文字列 PII MTL: 30 DAYS

The postal code of the new address.

iso_country
必須
post iso_country_code Not PII

The ISO country code of the new address.

friendly_name
オプション
post 文字列 PII MTL: 30 DAYS

A descriptive string that you create to describe the new address. It can be up to 64 characters long.

emergency_enabled
オプション
post boolean Not PII

Whether to enable emergency calling on the new address. Can be: true or false.

auto_correct_address
オプション
post boolean Not PII

Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.

例 1
        
        
        
        

        リクエストが成功すると、Twilio は新しいアドレスを返します。

        Address検証関連のエラー

        エラー コード エラー名 エラーの説明
        21615 電話番号にはローカルアドレスが必要です この番号を購入するには、アカウントに現地の住所要件を満たした住所を持っていることが必要です。
        21628 アドレス検証エラー 指定されたAddressが検証できません。
        21629 アドレス検証エラー - 推奨されたアドレスを確認してください 指定されたAddressが検証できません。同様のアドレスが有効なものとして見つかりました。 推奨されるアドレスはエラーメッセージ本文に含まれます。

        Fetch an Address resource

        GET
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json
        パラメーター
        Names in None format
        account_sid
        必須
        GET sid<AC> Not PII

        The SID of the Account that is responsible for the Address resource to fetch.

        sid
        必須
        GET sid<AD> Not PII

        The Twilio-provided string that uniquely identifies the Address resource to fetch.

        例 1
              
              
              
              

              Read multiple Address resources

              GET
              https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses.json

              Returns a list of Address resource representations, each representing an address within your account. The list includes [paging information][paging-info].

              パラメーター
              Names in None format
              account_sid
              必須
              GET sid<AC> Not PII

              The SID of the Account that is responsible for the Address resource to read.

              customer_name
              オプション
              GET 文字列 PII MTL: 30 DAYS

              The customer_name of the Address resources to read.

              friendly_name
              オプション
              GET 文字列 PII MTL: 30 DAYS

              The string that identifies the Address resources to read.

              iso_country
              オプション
              GET iso_country_code Not PII

              The ISO country code of the Address resources to read.

              例 1
                    
                    
                    
                    
                    例 2
                          
                          
                          
                          
                          例 3
                                
                                
                                
                                
                                Show all phone numbers on your account that require the address `AD2a0747eba6abf96b7e3c3ff0b4530f6e`

                                List Dependent PNS Subresources

                                Show all phone numbers on your account that require the address `AD2a0747eba6abf96b7e3c3ff0b4530f6e`
                                GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json
                                

                                あなたのアカウントにあるIncomingPhoneNumbers で住所の特定を必要とする番号のリストを返します。

                                Dependent Phone Number インスタンスリソース

                                それぞれのアドレスインスタンスリソースは、どの番号が住所を必要としているのか閲覧するためのサブリソースをサポートします。電話番号の要件を満たす2つの住所を持っている場合、このサブリソースは電話番号をリストに表示しません。

                                ページング

                                このリストは ページ情報を 含みます。一つのページにレコードを入れようと計画している場合、ページバゴン号を増やして対応するよりも、nextpageuri を使ってください。nextpageuriを使用すると、次の要求はそれが中断したところからピックアップできます。あなたが積極的にアドレスを作成する場合、重複するデータを検索するのを防ぐことができようにすることができます。

                                Update an Address resource

                                post
                                https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json

                                POSTリクエストが成功すると、現住所をアップデートしアップデートされた情報を返します。HTTP GET と同じリターンコードを返します。

                                注 : IsoCountryもPOSTリクエストで変更できます。IsoCountryをアップデートするためには新しいアドレスが作成される必要があります。

                                パラメーター
                                Names in None format
                                account_sid
                                必須
                                post sid<AC> Not PII

                                The SID of the Account that is responsible for the Address resource to update.

                                sid
                                必須
                                post sid<AD> Not PII

                                The Twilio-provided string that uniquely identifies the Address resource to update.

                                friendly_name
                                オプション
                                post 文字列 PII MTL: 30 DAYS

                                A descriptive string that you create to describe the address. It can be up to 64 characters long.

                                customer_name
                                オプション
                                post 文字列 PII MTL: 30 DAYS

                                The name to associate with the address.

                                street
                                オプション
                                post 文字列 PII MTL: 30 DAYS

                                The number and street address of the address.

                                city
                                オプション
                                post 文字列 Not PII

                                The city of the address.

                                region
                                オプション
                                post 文字列 Not PII

                                The state or region of the address.

                                postal_code
                                オプション
                                post 文字列 PII MTL: 30 DAYS

                                The postal code of the address.

                                emergency_enabled
                                オプション
                                post boolean Not PII

                                Whether to enable emergency calling on the address. Can be: true or false.

                                auto_correct_address
                                オプション
                                post boolean Not PII

                                Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.

                                例 1
                                      
                                      
                                      
                                      
                                      名前と番地をそれぞれ ‘Customer 456’ と ‘2 Hasselhoff Lane’ に変更します。

                                      Update a customer name and street address

                                      名前と番地をそれぞれ ‘Customer 456’ と ‘2 Hasselhoff Lane’ に変更します。

                                      Delete an Address resource

                                      削除する
                                      https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json

                                      アドレスを削除します。

                                      If this address is required for any active IncomingPhoneNumbers, it cannot be deleted and you will receive Error [21625][21625]. However, if you have a second address that fulfills the AddressRequirement, the address will be successfully deleted. The DependentPhoneNumbers Instance Subresource will allow you to see which IncomingPhoneNumbers require a given address.

                                      削除に成功すると、本文(Body)のない HTTP 204 レスポンスを返します。

                                      パラメーター
                                      Names in None format
                                      account_sid
                                      必須
                                      削除する sid<AC> Not PII

                                      The SID of the Account that is responsible for the Address resource to delete.

                                      sid
                                      必須
                                      削除する sid<AD> Not PII

                                      The Twilio-provided string that uniquely identifies the Address resource to delete.

                                      例 1
                                            
                                            
                                            
                                            
                                            Rate this page:

                                            ヘルプが必要ですか?

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