Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Hosted Number Order Resource


(error)

Danger

The Hosted Phone Numbers API is currently in development and not intended for use by new customers. This documentation exists to support customers who are already using the API. A new version of this API will be released as a generally available (GA) product in the near future. New customers should wait for the Hosted Phone Numbers GA release.

The Hosted Number Orders product allows an account to request for their phone numbers to be hosted on Twilio for SMS. Start the Hosted Number onboarding process by sending a POST to the list resource, which will create a new request to host a phone number, or move the Hosted Number Order along the onboarding process by updating the status of the Hosted Number Orders Instance Resource. Upon creation of a Hosted Number Order instance resource, a corresponding IncomingPhoneNumbers instance resource will also be created. Currently, Twilio only has the ability to onboard landline or toll-free US & Canada numbers that are not currently SMS enabled.

After the number's ownership has been verified, the user will then need to create a new Authorization Document that is electronically signed, giving Twilio permission to route SMS to and from Twilio's network. To see how to interact with the Authorization Documents resource, please visit the Public API reference.

Once the process is completed, users will be able to answer phone calls on their existing infrastructure and leverage the same number identity for two-way SMS on Twilio's platform.


HostedNumberOrder Properties

hostednumberorder-properties page anchor
Resource properties
sidtype: SID<HR>Not PII

A 34 character string that uniquely identifies this HostedNumberOrder.


account_sidtype: SID<AC>Not PII

A 34 character string that uniquely identifies the account.


incoming_phone_number_sidtype: SID<PN>Not PII

address_sidtype: SID<AD>Not PII

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


signing_document_sidtype: SID<PX>Not PII

A 34 character string that uniquely identifies the Authorization Document(link takes you to an external page) the user needs to sign.


phone_numbertype: string<PHONE NUMBER>Not PII

Phone number to be hosted. This must be in E.164(link takes you to an external page) format, e.g., +16175551212


capabilitiestype: object<PHONE NUMBER CAPABILITIES>Not PII

Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported.


friendly_nametype: stringPII MTL: 30 days

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


unique_nametype: stringPII MTL: 30 days

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


statustype: enum<STRING>Not PII

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(link takes you to an external page) section for more information on each of these statuses.

Possible values:
receivedpending-verificationverifiedpending-loacarrier-processingtestingcompletedfailedaction-required

failure_reasontype: stringNot PII

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


date_createdtype: string<DATE TIME>Not PII

The date this resource was created, given as GMT RFC 2822(link takes you to an external page) format.


date_updatedtype: string<DATE TIME>Not PII

The date that this resource was updated, given as GMT RFC 2822(link takes you to an external page) format.


verification_attemptstype: integerNot PII

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


emailtype: stringPII MTL: 30 days

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


cc_emailstype: string[]PII MTL: 30 days

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


urltype: string<URI>Not PII

The URL of this HostedNumberOrder.


verification_typetype: enum<STRING>Not PII

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

Possible values:
phone-callphone-bill

verification_document_sidtype: SID<RI>Not PII

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


extensiontype: stringNot PII

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


call_delaytype: integerNot PII

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


verification_codetype: stringNot PII

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


verification_call_sidstype: string[]Not PII

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


StatusDescription
twilio-processingTwilio is processing your request and will either send to the failed status if the number is not eligible to be hosted, or move the number to received status.
receivedTwilio has received the HostedNumberOrder request and determined that the phone number in the request can be hosted on Twilio's platform.
pending-verificationTwilio is awaiting the Hosted Number Order to be verified by the end-user by picking up the phone and listening to a security token. The verification code is valid for 10 minutes. Subsequent calls to the API within the expiration time will send the same verification code. There can be a max of three verification attempts before the status changes to action_required.
verifiedTwilio has confirmed with a security token that the person answering the phone has verified their request for Hosted SMS.
pending-loaLOA for the HostedNumberOrder has been generated, but the document has not yet been signed by the email recipient specified on the HostedNumberOrder.
carrier-processingLOA for the HostedNumberOrder has been signed, and the phone number has been submitted to Twilio's underlying provider/carrier to enable the specified capabilities.
testingThe phone number is undergoing capability testing for the capabilities specified in this order.
completedHostedNumberOrder onboarding has completed and the phone number is ready for use.
action-requiredHostedNumberOrder onboarding encountered a failure. An operations specialist will investigate the failure.
failedThe Hosted Number Order failed because the number is currently SMS enabled or has been idle for more than 30 days. At this point, it is no longer possible to re-submit the request for the failed Hosted Number Order. However, a new Hosted Number Order can be created for the same phone number once SMS registration has been deactivated on the phone number or the previous Hosted Number Order has failed due to being idle.

