Download

API Reference

Messages

Attachments

Download an attachment

post/v0/download-attachment

Download an attachment from a message and return the local file path

Body ParametersExpand Collapse

chatID: string

Unique identifier of the chat (supports both chatID and localChatID).

messageID: string

The message ID (eventID) containing the attachment.

ReturnsExpand Collapse

success: boolean

Whether the attachment was successfully downloaded.

error: optional string

Error message if the download failed.

filePath: optional string

Local file system path to the downloaded attachment.

HTTPTypeScript

curl http://localhost:23373/v0/download-attachment \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN" \
    -d '{
          "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com",
          "messageID": "messageID"
        }'

200 example

{
  "success": true,
  "error": "error",
  "filePath": "filePath"
}

Returns Examples

200 example

{
  "success": true,
  "error": "error",
  "filePath": "filePath"
}