Skip to main content

​
Request

Supported values for type:
  • image
  • audio
  • video
  • document
For all media types, only link is supported.

​
Field types

  • to: string (required)
  • type: string = image | audio | video | document (required)
  • image: object (required when type=image)
  • image.link: string (required)
  • image.caption: string (optional)
  • audio: object (required when type=audio)
  • audio.link: string (required)
  • audio.voice: boolean (optional)
  • video: object (required when type=video)
  • video.link: string (required)
  • video.caption: string (optional)
  • document: object (required when type=document)
  • document.link: string (required)
  • document.filename: string (optional)
  • document.caption: string (optional)

​
Field behavior and limits

  • link is required for every media subtype and must be a public URL.
  • image.caption is optional, max 1024 characters.
  • video.caption is optional, max 1024 characters.
  • document.caption is optional, max 1024 characters.
  • document.filename is optional; include extension (for example invoice.pdf), max 240 characters.
  • audio.voice is optional boolean:
    • true: marks the audio as a voice note.
    • false or omitted: sends as regular audio.
    • For voice notes, use OGG/OPUS compatible media.

​
Supported formats and max size

Audio (max 16 MB):
  • AAC: .aac (audio/aac)
  • AMR: .amr (audio/amr)
  • MP3: .mp3 (audio/mpeg)
  • MP4 Audio: .m4a (audio/mp4)
  • OGG Audio: .ogg (audio/ogg) with OPUS codec only and mono input
Document (max 100 MB):
  • Text: .txt (text/plain)
  • Microsoft Excel: .xls (application/vnd.ms-excel)
  • Microsoft Excel: .xlsx (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet)
  • Microsoft Word: .doc (application/msword)
  • Microsoft Word: .docx (application/vnd.openxmlformats-officedocument.wordprocessingml.document)
  • Microsoft PowerPoint: .ppt (application/vnd.ms-powerpoint)
  • Microsoft PowerPoint: .pptx (application/vnd.openxmlformats-officedocument.presentationml.presentation)
  • PDF: .pdf (application/pdf)
Image (max 5 MB):
  • JPEG: .jpeg (image/jpeg)
  • PNG: .png (image/png)
  • Images must be 8-bit RGB or RGBA.
Video (max 16 MB):
  • 3GPP: .3gp (video/3gpp)
  • MP4 Video: .mp4 (video/mp4)
  • Codec constraints: H.264 video and AAC audio only.
  • Recommended for compatibility: H.264 Main without B-frames or H.264 Baseline, and faststart (moov before mdat).
For sticker-specific constraints (.webp and size limits), see Sticker.

​
Image

{
  "to": "+573001112233",
  "type": "image",
  "image": {
    "link": "https://example.com/image.jpg",
    "caption": "Imagen de referencia"
  }
}

​
Audio

{
  "to": "+573001112233",
  "type": "audio",
  "audio": {
    "link": "https://example.com/audio.ogg",
    "voice": true
  }
}

​
Video

{
  "to": "+573001112233",
  "type": "video",
  "video": {
    "link": "https://example.com/video.mp4",
    "caption": "Video"
  }
}

​
Document

{
  "to": "+573001112233",
  "type": "document",
  "document": {
    "link": "https://example.com/file.pdf",
    "filename": "file.pdf",
    "caption": "Documento"
  }
}