MMS (1.0.0)

Everything about MMS

Send MMS

Send MMS

You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains a status and details for each recipient.

Refer to Application Status Codes for the possible response message status strings.

How many characters can I send in a message?

Standard MMS Message

1500 characters

Unicode MMS Message

500 characters

If a message is longer the allowed number of characters it will be truncated. If a message contains any characters that aren't in the GSM 03.38 character set, the message type will be treated as unicode. (https://en.wikipedia.org/wiki/GSM_03.38)

Maximum File Size

You can send a single attachment with a size of up to 250 kB. Some older devices can only accept attachments with up to 30 kB.

Supported File Types

Supported file types are listed below. If you need to convert a file to a supported format, it can be first passed to our uploads endpoint: /uploads?convert=mms
This will return a URL to the converted image file that can be used in the /mms/send endpoint.
Contact us to add support for any other file type.

Images

File type	Required to be passed to uploads endpoint first?
`jpg`	No
`gif`	No
`jpeg`	Yes
`png`	Yes
`bmp`	Yes

Properties

Name	Type	Required	Restrictions	Description
media_file	string	true	none	Media file you want to send
to	string	true	none	Recipient phone number in E.164 format
body	string	true	none	Your message
subject	string	true	none	Subject line (max 20 characters)
from	string	true	yes	Your sender id

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/mms/send

Request samples

application/json

{"media_file": "{{imageFileURL}}",
"messages": [{"source": "php",
"to": "+61411111111",
"from": "+61411111111",
"subject": "Test MMS",
"body": "Image attached",
"schedule": 1512538536
}
]
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Messages queued for delivery.",
"data": {"total_price": 13.2,
"total_count": 1,
"queued_count": 1,
"messages": [{"list_id": null,
"contact_id": 4,
"message_id": "D7A79BF1-4806-43F8-8339-6B9F8385D9A4",
"to": "+61298444214",
"subject": "This is a subject",
"from": "+61411111111",
"body": "John This is a test message.",
"country": "AU",
"custom_string": "",
"schedule": "",
"message_parts": 1,
"message_price": "2.4200",
"_media_file_url": "https://yourdomain.com/tpLaX6A.gif",
"status": "SUCCESS"
}
]
}
}

Calculate MMS Price

Get Price for MMS sent

Properties

Name	Type	Required	Restrictions	Description
media_file	string	true	none	Media file you want to send
to	string	true	none	Recipient phone number in E.164 format
body	string	true	none	Your message
subject	string	true	none	Subject line (max 20 characters)
from	string	true	yes	Your sender id

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/mms/price

Request samples

application/json

{"media_file": "{{imageFileURL}}",
"messages": [{"source": "php",
"subject": "This is a subject",
"from": "test",
"body": "This is a test message.",
"to": "+61437887639",
"country": "AU"
}
]
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Messages queued for delivery.",
"data": {"total_price": 19.36,
"total_count": 1,
"queued_count": 1,
"messages": [{"list_id": null,
"contact_id": 4,
"message_id": "D7A79BF1-4806-43F8-8339-6B9F8385D9A4",
"to": "+61298444214",
"subject": "This is a subject",
"from": "+61411111111",
"body": "John This is a test message.",
"country": "AU",
"custom_string": "",
"schedule": "",
"message_parts": 1,
"message_price": "2.4200",
"_media_file_url": "https://yourdomain.com/tpLaX6A.gif",
"status": "SUCCESS"
}
]
}
}

View MMS History

Get all mms history

Parameters

Parameter	In	Type	Required	Description
date_from	query	integer(int32)	false	Start date (Unix Timestamp e.g. 1436849372)
date_to	query	integer(int32)	false	End date (Unix Timestamp e.g. 1436879372)
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

query Parameters

limit

integer

Example: limit=100

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/mms/history

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/mms/history?date_from=&date_to='

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data.",
"data": {"total": 2,
"per_page": 15,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 2,
"data": [{"direction": "out",
"date": "1436932432",
"to": "+16783270696",
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton 1iQByXxdLN.",
"status": "Completed",
"from": "sendlist",
"schedule": "1436879372",
"status_code": null,
"status_text": null,
"error_code": null,
"error_text": "string",
"message_id": "4E90F4C3-43A3-489D-9AB8-DA1F4332A0C3",
"message_parts": "1.00",
"message_price": "0.070000",
"from_email": null,
"list_id": null,
"custom_string": "this is a test",
"contact_id": 0,
"user_id": 1,
"subaccount_id": 1,
"country": "US",
"carrier": "string",
"first_name": "John",
"last_name": "Doe",
"_api_username": "johndoe"
}
]
}
}

Export MMS History

Export all mms history

Parameters

Parameter	In	Type	Required	Description
filename	query	string	true	Filename to download history as

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

query Parameters

filename	string Example: filename=MMS_history.csv
q	string
order_by	string Example: order_by=date_added:desc
date_from	string
date_to	string
limit	integer Example: limit=50000

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/mms/history/export

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/mms/history/export?filename={filename}'

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here.",
"data": {"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
}
}