Send Messages | Twilio

This operation creates and sends out messages to the specified recipients.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Request

This endpoint expects an object.

tolist of objectsRequired

An array of recipient objects to send the message(s) to.

Use AddressRecipient to describe the recipient by their address.
Use ConnectedAddressRecipient to send a message to a recipient with multiple addresses, Twilio will select the optimal channel and perform retries across channels (if necessary).
Use ProfileRecipient to reference a stored Profile.

An array of recipient objects to send the message(s) to. - Use `AddressRecipient` to describe the recipient by their address. - Use `ConnectedAddressRecipient` to send a message to a recipient with multiple addresses, Twilio will select the optimal channel and perform retries across channels (if necessary). - Use `ProfileRecipient` to reference a stored `Profile`.

contentobjectRequired

The content of the Message.

Use MessageContentTextWithMedia to send a Message with just text and/or media.
Use MessageContentTemplate to reference a stored Content template.
Use MessageContentChannelModules to send rich content and different content per channel.

Use the Liquid templating language for personalization in any text-based field.
When using a templated content, use the variables field on each recipient to specify the values to substitute.
For each variable you specify in your template, you should have a matching key in each recipient’s variables object.
When targeting Audience or Profile recipients, you may specify variables with values that reference stored fields, including custom fields, on the Profile — for example: ${Twilio.Profile.firstName} or ${Twilio.Profile.myCustomField}.

The content of the Message. - Use `MessageContentTextWithMedia` to send a Message with just text and/or media. - Use `MessageContentTemplate` to reference a stored `Content` template. - Use `MessageContentChannelModules` to send rich content and different content per channel. *** * Use the [Liquid](https://shopify.github.io/liquid/) templating language for personalization in any text-based field. * When using a templated content, use the `variables` field on each recipient to specify the values to substitute. * For each variable you specify in your template, you should have a matching key in each recipient's `variables` object. * When targeting `Audience` or `Profile` recipients, you may specify `variables` with values that reference stored fields, including custom fields, on the `Profile` -- for example: `${Twilio.Profile.firstName}` or `${Twilio.Profile.myCustomField}`.

fromobjectOptional

The sending identity to associate with the Message(s).

scheduleobjectOptional

A schedule defines when a communication will be sent to a recipient.

tagsmap from strings to stringsOptional

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs.

This field can be templated with Liquid. Specify variables with each recipient for personalization.

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs. This field can be templated with [Liquid](https://shopify.github.io/liquid/). Specify `variables` with each recipient for personalization.

Response headers

Locationstring or null

The location (uri) of the Operation resource. Issue a GET request to this URI to retrieve the status of the Operation.

Response

The request was accepted and an Operation was created to track its progress. The response body contains the ID and link to the Operation resource.

operationIdstringformat: "^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"

The Operation ID is an identifier that can be used to correlate all of the resources created in a request. Issue a GET request to the resource list location, using the Operation ID as a query parameter to retrieve the resources that correlate with the Operation.

operationLocationstringformat: "uri"

The location (uri) of the Operation resource identified by operationId.

Errors

The content of the Message.

Use MessageContentTextWithMedia to send a Message with just text and/or media.
Use MessageContentTemplate to reference a stored Content template.
Use MessageContentChannelModules to send rich content and different content per channel.

Use the Liquid templating language for personalization in any text-based field.
When using a templated content, use the variables field on each recipient to specify the values to substitute.
For each variable you specify in your template, you should have a matching key in each recipient’s variables object.
When targeting Audience or Profile recipients, you may specify variables with values that reference stored fields, including custom fields, on the Profile — for example: ${Twilio.Profile.firstName} or ${Twilio.Profile.myCustomField}.

1	curl -X POST 'https://comms.twilio.com/preview/Messages' \
2	--header 'Content-Type: application/json' \
3	--data '{
4	"to": [{
5	"address": "+12065551337",
6	"channel": "phone"
7	}],
8	"content": {
9	"text": "What day is it?"
10	}
11	}'\
12	-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN \