メニュー

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: Hosted Number Orders

Hosted Numbers API is currently in Private Developer Preview

The Hosted Number Orders product allows an account to request for their phone numbers to be hosted on Twilio for SMS. Start the Hosted Number onboarding process by sending a POST to the list resource, which will create a new request to host a phone number, or move the Hosted Number Order along the onboarding process by updating the status of the Hosted Number Orders Instance Resource. Upon creation of a Hosted Number Order instance resource, a corresponding IncomingPhoneNumbers instance resource will also be created. Currently, Twilio only has the ability to onboard landline or toll-free US & Canada numbers that are not currently SMS enabled.

After the number's ownership has been verified, the user will then need to create a new Authorization Document that is electronically signed, giving Twilio permission to route SMS to and from Twilio's network. To see how to interact with the Authorization Documents resource, please visit the Public API reference.

Once the process is completed, users will be able to answer phone calls on their existing infrastructure and leverage the same number identity for two-way SMS on Twilio's platform.

Hosted Number Orders Instance Resource

The Hosted Number Orders instance resource represents a request to host a phone number's capability on Twilio's platform.

リソースURI

preview.twilio.com/HostedNumbers/HostedNumberOrders/{HostedNumberOrderSid}

リソースのプロパティ

Names in PHP format
sid
sid<HR> Not PII

このHostedNumberOrderを一意に識別する34文字の文字列です。

accountSid
sid<AC> Not PII

アカウントを一意に識別する34文字の文字列です。

incomingPhoneNumberSid
sid<PN> Not PII

ホストされる電話番号を表すIncomingPhoneNumberリソースを一意に識別する34文字の文字列です。

addressSid
sid<AD> Not PII

A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

signingDocumentSid
sid<PX> Not PII

A 34 character string that uniquely identifies the Authorization Document the user needs to sign.

phoneNumber
phone_number<e164> Not PII

Phone number to be hosted. This must be in E.164 format, e.g., +16175551212

capabilities
phone_number_capabilities Not PII

Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported.

friendlyName
文字列 PII MTL: 30 DAYS

A 64 character string that is a human-readable text that describes this resource.

uniqueName
文字列 PII MTL: 30 DAYS

Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

status
enum:status Not PII

Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the HostedNumberOrders Status Values section for more information on each of these statuses.

failureReason
文字列 Not PII

A message that explains why a hosted_number_order went to status "action-required"

dateCreated
date_time<iso8601> Not PII

このリソースが作成された日付で、GMT RFC 2822形式で返されます。

dateUpdated
date_time<iso8601> Not PII

このリソースが更新された日付で、GMT RFC 2832形式が使用されます。

verificationAttempts
integer Not PII

The number of attempts made to verify ownership of the phone number that is being hosted.

email
文字列 PII MTL: 30 DAYS

Email of the owner of this phone number that is being hosted.

ccEmails
string[] PII MTL: 30 DAYS

A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.

url
url Not PII

The URL of this HostedNumberOrder.

verificationType
enum:verification_type Not PII

The type of ownership verification required to move the number to a verified state. The verification methods are phone-call or phone-bill.

verificationDocumentSid
sid<RI> Not PII

A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.

extension
文字列 Not PII

A numerical extension to be used when making the ownership verification call.

callDelay
integer Not PII

A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.

verificationCode
文字列 Not PII

A verification code provided in the response for a user to enter when they pick up the phone call.

verificationCallSids
string[] Not PII

A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.

HostedNumberOrdersステータス値

