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"
}'
const message = await client.messages.sendDocument(sessionId, {
to: '5511999999999',
document: 'https://exemplo.com/relatorio.pdf',
fileName: 'Relatório Janeiro 2024.pdf',
caption: 'Segue o relatório solicitado',
});
message = client.messages.send_document(
session_id,
to='5511999999999',
document='https://exemplo.com/relatorio.pdf',
file_name='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"
}
{
"statusCode": 400,
"error": "MEDIA_TOO_LARGE",
"message": "Arquivo excede o limite de 100MB"
}
Mensagens
Enviar Documento
Envia um documento (PDF, planilha, etc)
POST
/
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"
}'
const message = await client.messages.sendDocument(sessionId, {
to: '5511999999999',
document: 'https://exemplo.com/relatorio.pdf',
fileName: 'Relatório Janeiro 2024.pdf',
caption: 'Segue o relatório solicitado',
});
message = client.messages.send_document(
session_id,
to='5511999999999',
document='https://exemplo.com/relatorio.pdf',
file_name='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"
}
{
"statusCode": 400,
"error": "MEDIA_TOO_LARGE",
"message": "Arquivo excede o limite de 100MB"
}
Envia um documento para um contato ou grupo. Ideal para PDFs, planilhas, apresentações e outros arquivos.
Request Body
string
required
ID da sessão que enviará a mensagem.
string
required
Destinatário (número com DDI ou JID).
string
required
URL do documento ou conteúdo em base64.Tamanho máximo: 100 MB
string
Nome do arquivo que será exibido. Se não informado, será extraído da URL.Exemplo:
"relatorio-janeiro.pdf"string
MIME type do arquivo. Geralmente detectado automaticamente.Exemplo:
"application/pdf"string
Legenda do documento (opcional).
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"
}'
const message = await client.messages.sendDocument(sessionId, {
to: '5511999999999',
document: 'https://exemplo.com/relatorio.pdf',
fileName: 'Relatório Janeiro 2024.pdf',
caption: 'Segue o relatório solicitado',
});
message = client.messages.send_document(
session_id,
to='5511999999999',
document='https://exemplo.com/relatorio.pdf',
file_name='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"
}
{
"statusCode": 400,
"error": "MEDIA_TOO_LARGE",
"message": "Arquivo excede o limite de 100MB"
}
Tipos Comuns de Documento
| Tipo | MIME Type | Extensão |
|---|---|---|
application/pdf | ||
| Word | application/vnd.openxmlformats-officedocument.wordprocessingml.document | .docx |
| Excel | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | .xlsx |
| PowerPoint | application/vnd.openxmlformats-officedocument.presentationml.presentation | .pptx |
| ZIP | application/zip | .zip |
| CSV | text/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.