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://exemplo.com/arquivo.pdf",
  "fileName": "Meu documento"
}
'
{
  "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 gerada no painel de Segurança do Hub Message

Parâmetros de caminho

​
extension
string
obrigatório

Extensão do arquivo (ex: pdf, docx, xlsx)

Exemplo:

"pdf"

Corpo

application/json
​
phone
string
obrigatório

Telefone do destinatário (DDI + DDD + número)

Exemplo:

"5511999999999"

​
document
string
obrigatório

URL do documento ou dados em Base64

​
fileName
string

Nome do arquivo

​
caption
string

Descrição do documento

​
messageId
string

ID de uma mensagem existente para responder

​
delayMessage
integer

Delay em segundos antes do envio (1-15)

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

Resposta

Mensagem enviada com sucesso

​
zaapId
string

Identificador interno

​
messageId
string

ID da mensagem no WhatsApp

​
id
string

Mesmo valor do messageId (compatibilidade)