Calculate Price

POST

/sms/price

SMS

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/sms/price' \
--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": {
        "messages": [
            {
                "body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
                "country": "AU",
                "custom_string": "this is a test",
                "from": "sendmobile",
                "message_parts": 1,
                "message_price": "0.0566",
                "schedule": 1436874701,
                "status": "SUCCESS",
                "to": "+61411111111"
            },
            {
                "body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
                "country": "AU",
                "custom_string": "this is a test",
                "from": "sendlist",
                "message_parts": 1,
                "message_price": "0.0566",
                "schedule": 1436876011,
                "status": "SUCCESS",
                "to": "+61411111111"
            },
            {
                "body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
                "country": "US",
                "custom_string": "this is a test",
                "from": "sendlist",
                "message_parts": 1,
                "message_price": "0.0566",
                "schedule": 1436876011,
                "status": "SUCCESS",
                "to": "+16783270696"
            },
            {
                "body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
                "country": "US",
                "custom_string": "this is a test",
                "from": "sendlist",
                "message_parts": 1,
                "message_price": "0.0566",
                "schedule": 1436876011,
                "status": "SUCCESS",
                "to": "+16783275492"
            }
        ],
        "queued_count": 4,
        "total_count": 4,
        "total_price": 0.2264
    },
    "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.

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 Specific Inbound - Pull

Get all Delivery Receipts