Request a message dispatch

POST

/v1/api/dispatch

It creates a multi-channel and multi-language message for multiple recipients. Please note that there is a limit of 1000 recipients per request.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Message successfully sent

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

cURL

Simple SMSRCS text with SMS fallbackSpecific RCS text with SMS fallbackTemplate with placeholders

curl --location 'https://prod.your-api-server.com/v1/api/dispatch' \
--header 'Content-Type: application/json' \
--data '{
    "message": {
        "languageDefault": "en",
        "translations": {
            "en": {
                "contents": [
                    {
                        "text": {
                            "body": "Hello {{firstname}}! This is a simple SMS test."
                        }
                    }
                ]
            }
        }
    },
    "recipients": [
        {
            "recipientIdentifiers": [
                {
                    "channelIdType": "MSISDN",
                    "channelIdentifier": "+39347XXXXXXX"
                }
            ],
            "placeholders": {
                "firstname": "Mark"
            }
        },
        {
            "recipientIdentifiers": [
                {
                    "channelIdType": "MSISDN",
                    "channelIdentifier": "+39349XXXXXXX"
                }
            ],
            "placeholders": {
                "firstname": "Robert"
            }
        }
    ],
    "channels": {
        "sms": {
            "senderId": "{{SMS_SENDER_ID}}"
        }
    },
    "countryCodeFixEnabled": true,
    "countryCodeDefault": "IT"
}'

Response Example

200 - Example 1

{
    "dispatchId": "0K0FHMEJ4DPFZ",
    "scheduleDate": "2025-03-05T12:00:10Z",
    "rejectedRecipients": []
}

Modified at 2026-06-04 06:45:36

Dispatch messages info