curl --request POST \
--url https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-document/{extension} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "5511999999999",
"document": "https://example.com/file.pdf",
"fileName": "My document"
}
'{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}{
"error": 405,
"message": "Method not allowed"
}{
"error": 415,
"message": "Unsupported media type"
}Mensagens
Enviar documento
Envie documentos (PDF, DOC, XLS, etc) via WhatsApp
POST
/
send-document
/
{extension}
curl --request POST \
--url https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-document/{extension} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "5511999999999",
"document": "https://example.com/file.pdf",
"fileName": "My document"
}
'{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}{
"error": 405,
"message": "Method not allowed"
}{
"error": 415,
"message": "Unsupported media type"
}Conceituação
Método para envio de documentos. A extensão do arquivo deve ser informada no path da URL (ex:/send-document/pdf). Você pode enviar por URL ou por Base64.
Ao enviar em Base64, é obrigatório incluir o prefixo com o tipo do documento, por exemplo:
data:application/pdf;base64,.Os limites de tamanho e formatos suportados seguem as políticas do WhatsApp. Consulte a documentação oficial do WhatsApp para mais detalhes.
Autorizações
Secret Key generated in the Omni Z-API Security panel
Parâmetros de caminho
File extension (e.g. pdf, docx, xlsx)
Exemplo:
"pdf"
Corpo
application/json
Recipient phone number (country code + area code + number)
Exemplo:
"5511999999999"
Document URL or Base64 data
File name
Document description
ID of an existing message to reply to
Delay in seconds before sending (1-15)
Intervalo obrigatório:
1 <= x <= 15