SMS Phone Confirmation API — OTP senden

Support DQE
Support DQE
  • Aktualisiert

Der Endpunkt GDPR_MSG sendet eine SMS mit einem Verifizierungscode an eine Telefonnummer, zusammen mit den ausgewählten DSGVO-Kommunikationseinwilligungskanälen.

Verwandte SMS-Phone-Confirmation-Dokumentation:

GET-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/GDPR_MSG/?Phone={PHONE}&Duration={DURATION}&Custom_sms={CUSTOM_SMS_CONTENT}&Phonecom={VALUE_PHONECOM}&Email={VALUE_EMAIL}&Post={VALUE_POST}&Sms={VALUE_SMS}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Company={COMPANY_NAME}

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
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
Phone {PHONE} Telefonnummer im internationalen Format. Pflicht
Country {COUNTRY_CODE} ISO-3-Buchstaben-Ländercode. Pflicht
Company {COMPANY_NAME} Firmenname, der als SMS-Absender verwendet wird. Mindestens 3 und maximal 11 Zeichen. Pflicht
Custom_sms {CUSTOM_SMS_CONTENT} Benutzerdefinierter SMS-Inhalt. Auf 125 Zeichen begrenzt. Der Verifizierungscode wird automatisch angehängt. Pflicht
Duration {DURATION} Gültigkeitsdauer des SMS-Codes in Minuten. Optional
Phonecom {VALUE_PHONECOM} 1 oder 0. Gibt an, ob die Einwilligung zur telefonischen Kommunikation erteilt wurde. Optional
Email {VALUE_EMAIL} 1 oder 0. Gibt an, ob die Einwilligung zur E-Mail-Kommunikation erteilt wurde. Optional
Post {VALUE_POST} 1 oder 0. Gibt an, ob die Einwilligung zur postalischen Kommunikation erteilt wurde. Optional
Sms {VALUE_SMS} 1 oder 0. Gibt an, ob die Einwilligung zur SMS-Kommunikation erteilt wurde. Optional

Optionale Einwilligungsparameter für mehrere Kontakte: SMS2–SMS5, PHONE2–PHONE5, EMAIL2–EMAIL5, POST2–POST5 (Einwilligung für sekundäre Kontakte).

POST-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/GDPR_MSG/

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

Parameter Wert Beschreibung Pflicht/Optional
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
Phone {PHONE} Telefonnummer im internationalen Format. Pflicht
Country {COUNTRY_CODE} ISO-3-Buchstaben-Ländercode. Pflicht
Company {COMPANY_NAME} Firmenname, der als SMS-Absender verwendet wird. Mindestens 3 und maximal 11 Zeichen. Pflicht
Custom_sms {CUSTOM_SMS_CONTENT} Benutzerdefinierter SMS-Inhalt. Auf 125 Zeichen begrenzt. Der Verifizierungscode wird automatisch angehängt. Pflicht
Duration {DURATION} Gültigkeitsdauer des SMS-Codes in Minuten. Optional
Phonecom {VALUE_PHONECOM} 1 oder 0. Gibt an, ob die Einwilligung zur telefonischen Kommunikation erteilt wurde. Optional
Email {VALUE_EMAIL} 1 oder 0. Gibt an, ob die Einwilligung zur E-Mail-Kommunikation erteilt wurde. Optional
Post {VALUE_POST} 1 oder 0. Gibt an, ob die Einwilligung zur postalischen Kommunikation erteilt wurde. Optional
Sms {VALUE_SMS} 1 oder 0. Gibt an, ob die Einwilligung zur SMS-Kommunikation erteilt wurde. Optional

Optionale Einwilligungsparameter für mehrere Kontakte: SMS2–SMS5, PHONE2–PHONE5, EMAIL2–EMAIL5, POST2–POST5 (Einwilligung für sekundäre Kontakte).

Antwort

Erfolgsantwort

Die JSON-Antwort enthält den SMS-Zustellstatus und Verifizierungsmetadaten.

Schlüssel Beschreibung Format
status SMS-Zustellstatus. STRING
timeout Gültigkeitsdauer des Codes in Minuten. STRING
companyName Als Absender verwendeter Firmenname. STRING
country ISO-3-Buchstaben-Ländercode. STRING
to Telefonnummer des Empfängers im internationalen Format. STRING
channels Ausgewählte Kommunikationskanäle. JSON OBJECT
errors Fehlerdetails. JSON OBJECT
smsToken Eindeutige Kennung der SMS. Übergeben Sie diesen Wert an GDPR_VERIF als Parameter Token. STRING
dateTime Datum und Uhrzeit des SMS-Versands. STRING

Statuswerte:

Status Beschreibung
PENDING Die SMS wurde an den Betreiber gesendet.
DELIVERED Die SMS wurde erfolgreich zugestellt.
UNDELIVERABLE Die SMS konnte nicht zugestellt werden.
EXPIRED Die SMS ist vor der Zustellbestätigung abgelaufen.
REJECTED Die SMS wurde vom Betreiber abgelehnt.

Fehlercodes:

Code Beschreibung
00 Keine Fehler.
01 Fehlende Parameter.
02 Dienst für diese Lizenz nicht autorisiert.
03 Ungültige Telefonnummer.
04 Ungültiger Ländercode.
05 Ungültige Dauer.
06 Land nicht gefunden.
07 Ungültiger Firmenname.
08 Interner API-Fehler.
09 Kein Zustellstatus empfangen.
10 Ungültige Einwilligungswerte.
11 Mindestens ein Kommunikationskanal muss aktiviert sein.

Beispiel:

{
  "channels": {
    "phone": 0,
    "post": 0,
    "sms": 1,
    "email": 1
  },
  "to": "33612345678",
  "errors": {
    "00": "00 - No errors"
  },
  "status": "DELIVERED",
  "smsToken": "C6hfYZIER3CVoGVYwTiZLg",
  "timeout": "3",
  "companyName": "MYCOMPANY",
  "country": "FRA",
  "dateTime": "2019-07-29 11:32:32.876709"
}

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich