Send SMS messages

POST

/sms/outgoing/send

Submit 1 or more SMS messages to be sent by WinSMS. Maximum 1000 recipients per request.

The 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

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Not found

🟠405Method Not Allowed

🟠413Payload Too Large

🟠415Unsupported Media Type

🟠422Unprocessable Entity

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://www.winsms.co.za/api/rest/v1/sms/outgoing/send' \
--header 'Content-Type: application/json' \
--data-raw '{
    "maxSegments": 3,
    "message": "Happy holidays from all at TelAmeriCorp.",
    "recipients": [
        {
            "clientMessageId": "clientId-3023",
            "mobileNumber": "27444444444"
        },
        {
            "mobileNumber": "27555555555"
        },
        {
            "clientMessageId": "clientId-3024",
            "mobileNumber": "276666666666"
        }
    ],
    "scheduledTime": "201712251430"
}'

Response Example

200 - Example 1

{
    "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
        }
    ],
    "statusCode": 200,
    "timeStamp": "20170117054658978",
    "version": "1.0"
}

Modified at 2023-08-15 09:05:19

Get a list of incoming opt-out SMS messages

Send multiple different SMS messages