Pular para o conteúdo principal
POST
/
send-document
/
{extension}
curl --request POST \
  --url https://zapi.hubmessage.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"
}

​
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,.
A estrutura de resposta é idêntica à da Z-API. Seu código existente que processa esses retornos continuará funcionando sem alterações.
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

​
Authorization
string
header
obrigatório

Secret Key generated in the Hub Message Security panel

Parâmetros de caminho

​
extension
string
obrigatório

File extension (e.g. pdf, docx, xlsx)

Exemplo:

"pdf"

Corpo

application/json
​
phone
string
obrigatório

Recipient phone number (country code + area code + number)

Exemplo:

"5511999999999"

​
document
string
obrigatório

Document URL or Base64 data

​
fileName
string

File name

​
caption
string

Document description

​
messageId
string

ID of an existing message to reply to

​
delayMessage
integer

Delay in seconds before sending (1-15)

Intervalo obrigatório: 1 <= x <= 15

Resposta

Message sent successfully

​
zaapId
string

Internal identifier

​
messageId
string

WhatsApp message ID

​
id
string

Same value as messageId (compatibility)