API de Mensagens

Envie mensagens pelo WhatsBlast a partir de sistemas externos via API REST.

A API de Mensagens permite que outros sistemas enviem mensagens pelo WhatsBlast de forma programática — sem intervenção manual. Ideal para integrar com sistemas de agendamento, ERPs, e-commerce ou qualquer plataforma que precise enviar notificações via WhatsApp.

Disponibilidade por plano O acesso à API externa pode exigir um plano específico. Verifique com o administrador se a API está habilitada para sua conta.

Onde encontrar sua chave de API

1
Acesse API de Mensagens no menu lateral
2
Copie o Token de acesso exibido na tela. Esse token está vinculado a uma conexão WhatsApp específica (não à conta inteira) — cada conexão tem seu próprio token, e é ele que determina por qual número a mensagem será enviada.

Autenticação

Todas as requisições devem incluir o token no header:

Authorization: Bearer SEU_TOKEN_AQUI
Não existe parâmetro para escolher a conexão A conexão de envio é definida pelo próprio token usado na autenticação. Para enviar por números diferentes, use o token de cada conexão correspondente.

Endpoints disponíveis

Enviar mensagem de texto

POST /api/messages/send

{
  "number": "5518999991234",
  "body": "Olá! Sua consulta foi confirmada para amanhã às 14h."
}

Parâmetros opcionais:

CampoTipoO que faz
msdelaynumberAtraso em milissegundos antes de enviar a mensagem
quotedMsgstringID de uma mensagem para responder/citar
userIdnumberID do atendente a quem o ticket gerado deve ser atribuído
queueIdnumberID da fila para onde o ticket gerado deve ir
sendSignaturebooleanSe true, inclui a assinatura do atendente/sistema na mensagem
closeTicketbooleanSe true, encerra o ticket automaticamente após o envio
noRegisterbooleanSe true, envia a mensagem sem criar/registrar um ticket no sistema

Enviar mensagem com arquivo (upload direto)

Para enviar imagem, PDF, áudio ou outro arquivo direto do seu sistema (sem precisar hospedar a URL), envie como multipart/form-data no mesmo endpoint /api/messages/send, incluindo o campo medias com o(s) arquivo(s):

POST /api/messages/send
Content-Type: multipart/form-data

number=5518999991234
body=Segue o documento solicitado
medias=@arquivo.pdf

Enviar mensagem com imagem (via URL)

POST /api/messages/send/linkImage

{
  "number": "5518999991234",
  "body": "Segue o comprovante:",
  "mediaUrl": "https://seusite.com.br/arquivo.jpg"
}

Verificar se o número existe no WhatsApp

POST /api/messages/checkNumber

{
  "number": "5518999991234"
}

Enviar template oficial (conexão API Oficial / WABA)

Para conexões via API Oficial, mensagens iniciadas pela empresa fora da janela de 24h devem usar um template aprovado pela Meta. Veja a documentação completa em Templates Oficiais, incluindo o endpoint POST /messages/template/:ticketId e os formatos de variáveis e componentes.

Formato de resposta

Em caso de sucesso, a API retorna 200 com os dados da mensagem criada:

{
  "id": "3EB0...",
  "ticket": { "id": 142, "status": "open" },
  "number": "5518999991234",
  "body": "Olá! Sua consulta foi confirmada..."
}

Erros comuns

CódigoCausaSolução
401 Token ausente, inválido ou de conexão desconectada Confira o header Authorization e se a conexão correspondente está ativa
400 Campo number ou body ausente, ou formato de número inválido Use o formato internacional: 55 + DDD + número, sem espaços ou símbolos
404 Conexão referente ao token não foi encontrada Verifique se o token foi copiado corretamente, sem espaços extras
500 Erro ao enviar via conexão (ex: WhatsApp desconectado no momento do envio) Verifique o status da conexão em Conexões antes de reenviar

Formato do número

Use sempre o formato internacional sem espaços ou caracteres especiais: 55 (Brasil) + DDD + número. Exemplo: 5518999991234.

Casos de uso comuns

Testando a API Na tela de API de Mensagens dentro do WhatsBlast existe uma interface para testar os endpoints diretamente, sem precisar de código. Ótimo para validar antes de integrar.
Guarde seu token com segurança O token dá acesso de envio de mensagens pela sua conta. Não compartilhe em código público (GitHub, etc.) nem exponha em variáveis sem proteção.