Send an SMS

POST

/sms/send

SMS

You can post up to 1000 messages with each API call.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/sms/send' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messages": [
        {
            "body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
            "custom_string": "this is a test",
            "from": "sendmobile",
            "schedule": 1436874701,
            "source": "php",
            "to": "+61411111111"
        },
        {
            "body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
            "custom_string": "this is a test",
            "from": "sendlist",
            "list_id": 428,
            "schedule": 1436876011,
            "source": "php"
        }
    ]
}'

Response Example

{
    "data": {
        "currency": {
            "currency_name_long": "US Dollars",
            "currency_name_short": "USD",
            "currency_prefix_c": "¢",
            "currency_prefix_d": "$"
        },
        "messages": [
            {
                "body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
                "carrier": "Telstra",
                "country": "AU",
                "custom_string": "this is a test",
                "date": 1436871253,
                "direction": "out",
                "from": "sendmobile",
                "message_id": "BF7AD270-0DE2-418B-B606-71D527D9C1AE",
                "message_parts": 1,
                "message_price": 0.07,
                "schedule": 1436874701,
                "status": "SUCCESS",
                "subaccount_id": 1,
                "to": "+61411111111",
                "user_id": 1
            },
            {
                "body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
                "carrier": "Telstra",
                "country": "AU",
                "custom_string": "this is a test",
                "date": 1436871253,
                "direction": "out",
                "from": "sendlist",
                "message_id": "D0C273EE-816D-4DF2-8E9D-9D9C65F168F3",
                "message_parts": 1,
                "message_price": 0.07,
                "schedule": 1436876011,
                "status": "SUCCESS",
                "subaccount_id": 1,
                "to": "+61411111111",
                "user_id": 1
            },
            {
                "body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
                "carrier": "",
                "country": "US",
                "custom_string": "this is a test",
                "date": 1436871253,
                "direction": "out",
                "from": "sendlist",
                "message_id": "A1845B61-C404-4793-8661-97890C19C8A2",
                "message_parts": 1,
                "message_price": 0.07,
                "schedule": 1436876011,
                "status": "SUCCESS",
                "subaccount_id": 1,
                "to": "+16783270696",
                "user_id": 1
            },
            {
                "body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
                "carrier": "",
                "country": "US",
                "custom_string": "this is a test",
                "date": 1436871253,
                "direction": "out",
                "from": "sendlist",
                "message_id": "DB545FAA-7325-465F-A696-8BDBFA8C1E49",
                "message_parts": 1,
                "message_price": 0.07,
                "schedule": 1436876011,
                "status": "SUCCESS",
                "subaccount_id": 1,
                "to": "+16783275492",
                "user_id": 1
            }
        ],
        "queued_count": 4,
        "total_count": 4,
        "total_price": 0.28
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Here are your data."
}

Request

Body Params application/json

body

string

required

Your message.

country

string

optional

Recipient country.

custom_string

string

optional

Your reference. Will be passed back with all replies and delivery reports.

from

string

optional

Your sender id - more info.

from_email

string

optional

An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS.

list_id

number

optional

Your list ID if sending to a whole list. Can be used instead of 'to'.

schedule

number

optional

Leave blank for immediate delivery. Your schedule time as a unix timestamp.

source

string

optional

Your method of sending e.g. 'wordpress', 'php', 'c#'.

string

required

Recipient number in E.164 format or local format (more info).

Examples

Responses

🟢200OK

application/json

Body

object {0}

Get a Specific Delivery Receipt

Cancel a Scheduled Message