HostedNumberOrders Status Callback

status-callback page anchor

When a Hosted Number Order changes status, Twilio will make an asynchronous HTTP request to the StatusCallback URL if you provided one in your API request. By capturing this request, you can determine when the Hosted Number Order changes status.

The Hosted Number Orders status callback request passes the parameters listed in the table below:

StatusDescription
StatusThe new status of the Hosted Number Order
HostedNumberOrderSidThe unique sid of the Hosted Number Order
PhoneNumberThe [+E.164][e164] format of the Hosted Number Order

Create a HostedNumberOrder resource

create-a-hostednumberorder-resource page anchor
POST https://preview.twilio.com/HostedNumbers/HostedNumberOrders

Creates a new Hosted Number Order for the specified capability. Currently, only SMS is a supported capability.

Parameters

create-parameters page anchor
Request body parameters
PhoneNumbertype: string<PHONE NUMBER>Not PII
Required

The number to host in +E.164(link takes you to an external page) format


SmsCapabilitytype: booleanNot PII
Required

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


AccountSidtype: SID<AC>Not PII

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.


FriendlyNametype: stringPII MTL: 30 days

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


UniqueNametype: stringPII MTL: 30 days

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.


CcEmailstype: string[]PII MTL: 30 days

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


SmsUrltype: string<URI>Not PII

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


SmsMethodtype: enum<HTTP METHOD>Not PII

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.

Possible values:
HEADGETPOSTPATCHPUTDELETE

SmsFallbackUrltype: string<URI>Not PII

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.


SmsFallbackMethodtype: enum<HTTP METHOD>Not PII

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.

Possible values:
HEADGETPOSTPATCHPUTDELETE

StatusCallbackUrltype: string<URI>Not PII

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


StatusCallbackMethodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE

SmsApplicationSidtype: SID<AP>Not PII

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.


AddressSidtype: SID<AD>Not PII

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


Emailtype: stringPII MTL: 30 days

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


VerificationTypetype: enum<STRING>Not PII

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

Possible values:
phone-callphone-bill

VerificationDocumentSidtype: SID<RI>Not PII

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.

Create Hosted Number Order

create-hosted-number-order page anchor
Node.js
Python
C#
Java
PHP
Ruby
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.preview.hosted_numbers
_11
.hostedNumberOrders
_11
.create({phoneNumber: '+15017122661', smsCapability: true})
_11
.then(hosted_number_order => console.log(hosted_number_order.sid));

Output

_28
{
_28
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"address_sid": "AD11111111111111111111111111111111",
_28
"call_delay": 0,
_28
"capabilities": {
_28
"sms": true,
_28
"voice": false
_28
},
_28
"cc_emails": [],
_28
"date_created": "2017-03-28T20:06:39Z",
_28
"date_updated": "2017-03-28T20:06:39Z",
_28
"email": "test@twilio.com",
_28
"extension": null,
_28
"failure_reason": "",
_28
"friendly_name": null,
_28
"incoming_phone_number_sid": "PN11111111111111111111111111111111",
_28
"phone_number": "+15017122661",
_28
"sid": "HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"signing_document_sid": null,
_28
"status": "received",
_28
"unique_name": null,
_28
"url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"verification_attempts": 0,
_28
"verification_call_sids": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"verification_code": null,
_28
"verification_document_sid": null,
_28
"verification_type": "phone-call"
_28
}


Fetch a HostedNumberOrder resource

fetch-a-hostednumberorder-resource page anchor
GET https://preview.twilio.com/HostedNumbers/HostedNumberOrders/{Sid}

Returns a single, existing Hosted Number Orders instance resource specified by the requested Hosted Number Orders instance resource SID.

URI parameters
Sidtype: SID<HR>Not PII
Path Parameter

A 34 character string that uniquely identifies this HostedNumberOrder.

Fetch a HostedNumberOrder

