OTP-Zustellung

Diese API generiert Verifizierungscodes über die EngageLab-Plattform und stellt sie entsprechend der in der Vorlage angegebenen Kanalstrategie zu.

Wenn Sie Verifizierungscodes selbst generieren möchten, anstatt die EngageLab-Plattform zu verwenden, können Sie die API EngageLab OTP Custom Verification Code Delivery aufrufen.

Endpoint

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

Authentifizierung

Verwenden Sie HTTP Basic Authentication und fügen Sie Authorization dem HTTP-Header hinzu:

              
              Authorization: Basic ${base64_auth_string}

            

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

Anfragebeispiel

Request Header

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

            

Request Body

              
              {
  "to": "+6591234567",
  "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.

Hinweise zu params

1. Für vordefinierte Felder in der Vorlage, z. B. from_id, wird bei der Zustellung der Nachricht die in der Vorlage voreingestellte from_id verwendet, wenn kein Wert für das Feld param_vars angegeben wird.
2. Wenn ein Wert für das Feld param_vars angegeben wird, z. B. param_vars:{"from_id":"12345"}, dann wird die from_id der Vorlage bei der Zustellung der Nachricht durch 12345 ersetzt.
3. Gleichzeitig werden auch benutzerdefinierte Variablenfelder im Vorlageninhalt, die bei der Erstellung der Vorlage erstellt wurden, über param_vars zugewiesen. 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"
}

            

Beachten Sie, dass der zurückgegebene Wert send_channel nicht den endgültigen Kanal darstellt, der für die Zustellung der Nachricht an den Nutzer verwendet wurde. Er gibt nur den aktuell verwendeten Kanal an. Wenn die Vorlagenstrategie beispielsweise so konfiguriert ist, dass die Zustellung über den WhatsApp-Kanal fehlschlägt und dann automatisch eine erneute Zustellung über den SMS-Kanal erfolgt, gibt die API-Antwort den Wert whatsapp zurück. Nach einer gewissen Zeit, sobald der Zustellungsfehler erkannt wurde, sendet das System die Nachricht über den SMS-Kanal.

Fehlgeschlagene Antwort

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

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

            

Fehlercodes