Verifizierungsergebnis melden | OTP API-Referenz Deutsch

Nachdem EngageLab einen Verifizierungscode gesendet hat, können Sie diese API aufrufen, um ein erfolgreiches Verifizierungsergebnis für die Backfill-Statistik zu melden, wenn Sie die Verifizierung in Ihrem eigenen System abgeschlossen haben.

Diese API ist kostenlos und nimmt nur erfolgreiche Verifizierungsergebnisse entgegen.

Anfrage-URL

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

Authentifizierung

Bitte lesen Sie Authentifizierung, um zu erfahren, wie Sie die API-Authentifizierung durchführen.

Verwenden Sie den API Key der Anwendung, die die Nachricht gesendet hat, und stellen Sie sicher, dass dieser API Key die Berechtigung zur Verifizierung (verify) besitzt.

Anfragebeispiel

Anfrage-Header

POST /v1/backfill HTTP/1.1 Content-Type: application/json Authorization: Basic ${base64_auth_string}

              
              POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

Anfragetext

{ "message_id": "1725407449772531712", "verified_at": 1793116800 }

              
              {
    "message_id": "1725407449772531712",
    "verified_at": 1793116800
}

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Der Anfragetext verwendet JSON. Setzen Sie den Anfrage-Header Content-Type: application/json.

Parameter	Typ	Option	Beschreibung
message_id	String	Erforderlich	Nachrichten-ID des Verifizierungscodes, zurückgegeben von der Sende-API
verified_at	Integer	Erforderlich	Zeitpunkt der erfolgreichen Verifizierung als Unix-Zeitstempel in Sekunden

Antwortparameter

Erfolgsantwort

Der HTTP-Statuscode 200 bedeutet, dass die Plattform dieses erfolgreiche Verifizierungsergebnis aufgezeichnet hat.

Feld	Typ	Option	Beschreibung
code	Integer	Erforderlich	Bei Erfolg `0`
message	String	Erforderlich	Ergebnisbeschreibung. Bei Erfolg `success`

{ "code": 0, "message": "success" }

              
              {
    "code": 0,
    "message": "success"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

Der HTTP-Statuscode ist 4xx oder 5xx, und der Antworttext enthält einen Fehlercode und eine Fehlerbeschreibung. Wurde die Nachricht beispielsweise bereits erfolgreich verifiziert, gibt die API HTTP 400 zurück:

Feld	Typ	Option	Beschreibung
code	Integer	Erforderlich	Fehlercode, siehe die Fehlercodes unten
message	String	Erforderlich	Fehlerbeschreibung

{ "code": 3012, "message": "verify code has already validated" }

              
              {
    "code": 3012,
    "message": "verify code has already validated"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode	HTTP-Code	Beschreibung
1000	500	Interner Dienstfehler. Bitte versuchen Sie es später erneut
2001	401	Authentifizierungsinformationen fehlen oder sind ungültig
2002	401	Der API Key ist abgelaufen oder wurde deaktiviert
2002	403	Die aktuelle Anwendung ist nicht verfügbar
2004	403	Der API Key hat keine Berechtigung, diese API aufzurufen
3001	400	Das Anfrage-JSON ist ungültig oder ein Parametertyp ist falsch
3002	400	Ein Parameterwert ist ungültig, die Zeit liegt außerhalb des zulässigen Bereichs, oder die Nachricht unterstützt kein Backfill
3012	400	Die Nachricht wurde bereits erfolgreich verifiziert und muss nicht erneut gemeldet werden
4001	400	Die Nachricht existiert nicht oder gehört nicht zur aktuellen Anwendung

Behandeln Sie Fehler anhand von code. message erläutert den konkreten Grund.

Hinweise

Es werden nur erfolgreich gesendete Verifizierungscode-Nachrichten unterstützt. Nachrichten, deren Plattform-Verifizierung zuvor fehlgeschlagen ist oder das Zeitlimit überschritten hat, können weiterhin gemeldet werden, wenn Sie sie selbst erfolgreich verifiziert haben.
Die erste Meldung muss weniger als 30 Tage nach dem Versand der ursprünglichen Nachricht erfolgen. Maßgeblich ist der Zeitpunkt, zu dem die Plattform die Anfrage empfängt.
Der Zeitpunkt der erfolgreichen Verifizierung darf nicht vor dem Versandzeitpunkt der ursprünglichen Nachricht und nicht nach dem Empfangszeitpunkt dieser Anfrage durch die Plattform liegen.
Wurde eine Nachricht über diese API oder die API OTP verifizieren als erfolgreich verifiziert aufgezeichnet, geben weitere Meldungen oder Verifizierungen 3012 zurück.

Nach einem erfolgreichen Backfill sendet die Plattform den entsprechenden Nachrichtenstatus gemäß der Callback-Konfiguration der Anwendung.