OTP verifizieren
Anfrage-URL
POST https://otp.api.engagelab.cc/v1/verifications
Authentifizierung
Bitte lesen Sie Authentifizierung, um zu erfahren, wie Sie die API-Authentifizierung durchführen.
Anfragebeispiel
Anfrage-Header
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Anfragetext
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Anfrageparameter
| Parameter | Typ | Option | Beschreibung |
|---|---|---|---|
| message_id | String | Erforderlich | Die dem Verifizierungscode entsprechende Nachrichten-ID, die von der Schnittstelle /messages zurückgegeben wird |
| verify_code | String | Erforderlich | Der zu verifizierende Verifizierungscode |
Antwortparameter
Erfolgsantwort
| Feld | Typ | Option | Beschreibung |
|---|---|---|---|
| message_id | String | Erforderlich | Die dem Verifizierungscode entsprechende Nachrichten-ID, die von der Schnittstelle /v1/messages zurückgegeben wird |
| verify_code | String | Erforderlich | Der zu verifizierende Verifizierungscode |
| verified | Boolean | Erforderlich | Verifizierungsergebnis, true bedeutet erfolgreiche Verifizierung, false bedeutet fehlgeschlagene Verifizierung |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Beachten Sie, dass bei einer Verifizierungsanfrage für den Verifizierungscode derselben Nachricht gilt: Wenn der Verifizierungscode erfolgreich verifiziert wurde und diese Verifizierungsschnittstelle erneut aufgerufen wird, gibt die Schnittstelle einen Fehler zurück mit dem Hinweis, dass der Verifizierungscode dieser Nachricht bereits verifiziert wurde; das heißt, eine erneute Verifizierung des Verifizierungscodes nach erfolgreicher Verifizierung wird nicht unterstützt. Wenn Sie die Verifizierung in Ihrem eigenen System abschließen, rufen Sie Verifizierungsergebnis melden auf, um das erfolgreiche Verifizierungsergebnis zu melden.
Fehlerantwort
Der HTTP-Statuscode ist 4xx oder 5xx, und der Antworttext enthält die folgenden Felder:
| Feld | Typ | Option | Beschreibung |
|---|---|---|---|
| code | int | Erforderlich | Fehlercode, Details siehe Fehlercode-Beschreibung |
| message | String | Erforderlich | Fehlerdetails |
{
"code": 3003,
"message": "verify code has expired"
}
Fehlercodes
| Fehlercode | HTTP-Code | Beschreibung |
|---|---|---|
| 1000 | 500 | Interner Fehler |
| 2001 | 401 | Authentifizierung fehlgeschlagen, falsches Token übermittelt |
| 2002 | 401 | Authentifizierung fehlgeschlagen, Token ist abgelaufen oder deaktiviert |
| 2004 | 403 | Keine Berechtigung zum Aufruf dieser API |
| 3001 | 400 | Ungültiges Format des Anfrageparameters, bitte prüfen Sie, ob der JSON-Inhalt dem Parameterformat entspricht |
| 3002 | 400 | Fehlerhafte Anfrageparameter, bitte prüfen Sie, ob die Anfrageparameter die Anforderungen erfüllen |
| 3003 | 400 | Verifizierungscode ist abgelaufen oder wurde bereits verifiziert. Bei der Antwort mit diesem Fehlercode muss erneut eine neue Verifizierungscode-Nachricht gesendet werden |
| 3011 | 400 | Verifizierungscode abgelaufen |
| 4001 | 400 | Die Nachricht existiert nicht |