fetch-a-hostednumberorder page anchor
Node.js
Python
C#
Java
PHP
Ruby
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.preview.hosted_numbers
_11
.hostedNumberOrders('HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.fetch()
_11
.then(hosted_number_order => console.log(hosted_number_order.friendlyName));

Output

_34
{
_34
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"address_sid": "AD11111111111111111111111111111111",
_34
"call_delay": 15,
_34
"capabilities": {
_34
"sms": true,
_34
"voice": false
_34
},
_34
"cc_emails": [
_34
"aaa@twilio.com",
_34
"bbb@twilio.com"
_34
],
_34
"date_created": "2017-03-28T20:06:39Z",
_34
"date_updated": "2017-03-28T20:06:39Z",
_34
"email": "test@twilio.com",
_34
"extension": "5105",
_34
"failure_reason": "",
_34
"friendly_name": "friendly_name",
_34
"incoming_phone_number_sid": "PN11111111111111111111111111111111",
_34
"phone_number": "+14153608311",
_34
"sid": "HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"signing_document_sid": "PX11111111111111111111111111111111",
_34
"status": "received",
_34
"unique_name": "foobar",
_34
"url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"verification_attempts": 0,
_34
"verification_call_sids": [
_34
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_34
],
_34
"verification_code": "8794",
_34
"verification_document_sid": null,
_34
"verification_type": "phone-call"
_34
}


Read multiple HostedNumberOrder resources

read-multiple-hostednumberorder-resources page anchor
GET https://preview.twilio.com/HostedNumbers/HostedNumberOrders

URI parameters
Statustype: enum<STRING>Not PII
Query Parameter

The Status of this HostedNumberOrder. One of received, pending-verification, verified, pending-loa, carrier-processing, testing, completed, failed, or action-required.

Possible values:
receivedpending-verificationverifiedpending-loacarrier-processingtestingcompletedfailedaction-required

PhoneNumbertype: string<PHONE NUMBER>Not PII
Query Parameter

An E164 formatted phone number hosted by this HostedNumberOrder.


IncomingPhoneNumberSidtype: SID<PN>Not PII
Query Parameter

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


FriendlyNametype: stringPII MTL: 30 days
Query Parameter

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


UniqueNametype: stringPII MTL: 30 days
Query Parameter

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


PageSizetype: integerNot PII
Query Parameter

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


Pagetype: integerNot PII
Query Parameter

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


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple HostedNumberOrders

list-multiple-hostednumberorders page anchor
Node.js
Python
C#
Java
PHP
Ruby
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.preview.hosted_numbers
_11
.hostedNumberOrders
_11
.list({limit: 20})
_11
.then(hostedNumberOrders => hostedNumberOrders.forEach(h => console.log(h.sid)));

Output

_47
{
_47
"meta": {
_47
"first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0",
_47
"key": "items",
_47
"next_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=1",
_47
"page": 0,
_47
"page_size": 50,
_47
"previous_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0",
_47
"url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0"
_47
},
_47
"items": [
_47
{
_47
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_47
"address_sid": "AD11111111111111111111111111111111",
_47
"call_delay": 15,
_47
"capabilities": {
_47
"sms": true,
_47
"voice": false
_47
},
_47
"cc_emails": [
_47
"aaa@twilio.com",
_47
"bbb@twilio.com"
_47
],
_47
"date_created": "2017-03-28T20:06:39Z",
_47
"date_updated": "2017-03-28T20:06:39Z",
_47
"email": "test@twilio.com",
_47
"extension": "1234",
_47
"failure_reason": "",
_47
"friendly_name": "friendly_name",
_47
"incoming_phone_number_sid": "PN11111111111111111111111111111111",
_47
"phone_number": "+14153608311",
_47
"sid": "HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_47
"signing_document_sid": "PX11111111111111111111111111111111",
_47
"status": "received",
_47
"unique_name": "foobar",
_47
"url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_47
"verification_attempts": 0,
_47
"verification_call_sids": [
_47
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_47
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_47
],
_47
"verification_code": "8794",
_47
"verification_document_sid": null,
_47
"verification_type": "phone-call"
_47
}
_47
]
_47
}


Update a HostedNumberOrder resource

update-a-hostednumberorder-resource page anchor
POST https://preview.twilio.com/HostedNumbers/HostedNumberOrders/{Sid}

Tries to update a single, existing Hosted Number Orders instance resource's properties and returns the updated resource representation if successful. The returned response is identical to that returned above when fetching.

URI parameters
Sidtype: SID<HR>Not PII
Path Parameter

A 34 character string that uniquely identifies this HostedNumberOrder.


Request body parameters
FriendlyNametype: stringPII MTL: 30 days

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


UniqueNametype: stringPII MTL: 30 days

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


Emailtype: stringPII MTL: 30 days

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


CcEmailstype: string[]PII MTL: 30 days

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


Statustype: enum<STRING>Not PII

User can only post to pending-verification status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill.

Possible values:
receivedpending-verificationverifiedpending-loacarrier-processingtestingcompletedfailedaction-required

VerificationCodetype: stringNot PII

A verification code that is given to the user via a phone call to the phone number that is being hosted.


VerificationTypetype: enum<STRING>Not PII

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

Possible values:
phone-callphone-bill

VerificationDocumentSidtype: SID<RI>Not PII

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.


Extensiontype: stringNot PII

Digits to dial after connecting the verification call.


CallDelaytype: integerNot PII

The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.

Update Friendly Name of Hosted Number Order

update-friendly-name-of-hosted-number-order page anchor
Node.js
Python
C#
Java
PHP
Ruby
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.preview.hosted_numbers
_11
.hostedNumberOrders('HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.update({friendlyName: 'My important hosted number order'})
_11
.then(hosted_number_order => console.log(hosted_number_order.friendlyName));

Output

_34
{
_34
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"address_sid": "AD11111111111111111111111111111111",
_34
"call_delay": 15,
_34
"capabilities": {
_34
"sms": true,
_34
"voice": false
_34
},
_34
"cc_emails": [
_34
"test1@twilio.com",
_34
"test2@twilio.com"
_34
],
_34
"date_created": "2017-03-28T20:06:39Z",
_34
"date_updated": "2017-03-28T20:06:39Z",
_34
"email": "test+hosted@twilio.com",
_34
"extension": "1234",
_34
"failure_reason": "",
_34
"friendly_name": "My important hosted number order",
_34
"incoming_phone_number_sid": "PN11111111111111111111111111111111",
_34
"phone_number": "+14153608311",
_34
"sid": "HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"signing_document_sid": "PX11111111111111111111111111111111",
_34
"status": "pending-loa",
_34
"unique_name": "new unique name",
_34
"url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"verification_attempts": 1,
_34
"verification_call_sids": [
_34
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_34
],
_34
"verification_code": "8794",
_34
"verification_document_sid": null,
_34
"verification_type": "phone-call"
_34
}

Prove Ownership with Phone Call

prove-ownership-with-phone-call page anchor
Node.js
Python
C#
Java
PHP
Ruby
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.preview.hosted_numbers
_11
.hostedNumberOrders('HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.update({verificationType: 'phone-call', status: 'pending-verification'})
_11
.then(hosted_number_order => console.log(hosted_number_order.friendlyName));

Output

_34
{
_34
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"address_sid": "AD11111111111111111111111111111111",
_34
"call_delay": 15,
_34
"capabilities": {
_34
"sms": true,
_34
"voice": false
_34
},
_34
"cc_emails": [
_34
"test1@twilio.com",
_34
"test2@twilio.com"
_34
],
_34
"date_created": "2017-03-28T20:06:39Z",
_34
"date_updated": "2017-03-28T20:06:39Z",
_34
"email": "test+hosted@twilio.com",
_34
"extension": "1234",
_34
"failure_reason": "",
_34
"friendly_name": "new friendly name",
_34
"incoming_phone_number_sid": "PN11111111111111111111111111111111",
_34
"phone_number": "+14153608311",
_34
"sid": "HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"signing_document_sid": "PX11111111111111111111111111111111",
_34
"status": "pending-verification",
_34
"unique_name": "new unique name",
_34
"url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"verification_attempts": 1,
_34
"verification_call_sids": [
_34
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_34
"CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_34
],
_34
"verification_code": "8794",
_34
"verification_document_sid": null,
_34
"verification_type": "phone-call"
_34
}


Ownership Verification is a security measure to host the number with Twilio for SMS to ensure the authenticity of the request.


Delete a HostedNumberOrder resource

delete-a-hostednumberorder-resource page anchor
DELETE https://preview.twilio.com/HostedNumbers/HostedNumberOrders/{Sid}

Cancels the Hosted Number Order, and consequently, deletes the corresponding Incoming Phone Number.

(warning)

Warning

You can only issue the DELETE request when the HostedNumberOrder status is in received, pending-verification, verified or pending-loa. If the Hosted Number Order is completed, you can off-board the Twilio platform by issuing a DELETE request to the corresponding IncomingPhoneNumbers. If the Hosted Number Order is in a failed state due to either current SMS enablement or idle timeout, a new Hosted Number Order can be created. Please note that the Hosted Number Order will keep failing if SMS enablement is not removed from the number.

URI parameters
Sidtype: SID<HR>Not PII
Path Parameter

A 34 character string that uniquely identifies this HostedNumberOrder.

Delete a HostedNumberOrder

delete-a-hostednumberorder page anchor
Node.js
Python
C#
Java
PHP
Ruby
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.preview.hosted_numbers
_10
.hostedNumberOrders('HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.remove();


Rate this page: