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

**POST /HostedNumbers/HostedNumberOrders**

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


## Servers
- https://preview.twilio.com: https://preview.twilio.com ()


## Authentication methods
- Account sid auth token


## Parameters



### Body: application/x-www-form-urlencoded (object)

- **PhoneNumber** (string(phone-number))
  The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format
- **SmsCapability** (boolean)
  Used to specify that the SMS capability will be hosted on Twilio's platform.
- **AccountSid** (string)
  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.
- **FriendlyName** (string)
  A 64 character string that is a human readable text that describes this resource.
- **UniqueName** (string)
  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.
- **CcEmails** (array[string])
  Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.
- **SmsUrl** (string(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** (string(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.
- **SmsFallbackUrl** (string(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** (string(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.
- **StatusCallbackUrl** (string(uri))
  Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.
- **StatusCallbackMethod** (string(http-method))
  Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.
- **SmsApplicationSid** (string)
  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.
- **AddressSid** (string)
  Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
- **Email** (string)
  Optional. Email of the owner of this phone number that is being hosted.
- **VerificationType** (string)
  The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`.
- **VerificationDocumentSid** (string)
  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.


## Responses
### 201
Created
#### Headers
- **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

#### Body: application/json (object)
- **sid** (string | null)
  A 34 character string that uniquely identifies this HostedNumberOrder.
- **account_sid** (string | null)
  A 34 character string that uniquely identifies the account.
- **incoming_phone_number_sid** (string | null)
  A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted.
- **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.
- **signing_document_sid** (string | null)
  A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign.
- **phone_number** (string(phone-number) | null)
  Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212
- **capabilities** (object(phone-number-capabilities) | null)
  Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported.
- **friendly_name** (string | null)
  A 64 character string that is a human-readable text that describes this resource.
- **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 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](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) section for more information on each of these statuses.
- **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](http://www.ietf.org/rfc/rfc2822.txt) format.
- **date_updated** (string(date-time) | null)
  The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
- **verification_attempts** (integer)
  The number of attempts made to verify ownership of the phone number that is being hosted.
- **email** (string | null)
  Email of the owner of this phone number that is being hosted.
- **cc_emails** (array[string] | null)
  A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.
- **url** (string(uri) | null)
  The URL of this HostedNumberOrder.
- **verification_type** (string)
  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_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.
- **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.
- **verification_code** (string | null)
  A verification code provided in the response for a user to enter when they pick up the phone 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.


[Powered by Bump.sh](https://bump.sh)