SMS Phone Confirmation API — OTP verifizieren

Support DQE
Support DQE
  • Aktualisiert

Der Endpunkt GDPR_VERIF verifiziert den vom Nutzer eingegebenen PIN-Code anhand des Tokens, das von einer vorherigen GDPR_MSG-Anfrage zurückgegeben wurde.

Verwandte SMS-Phone-Confirmation-Dokumentation:

GET-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/GDPR_VERIF/?Phone={PHONE}&Token={SMS_TOKEN}&Pin={CODE_PIN}

Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen:

Parameter Wert Beschreibung Pflicht/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
Phone {PHONE} Telefonnummer im internationalen Format. Pflicht
Token {SMS_TOKEN} Von der GDPR_MSG-Anfrage zurückgegebene Kennung (Feld smsToken). Pflicht
Pin {CODE_PIN} 6-stelliger Verifizierungscode, den der Nutzer per SMS erhalten hat. Pflicht

POST-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/GDPR_VERIF/

Fügen Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu.

Parameter Wert Beschreibung Pflicht/Optional
Phone {PHONE} Telefonnummer im internationalen Format. Pflicht
Token {SMS_TOKEN} Von der GDPR_MSG-Anfrage zurückgegebene Kennung (Feld smsToken). Pflicht
Pin {CODE_PIN} 6-stelliger Verifizierungscode, den der Nutzer per SMS erhalten hat. Pflicht

Antwort

Erfolgsantwort

Schlüssel Beschreibung Format
status OK, wenn der PIN gültig ist, andernfalls KO. STRING
phone Telefonnummer im internationalen Format. STRING
dateTime Datum und Uhrzeit der Verifizierung. STRING
channels Ausgewählte Kommunikationskanäle. JSON OBJECT
errors Fehlerdetails. JSON OBJECT

Fehlercodes:

Code Beschreibung
00 Keine Fehler.
01 Fehlende Parameter.
02 Der PIN muss 6 Ziffern enthalten.
03 PIN abgelaufen.
04 PIN für dieses Token oder diese Telefonnummer ungültig.
05 Ungültiges Token.

Beispiel:

{
  "status": "OK",
  "phone": "33631525429",
  "errors": {
    "00": "00 - No errors"
  },
  "channels": {
    "phone": 0,
    "post": 0,
    "sms": 1,
    "email": 1
  },
  "dateTime": "2019-07-29 11:34:48.998397"
}

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich