Pular para o conteúdo principal

​
Fluxo recomendado

1

Criar a instancia

Chame PUT /instances/create com JWT para criar a instancia e receber o id e o token.
2

Garantir billing

Use POST /instances/{id}/subscribe para ativar a assinatura (fluxo padrao direct na API, com cartao cadastrado como padrao).
3

Parear o WhatsApp

Use GET /instances/{id}/session/qr (repetindo o pedido enquanto o pareamento nao concluir) ou GET /instances/{id}/session/paircode/{phone} no fluxo com codigo. Este passo inicia o fluxo no worker; nao e necessario chamar connect separadamente.
4

Enviar e receber eventos

Configure webhook, envie mensagens e acompanhe status pelos endpoints da API.

​
Exemplo resumido

# 1. criar
curl -X PUT "https://api.vzaps.com/instances/create" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{"name":"Minha instancia"}'

# 2. assinar (fluxo direto na API; exige cartao padrao no Stripe)
curl -X POST "https://api.vzaps.com/instances/INSTANCE_ID/subscribe" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{}'

# 3. QR / pareamento (GET inicia o fluxo no worker; repita ate a conta ficar ativa)
curl -X GET "https://api.vzaps.com/instances/INSTANCE_ID/session/qr" \
  -H "X-Instance-Token: TOKEN_DA_INSTANCIA" \
  -H "X-Client-Token: SEU_CLIENT_TOKEN"

​
O que observar em cada etapa

  • create: devolve o token da instancia e o status comercial inicial.
  • subscribe: em uso normal pela API, retorna mode: "direct" quando a assinatura e criada com o cartao padrao.
  • session/qr: quando a conta WhatsApp ainda nao estiver autenticada, devolve um QRCode em data URL; repita o GET ate concluir o pareamento.
  • session/status: devolve apenas data.connected: true se a instancia esta conectada ao WhatsApp (conta autenticada), false caso contrario.

​
Cancelamento e retomada

  • Use PUT ou DELETE /instances/{id}/cancel para cancelar a instancia pela API publica.
  • Use POST /instances/{id}/resume-subscription quando houver cancelamento ao fim do periodo e voce quiser reverter esse agendamento.

​
Depois do onboarding

Quando a instancia estiver ativa e conectada, voce pode:
  • configurar e consultar webhook;
  • enviar mensagens, arquivos, links, listas e botoes;
  • consultar usuarios, grupos, contatos e filas de mensagens;
  • usar session/status para ver se esta conectado ao WhatsApp e acompanhar filas pelos endpoints de fila.