Send a message

After you have defined the message type(s) and channel(s) to use for your communication, use the send a Messages API message to create your request.

Depending on the channels and message type you use, remember to add additional options to your send request.

adaptationMode

Add the adaptationMode parameter to your API request to allow a message to be sent even if it contains elements that are unsupported by the channel.

For example, if you want to include a button in your SMS message, you can set the adaptationMode parameter to 'true' and the Messages API will handle the delivery of the message to WhatsApp as expected. However, it will render only text for the SMS channel.

If the parameter is set to 'false' and you attempt to send a message over a channel that does not support the defined element, then it will result in an error.

{
    "messages": [
        {
            "channel": "WHATSAPP",
            "content": {
                "body": {
                    "text": "Thank you for joining us on Athleete Unlocked! Would you like to subscribe for future Athleete events?",
                    "type": "TEXT"
                },
                "buttons": [
                    {
                        "type": "REPLY",
                        "text": "Yes",
                        "postbackData": "true"
                    },
                    {
                        "type": "REPLY",
                        "text": "No",
                        "postbackData": "false"
                    }
                ]
            },
            "options": {
                "adaptationMode": true
            },
            "sender": "441234567890",
            "destinations": [
                {
                    "to": "440987654321"
                }
            ]
        }
    ]
}

Output

SMS, MMS, and Viber with adaptationMode enabled.

Buttons

Image

Image with header

Templates

Document

Video

failover

User failover to always deliver your messages. This option provides messages delivery on other channels in case first option was unsuccessful.

You can:

• Automate channel switching - Messages API automatically changes channel in the event of a failed messages delivery.
• Configure validity period - Define period from 10 seconds to 48 hours for each channel. After validity period is expired, channel is switched and validity period for new channel starts.
• Customize failover flow - Define and prioritize channel failover order.

NotifyURL

Use the NotifyURL option if you want users to be able to set the URL where they want to receive API responses. Define the URL under the webhooks parameter of the API request.

{
    "messages": [
        {
            "content": {
                "body": {
                    "text": "Thank you for your registration!",
                    "type": "TEXT"
                }
            },
            "webhooks": {
                "delivery": {
                    "url": "https://notifyme.delivery"
                },
                "sender": "441234567890",
                "destinations": [
                    {
                        "to": "440987654321"
                    }
                ],
                "channel": "SMS"
            }
        }
    ]
}

callbackdata

Use callbackdata if you want to define additional data that users want to see in the delivery reports.