message

download media from message

Downloads the media content from a message and returns a temporary download URL valid for 15 minutes. Use this instead of get-message-by-id with includeMedia when you only need the media file.

post/instances/{id}/client/action/download-media

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/client/action/download-media
Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

Serialized message ID in format: <fromMe><chatId><messageHash>

Example request

{
  "messageId": "false_12345678901@c.us_ABCDEF1234567890"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Media download URL generated.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "media": {
        "url": "https://media.waapi.app/webhook_media/abc123/msgId.jpg?X-Amz-Expires=900",
        "mimetype": "image/jpeg",
        "filename": "photo.jpg",
        "filesize": 245830
      }
    }
  }
}

Changes

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