Twilio Numbers API is a cloud-based service that allows developers to programmatically provision and manage phone numbers for communication channels like voice, SMS, and MMS. With this API, users can search, purchase, configure, and release phone numbers in more than 100 countries worldwide.
components:
schemas:
numbers.v2.authorization_document:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^PX[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies this
AuthorizationDocument.
address_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AD[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies the Address resource
that is associated with this AuthorizationDocument.
status:
type: string
$ref: '#/components/schemas/authorization_document_enum_status'
nullable: true
description: >-
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](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values)
for more information on each of these statuses.
email:
type: string
nullable: true
description: Email that this AuthorizationDocument will be sent to for signing.
x-twilio:
pii:
handling: standard
deleteSla: 30
cc_emails:
type: array
items:
type: string
nullable: true
description: >-
Email recipients who will be informed when an Authorization Document
has been sent and signed.
x-twilio:
pii:
handling: standard
deleteSla: 30
date_created:
type: string
format: date-time
nullable: true
description: >-
The date this resource was created, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date that this resource was updated, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
url:
type: string
format: uri
nullable: true
links:
type: object
format: uri-map
nullable: true
authorization_document_enum_status:
type: string
enum:
- opened
- signing
- signed
- canceled
- failed
numbers.v2.bulk_hosted_number_order:
type: object
properties:
bulk_hosting_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BH[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies this
BulkHostedNumberOrder.
request_status:
type: string
$ref: '#/components/schemas/bulk_hosted_number_order_enum_request_status'
nullable: true
description: >-
A string that shows the status of the current Bulk Hosting request,
it can vary between these values: 'QUEUED','IN_PROGRESS','PROCESSED'
friendly_name:
type: string
nullable: true
description: >-
A 128 character string that is a human-readable text that describes
this resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
notification_email:
type: string
nullable: true
description: >-
Email address used for send notifications about this Bulk hosted
number request.
x-twilio:
pii:
handling: standard
deleteSla: 30
date_created:
type: string
format: date-time
nullable: true
description: >-
The date this resource was created, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
date_completed:
type: string
format: date-time
nullable: true
description: >-
The date that this resource was completed, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
url:
type: string
format: uri
nullable: true
description: The URL of this BulkHostedNumberOrder resource.
total_count:
type: integer
nullable: true
description: The total count of phone numbers in this Bulk hosting request.
results:
type: array
items: {}
nullable: true
description: >-
Contains a list of all the individual hosting orders and their
information, for this Bulk request. Each result object is grouped by
its order status. To see a complete list of order status, please
check
'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
x-twilio:
pii:
handling: standard
deleteSla: 30
bulk_hosted_number_order_enum_request_status:
type: string
enum:
- QUEUED
- IN_PROGRESS
- PROCESSED
numbers.v2.regulatory_compliance.bundle:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BU[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Bundle resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Bundle resource.
regulation_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^RN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string of a regulation that is associated to the Bundle
resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
status:
type: string
$ref: '#/components/schemas/bundle_enum_status'
nullable: true
description: The verification status of the Bundle resource.
valid_until:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format when the
resource will be valid until.
email:
type: string
nullable: true
description: >-
The email address that will receive updates when the Bundle resource
changes status.
status_callback:
type: string
format: uri
nullable: true
description: The URL we call to inform your application of status changes.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Bundle resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of the Assigned Items of the Bundle resource.
bundle_enum_status:
type: string
enum:
- draft
- pending-review
- in-review
- twilio-rejected
- twilio-approved
- provisionally-approved
bundle_enum_end_user_type:
type: string
enum:
- individual
- business
bundle_enum_sort_by:
type: string
enum:
- valid-until
- date-updated
bundle_enum_sort_direction:
type: string
enum:
- ASC
- DESC
numbers.v2.regulatory_compliance.bundle.bundle_copy:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BU[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Bundle resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Bundle resource.
regulation_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^RN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string of a regulation that is associated to the Bundle
resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
status:
type: string
$ref: '#/components/schemas/bundle_copy_enum_status'
nullable: true
description: The verification status of the Bundle resource.
valid_until:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format when the
resource will be valid until.
email:
type: string
nullable: true
description: >-
The email address that will receive updates when the Bundle resource
changes status.
status_callback:
type: string
format: uri
nullable: true
description: The URL we call to inform your application of status changes.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
bundle_copy_enum_status:
type: string
enum:
- draft
- pending-review
- in-review
- twilio-rejected
- twilio-approved
- provisionally-approved
bundle_copy_enum_end_user_type:
type: string
enum:
- individual
- business
numbers.v2.authorization_document.dependent_hosted_number_order:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^HR[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies this Authorization
Document
bulk_hosting_request_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BH[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies the bulk hosting
request associated with this HostedNumberOrder.
next_step:
type: string
nullable: true
description: >-
The next step you need to take to complete the hosted number order
and request it successfully.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
incoming_phone_number_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^PN[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies the
IncomingPhoneNumber resource created by this HostedNumberOrder.
address_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AD[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies the Address resource
that represents the address of the owner of this phone number.
signing_document_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^PX[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies the LOA document
associated with this HostedNumberOrder.
phone_number:
type: string
format: phone-number
nullable: true
description: An E164 formatted phone number hosted by this HostedNumberOrder.
capabilities:
type: object
format: phone-number-capabilities
properties:
mms:
type: boolean
sms:
type: boolean
voice:
type: boolean
fax:
type: boolean
nullable: true
description: >-
A mapping of capabilities this hosted phone number will have enabled
on Twilio's platform.
friendly_name:
type: string
nullable: true
description: A human readable description of this resource, up to 128 characters.
x-twilio:
pii:
handling: standard
deleteSla: 30
status:
type: string
$ref: '#/components/schemas/dependent_hosted_number_order_enum_status'
nullable: true
description: >-
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](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values)
for more information on each of these statuses.
failure_reason:
type: string
nullable: true
description: >-
A message that explains why a hosted_number_order went to status
"action-required"
date_created:
type: string
format: date-time
nullable: true
description: >-
The date this resource was created, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date that this resource was updated, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
email:
type: string
nullable: true
description: Email of the owner of this phone number that is being hosted.
x-twilio:
pii:
handling: standard
deleteSla: 30
cc_emails:
type: array
items:
type: string
nullable: true
description: >-
Email recipients who will be informed when an Authorization Document
has been sent and signed
x-twilio:
pii:
handling: standard
deleteSla: 30
contact_title:
type: string
nullable: true
description: >-
The title of the person authorized to sign the Authorization
Document for this phone number.
contact_phone_number:
type: string
format: phone-number
nullable: true
description: >-
The contact phone number of the person authorized to sign the
Authorization Document.
dependent_hosted_number_order_enum_status:
type: string
enum:
- received
- verified
- pending-loa
- carrier-processing
- completed
- failed
- action-required
numbers.v2.regulatory_compliance.end_user:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IT[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string created by Twilio to identify the End User
resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the End User resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
type:
type: string
$ref: '#/components/schemas/end_user_enum_type'
nullable: true
description: >-
The type of end user of the Bundle resource - can be `individual` or
`business`.
attributes:
nullable: true
description: >-
The set of parameters that are the attributes of the End Users
resource which are listed in the End User Types.
x-twilio:
pii:
handling: standard
deleteSla: 30
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the End User resource.
end_user_enum_type:
type: string
enum:
- individual
- business
numbers.v2.regulatory_compliance.end_user_type:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^OY[0-9a-fA-F]{32}$
nullable: true
description: The unique string that identifies the End-User Type resource.
friendly_name:
type: string
nullable: true
description: >-
A human-readable description that is assigned to describe the
End-User Type resource. Examples can include first name, last name,
email, business name, etc
machine_name:
type: string
nullable: true
description: >-
A machine-readable description of the End-User Type resource.
Examples can include first_name, last_name, email, business_name,
etc.
fields:
type: array
items: {}
nullable: true
description: >-
The required information for creating an End-User. The required
fields will change as regulatory needs change and will differ for
businesses and individuals.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the End-User Type resource.
numbers.v2.regulatory_compliance.bundle.evaluation:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^EL[0-9a-fA-F]{32}$
nullable: true
description: The unique string that identifies the Evaluation resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Bundle resource.
regulation_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^RN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string of a regulation that is associated to the Bundle
resource.
bundle_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BU[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Bundle resource.
status:
type: string
$ref: '#/components/schemas/evaluation_enum_status'
nullable: true
description: The compliance status of the Evaluation resource.
results:
type: array
items: {}
nullable: true
description: >-
The results of the Evaluation which includes the valid and invalid
attributes.
date_created:
type: string
format: date-time
nullable: true
url:
type: string
format: uri
nullable: true
evaluation_enum_status:
type: string
enum:
- compliant
- noncompliant
numbers.v2.hosted_number_order:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^HR[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies this
HostedNumberOrder.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: A 34 character string that uniquely identifies the account.
incoming_phone_number_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^PN[0-9a-fA-F]{32}$
nullable: true
description: >-
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:
type: string
minLength: 34
maxLength: 34
pattern: ^AD[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies the Address resource
that represents the address of the owner of this phone number.
signing_document_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^PX[0-9a-fA-F]{32}$
nullable: true
description: >-
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:
type: string
format: phone-number
nullable: true
description: >-
Phone number to be hosted. This must be in
[E.164](https://en.wikipedia.org/wiki/E.164) format, e.g.,
+16175551212
x-twilio:
pii:
handling: standard
deleteSla: 30
capabilities:
type: object
format: phone-number-capabilities
properties:
mms:
type: boolean
sms:
type: boolean
voice:
type: boolean
fax:
type: boolean
nullable: true
description: >-
Set of booleans describing the capabilities hosted on Twilio's
platform. SMS is currently only supported.
friendly_name:
type: string
nullable: true
description: >-
A 128 character string that is a human-readable text that describes
this resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
status:
type: string
$ref: '#/components/schemas/hosted_number_order_enum_status'
nullable: true
description: >-
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:
type: string
nullable: true
description: >-
A message that explains why a hosted_number_order went to status
"action-required"
date_created:
type: string
format: date-time
nullable: true
description: >-
The date this resource was created, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date that this resource was updated, given as [GMT RFC
2822](http://www.ietf.org/rfc/rfc2822.txt) format.
email:
type: string
nullable: true
description: Email of the owner of this phone number that is being hosted.
x-twilio:
pii:
handling: standard
deleteSla: 30
cc_emails:
type: array
items:
type: string
nullable: true
description: >-
A list of emails that LOA document for this HostedNumberOrder will
be carbon copied to.
x-twilio:
pii:
handling: standard
deleteSla: 30
url:
type: string
format: uri
nullable: true
description: The URL of this HostedNumberOrder.
contact_title:
type: string
nullable: true
description: >-
The title of the person authorized to sign the Authorization
Document for this phone number.
contact_phone_number:
type: string
format: phone-number
nullable: true
description: >-
The contact phone number of the person authorized to sign the
Authorization Document.
bulk_hosting_request_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BH[0-9a-fA-F]{32}$
nullable: true
description: >-
A 34 character string that uniquely identifies the bulk hosting
request associated with this HostedNumberOrder.
next_step:
type: string
nullable: true
description: >-
The next step you need to take to complete the hosted number order
and request it successfully.
hosted_number_order_enum_status:
type: string
enum:
- received
- verified
- pending-loa
- carrier-processing
- completed
- failed
- action-required
numbers.v2.regulatory_compliance.bundle.item_assignment:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BV[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Item Assignment
resource.
bundle_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BU[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Bundle resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Item Assignment resource.
object_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of an object bag that holds information of the different
items.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Identity resource.
numbers.v2.regulatory_compliance.regulation:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^RN[0-9a-fA-F]{32}$
nullable: true
description: The unique string that identifies the Regulation resource.
friendly_name:
type: string
nullable: true
description: >-
A human-readable description that is assigned to describe the
Regulation resource. Examples can include Germany: Mobile -
Business.
iso_country:
type: string
nullable: true
description: The ISO country code of the phone number's country.
number_type:
type: string
nullable: true
description: >-
The type of phone number restricted by the regulatory requirement.
For example, Germany mobile phone numbers provisioned by businesses
require a business name with commercial register proof from the
Handelsregisterauszug and a proof of address from
Handelsregisterauszug or a trade license by Gewerbeanmeldung.
end_user_type:
type: string
$ref: '#/components/schemas/regulation_enum_end_user_type'
nullable: true
description: >-
The type of End User the regulation requires - can be `individual`
or `business`.
requirements:
nullable: true
description: >-
The SID of an object that holds the regulatory information of the
phone number country, phone number type, and end user type.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Regulation resource.
regulation_enum_end_user_type:
type: string
enum:
- individual
- business
numbers.v2.regulatory_compliance:
type: object
properties: {}
numbers.v2.regulatory_compliance.bundle.replace_items:
type: object
properties:
sid:
type: stri
# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/numbers-openapi-original.yml