Get Price

POST

/mms/price

MMS

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/mms/price' \
--header 'Content-Type: application/json' \
--data-raw '{
    "media_file": "http://yourdomain.com/tpLaX6A.gif",
    "messages": [
        {
            "body": "This is a test body with special character: 英",
            "country": "AU",
            "from": "test",
            "source": "php",
            "subject": "This is a subject",
            "to": "+61437111222"
        }
    ]
}'

Response Example

{
    "data": {
        "_currency": {
            "currency_name_long": "Australian Dollars",
            "currency_name_short": "AUD",
            "currency_prefix_c": "c",
            "currency_prefix_d": "$"
        },
        "messages": [
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 4,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "2E7EFEC7-70FE-4E29-8F80-31A2F59003E8",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 5,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "773DE8EE-DF60-46F5-ADCB-1E28AF5B1FED",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 6,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "52774EFE-4310-4202-AE19-71FDD0086B15",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 7,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "97E06BA5-C106-40ED-ABD1-7B6CF4673278",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 8,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "5FB49B3E-FE94-4556-B5C2-5F874211A04E",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 9,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "AFAC3FCA-B05F-43E5-967F-9F78E206C2C7",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 10,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "E7C11ECB-FC96-42C1-83F9-3AA106D1A183",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
                "body": "John This is a test message.",
                "contact_id": 11,
                "country": "AU",
                "custom_string": "",
                "from": "test",
                "list_id": 429,
                "message_id": "D84AD2E9-DE92-46E0-8A9B-14509496E644",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            }
        ],
        "queued_count": 8,
        "total_count": 8,
        "total_price": 19.36
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Messages queued for delivery."
}

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'.

media_file

string

required

Media file you want to send.

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#'.

subject

string

required

Subject line. Maximum 20 characters.

string

required

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

Examples

Responses

🟢200OK

application/json

Body

object {0}

Get MMS History

Get all Delivery Receipts