Benutzerdefinierte OTP-Code-Zustellung

Wenn Sie Verifizierungscodes selbst generieren möchten, anstatt sie von der EngageLab-Plattform generieren zu lassen, können Sie diese API aufrufen.

Diese API wird speziell zum Senden vorab generierter Verifizierungscodes verwendet und generiert selbst keine Verifizierungscodes. Nach dem Senden eines Verifizierungscodes ist es nicht erforderlich, eine Verifizierungs-API zur Validierung aufzurufen.

Wenn Sie möchten, dass die EngageLab-Plattform Verifizierungscodes generiert, können Sie die API EngageLab OTP Verification Code Delivery aufrufen.

Endpunkt

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

Authentifizierung

Verwenden Sie HTTP Basic Authentication, indem Sie Authorization zum HTTP-Header hinzufügen:

              
              Authorization: Basic ${base64_auth_string}

            

Der Generierungsalgorithmus für base64_auth_string lautet: base64(dev_key:dev_secret)

Anfragebeispiel

Anfrage-Header

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

            

Anfrage-Body

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

            

Anfrageparameter

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

Beschreibung von params

1. Für vordefinierte Vorlagenfelder wie from_id gilt: Wenn der Feldwert param_vars nicht angegeben wird, wird beim Senden der Nachricht das in der Vorlage vordefinierte from_id verwendet.
2. Wenn der Feldwert param_vars angegeben wird, z. B. param_vars:{"from_id":"12345"}, wird das from_id der Vorlage beim Senden der Nachricht durch 12345 ersetzt.
3. Benutzerdefinierte Variablenfelder im Vorlageninhalt, die bei der Erstellung der Vorlage angelegt wurden, werden ebenfalls über param_vars mit Werten versehen. Wenn der Vorlageninhalt beispielsweise Hi {{name}}, your verify code is {{code}} lautet, ist der Zuweisungsparameter param_vars:{"name":"Bob"} erforderlich.

Antwortparameter

Erfolgreiche Antwort

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

            

Bitte beachten Sie, dass der zurückgegebene Wert send_channel nicht den endgültigen Kanal darstellt, der für die Zustellung der Nachricht an den Benutzer verwendet wird; er steht nur für den aktuell verwendeten Kanal. Wenn die Vorlagenstrategie beispielsweise so konfiguriert ist, dass bei einer fehlgeschlagenen Zustellung über den WhatsApp-Kanal automatisch ein erneuter Versuch über den SMS-Kanal erfolgt, gibt die API-Antwort den Wert whatsapp zurück. Nach einer gewissen Zeit sendet das System über den SMS-Kanal, wenn ein Zustellungsfehler erkannt wird.

Fehlgeschlagene Antwort

Der HTTP-Statuscode ist 4xx oder 5xx, und der Antwort-Body enthält die folgenden Felder:

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

            

Fehlercodes