v1

latestOpenAPI 3.0.02026-07-244771176.5 KB
MMS

Get MMS

This request retrieves the information of an existing sent MMS message. You only need to supply the unique message id that was returned upon creation.

get/v2/mms/{id}

Path parameters

idstring uuid required

Unique ID of the sent MMS

Response

A single MMS message

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"
}