Download file from a message

Downloads the file associated with a media message (image, video, audio, document, or sticker).

Parameters

• id (string, required): Message ID
• return_base64 (boolean, default: false): Returns file in base64
• generate_mp3 (boolean, default: true): For audio, defines return format
  • true: Returns MP3
  • false: Returns OGG
• return_link (boolean, default: true): Returns public file URL
• transcribe (boolean, default: false): Transcribes audio to text
• openai_apikey (string, optional): OpenAI Key for transcription
  • If not provided, uses the key saved in the instance
  • If provided, updates and saves to the instance for future calls
• download_quoted (boolean, default: false): Downloads media from the quoted message
  • Useful for downloading original status content
  • When a message is a reply to a status, allows downloading the original status media
  • Contextualization: By downloading the quoted media, you identify the conversation context
    • Example: If someone replies to a promotion, downloading the media lets you know the question is about that specific promotion

Examples

Download audio as MP3:

{
  "id": "7EB0F01D7244B421048F0706368376E0",
  "generate_mp3": true
}

Transcribe audio:

{
  "id": "7EB0F01D7244B421048F0706368376E0",
  "transcribe": true
}

Base64 only (without saving):

{
  "id": "7EB0F01D7244B421048F0706368376E0",
  "return_base64": true,
  "return_link": false
}

Download status media (quoted message):

{
  "id": "7EB0F01D7244B421048F0706368376E0",
  "download_quoted": true
}

Useful when the customer replies to a promotion/status - you download the original media to understand which product/offer they are asking about.

Response

{
  "fileURL": "[https://api.example.com/files/file.mp3](https://api.example.com/files/file.mp3)",
  "mimetype": "audio/mpeg",
  "base64Data": "UklGRkj...",
  "transcription": "Transcribed text"
}

Note:

• By default, unless defined otherwise:
  1. Audios are returned as MP3.
  2. And all download requests are returned with a public URL.
• Transcription requires a valid OpenAI key. The key can be configured once in the instance and will be automatically reused.