Status 概要
twilio-processing Twilio is processing your request and will either send to the failed status if the number is not eligible to be hosted, or move the number to received status.
received TwilioはHostedNumberOrderリクエストを受信し、リクエスト中の電話番号がTwilioのプラットフォーム上でホスト可能であると判断しました。
pending-verification Twilio is awaiting the Hosted Number Order to be verified by the end-user by picking up the phone and listening to a security token, or supplying a copy of the phone bill. The verification code is valid for 10 minutes. Subsequent calls to the API within the expiration time will send the same verification code. There can be a max of three verification attempts before the status changes to action_required.
検証済み Twilioはセキュリティートークンによってその電話に出た個人がSMSをホストするリクエストを検証したことを確認しました。
pending-loa HostedNumberOrder用の委任状が生成されましたが、ドキュメントがHostedNumberOrdrで指定されたメール受信者によって署名されていません。
carrier-processing HostedNumberOrderに対する委任状が署名され、電話番号はTwilioの契約しているプロバイダーまたはキャリアーに対して指定された機能をオンにするよう申請しました。
testing 電話番号はこのオーダーで指定された機能に対するケイパビリティーテストを実行中です。
completed HostedNumberOrderのオンボーディングが完了し、電話番号の使用準備が整いました。
action-required HostedNumberOrderのオンボーディングが失敗しました。 オペレーションスペシャリストが失敗について調査を行います。
failed The Hosted Number Order failed because the number is currently SMS enabled or has been idle for more than 30 days. At this point, it is no longer possible to re-submit the request for the failed Hosted Number Order. However, a new Hosted Number Order can be created for the same phone number once SMS registration has been deactivated on the phone number or the previous Hosted Number Order has failed due to being idle.

HostedNumberOrdersステータスコールバック

StatusCallbackURLをAPIリクエストに指定している場合、Hosted Number Ordersのステータスが変化すると、Twilioは非同期のHTTPリクエストをそのURLに送信します。 このリクエストを捕捉することで、Hosted Number Ordersのステータスが変化したことを知ることができます。

The Hosted Number Orders status callback request passes the additional parameters listed in the table below:

Status 概要
Status Hosted Number Orderの新しいステータスです
HostedNumberOrderSid Hosted Number Orderの一意なSIDです。
PhoneNumber The +E.164 format of the Hosted Number Order

HTTP GET

