Primeiros passos

Em poucos minutos você cria uma instância, conecta o número de WhatsApp e dispara a primeira mensagem.

1. Crie uma instância

Uma instância é um número de WhatsApp conectado. A quantidade que você pode criar depende do seu plano.

POST/v1/instances

curl -X POST https://dashboard.vistoazul.com.br/api/v1/instances \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"vendas"}'

Resposta — já vem com o QR code pra conectar:

{
  "instance": { "id": "...", "name": "vendas" },
  "qrcode": "data:image/png;base64,..."
}

Limite do plano: se você já atingiu o número de conexões do seu plano, a criação retorna 403. Faça upgrade no painel pra liberar mais.

2. Conecte o número

Você tem dois caminhos:

Opção A — QR code

Renderize o qrcode da resposta acima e escaneie no celular: WhatsApp → Aparelhos conectados → Conectar aparelho. Para gerar um novo QR (instância caiu):

GET/v1/instances/:instance/connect

curl https://dashboard.vistoazul.com.br/api/v1/instances/vendas/connect \
  -H "Authorization: Bearer SUA_API_KEY"

Opção B — código de pareamento

Sem escanear: gera um código de 8 dígitos pra digitar no celular (Conectar com número de telefone).

POST/v1/instances/:instance/pair

curl -X POST https://dashboard.vistoazul.com.br/api/v1/instances/vendas/pair \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone":"5511999999999"}'

3. Confira o status

GET/v1/instances

{
  "instances": [
    { "name": "vendas", "number": "5511999999999",
      "status": "connected", "profileName": "Loja Exemplo" }
  ]
}

O status pode ser connected, connecting ou disconnected. Use o valor de name nas próximas chamadas.

4. Ajustes da instância (opcional)

Configure o comportamento do número — ignorar grupos, ficar sempre online, marcar mensagens como lidas, rejeitar chamadas, etc.

POST/v1/instances/:instance/settings

curl -X POST https://dashboard.vistoazul.com.br/api/v1/instances/vendas/settings \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"alwaysOnline":true,"rejectCall":true,"msgCall":"Não atendo chamadas por aqui 🙏"}'

Pronto. Número conectado? Siga para Enviar mensagens.

Anterior← Visão geral PróximoEnviar mensagens →