TWtwilio
PreviewHostedNumbersHostedNumberOrder

Host a phone number's capability on Twilio's platform.

Host a phone number's capability on Twilio's platform.

post/HostedNumbers/HostedNumberOrders

Request

  • Base URL
    https://preview.twilio.com
  • URL
    https://preview.twilio.com/HostedNumbers/HostedNumberOrders
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

PhoneNumberstring phone-number required

The number to host in +E.164 format

SmsCapabilityboolean required

Used to specify that the SMS capability will be hosted on Twilio's platform.

AccountSidstring

This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.

FriendlyNamestring

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

UniqueNamestring

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

CcEmailsstring[]

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

SmsUrlstring uri

The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.

SmsMethod'GET' | 'POST' http-method

The HTTP method that should be used to request the SmsUrl. Must be either GET or POST. This will be copied onto the IncomingPhoneNumber resource.

SmsFallbackUrlstring uri

A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.

SmsFallbackMethod'GET' | 'POST' http-method

The HTTP method that should be used to request the SmsFallbackUrl. Must be either GET or POST. This will be copied onto the IncomingPhoneNumber resource.

StatusCallbackUrlstring uri

Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.

StatusCallbackMethod'GET' | 'POST' http-method

Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.

SmsApplicationSidstring

Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a SmsApplicationSid is present, Twilio will ignore all of the SMS urls above and use those set on the application.

AddressSidstring

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

Emailstring

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

VerificationType'phone-call' | 'phone-bill'

The type of ownership verification required to move the number to a verified state. The verification methods are phone-call or phone-bill.

VerificationDocumentSidstring

Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.

Response

Created

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 64 character string that is a human-readable text that describes this resource.

unique_namestring nullable

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

verification_attemptsinteger

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

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.

verification_type'phone-call' | 'phone-bill'

The type of ownership verification required to move the number to a verified state. The verification methods are phone-call or phone-bill.

verification_document_sidstring nullable

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

extensionstring nullable

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

call_delayinteger

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

verification_codestring nullable

A verification code provided in the response for a user to enter when they pick up the phone call.

verification_call_sidsstring[] nullable

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

Changes

No operation changes recorded.