Send MMS

POST

/mms/send

MMS

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/mms/send' \
--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": "https://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 4,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "D7A79BF1-4806-43F8-8339-6B9F8385D9A4",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 5,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "73034A6D-4F90-4DE3-9F9B-64F228A30195",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 6,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "A1E139C1-3CB0-42C8-A8EC-070BE5FE2D06",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 7,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "D202B823-C4ED-40F8-8F6E-08BF3EAE24D2",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 8,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "50469507-2C91-4EB0-A628-DEF8A921D53C",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 9,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "AFF1D0A3-1BDC-4A4F-8290-1A112579AB88",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 10,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "81C3CB6D-FD6C-44BF-9542-46FACFC423FB",
                "message_parts": 1,
                "message_price": "2.4200",
                "schedule": "",
                "status": "SUCCESS",
                "subject": "This is a subject",
                "to": "+61298444214"
            },
            {
                "_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
                "body": "John This is a test message.",
                "contact_id": 11,
                "country": "AU",
                "custom_string": "",
                "from": "+61298444213",
                "list_id": 429,
                "message_id": "55B901D2-38BD-4A3F-839C-E647FC0B4BAB",
                "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

The number to send from. Either leave blank or use a ClickSend number only.

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 Delivery Receipt

Cancel MMS