Twilio Messaging API is a powerful tool that allows developers to easily integrate text messaging functionality into their applications. With this API, developers can send and receive SMS and MMS messages, as well as receive delivery and read receipts. This enables businesses to engage with their customers through personalized and timely text messages, such as appointment reminders, notifications, and promotional campaigns.
components:
schemas:
messaging.v1.service.alpha_sender:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AI[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the AlphaSender
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 AlphaSender resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Service](https://www.twilio.com/docs/chat/rest/service-resource)
the resource is associated with.
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.
alpha_sender:
type: string
nullable: true
description: The Alphanumeric Sender ID string.
capabilities:
type: array
items:
type: string
nullable: true
description: >-
An array of values that describe whether the number can receive
calls or messages. Can be: `SMS`.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the AlphaSender resource.
messaging.v1.brand_registrations.brand_registration_otp:
type: object
properties:
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 Brand Registration resource.
brand_registration_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string to identify Brand Registration of Sole Proprietor
Brand
messaging.v1.brand_registrations:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BN[0-9a-fA-F]{32}$
nullable: true
description: The unique string to identify Brand Registration.
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 Brand Registration resource.
customer_profile_bundle_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BU[0-9a-fA-F]{32}$
nullable: true
description: A2P Messaging Profile Bundle BundleSid.
a2p_profile_bundle_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BU[0-9a-fA-F]{32}$
nullable: true
description: A2P Messaging Profile Bundle BundleSid.
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.
brand_type:
type: string
nullable: true
description: >-
Type of brand. One of: "STANDARD", "SOLE_PROPRIETOR".
SOLE_PROPRIETOR is for the low volume, SOLE_PROPRIETOR campaign use
case. There can only be one SOLE_PROPRIETOR campaign created per
SOLE_PROPRIETOR brand. STANDARD is for all other campaign use cases.
Multiple campaign use cases can be created per STANDARD brand.
status:
type: string
$ref: '#/components/schemas/brand_registrations_enum_status'
nullable: true
description: >-
Brand Registration status. One of "PENDING", "APPROVED", "FAILED",
"IN_REVIEW", "DELETED".
tcr_id:
type: string
nullable: true
description: >-
Campaign Registry (TCR) Brand ID. Assigned only after successful
brand registration.
failure_reason:
type: string
nullable: true
description: >-
A reason why brand registration has failed. Only applicable when
status is FAILED.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Brand Registration resource.
brand_score:
type: integer
nullable: true
description: >-
The secondary vetting score if it was done. Otherwise, it will be
the brand score if it's returned from TCR. It may be null if no
score is available.
brand_feedback:
type: array
items:
type: string
$ref: '#/components/schemas/brand_registrations_enum_brand_feedback'
nullable: true
description: Feedback on how to improve brand score
identity_status:
type: string
$ref: '#/components/schemas/brand_registrations_enum_identity_status'
nullable: true
description: >-
When a brand is registered, TCR will attempt to verify the identity
of the brand based on the supplied information.
russell_3000:
type: boolean
nullable: true
description: Publicly traded company identified in the Russell 3000 Index
government_entity:
type: boolean
nullable: true
description: Identified as a government entity
tax_exempt_status:
type: string
nullable: true
description: >-
Nonprofit organization tax-exempt status per section 501 of the U.S.
tax code.
skip_automatic_sec_vet:
type: boolean
nullable: true
description: >-
A flag to disable automatic secondary vetting for brands which it
would otherwise be done.
mock:
type: boolean
nullable: true
description: >-
A boolean that specifies whether brand should be a mock or not. If
true, brand will be registered as a mock brand. Defaults to false if
no value is provided.
links:
type: object
format: uri-map
nullable: true
brand_registrations_enum_status:
type: string
enum:
- PENDING
- APPROVED
- FAILED
- IN_REVIEW
- DELETED
brand_registrations_enum_identity_status:
type: string
enum:
- SELF_DECLARED
- UNVERIFIED
- VERIFIED
- VETTED_VERIFIED
brand_registrations_enum_brand_feedback:
type: string
enum:
- TAX_ID
- STOCK_SYMBOL
- NONPROFIT
- GOVERNMENT_ENTITY
- OTHERS
messaging.v1.brand_registrations.brand_vetting:
type: object
properties:
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 vetting record.
brand_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BN[0-9a-fA-F]{32}$
nullable: true
description: The unique string to identify Brand Registration.
brand_vetting_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^VT[0-9a-fA-F]{32}$
nullable: true
description: The Twilio SID of the third-party vetting record.
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.
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.
vetting_id:
type: string
nullable: true
description: The unique identifier of the vetting from the third-party provider.
vetting_class:
type: string
nullable: true
description: >-
The type of vetting that has been conducted. One of “STANDARD”
(Aegis) or “POLITICAL” (Campaign Verify).
vetting_status:
type: string
nullable: true
description: >-
The status of the import vetting attempt. One of “PENDING,”
“SUCCESS,” or “FAILED”.
vetting_provider:
type: string
$ref: '#/components/schemas/brand_vetting_enum_vetting_provider'
nullable: true
description: >-
The third-party provider that has conducted the vetting. One of
“CampaignVerify” (Campaign Verify tokens) or “AEGIS” (Secondary
Vetting).
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Brand Vetting resource.
brand_vetting_enum_vetting_provider:
type: string
enum:
- campaign-verify
messaging.v1.service.channel_sender:
type: object
properties:
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 ChannelSender resource.
messaging_service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Service](https://www.twilio.com/docs/messaging/services) the
resource is associated with.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^XE[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the ChannelSender
resource.
sender:
type: string
nullable: true
description: >-
The unique string that identifies the sender e.g
whatsapp:+123456XXXX.
sender_type:
type: string
nullable: true
description: >-
A string value that identifies the sender type e.g WhatsApp,
Messenger.
country_code:
type: string
nullable: true
description: >-
The 2-character [ISO Country
Code](https://www.iso.org/iso-3166-country-codes.html) of the
number.
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 ChannelSender resource.
messaging.v1.deactivation:
type: object
properties:
redirect_to:
type: string
format: uri
nullable: true
description: >-
Returns an authenticated url that redirects to a file containing the
deactivated numbers for the requested day. This url is valid for up
to two minutes.
messaging.v1.domain_cert_v4:
type: object
properties:
domain_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^DN[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Domain resource.
date_updated:
type: string
format: date-time
nullable: true
description: Date that this Domain was last updated.
date_expires:
type: string
format: date-time
nullable: true
description: >-
Date that the private certificate associated with this domain
expires. You will need to update the certificate before that date to
ensure your shortened links will continue to work.
date_created:
type: string
format: date-time
nullable: true
description: >-
Date that this Domain was registered to the Twilio platform to
create a new Domain object.
domain_name:
type: string
format: uri
nullable: true
description: Full url path for this domain.
certificate_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CW[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify this Certificate
resource.
url:
type: string
format: uri
nullable: true
cert_in_validation:
nullable: true
description: >-
Optional JSON field describing the status and upload date of a new
certificate in the process of validation
messaging.v1.domain_config:
type: object
properties:
domain_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^DN[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Domain resource.
config_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZK[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Domain config
(prefix ZK).
fallback_url:
type: string
format: uri
nullable: true
description: >-
Any requests we receive to this domain that do not match an existing
shortened message will be redirected to the fallback url. These will
likely be either expired messages, random misdirected traffic, or
intentional scraping.
callback_url:
type: string
format: uri
nullable: true
description: >-
URL to receive click events to your webhook whenever the recipients
click on the shortened links.
continue_on_failure:
type: boolean
nullable: true
description: >-
Boolean field to set customer delivery preference when there is a
failure in linkShortening service
date_created:
type: string
format: date-time
nullable: true
description: Date this Domain Config was created.
date_updated:
type: string
format: date-time
nullable: true
description: Date that this Domain Config was last updated.
url:
type: string
format: uri
nullable: true
disable_https:
type: boolean
nullable: true
description: >-
Customer's choice to send links with/without "https://" attached to
shortened url. If true, messages will not be sent with https:// at
the beginning of the url. If false, messages will be sent with
https:// at the beginning of the url. False is the default behavior
if it is not specified.
messaging.v1.domain_config_messaging_service:
type: object
properties:
domain_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^DN[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Domain resource.
config_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZK[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Domain config
(prefix ZK).
messaging_service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: The unique string that identifies the messaging service
fallback_url:
type: string
format: uri
nullable: true
description: >-
Any requests we receive to this domain that do not match an existing
shortened message will be redirected to the fallback url. These will
likely be either expired messages, random misdirected traffic, or
intentional scraping.
callback_url:
type: string
format: uri
nullable: true
description: >-
URL to receive click events to your webhook whenever the recipients
click on the shortened links.
continue_on_failure:
type: boolean
nullable: true
description: >-
Boolean field to set customer delivery preference when there is a
failure in linkShortening service
date_created:
type: string
format: date-time
nullable: true
description: Date this Domain Config was created.
date_updated:
type: string
format: date-time
nullable: true
description: Date that this Domain Config was last updated.
url:
type: string
format: uri
nullable: true
messaging.v1.external_campaign:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^QE[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that identifies a US A2P Compliance resource
`QE2c6890da8086d771620e9b13fadeba0b`.
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 the
Campaign belongs to.
campaign_id:
type: string
nullable: true
description: ID of the preregistered campaign.
messaging_service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Messaging
Service](https://www.twilio.com/docs/messaging/api/service-resource)
that the resource is associated with.
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.
messaging.v1.linkshortening_messaging_service:
type: object
properties:
domain_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^DN[0-9a-fA-F]{32}$
nullable: true
description: The unique string identifies the domain resource
messaging_service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: The unique string that identifies the messaging service
url:
type: string
format: uri
nullable: true
messaging.v1.linkshortening_messaging_service_domain_association:
type: object
properties:
domain_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^DN[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Domain resource.
messaging_service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: The unique string that identifies the messaging service
url:
type: string
format: uri
nullable: true
messaging.v1.service.phone_number:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^PN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the PhoneNumber
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 PhoneNumber resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Service](https://www.twilio.com/docs/chat/rest/service-resource)
the resource is associated with.
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.
phone_number:
type: string
format: phone-number
nullable: true
description: >-
The phone number in
[E.164](https://www.twilio.com/docs/glossary/what-e164) format,
which consists of a + followed by the country code and subscriber
number.
country_code:
type: string
nullable: true
description: >-
The 2-character [ISO Country
Code](https://www.iso.org/iso-3166-country-codes.html) of the
number.
capabilities:
type: array
items:
type: string
nullable: true
description: >-
An array of values that describe whether the number can receive
calls or messages. Can be: `Voice`, `SMS`, and `MMS`.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the PhoneNumber resource.
messaging.v1.service:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Service 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 Service resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
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.
inbound_request_url:
type: string
format: uri
nullable: true
description: >-
The URL we call using `inbound_method` when a message is received by
any phone number or short code in the Service. When this property is
`null`, receiving inbound messages is disabled. All messages sent to
the Twilio phone number or short code will not be logged and
received on the Account. If the `use_inbound_webhook_on_number`
field is enabled then the webhook url defined on the phone number
will override the `inbound_request_url` defined for the Messaging
Service.
inbound_method:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
nullable: true
description: >-
The HTTP method we use to call `inbound_request_url`. Can be `GET`
or `POST`.
fallback_url:
type: string
format: uri
nullable: true
description: >-
The URL that we call using `fallback_method` if an error occurs
while retrieving or executing the TwiML from the Inbound Request
URL. If the `use_inbound_webhook_on_number` field is enabled then
the webhook url defined on the phone number will override the
`fallback_url` defined for the Messaging Service.
fallback_method:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
nullable: true
description: >-
The HTTP method we use to call `fallback_url`. Can be: `GET` or
`POST`.
status_callback:
type: string
format: uri
nullable: true
description: >-
The URL we call to [pass status
updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values)
about message delivery.
sticky_sender:
type: boolean
nullable: true
description: >-
Whether to enable [Sticky
Sender](https://www.twilio.com/docs/messaging/services#sticky-sender)
on the Service instance.
mms_converter:
type: boolean
nullable: true
description: >-
Whether to enable the [MMS
Converter](https://www.twilio.com/docs/messaging/services#mms-converter)
for messages sent through the Service instance.
smart_encoding:
type: boolean
nullable: true
description: >-
Whether to enable [Smart
Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding)
for messages sent through the Service instance.
scan_message_content:
type: string
$ref: '#/components/schemas/service_enum_scan_message_content'
nullable: true
description: Reserved.
fallback_to_long_code:
type: boolean
nullable: true
description: >-
[OBSOLETE] Former feature used to fallback to long code sender after
certain short code message failures.
area_code_geomatch:
type: boolean
nullable: true
description: >-
Whether to enable [Area Code
Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch)
on the Service Instance.
synchronous_validation:
type: boolean
nullable: true
description: Reserved.
validity_period:
type: integer
nullable: true
description: >-
How long, in seconds, messages sent from the Service are valid. Can
be an integer from `1` to `14,400`.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Service resource.
links:
type: object
format: uri-map
nullable: true
description: The absolute URLs of related resources.
usecase:
type: string
nullable: true
description: >-
A string that describes the scenario in which the Messaging Service
will be used. Possible values are `notifications`, `marketing`,
`verification`, `discussion`, `poll`, `undeclared`.
us_app_to_person_registered:
type: boolean
nullable: true
description: Whether US A2P campaign is registered for this Service.
use_inbound_webhook_on_number:
type: boolean
nullable: true
description: >-
A boolean value that indicates either the webhook url configured on
the phone number will be used or
`inbound_request_url`/`fallback_url` url will be called when a
message is received from the phone number. If this field is enabled
then the webhook url defined on the phone number will override the
`inbound_request_url`/`fallback_url` defined for the Messaging
Service.
service_enum_scan_message_content:
type: string
enum:
- inherit
- enable
- disable
messaging.v1.service.short_code:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^SC[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the ShortCode
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 ShortCode resource.
service_sid:
# --- truncated at 32 KB (144 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/messaging-openapi-original.yml