Download media content (image, video, audio, document) from a message. The media is returned as base64-encoded data.
This endpoint only works for messages that contain media. Text-only messages will return an error.
Request
The unique identifier of the message containing mediaExample: 3EB0123456789ABCDEF
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.
Response
HTTP status code (e.g., 200)
Response code (e.g., SUCCESS)
Response message describing the resultExample: Media downloaded successfully
Status of the download operation
MIME type of the downloaded mediaExample: image/jpeg
Size of the file in bytesExample: 524288
Original filename of the mediaExample: image.jpg
Base64 encoded media data
curl -X GET \
'https://your-api-domain.com/message/3EB0123456789ABCDEF/[email protected]' \
-H 'X-Device-Id: my-device' \
-u 'username:password'
{
"status": 200,
"code": "SUCCESS",
"message": "Media downloaded successfully",
"results": {
"status": "Media downloaded successfully",
"mime_type": "image/jpeg",
"file_size": 524288,
"file_name": "image.jpg",
"data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}
}
