Path parameters

• SigningDocumentSid string Required

  A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.

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

Query parameters

• 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 received, pending-verification, verified, pending-loa, carrier-processing, testing, completed, failed, or action-required.

• PhoneNumber string(phone-number)

  An E164 formatted phone number hosted by this HostedNumberOrder.

• IncomingPhoneNumberSid string

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

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

• FriendlyName string

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

• UniqueName string

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

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  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

  • items array[object]
    Hide items attributes Show items attributes object

    • sid string | null

      A 34 character string that uniquely identifies this Authorization Document

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

    • account_sid string | null

      The unique SID identifier of the Account.

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

    • incoming_phone_number_sid string | null

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

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

    • address_sid string | null

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

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

    • signing_document_sid string | null

      A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.

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

    • phone_number string(phone-number) | null

      An E164 formatted phone number hosted by this HostedNumberOrder.

    • capabilities object(phone-number-capabilities) | null

      A mapping of capabilities this hosted phone number will have enabled on Twilio's platform.

      Hide capabilities attributes Show capabilities attributes object(phone-number-capabilities) | null

      • mms boolean
      • sms boolean
      • voice boolean
      • fax boolean
    • friendly_name string | null

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

    • unique_name string | null

      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 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 received, pending-verification, verified, pending-loa, carrier-processing, testing, completed, failed, or action-required.

    • failure_reason string | null

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

    • 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.

    • verification_attempts integer

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

      Default value is 0.

    • email string | null

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

    • cc_emails array[string] | null

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

    • verification_type string

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

      Values are phone-call or phone-bill.

    • verification_document_sid string | null

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

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

    • extension string | null

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

    • call_delay integer

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

      Default value is 0.

    • verification_code string | null

      The digits passed during the ownership verification call.

    • verification_call_sids array[string] | null

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

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)