Sign in
NumbersV2HostedNumberOrder

Updates a specific HostedNumberOrder.

Updates a specific HostedNumberOrder.

post/v2/HostedNumber/Orders/{Sid}

Path parameters

Sidstring required

The SID of the HostedNumberOrder resource to update.

Response

OK

sidstring nullable

A 34 character string that uniquely identifies this HostedNumberOrder.

account_sidstring nullable

A 34 character string that uniquely identifies the account.

incoming_phone_number_sidstring nullable

A 34 character string that uniquely identifies the IncomingPhoneNumber resource that represents the phone number being hosted.

address_sidstring nullable

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

signing_document_sidstring nullable

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

phone_numberstring phone-number nullable

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

friendly_namestring nullable

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

status'twilio-processing' | 'received' | 'pending-verification' | 'verified' | 'pending-loa' | 'carrier-processing' | 'testing' | 'completed' | 'failed' | 'action-required'

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.

failure_reasonstring nullable

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

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

emailstring nullable

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

cc_emailsstring[] nullable

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

urlstring uri nullable

The URL of this HostedNumberOrder.

contact_titlestring nullable

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

contact_phone_numberstring phone-number nullable

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

bulk_hosting_request_sidstring nullable

A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.

next_stepstring nullable

The next step you need to take to complete the hosted number order and request it successfully.

verification_attemptsinteger

The number of attempts made to verify ownership via a call for the hosted phone number.

verification_call_sidsstring[] nullable

The Call SIDs that identify the calls placed to verify ownership.

verification_call_delayinteger

The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.

verification_call_extensionstring nullable

The numerical extension to dial when making the ownership verification call.

verification_codestring nullable

The digits the user must pass in the ownership verification call.

verification_type'phone-call'

The method used to verify ownership of the number to be hosted. Can be: phone-call or phone-bill and the default is phone-call.

Changes

Changed in 2 of the 53 revisions of this API.23

  • v2837f4d2978ba22See the full diff
    • ●

      added the new testing enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new twilio-processing enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new testing enum value to the request property

      request-property-enum-value-added

    • ○

      added the new twilio-processing enum value to the request property

      request-property-enum-value-added

  • v28f940ec3f3851See the full diff
    • ○

      endpoint added

      endpoint-added