Send Outbound Message

Submits Outbound Message for sending.

Response status code 200 means that the Outbound Message was accepted for delivery. It does not guarantee that the message will be sent right away, or ever. Depending on the TCR Campaign association state, the remaining TCR limit and the Opt-Out of the recipient, the message may end up queued or even discarded.

In case MediaUrls array is not empty (i.e. contains at least one attachment URL) and/or more than 1 recipient the message is considered MMS.

Authorization

AuthorizationBasic <token>

Basic Authorization header using the BASIC scheme. Use a pair companySid:token to access the API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Submit Outbound Message request.

from*string

Sender of the message. Must be one of the Phone Numbers owned by you.

Lengthlength <= 16

Example"+12145678900"

to?string

Recipient of the message. Either to or recipients field (and not both) must be defined. Specifying this field is equivalent to specifying recipients array with a single element.

Lengthlength <= 16

Example"+19876543210"

recipients?array<string>

Recipients of the message. If multiple Phone Numbers are specified, the request will be treated as a group MMS request. Either to or recipients field (and not both) must be defined.

Lengthlength <= 10

Example

[  "+19876543210",  "+12345678900"]

text?|

Text of the message. Can be empty only when MediaUrls set.

Lengthlength <= 8000

Example"Glad to see you!"

priority?|

Priority of the message. 'Normal' if not specified. Possible values:

Urgent: Urgent
High: High
Normal: Normal
Low: Low

Example"Normal"

mediaUrls?array<string>|

Attachment URLs of the message. If null or empty, the message is treated as SMS, else - MMS. All elements must be well-formed absolute URL strings. Only HTTP and HTTPS schemes are supported.

Examplenull

callbackUrlOverride?|

If specified, the events for this Outbound Message will be sent to the specified URL. If this URL is empty then Messaging Config URLs are used for Outbound Message events. Adds 'https://' if no HTTP schema is defined.

expiresOn?|

UTC timestamp indicating when the Outbound Message will expire.

If the value is within 72 hours of message submission, it will be used as-is. If the value is null or exceeds 72 hours from the request time, it will be automatically overwritten to 72 hours from the time of submission. After the expiration time, no delivery attempts will be made, and the message will be marked as "Expired".

Formatdate-time

Example"2025-06-01T15:00:00Z"

conversationMetadata?|

Specifies new metadata value for this and subsequent messages in the current conversion.

Conversation metadata is an arbitrary text value associated with a pair of phone numbers, one being a company phone number. Once specified, all subsequent Outbound Messages and Inbound Messages in the same conversation will get this metadata value. Conversation metadata can be overriden multiple times, but this does not affect previous messages in the conversation, only future messages are affected. Conversation metadata is not supported for group messages.

Lengthlength <= 2048

ignoreSendingTimes?boolean

If true, the message will be sent regardless of the Time Routing configured for the Messaging Config.

Examplefalse

Response Body

curl -X POST "https://example.com/v1/OutboundMessages" \  -H "Content-Type: application/json" \  -d '{    "from": "+12145678900",    "to": "+19876543210",    "text": "Glad to see you!",    "ignoreSendingTimes": false  }'

{  "sid": "OM08d9704f044a2fa13d3faa216fcf4574b64b19be32626243",  "segmentCount": 0}

{  "errorCode": 0,  "errorMessage": "string"}

{  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",  "title": "Error title",  "detail": "Error detailed message",  "traceId": "|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}

Send Outbound Message

Authorization

Request Body

Response Body

200text/plain

400text/plain

403text/plain