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?

Authorization Document Resource

Hosted Numbers API is currently in private Developer Preview

An Authorization Document is a resource representing a legally binding document between Twilio and a customer to Authorize Twilio to run SMS traffic on a given set of Phone Numbers.

Hosted Number Orders can be assigned to an Authorization Document detailing which Address a Hosted Number Order is activated with. Once the Authorization Document has been signed, the Hosted Number Orders will then be registered to Twilio for routing capability.

AuthorizationDocument properties

Names in PHP format
sid
sid<PX> Not PII

A 34 character string that uniquely identifies this AuthorizationDocument.

addressSid
sid<AD> Not PII

A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

status
enum:status Not PII

Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

email
文字列 PII MTL: 30 DAYS

Email that this AuthorizationDocument will be sent to for signing.

ccEmails
string[] PII MTL: 30 DAYS

Email recipients who will be informed when an Authorization Document has been sent and signed.

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
date_time<iso8601> Not PII

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

url
url Not PII

links
uri_map Not PII

ステータス値

Status 概要
opened Document is open and mutable.
signing Document has been sent out to the Email for signature and is immutable.
signed Document has been signed by the Email recipient and is immutable.
canceled Document has been canceled by the Email recipient and is immutable.
failed Document has failed with an error and is immutable.

Create an AuthorizationDocument resource

post
https://preview.twilio.com/HostedNumbers/AuthorizationDocuments

Create an Authorization Document for authorizing the hosting of phone numbers' capability on Twilio's platform.

The resource is explicit and all Hosted Number Orders added upon creation are the entire list of numbers that are assigned to the Authorization Document. Once the POST to create a new Authorization Document has been created, the LOA will immediately be sent out for signature.

パラメーター
Names in None format
hosted_number_order_sids
必須
post string[] Not PII

A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.

address_sid
必須
post sid<AD> Not PII

A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

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

Email that this AuthorizationDocument will be sent to for signing.

contact_title
必須
post 文字列 Not PII

The title of the person authorized to sign the Authorization Document for this phone number.

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

The contact phone number of the person authorized to sign the Authorization Document.

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

Email recipients who will be informed when an Authorization Document has been sent and signed.

        
        
        
        

        Fetch an AuthorizationDocument resource

        GET
        https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/{Sid}
        パラメーター
        Names in None format
        sid
        必須
        GET sid<PX> Not PII

        A 34 character string that uniquely identifies this AuthorizationDocument.

              
              
              
              

              Read multiple AuthorizationDocument resources

              GET
              https://preview.twilio.com/HostedNumbers/AuthorizationDocuments
              パラメーター
              Names in None format
              email
              オプション
              GET 文字列 PII MTL: 30 DAYS

              Email that this AuthorizationDocument will be sent to for signing.

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

              Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

                    
                    
                    
                    

                    Update an AuthorizationDocument resource

                    post
                    https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/{Sid}

                    Requests to update a single, existing Authorization Documents instance resource’s properties and returns the updated resource representation if successful.

                    Authorization Documents can only be updated when in opened status. To update the Authorization Document, update the Status to opened.

                    パラメーター
                    Names in None format
                    hosted_number_order_sids
                    オプション
                    post string[] Not PII

                    A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.

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

                    A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

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

                    Email that this AuthorizationDocument will be sent to for signing.

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

                    Email recipients who will be informed when an Authorization Document has been sent and signed

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

                    Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

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

                    The title of the person authorized to sign the Authorization Document for this phone number.

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

                    The contact phone number of the person authorized to sign the Authorization Document.

                          
                          
                          
                          
                          Rate this page:

                          ヘルプが必要ですか?

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