Send multiple different SMS messages

POST

/sms/outgoing/sendmulti

sms

Submit multiple different SMS messages to be sent to multiple recipients. Maximum 1000 recipients across all messages.

Each SMS message text can be a maximum of 918 characters long. If you are submitting a message longer than 160 characters, you should change the value of maxSegments.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://www.winsms.co.za/api/rest/v1/sms/outgoing/sendmulti' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messages": [
        {
            "maxSegments": 3,
            "message": "Happy holidays from all at TelAmeriCorp.",
            "recipients": [
                {
                    "clientMessageId": "clientId-3023",
                    "mobileNumber": "27444444444"
                },
                {
                    "mobileNumber": "27555555555"
                },
                {
                    "clientMessageId": "clientId-3024",
                    "mobileNumber": "276666666666"
                }
            ],
            "scheduledTime": "201712251430"
        },
        {
            "maxSegments": 1,
            "message": "TelAmeriCorp flash sale - call now for details",
            "recipients": [
                {
                    "clientMessageId": "clientId-0015",
                    "mobileNumber": "27333333333"
                },
                {
                    "mobileNumber": "27222222222"
                }
            ],
            "scheduledTime": "201801010900"
        }
    ]
}'

Response Example

200 - Example 1

{
  "messages": [
    {
      "message": "Happy holidays from all at TelAmeriCorp.",
      "recipients": [
        {
          "acceptError": "",
          "accepted": true,
          "apiMessageId": 2316,
          "clientMessageId": "clientId-3023",
          "creditCost": 1,
          "mobileNumber": "27444444444",
          "newCreditBalance": 188.6,
          "scheduledTime": "201712251430"
        },
        {
          "acceptError": "",
          "accepted": true,
          "apiMessageId": 2317,
          "clientMessageId": null,
          "creditCost": 1,
          "mobileNumber": "27555555555",
          "newCreditBalance": 187.6,
          "scheduledTime": "201712251430"
        },
        {
          "acceptError": "BADDEST",
          "accepted": false,
          "apiMessageId": null,
          "clientMessageId": "clientId-3024",
          "creditCost": 0,
          "mobileNumber": "276666666666",
          "newCreditBalance": 187.6,
          "scheduledTime": null
        }
      ]
    },
    {
      "message": "TelAmeriCorp flash sale - call now for details",
      "recipients": [
        {
          "acceptError": "",
          "accepted": true,
          "apiMessageId": 2318,
          "clientMessageId": "clientId-0015",
          "creditCost": 1,
          "mobileNumber": "27333333333",
          "newCreditBalance": 186.6,
          "scheduledTime": "201801010900"
        },
        {
          "acceptError": "",
          "accepted": true,
          "apiMessageId": 2319,
          "clientMessageId": null,
          "creditCost": 1,
          "mobileNumber": "27222222222",
          "newCreditBalance": 185.6,
          "scheduledTime": "201801010900"
        }
      ]
    }
  ],
  "statusCode": 200,
  "timeStamp": "20170117054658978",
  "version": "1.0"
}

Request

Body Params application/json

messages

array[object (messageDetails) {4}]

optional

maxSegments

integer

optional

Optional - The maximum GSM Encoded segment count that the message is allowed to utilise.

This defaults to 1, allowing for a maximum GSM Encoded message length of 160 characters.

The maximum value is 6, which allows for a GSM Encoded message length of 918 characters.

If you intend to send a message longer than 160 characters, this value should be specified.

>= 1<= 6

Default:

Example:

message

string

required

The SMS text to be sent.

Example:

Happy holidays from all at TelAmeriCorp.

recipients

array[object (messageRecipientDetails) {2}]

required

An array of messageRecipientDetails objects.

>= 1 items<= 1000 items

scheduledTime

string

optional

Optional - The date and time that an SMS should be delivered. If not specified, or is set for a date/time prior to the current date/time, the SMS message will be sent immediately.

If specified, this value should have the format YYYYMMDDHHmm.

Example:

201712251430

Examples

Responses

🟢200OK

application/json

Body

messages

array[object (messageDetailsResponse) {2}]

optional

An array of messageDetailsResponse objects

message

string

optional

The message text that was sent.

recipients

array[object (messageRecipientResponse) {8}]

optional

An array of messageRecipientResponse objects

>= 1 items<= 1000 items

statusCode

integer

optional

The http status code returned - reflected in the body for convenience

timeStamp

string

optional

The date/time the request was processed, in the format YYYYMMDDhhmmssSSS

version

string

optional

The current version of the API of the endpoint that was called

🟠400Bad Request

🟠401Unauthorized

🟠404Not found

🟠405Method Not Allowed

🟠413Payload Too Large

🟠415Unsupported Media Type

🟠422Unprocessable Entity

🔴500Internal Server Error

Send SMS messages

Get SMS delivery statuses