Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.

POST /HostedNumbers/AuthorizationDocuments
Account sid auth token

Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.

application/x-www-form-urlencoded

Body

  • HostedNumberOrderSids array[string] Required

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

  • AddressSid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AD[0-9a-fA-F]{32}$.

  • Email string Required

    Email that this AuthorizationDocument will be sent to for signing.

  • ContactTitle string Required

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

  • ContactPhoneNumber string Required

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

  • CcEmails array[string]

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

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

      A 34 character string that uniquely identifies this AuthorizationDocument.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PX[0-9a-fA-F]{32}$.

    • address_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AD[0-9a-fA-F]{32}$.

    • status string

      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.

      Values are opened, signing, signed, canceled, or failed.

    • email string | null

      Email that this AuthorizationDocument will be sent to for signing.

    • cc_emails array[string] | null

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

    • date_created string(date-time) | null

      The date this resource was created, given as GMT RFC 2822 format.

    • date_updated string(date-time) | null

      The date that this resource was updated, given as GMT RFC 2822 format.

    • url string(uri) | null
    • links object(uri-map) | null
POST /HostedNumbers/AuthorizationDocuments 
curl \
 --request POST 'https://preview.twilio.com/HostedNumbers/AuthorizationDocuments' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Email=test%2Bhosted%40twilio.com&CcEmails=test1%40twilio.com&CcEmails=test2%40twilio.com&AddressSid=ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ContactTitle=Mr.&ContactPhoneNumber=%2B14155555555&HostedNumberOrderSids=HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01&HostedNumberOrderSids=HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02'
Request example 
{"Email" => "test+hosted@twilio.com", "CcEmails" => ["test1@twilio.com", "test2@twilio.com"], "AddressSid" => "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "ContactTitle" => "Mr.", "ContactPhoneNumber" => "+14155555555", "HostedNumberOrderSids" => ["HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02"]}
Response examples (201) 
{
  "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "email": "test+hosted@twilio.com",
  "links": {
    "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders"
  },
  "status": "signing",
  "cc_emails": [
    "test1@twilio.com",
    "test2@twilio.com"
  ],
  "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2017-03-28T20:06:39Z",
  "date_updated": "2017-03-28T20:06:39Z"
}