SMS Phone Confirmation API
Der Endpunkt /GDPR_VERIF/ überprüft den vom Nutzer eingegebenen PIN-Code anhand des Tokens, das von einer vorherigen GDPR_MSG-Anfrage zurückgegeben wurde.
Wann dieser Endpunkt verwendet wird – Rufen Sie
GDPR_VERIF auf, um die per SMS empfangene PIN eines Nutzers zu überprüfen. Sie müssen zunächst ein Token abrufen, indem Sie SMS Phone Confirmation API — OTP senden (/GDPR_MSG/) → aufrufen.
/GDPR_VERIF/
Anfrage
Sowohl GET als auch POST werden unterstützt.
{SERVER_ADDRESS} wird von DQE bei der Kontoerstellung bereitgestellt. Wenden Sie sich an Ihren DQE-Kundenbetreuer, um sie zu erhalten.
GEThttps://{SERVER_ADDRESS}/GDPR_VERIF/?Phone={PHONE}&Token={SMS_TOKEN}&Pin={CODE_PIN}
Codebeispiele
PIN-Code überprüfen
curl "https://{SERVER_ADDRESS}/GDPR_VERIF/?Phone=33612345678&Token=C6hfYZIER3CVoGVYwTiZLg&Pin=123456"
fetch("https://{SERVER_ADDRESS}/GDPR_VERIF/?" + new URLSearchParams({
Phone: "33612345678",
Token: "C6hfYZIER3CVoGVYwTiZLg",
Pin: "123456"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/GDPR_VERIF/",
params={
"Phone": "33612345678",
"Token": "C6hfYZIER3CVoGVYwTiZLg",
"Pin": "123456",
},
)
print(response.json())
<?php
$params = http_build_query([
'Phone' => '33612345678',
'Token' => 'C6hfYZIER3CVoGVYwTiZLg',
'Pin' => '123456',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/GDPR_VERIF/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/GDPR_VERIF/', {
params: {
Phone: '33612345678',
Token: 'C6hfYZIER3CVoGVYwTiZLg',
Pin: '123456'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/GDPR_VERIF/"
+ "?Phone=33612345678&Token=C6hfYZIER3CVoGVYwTiZLg&Pin=123456";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/GDPR_VERIF/" +
"?Phone=33612345678&Token=C6hfYZIER3CVoGVYwTiZLg&Pin=123456";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/GDPR_VERIF/" +
"?Phone=33612345678&Token=C6hfYZIER3CVoGVYwTiZLg&Pin=123456"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
POSThttps://{SERVER_ADDRESS}/GDPR_VERIF/
Senden Sie alle Parameter im Anfragetext mit Content-Type: application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.
Codebeispiele
PIN-Code überprüfen
curl -X POST "https://{SERVER_ADDRESS}/GDPR_VERIF/" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "Phone=33612345678" \
-d "Token=C6hfYZIER3CVoGVYwTiZLg" \
-d "Pin=123456"
fetch("https://{SERVER_ADDRESS}/GDPR_VERIF/", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({
Phone: "33612345678",
Token: "C6hfYZIER3CVoGVYwTiZLg",
Pin: "123456"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/GDPR_VERIF/",
data={
"Phone": "33612345678",
"Token": "C6hfYZIER3CVoGVYwTiZLg",
"Pin": "123456",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/GDPR_VERIF/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Phone' => '33612345678',
'Token' => 'C6hfYZIER3CVoGVYwTiZLg',
'Pin' => '123456',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/GDPR_VERIF/', qs.stringify({
Phone: '33612345678',
Token: 'C6hfYZIER3CVoGVYwTiZLg',
Pin: '123456'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Phone=33612345678&Token=C6hfYZIER3CVoGVYwTiZLg&Pin=123456";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/GDPR_VERIF/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string> {
["Phone"] = "33612345678",
["Token"] = "C6hfYZIER3CVoGVYwTiZLg",
["Pin"] = "123456"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/GDPR_VERIF/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("Phone", "33612345678")
form.Set("Token", "C6hfYZIER3CVoGVYwTiZLg")
form.Set("Pin", "123456")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/GDPR_VERIF/", form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameter
| Parameter | Beschreibung | Pflicht/Optional |
|---|---|---|
| Phone | Telefonnummer im internationalen Format, ohne das Pluszeichen + und ohne Leerzeichen (zum Beispiel 49XXXXXXXXXXX für Deutschland). |
Pflicht |
| Token | Identifikator, der von der GDPR_MSG-Anfrage zurückgegeben wird (Feld smsToken). |
Pflicht |
| Pin | 6-stelliger Verifizierungscode, der vom Nutzer per SMS empfangen wurde. | Pflicht |
Antwort
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| status |
OK, wenn die PIN gültig ist, andernfalls KO. |
String |
| phone | Telefonnummer im internationalen Format. | String |
| dateTime | Datum und Uhrzeit der Überprüfung. | String |
| channels | Ausgewählte Kommunikationskanäle. | Object |
| errors | Fehlerdetails. Siehe die Tabelle der Fehlercodes unten. | Object |
Fehlercodes
| Code | Beschreibung |
|---|---|
00 |
Keine Fehler. |
01 |
Fehlende Parameter. |
02 |
Die PIN muss 6 Ziffern enthalten. |
03 |
Die PIN ist abgelaufen. |
04 |
Die PIN ist für dieses Token oder diese Telefonnummer ungültig. |
05 |
Ungültiges Token. |
Antwortbeispiel
Gültige PIN
{
"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"
}
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.
Konsole öffnen
Siehe auch
Verknüpfung mit