API Documentation

POST

/instances/create

Criar Cliente WhatsApp

Criar uma nova instância do cliente WhatsApp. Este endpoint inicializa uma sessão dedicada permitindo envio e recebimento de mensagens. Depois disso utilize o endpoint de conexão para escanear o QR Code. Necessário antes de enviar qualquer mensagem.

GET

/instances/connect/{clientId}

Conectar Cliente WhatsApp

Retorna o QR Code necessário para autenticar sua instância do WhatsApp. O usuário deve escanear o QR Code para estabelecer conexão segura. Após a conexão o status mudará para 'conectado'.

POST

/messages/text

Enviar Mensagem

Envia uma mensagem de texto para um número WhatsApp. As mensagens são processadas em tempo quase real. Certifique‑se de que o cliente esteja conectado antes de enviar mensagens.

POST

/messages/typing

Simular Digitação

Simula o status de digitação por um período determinado. Melhora o engajamento mostrando que o bot está digitando antes de responder.