API do WhatsApp

Início rápido do WhatsApp

Entregue códigos OTP por WhatsApp com encriptação de ponta a ponta. Alcance mais de 2 mil milhões de utilizadores em mercados onde o SMS tem taxas de entrega baixas.

O utilizador tem de ter o WhatsApp instalado e o número registado. A mensagem aparecerá na sua caixa de entrada do WhatsApp — não é necessário opt-in para mensagens OTP enviadas através da Novauth.

Quer testar sem mensagens reais? Use o Modo sandbox — nenhuma mensagem de WhatsApp enviada, códigos OTP previsíveis e sem faturação.

1Enviar uma mensagem OTP de WhatsApp

Faça POST do número do destinatário e do código OTP no campo text. A Novauth envolve-o num modelo de entrega com a sua marca antes do envio — passe apenas o código numérico, não uma frase completa.

POST/api/v1/connect-hub/whatsapp/otp

bash

curl -X POST https://api.novauth.com/api/v1/connect-hub/whatsapp/otp \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-account-id: YOUR_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "to":   "+14155552671",
    "text": "482951"
  }'

200 OK — Resposta

json

{
  "uuid": "01JQHM3P7KXNV8W2QF5DG6TYAB",  // save for delivery tracking
  "to":   "14155552671"                     // no + prefix
}

2Verificar o estado de entrega

Consulte o WDR (WhatsApp Delivery Report) para acompanhar o progresso da mensagem na rede do WhatsApp: enviada → entregue → lida.

GET/api/v1/connect-hub/whatsapp/{uuid}/wdr

bash

curl https://api.novauth.com/api/v1/connect-hub/whatsapp/01JQHM.../wdr \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-account-id: YOUR_ACCOUNT_ID"

3Comunicar o resultado da verificação

Depois de o utilizador submeter o código mostrado no seu WhatsApp, faça POST do resultado para fechar o registo da mensagem e registar o resultado.

POST/api/v1/connect-hub/whatsapp/webhook

bash

# Report verification outcome after the user submits the code
curl -X POST https://api.novauth.com/api/v1/connect-hub/whatsapp/webhook \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-account-id: YOUR_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "uuid":   "01JQHM...",
    "status": "Success"
  }'

Referência da API

POST/whatsapp/otpEnviar mensagem OTP de WhatsApp

GET/whatsapp/{uuid}/wdrObter relatório de entrega do WhatsApp

POST/whatsapp/webhookComunicar o resultado da verificação

POST/whatsapp/wdrListar todos os registos de WA (paginado)

Corpo do pedido — POST /whatsapp/otp

tostringrequiredTelefone do destinatário em formato E.164

textstringrequiredCódigo OTP a entregar (p. ex. 482951). A Novauth envolve-o num modelo de mensagem com a sua marca.