Sign in

v1

latestOpenAPI 3.0.02026-07-244771176.5 KB
MMS

Send MMS

The Send MMS endpoint allows you to send multimedia messages (MMS) to recipients.

post/v2/mms

Request body

subjectstring

Subject of the message. Maximum length of 20 characters.

messagestring

Body text of the message. Maximum length of 1,000 characters. If opt-out is required, insert parameter [opt-out-link] into the message and a link will be generated.

message_refstring

A reference supplied by your system. Maximum length of 500 characters. This reference will be passed back in webhooks so that you can relate events to messages you sent. For example, being able to relate a Link Hit event to a specific sent message.

senderstring required

The sender is the number that shows recipients who sent the message.

recipientstring required

The destination number for delivery. Can be either in local format or in international format. For international format, it should follow E.164 standard. http://en.wikipedia.org/wiki/E.164 Can only send to Australia currently. Examples of conversions to E.164 format: Australia 0438 333 061 => 61438333061

content_urlsstring[] required

Specify a list of URLs of the media file(s) that you are trying to send. Supported file formats include jpg, gif, png, MP3, and video MP4. Only one image up to 400 KB can be attached at a time. URLs must be absolute paths to the media file, they cannot be relative paths. For example, https://outbound-mms.smsbump.com/2024/fashion.gif.

track_linksboolean

Enable the link tracking feature which replaces links in outbound messages with shortened links. This allows us to track when recipients view links.

is_sandboxboolean

Deprecated. Will be removed in a future version.

Example request

{
  "subject": "USS Enterprise"
}

Response

OK

idstring required

Unique identifier for the MMS message.

recipientstring required

The destination number for delivery.

senderstring required

The sender number.

countrystring required

Country code.

subjectstring required

Subject of the message.

messagestring required

Body text of the message.

message_refstring required

Reference supplied by your system.

content_urlsstring[] required

List of media file URLs.

statusstring required

Status of the message.

track_linksboolean required

Whether link tracking is enabled.

is_sandboxboolean required

Deprecated. Will be removed in a future version.

created_atstring date-time required

Timestamp when the MMS was created.

updated_atstring date-time required

Timestamp when the MMS was last updated.

Example response

{
  "id": "6fdae71c-dad7-4c36-9734-a69693ec2318",
  "recipient": "61435795809",
  "sender": "61481074185",
  "country": "AU",
  "subject": "USS Enterprise",
  "message": "Check out this amazing specimen.",
  "message_ref": "ncc1701d",
  "content_urls": [
    "http://res.cloudinary.com/burstsms/image/upload/v1590111670/enterprise-d_ghf9t8.jpg"
  ],
  "status": "sent",
  "track_links": true,
  "created_at": "2022-03-29T04:42:01.631708Z",
  "updated_at": "2022-03-29T04:42:01.776094Z"
}