Send bulk SMS messages

Testing Env

https://test.your-api-server.com

POST

/api/sms/send-bulk-messages/v1

Allows sending bulk SMS messages to multiple recipients.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://test.your-api-server.com/api/sms/send-bulk-messages/v1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messageId": "string",
    "referenceId1": "string",
    "referenceId2": "string",
    "serviceId": "string",
    "requestId": "string",
    "initiatorId": "string",
    "bulkId": "string",
    "messages": [
        {
            "destinations": [
                {
                    "destination": "string",
                    "messageId": "string"
                }
            ],
            "callbackData": "string",
            "deliveryTimeWindow": {
                "days": [
                    "MONDAY"
                ],
                "from": {
                    "hour": 0,
                    "minute": 0
                },
                "to": {
                    "hour": 0,
                    "minute": 0
                }
            },
            "text": "string",
            "entityId": "string",
            "sendAt": "2019-08-24T14:15:22Z",
            "validityPeriodMinutes": 0,
            "priority": 0
        }
    ]
}'

Response Example

200 - Example 1

{
    "code": 0,
    "message": {},
    "data": {
        "destinations": [
            {
                "destination": "string",
                "messageId": "string"
            }
        ],
        "callbackData": "string",
        "deliveryTimeWindow": {
            "days": [
                "MONDAY"
            ],
            "from": {
                "hour": 0,
                "minute": 0
            },
            "to": {
                "hour": 0,
                "minute": 0
            }
        },
        "text": "string",
        "entityId": "string",
        "sendAt": "2019-08-24T14:15:22Z",
        "validityPeriodMinutes": 0,
        "priority": 0
    },
    "correlationId": "string",
    "conversationId": "string",
    "requestId": "string",
    "items": [
        {
            "destinations": [
                {
                    "destination": "string",
                    "messageId": "string"
                }
            ],
            "callbackData": "string",
            "deliveryTimeWindow": {
                "days": [
                    "MONDAY"
                ],
                "from": {
                    "hour": 0,
                    "minute": 0
                },
                "to": {
                    "hour": 0,
                    "minute": 0
                }
            },
            "text": "string",
            "entityId": "string",
            "sendAt": "2019-08-24T14:15:22Z",
            "validityPeriodMinutes": 0,
            "priority": 0
        }
    ],
    "itemPagination": {
        "totalElements": 0,
        "pageSize": 0,
        "totalPages": 0,
        "pageNumber": 0,
        "offSet": 0
    },
    "bulkId": "string",
    "smsMessageDeliveryStatuses": [
        {
            "messageId": "string",
            "messageGroupStatus": {
                "statusGroupName": "string",
                "deliveryStatus": "QUEUED",
                "statusDescription": "string",
                "action": "string"
            },
            "destination": "string",
            "smsCount": 0
        }
    ],
    "isSuccessful": true
}

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Bulk messages queued successfully

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Modified at 2025-05-16 13:32:30

Send a simple SMS message

Get message status