Pular para o conteúdo principal

Quickstart — primeiro envio em 5 minutos

Você vai conectar um número e enviar a primeira mensagem.

1. Pegue sua API key​

No painel (admin) ou com o super-admin, crie uma API key do seu tenant. Ela vira Authorization: Bearer bz_live_... em toda chamada.

2. Crie um número e conecte por QR​

# cria a instância (número)
curl -X POST https://api.bzapper.com.br/instances \
  -H "Authorization: Bearer $BZ_KEY" -H "Content-Type: application/json" \
  -d '{"phone":"+5511999999999","nickname":"vendas"}'

# inicia a conexão por QR (ou ?method=code para código de pareamento)
curl -X POST "https://api.bzapper.com.br/instances/$ID/connect?method=qr" \
  -H "Authorization: Bearer $BZ_KEY"

A resposta traz qr_code. Renderize como QR e escaneie no WhatsApp em Aparelhos conectados → Conectar um aparelho. Acompanhe o status:

curl "https://api.bzapper.com.br/instances/$ID" -H "Authorization: Bearer $BZ_KEY"
# status: qr_pending → connecting → connected (número novo entra em "warming")

Dica: abra o stream SSE (GET /stream) e veja o status mudar na hora.

3. Envie a primeira mensagem​

curl -X POST https://api.bzapper.com.br/messages/text \
  -H "Authorization: Bearer $BZ_KEY" -H "Content-Type: application/json" \
  -d '{"instance_id":"'$ID'","to":"+5511988888888","body":"Olá do bZapper! 🐝"}'

Pronto. O envelope de status (message.sent/delivered/read) chega pelos webhooks e pelo SSE, com seu client_reference ecoado de ponta a ponta.

Próximo: validar webhooks (HMAC).