Authorization Document Resource
The Hosted Phone Numbers API is currently in development and not intended for use by new customers. This documentation exists to support customers who are already using the API. A new version of this API will be released as a generally available (GA) product in the near future. New customers should wait for the Hosted Phone Numbers GA release.
An Authorization Document is a resource representing a legally binding document between Twilio and a customer to Authorize Twilio to run messaging 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
| Resource Properties in REST API format | |
|---|---|
sid
|
A 34 character string that uniquely identifies this AuthorizationDocument. |
address_sid
|
A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument. |
status
|
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
|
Email that this AuthorizationDocument will be sent to for signing. |
cc_emails
|
Email recipients who will be informed when an Authorization Document has been sent and signed. |
date_created
|
The date this resource was created, given as GMT RFC 2822 format. |
date_updated
|
The date that this resource was updated, given as GMT RFC 2822 format. |
url
|
|
links
|
|
Status Values
| Status | Description |
|---|---|
| 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
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.
Parameters
| Parameters in REST API format | |
|---|---|
hosted_number_order_sids
Required
|
A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform. |
address_sid
Required
|
A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument. |
email
Required
|
Email that this AuthorizationDocument will be sent to for signing. |
contact_title
Required
|
The title of the person authorized to sign the Authorization Document for this phone number. |
contact_phone_number
Required
|
The contact phone number of the person authorized to sign the Authorization Document. |
cc_emails
Optional
|
Email recipients who will be informed when an Authorization Document has been sent and signed. |
Example 1
Fetch an AuthorizationDocument resource
https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
A 34 character string that uniquely identifies this AuthorizationDocument. |
Example 1
Read multiple AuthorizationDocument resources
https://preview.twilio.com/HostedNumbers/AuthorizationDocuments
Parameters
| Parameters in REST API format | |
|---|---|
email
Optional
|
Email that this AuthorizationDocument will be sent to for signing. |
status
Optional
|
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. |
Example 1
Update an AuthorizationDocument resource
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.
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
A 34 character string that uniquely identifies this AuthorizationDocument. |
hosted_number_order_sids
Optional
|
A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform. |
address_sid
Optional
|
A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument. |
email
Optional
|
Email that this AuthorizationDocument will be sent to for signing. |
cc_emails
Optional
|
Email recipients who will be informed when an Authorization Document has been sent and signed |
status
Optional
|
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
Optional
|
The title of the person authorized to sign the Authorization Document for this phone number. |
contact_phone_number
Optional
|
The contact phone number of the person authorized to sign the Authorization Document. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
