O que sua integração precisa fazer?

Exemplo: Confirmar um pedido ou avisar uma atualização.

POST /instances/{instance}/messages com to e text. A resposta 202 devolve o id; o envio é processado em fila.

Exemplo: Enviar uma foto do produto ou uma nota de voz.

Mesma rota, com media_url ou media_base64. Imagem JPEG, PNG ou WebP; vídeo MP4 ou 3GP; até 16 MB. Áudio pode sair como nota de voz.

Exemplo: Enviar um boleto ou contrato em PDF.

type document com filename opcional, em qualquer formato, até 50 MB. O text vira legenda.

Exemplo: Encaminhar a resposta do cliente para o seu sistema.

Evento message.received com remetente, tipo e link para baixar o arquivo, válido por 7 dias.

Exemplo: Saber se a mensagem foi entregue e lida.

O evento message.status informa sent, delivered, read ou failed.

Exemplo: Conectar seu backend ao serviço.

Base HTTPS versionada em /api/v1, com requisições e respostas JSON.

Exemplo: Identificar chamadas autorizadas.

Chave Bearer com prefixo mc_, usada no backend. GET /health dispensa autenticação.

Exemplo: Atualizar seu sistema a cada evento.

message.received, message.status e instance.status, com assinatura HMAC-SHA256 e até 5 novas tentativas.

Exemplo: Automatizar sem escrever código.

No painel, em Instâncias → Integração, cole a URL do webhook da ferramenta e envie um teste.

Exemplo: Decidir quando corrigir ou repetir uma chamada.

Respostas 401, 402, 403, 404, 422 e 5xx, com mensagem e campo errors.

Exemplo: Separar números por operação ou cliente.

POST /instances com name, driver e webhook_url opcional.

Exemplo: Vincular um número de WhatsApp à instância.

O driver whatsapp_web vincula o número por QR Code.

Exemplo: Mostrar o QR Code dentro do seu produto.

POST /instances/{instance}/connect retorna o QR, que pode ser exibido como imagem.

Exemplo: Avisar sua equipe quando um número desconectar.

GET /instances/{instance}/status e o evento instance.status informam conexão e queda.

Exemplo: Reconciliar mensagens depois de uma indisponibilidade.

GET /instances/{instance}/messages filtra por direction, after_id e since, até 100 por página.

Exemplo: Dimensionar arquivos e armazenamento.

Arquivos ficam guardados por 30 dias. A quantidade de instâncias depende do plano.

Exemplo: Manter os acessos sob controle.

Crie chaves com validade e revogue quando precisar. O token completo aparece uma única vez.