Get a message's file

A short-lived signed URL for one message's photo, video, audio, sticker or document, with its type, MIME type and filename.

The URL works for five minutes (until expires_at) and is minted for each call: download the file straight away, and call again when you need it later. Files are private; a URL is never reused.

Take the path from a message's media_download_path in the messages list. A message with no file, or one in a conversation your key cannot see, answers 404 not_found.

While the file is still being fetched from the channel (media_status pending) the answer is 409 conflict with details.reason media_pending: retry in a few seconds. When the fetch failed for good (media_status failed) it is 404 not_found with details.reason media_unavailable.

get/api/v1/conversations/{id}/messages/{messageId}/media

Request

Base URL: https://app.blueticked.com
URL: https://app.blueticked.com/api/v1/conversations/{id}/messages/{messageId}/media
Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Response

Success

request_idstring required

Example response

{
  "data": {
    "url": "https://…/storage/v1/object/sign/inbound-media/…/invoice-4471.pdf?token=…",
    "media_type": "document",
    "media_mime": "application/pdf",
    "media_filename": "invoice-4471.pdf"
  },
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.