POSThttps://sms-notification.montymobile.com/api/v2/sms/send-bulk-sms

Send Bulk SMS API

Overview

The Send Bulk SMS API allows sending the same SMS message to multiple destination numbers within a single API request.

Request Headers

text
Tenant: {Tenant_ID}
api-key: {API_KEY}
Content-Type: application/json

Request Body

json
{
  "Source": "MontyTest",
  "Message": "test message",
  "Destination": []
}
Example
{
  "Source": "MontyTest",
  "Message": "Your OTP code is xxxx",
  "Destination": [
    "xxxx",
    "xxxx",
    "xxxx"
  ]
}

Request Parameters

ParameterTypeRequiredDescription
SourceStringYesSender ID used for the SMS
MessageStringYesSMS content to be delivered
DestinationArrayYesList of recipient mobile numbers

cURL Example

bash
curl -X POST "https://sms-notification.montymobile.com/api/v2/sms/send-bulk-sms" \
-H "Tenant: {Tenant_ID}" \
-H "api-key: {API_KEY}" \
-H "Content-Type: application/json" \
-d '{
  "Source": "MontyTest",
  "Message": "test message",
  "Destination": []
}'

Success Response

json
{
    "message": "Success",
    "code": "8_10_200",
    "success": true,
    "data": [
        {
            "messageId": "xxx",
            "errorCode": 0,
            "description": null,
            "destination": "xxxx"
        },
        {
            "messageId": "xxx",
            "errorCode": 0,
            "description": null,
            "destination": "xxxx"
        }
    ],
    "version": "2"
}

Response Fields

FieldTypeDescription
messageStringHuman-readable status message (e.g. "Success")
codeStringInternal response code returned by the platform
successBooleanIndicates whether the request was processed successfully
data.messageIdStringUnique identifier assigned to the sent message
data.errorCodeInteger0 indicates no error; a non-zero value indicates a specific failure reason
data.descriptionStringAdditional detail about the result; null when there is no error
data.destinationStringRecipient mobile number the response corresponds to
versionStringAPI version that generated the response