Sending OTP Codes Securely - Explore Delivery Methods and Best Practices

Diese API generiert den Verifizierungscode über die EngageLab-Plattform und versendet ihn entsprechend der im Template festgelegten Kanalstrategie.

Wenn Sie den Verifizierungscode lieber selbst generieren möchten, anstatt die EngageLab-Plattform zu nutzen, können Sie die EngageLab Custom OTP Send API aufrufen.

Endpoint

POST https://otp.api.engagelab.cc/v1/messages

Authentifizierung

Zur Verifizierung wird HTTP Basic Authentication verwendet. Fügen Sie eine Autorisierung im HTTP-Header hinzu:

              
              Authorization: Basic ${base64_auth_string}

            

Der Algorithmus zur Generierung des base64_auth_string lautet: base64(dev_key:dev_secret)

Beispiel für eine Anfrage

Anfrage-Header

              
              POST /v1/messages  HTTP/1.1  
Content-Type: application/json  
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Anfrage-Body

              
              {
    "to": "+8618701235678",
    "template":{
      "id":"test-template-1",
      "language": "default",
        "params": {
        "key1": "value1",
        "key2": "value2"
        }
    }
}

            

Anfrageparameter

Das Anfrageobjekt wird im JSON-Format übergeben, daher muss der Anfrage-Header Content-Type: application/json enthalten.

Hinweise zu params

1. Für Templates mit vordefinierten Feldern wie from_id gilt: Wird der Wert für das Feld param_vars nicht übergeben, verwendet die Nachricht beim Versand die im Template vordefinierte from_id.
2. Werden Werte für das Feld param_vars übergeben, z. B. param_vars:{"from_id":"12345"}, wird beim Versand die from_id des Templates durch 12345 ersetzt.
3. Ebenso können Sie für benutzerdefinierte Variablenfelder im Template-Inhalt Werte über param_vars zuweisen, z. B. für den Template-Inhalt Hi {{name}}, your verify code is {{code}} übergeben Sie die Parameter mit param_vars:{"name":"Bob"}.

Antwortparameter

Erfolgreiche Antwort

              
              {
    "message_id": "1725407449772531712",
    "send_channel": "sms"
}

            

Beachten Sie, dass der zurückgegebene Wert von send_channel nicht den endgültigen Versandkanal an die Nutzer:innen darstellt, sondern nur den aktuellen Versandschritt. Ist beispielsweise im Template eine Strategie hinterlegt, bei Zustellfehler von WhatsApp auf SMS zurückzufallen, zeigt die API-Rückgabe zunächst whatsapp an. Wird später ein Zustellfehler erkannt, nutzt das System für den Versand den SMS-Kanal.

Fehlerantwort

HTTP-Statuscode 4xx oder 5xx, der Antwort-Body enthält folgende Felder:

              
              {
    "code": 5001,
    "message": "sms send fail"
}

            

Fehlercodes