リクエストされたHosted Number OrdersインスタンスリソースSIDによって指定された、単一の既存Hosted Number Ordersインスタンスリソースを返します。

        
        
        
        

        HTTP POST

        単一の、既に存在するHosted Number Ordersインスタンスリソースのプロパティーの更新を試み、成功した場合は更新済みリソースの表現を返します。 返されたレスポンスはGETリクエストの発行時に上記で返されたものと同一です。

        HostedNumberOrdersインスタンスPOSTオプションパラメーター

        Names in PHP format
        friendlyName
        オプション
        post 文字列 PII MTL: 30 DAYS

        このリソースを表す最大64文字の人間にとって読み取りやすい文字列です。

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

        Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

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

        Email of the owner of this phone number that is being hosted.

        ccEmails
        オプション
        post string[] PII MTL: 30 DAYS

        Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.

        status
        オプション
        post enum:status Not PII

        User can only post to pending-verification status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill.

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

        ホストされる電話番号への通話でユーザーに通知される検証コードです。

        verificationType
        オプション
        post enum:verification_type Not PII

        Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.

        verificationDocumentSid
        オプション
        post sid<RI> Not PII

        Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.

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

        バリデーションの電話が接続された後にダイヤルする数字です。

        callDelay
        オプション
        post integer Not PII

        バリデーションの電話をかける前の遅延を、0 から 60 までの秒数で指定します。 初期値は 0 です。

              
              
              
              
              レスポンス

              返却されるレスポンスはGETリクエストの送信時に返却されるものと同一です。

                    
                    
                    
                    
                          
                          
                          
                          
                          Ownership Verification

                          Ownership Verification is a security measure to host the number with Twilio for SMS to ensure the authenticity of the request.

                          HTTP DELETE

                          Cancels the Hosted Number Order, and consequently, deletes the corresponding Incoming Phone Number.

                          Note: you can only issue the DELETE request when the HostedNumberOrder status is in received, pending-verification, verified or pending-loa. If the Hosted Number Order is completed, you can off-board the Twilio platform by issuing a DELETE request to the corresponding IncomingPhoneNumbers. If the Hosted Number Order is in a failed state due to either current SMS enablement or idle timeout, a new Hosted Number Order can be created. Please note that the Hosted Number Order will keep failing if SMS enablement is not removed from the number.

                                
                                
                                
                                
                                レスポンス

                                リクエストが成功すると、レスポンスBodyのないHTTP 204が返されます。

                                HostedNumberOrdersリストリソース

                                The HostedNumberOrders list resource represents the list of active and completed or failed Hosted Number Orders for the account.

                                リソースURI

                                preview.twilio.com/HostedNumbers/HostedNumberOrders/
                                

                                リストフィルター

                                Names in PHP format
                                status
                                オプション
                                GET enum:status Not PII

                                The Status of this HostedNumberOrder. One of received, pending-verification, verified, pending-loa, carrier-processing, testing, completed, failed, or action-required.

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

                                An E164 formatted phone number hosted by this HostedNumberOrder.

                                incomingPhoneNumberSid
                                オプション
                                GET sid<PN> Not PII

                                A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

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

                                A human readable description of this resource, up to 64 characters.

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

                                Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

                                HTTP GET

                                Retrieves a list of all Hosted Number Orders for an account.

                                      
                                      
                                      
                                      
                                      レスポンス

                                      上記のインスタンスレスポンスの一覧です。

                                      HTTP POST

                                      Creates a new Hosted Number Order for the specified capability. Currently, only SMS is a supported capability.

                                      パラメーター

                                      Names in PHP format
                                      accountSid
                                      オプション
                                      post sid<AC> Not PII

                                      ユーザーが認証に使用しているアカウントSIDが既定値になります。 ここにはHostedNumberOrderを追加するサブアカウントを指定できます。

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

                                      このリソースを表す最大64文字の人間にとって読み取りやすい文字列です。

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

                                      Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

                                      ccEmails
                                      オプション
                                      post string[] PII MTL: 30 DAYS

                                      Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.

                                      smsUrl
                                      オプション
                                      post url Not PII

                                      電話番号にSMSが送信された時にTwilioがリクエストすべきURLです。 これはIncomingPhoneNumberにコピーされます。

                                      smsMethod
                                      オプション
                                      post http_method Not PII

                                      SmsUrlへのリクエストに使用されるHTTPメソッドです。 GETまたはPOSTのいずれかでなければなりません。 これはIncomingPhoneNumberにコピーされます。

                                      smsFallbackUrl
                                      オプション
                                      post url Not PII

                                      SmsUrlで定義されたTwiMLのリクエストまたは実行にエラーが発生した際にTwilioがリクエストを行うURLです。 これはIncomingPhoneNumberにコピーされます。

                                      smsFallbackMethod
                                      オプション
                                      post http_method Not PII

                                      SmsFallbackUrlへのリクエストに使用されるHTTPメソッドです。 GETまたはPOSTのいずれかでなければなりません。これはIncomingPhoneNumberにコピーされます。

                                      statusCallbackUrl
                                      オプション
                                      post url Not PII

                                      Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.

                                      statusCallbackMethod
                                      オプション
                                      post http_method Not PII

                                      Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.

                                      smsApplicationSid
                                      オプション
                                      post sid<AP> Not PII

                                      Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a SmsApplicationSid is present, Twilio will ignore all of the SMS urls above and use those set on the application.

                                      addressSid
                                      オプション
                                      post sid<AD> Not PII

                                      Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

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

                                      Optional. Email of the owner of this phone number that is being hosted.

                                      verificationType
                                      オプション
                                      post enum:verification_type Not PII

                                      Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.

                                      verificationDocumentSid
                                      オプション
                                      post sid<RI> Not PII

                                      Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.

                                      phoneNumber
                                      必須
                                      post phone_number<e164> Not PII

                                      The number to host in +E.164 format

                                      smsCapability
                                      必須
                                      post boolean Not PII

                                      Used to specify that the SMS capability will be hosted on Twilio's platform.

                                            
                                            
                                            
                                            
                                            レスポンス

                                            返されるレスポンスは、HostedNumberOrdersインスタンスリソースへのGETリクエストの送信時に返されるものと同一です。

                                            Rate this page:

                                            ヘルプが必要ですか?

                                            We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.