Skip to main content
POST
https://api.oxenty.api.br
/
api
/
messages
/
document
curl -X POST "https://api.oxenty.api.br/api/messages/document" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "document": "https://exemplo.com/relatorio.pdf",
    "fileName": "Relatório Janeiro 2024.pdf",
    "caption": "Segue o relatório solicitado"
  }'
{
  "messageId": "3EB0ABC123DEF456789GHI",
  "status": "sent",
  "to": "5511999999999@s.whatsapp.net",
  "timestamp": "2024-01-15T10:30:00.000Z"
}
Envia um documento para um contato ou grupo. Ideal para PDFs, planilhas, apresentações e outros arquivos.

Request Body

sessionId
string
required
ID da sessão que enviará a mensagem.
to
string
required
Destinatário (número com DDI ou JID).
document
string
required
URL do documento ou conteúdo em base64.Tamanho máximo: 100 MB
fileName
string
Nome do arquivo que será exibido. Se não informado, será extraído da URL.Exemplo: "relatorio-janeiro.pdf"
mimetype
string
MIME type do arquivo. Geralmente detectado automaticamente.Exemplo: "application/pdf"
caption
string
Legenda do documento (opcional).
quoted
object
Responder a uma mensagem específica.
curl -X POST "https://api.oxenty.api.br/api/messages/document" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "to": "5511999999999",
    "document": "https://exemplo.com/relatorio.pdf",
    "fileName": "Relatório Janeiro 2024.pdf",
    "caption": "Segue o relatório solicitado"
  }'
{
  "messageId": "3EB0ABC123DEF456789GHI",
  "status": "sent",
  "to": "5511999999999@s.whatsapp.net",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Tipos Comuns de Documento

TipoMIME TypeExtensão
PDFapplication/pdf.pdf
Wordapplication/vnd.openxmlformats-officedocument.wordprocessingml.document.docx
Excelapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet.xlsx
PowerPointapplication/vnd.openxmlformats-officedocument.presentationml.presentation.pptx
ZIPapplication/zip.zip
CSVtext/csv.csv
O WhatsApp exibirá uma prévia do documento quando possível (ex: PDFs). Para arquivos sem prévia, será mostrado apenas o nome e tamanho.