WhatsApp-API

WhatsApp-Schnellstart

OTP-Codes über WhatsApp mit Ende-zu-Ende-Verschlüsselung zustellen. Über 2 Mrd. Nutzer in Märkten erreichen, wo SMS geringe Zustellraten hat.

Der Nutzer muss WhatsApp installiert haben und seine Nummer registriert sein. Die Nachricht erscheint in seinem WhatsApp-Posteingang – für OTP-Nachrichten, die über Novauth gesendet werden, ist kein Opt-in erforderlich.

Testen ohne echte Nachrichten? Sandbox-Modus verwenden – keine WhatsApp-Nachrichten gesendet, vorhersehbare OTP-Codes und keine Abrechnung.

1WhatsApp-OTP-Nachricht senden

Nummer des Empfängers und OTP-Code im Feld text per POST senden. Novauth verpackt ihn in eine markenbezogene Zustellvorlage – nur den numerischen Code übergeben, keinen vollständigen Satz.

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 — Antwort

json

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

2Zustellstatus prüfen

Den WDR (WhatsApp Delivery Report) abrufen, um den Nachrichtenfortschritt durch das WhatsApp-Netzwerk zu verfolgen: sent → delivered → read.

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"

3Verifizierungsergebnis melden

Nachdem der Nutzer den in seinem WhatsApp angezeigten Code eingegeben hat, das Ergebnis per POST senden, um den Nachrichtendatensatz zu schließen und das Ergebnis zu erfassen.

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"
  }'

API-Referenz

POST/whatsapp/otpWhatsApp-OTP-Nachricht senden

GET/whatsapp/{uuid}/wdrWhatsApp-Zustellbericht abrufen

POST/whatsapp/webhookVerifizierungsergebnis melden

POST/whatsapp/wdrAlle WA-Datensätze auflisten (paginiert)

Request-Body — POST /whatsapp/otp

tostringrequiredEmpfängertelefon im E.164-Format

textstringrequiredZu übermittelnder OTP-Code (z. B. 482951). Novauth verpackt ihn in eine markenbezogene Nachrichtenvorlage.