Este guia leva você da conta vazia ao primeiro envio. Tudo via API: registro, OTP, cartão, plano e mensagem.
Em poucas palavras
- Registrar conta com survey de onboarding (campos com enums fixos)
- Verificar telefone com OTP → recebe
apiKey (guarde agora)
- Opcional: cadastrar cartão e assinar plano
- Enviar mensagem com a API key nos canais
Enums do onboarding: Registro e verificação.
1. Registrar conta
Resposta: verificationToken, deliveryChannel (whatsapp ou sms), expiresAt, retryAfter.
2. Verificar telefone
Resposta: apiKey, workspaceId, user. Guarde a apiKey — ela não é exibida novamente.
3. (Opcional) Cadastrar cartão e assinar plano
Detalhes de cartão, PIX e recarga: Billing.
4. Enviar primeira mensagem
Login em conta existente
Com 2FA: o primeiro login devolve requiresSecondFactor + verificationToken; chame login de novo com esse token + totpCode (não use verify). Detalhes: Registro e verificação.
Segundo workspace
Depois faça login com workspaceId do novo workspace para obter API key nele.
Idempotency-Key
Em envios (POST /v1/*/messages), use header Idempotency-Key. Respostas cacheadas incluem Idempotency-Replayed: true.
Próximos passos
- Webhooks: receber eventos no seu servidor
- Workspaces: organizar instâncias e equipe
- Escopos: restringir a chave para produção