Custom OTP Code Delivery - Secure Transmission and Best Practices

Wenn Sie den Verifizierungscode lieber selbst generieren möchten, anstatt die EngageLab-Plattform zu verwenden, können Sie diese API aufrufen.

Diese API dient ausschließlich dem Versand bereits generierter Verifizierungscodes und generiert die Codes nicht selbst. Nach dem Versand des Verifizierungscodes ist kein weiterer Aufruf der Verifizierungs-API zur Validierung erforderlich.

Wenn Sie möchten, dass die EngageLab-Plattform den Verifizierungscode generiert, nutzen Sie bitte die EngageLab OTP Send API.

Endpoint

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

Authentifizierung

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

              
              Authorization: Basic ${base64_auth_string}

            

Der base64_auth_string wird wie folgt generiert: base64(dev_key:dev_secret)

Beispiel für eine Anfrage

Request Header

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

            

Request Body

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

            

Anfrageparameter

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

Hinweise zu params

1. Für Templates mit vordefinierten Feldern wie from_id gilt: Wird kein Wert für das Feld param_vars übergeben, verwendet die Nachricht beim Versand den im Template hinterlegten from_id-Wert.
2. Werden Werte für param_vars übergeben, z. B. param_vars:{"from_id":"12345"}, ersetzt beim Versand der Wert 12345 den im Template hinterlegten from_id.
3. Ebenso können benutzerdefinierte Variablen im Template-Inhalt über param_vars zugewiesen werden, z. B. für den Template-Text Hi {{name}}, your verify code is {{code}} erfolgt die Zuweisung 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 Versandweg. Ist beispielsweise im Template eine Strategie hinterlegt, bei Zustellfehler von WhatsApp auf SMS umzuschalten, zeigt die API zunächst WhatsApp an. Wird ein Fehler erkannt, erfolgt der Versand automatisch per SMS.

Fehlerantwort

Bei einem HTTP-Statuscode 4xx oder 5xx enthält der Response-Body folgende Felder:

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

            

Fehlercodes