Primeiros passos

Início rápido

Crie uma instância, pareie o WhatsApp e envie a primeira mensagem em poucos minutos.

1. Crie a instância

No painel do tenant use o wizard em Instâncias → Nova, ou via API com TokenAccount.

2. Conecte o WhatsApp

GET ou POST `/api/instance/connect/{instance}` devolve o QR (base64). Escaneie em WhatsApp → Aparelhos conectados.

O socket de pairing fica vivo alguns minutos. Não fique gerando QR em loop — use GET para consultar o QR atual e POST `?fresh=1` só quando quiser um novo.

Depois do primeiro pareamento, o aparelho aparece como Wagzap (desktop). Se a sessão antiga mostrar “Outro dispositivo”, gere um QR novo e pareie de novo.

3. Envie um texto

Use o TokenInstance no header `token` (também aceita `apikey` e `Authorization: Bearer`). Número com DDI, sem +.

POST/api/instance/new

Criar instância

Provisiona uma instância na conta do TokenAccount. O nome precisa ser único na conta (slug).

Auth: TokenAccount

Body

CampoTipoDescrição
instanceNamestringobrigatórioslug único, ex.: vendas

cURL

curl -X POST https://api.wagzap.com.br/api/instance/new \
  -H "token: $TOKEN_ACCOUNT" \
  -H "Content-Type: application/json" \
  -d '{
  "instanceName": "vendas"
}'
GET/api/instance/connect/{instance}

Obter QR

Inicia ou reutiliza o pairing. Resposta inclui qrCode / base64 e status.

Auth: TokenInstance

cURL

curl -X GET https://api.wagzap.com.br/api/instance/connect/vendas \
  -H "token: $TOKEN_INSTANCE"
POST/api/message/text/{instance}

Primeira mensagem

Envia texto para um número com DDI, sem +.

Auth: TokenInstance

Body

CampoTipoDescrição
numberstringobrigatório5511999999999
messagestringobrigatóriotexto (alias: text)

cURL

curl -X POST https://api.wagzap.com.br/api/message/text/vendas \
  -H "token: $TOKEN_INSTANCE" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "5511999999999",
  "message": "Olá da Wagzap"
}'