Enviar Mídia

Endpoint para enviar arquivos de mídia (imagens, documentos, vídeos, áudios) via WhatsApp.

Endpoint

POST /message/sendMedia/{apiToken}

Headers

Nome	Tipo	Descrição
apikey	string	Sua chave de API
Content-Type	string	Deve ser application/json

Corpo da Requisição

{
  "number": "string",
  "options": {
    "delay": 123,
    "presence": "composing"
  },
  "mediaMessage": {
    "mediaType": "image",
    "fileName": "arquivo.pdf",
    "caption": "string",
    "media": "string"
  }
}

Parâmetros do Corpo

Campo	Tipo	Descrição
number	string	Número do destinatário (formato: DDI+DDD+Número)
options	object	Configurações adicionais da mensagem
mediaMessage	object	Conteúdo da mídia

Objeto options

Campo	Tipo	Descrição
delay	integer	Tempo de presença em milissegundos antes do envio
presence	enum	Tipo de presença a ser exibida. Opções: "composing", "recording"

Objeto mediaMessage

Campo	Tipo	Descrição
mediaType	enum	Tipo de mídia: "image", "video", "document", "audio"
fileName	string	Nome do arquivo (obrigatório apenas para tipo "document")
caption	string	Legenda da mídia (não disponível para tipo "audio")
media	string	URL ou Base64 do arquivo de mídia

Exemplos de Requisição

Enviando uma Imagem

const options = {
  method: 'POST',
  headers: {
    apikey: 'sua-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    number: "5511999999999",
    options: {
      delay: 1000,
      presence: "composing"
    },
    mediaMessage: {
      mediaType: "image",
      caption: "Minha foto",
      media: "base64_ou_url_da_midia"
    }
  })
};

Enviando um Documento

const options = {
  method: 'POST',
  headers: {
    apikey: 'sua-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    number: "5511999999999",
    options: {
      delay: 1000,
      presence: "recording"
    },
    mediaMessage: {
      mediaType: "document",
      fileName: "relatorio.pdf", // Obrigatório para documentos
      caption: "Relatório Mensal",
      media: "base64_ou_url_do_documento"
    }
  })
};

Enviando um Áudio

const options = {
  method: 'POST',
  headers: {
    apikey: 'sua-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    number: "5511999999999",
    options: {
      delay: 1000,
      presence: "recording"
    },
    mediaMessage: {
      mediaType: "audio",
      media: "base64_ou_url_do_audio"
    }
  })
};

Resposta de Sucesso

{
  "status": "success",
  "message": "Media sent successfully",
  "data": {
    "messageId": "XXXXXXXXXXXXX"
  }
}

Notas Importantes

• Para o tipo document, o campo fileName é obrigatório
• O campo caption não está disponível para envios do tipo audio
• O campo media aceita tanto URLs quanto arquivos codificados em base64
• O campo presence aceita "composing" ou "recording" como valores
• O campo delay define o tempo em milissegundos que o status de presença será exibido antes do envio da mensagem