Phone-Validierung – RESTful API
Der Endpunkt phonelookup validiert und formatiert Festnetz- oder Mobiltelefonnummern und liefert Carrier-, Standort- und Typinformationen sowie optional den Aktivitätsstatus.
Wann sollten Sie diesen Endpunkt verwenden - Rufen Sie
phonelookup auf, um eine Telefonnummer zu validieren und Carrier, Typ und Standort in einer einzigen JSON-Antwort zu erhalten. Suchen Sie stattdessen die klassische XML/formularbasierte Integration? Siehe Classic Phone API (/TEL/) →
phonelookup
Anfrage
Sowohl GET als auch POST werden unterstützt.
{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoerstellung bereitgestellt. Wenden Sie sich an Ihren DQE-Kundenbetreuer, um diese Zugangsdaten zu erhalten.
GEThttps://{SERVER_ADDRESS}/v1/phonelookup/?Number={NUMBER}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Format={FORMAT}&Activity={ACTIVITY}&TimeOut={TIMEOUT}&Separator={SEPARATOR}
Codebeispiele
Gültige Mobilfunknummer
curl "https://{SERVER_ADDRESS}/v1/phonelookup/?Number=0606060606&Country=FRA&Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/v1/phonelookup/?" + new URLSearchParams({
Number: "0606060606",
Country: "FRA",
Licence: "{LICENCE_CODE}"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/v1/phonelookup/",
params={
"Number": "0606060606",
"Country": "FRA",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$params = http_build_query([
'Number' => '0606060606',
'Country' => 'FRA',
'Licence' => '{LICENCE_CODE}',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/v1/phonelookup/?{$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}/v1/phonelookup/', {
params: {
Number: '0606060606',
Country: 'FRA',
Licence: '{LICENCE_CODE}'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/v1/phonelookup/"
+ "?Number=0606060606&Country=FRA&Licence={LICENCE_CODE}";
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}/v1/phonelookup/" +
"?Number=0606060606&Country=FRA&Licence={LICENCE_CODE}";
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}/v1/phonelookup/" +
"?Number=0606060606&Country=FRA&Licence={LICENCE_CODE}"
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}/v1/phonelookup/
Senden Sie alle Parameter im Request-Body im Format Content-Type: application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.
Codebeispiele
Gültige Mobilfunknummer
curl -X POST "https://{SERVER_ADDRESS}/v1/phonelookup/" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "Number=0606060606" \
-d "Country=FRA" \
-d "Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/v1/phonelookup/", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({
Number: "0606060606",
Country: "FRA",
Licence: "{LICENCE_CODE}"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/v1/phonelookup/",
data={
"Number": "0606060606",
"Country": "FRA",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/v1/phonelookup/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Number' => '0606060606',
'Country' => 'FRA',
'Licence' => '{LICENCE_CODE}',
]));
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}/v1/phonelookup/', qs.stringify({
Number: '0606060606',
Country: 'FRA',
Licence: '{LICENCE_CODE}'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Number=0606060606&Country=FRA&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/v1/phonelookup/"))
.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> {
["Number"] = "0606060606",
["Country"] = "FRA",
["Licence"] = "{LICENCE_CODE}"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/v1/phonelookup/",
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("Number", "0606060606")
form.Set("Country", "FRA")
form.Set("Licence", "{LICENCE_CODE}")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/v1/phonelookup/", form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameter
| Parameter | Beschreibung | Pflicht/Optional |
|---|---|---|
| Number | Zu validierende Telefonnummer. | Pflicht |
| Country | ISO-3-Buchstaben-Ländercode. | Pflicht |
| Licence | Ihr DQE-Lizenzschlüssel. Wenden Sie sich an den Support, falls Sie noch keinen haben. | Pflicht |
| Format | Gewünschtes Ausgabeformat. Siehe die Tabelle der Formatwerte unten. | Optional |
| Activity |
Y, wenn Sie die Aktivität der Telefonnummer abrufen möchten. |
Optional |
| TimeOut | Maximale Abfragezeit für die Überprüfung, in Sekunden. Beispiel: 0.5 für 500 ms. |
Optional |
| Separator | Trennzeichen, das in der formatierten Telefonnummer verwendet wird. Zulässige Werte: - und .. Funktioniert nur bei Formaten, die Leerzeichen verwenden (1, 2, 3, 4, 6) |
Optional |
Formatwerte
Die folgenden Werte gelten für den Parameter Format sowohl bei GET- als auch bei POST-Anfragen.
| Wert | Beschreibung | Beispiele (Deutschland / Frankreich / USA) |
|---|---|---|
| 0 | Nationales Format ohne Leerzeichen | 0301234567 / 0123456789 / (202)555-0123 |
| 1 | Nationales Format mit länderspezifischer Zifferngruppierung | 030 1234567 / 01 23 45 67 89 / (202) 555-0123 |
| 2 | Internationales Format mit länderspezifischer Zifferngruppierung | +49 30 1234567 / +33 1 23 45 67 89 / +1 202-555-0123 |
| 3 | Internationales Format mit Leerzeichen zwischen Landesvorwahl und Teilnehmernummer | +49 301234567 / +33 123456789 / +1 2025550123 |
| 4 | Internationales Format mit Trunk-Präfix und kompakter Teilnehmernummer | +49 (0)301234567 / +33 (0)123456789 / +1 (0)2025550123 |
| 5 | Internationales Format ohne Leerzeichen | +49301234567 / +33123456789 / +12025550123 |
| 6 | Internationales Format mit Trunk-Präfix und länderspezifischer Zifferngruppierung | +49 (0) 30 1234567 / +33 (0) 1 23 45 67 89 / +1 (0) (202) 555-0123 |
| 7 | Nationales Format mit durch Punkte getrennter länderspezifischer Zifferngruppierung | 030.1234567 / 01.23.45.67.89 / (202).555-0123 |
| 8 | Internationales Format mit durch Punkte getrennter länderspezifischer Zifferngruppierung | +49.30.1234567 / +33.1.23.45.67.89 / +1.202-555-0123 |
| 9 | Internationales Format ohne Leerzeichen und ohne führendes Pluszeichen | 49301234567 / 33123456789 / 1202-555-0123 |
Antwort
Bei Erfolg gibt die API ein JSON-Objekt mit der Anzahl der Ergebnisse und einem Array der validierten Telefonnummern zurück.
Fachliche Einordnung:
IdError liefert das detaillierte Validierungsergebnis (0: ungültig oder nicht existierend, 1: gültig und zugewiesen, 2: nur gültige Syntax, nicht zugewiesen) — siehe die vollständige Liste in der API-Antwortcodes-Referenz.| Schlüssel | Beschreibung | Typ |
|---|---|---|
| Found | Anzahl der zurückgegebenen Telefonnummern. | Integer |
| Phones | Array der Validierungsergebnisse, ein Eintrag pro übermittelter Telefonnummer. | Array |
| IdError | Validierungs-Rückgabecode. Siehe die API-Antwortcodes-Referenz. | String |
| Ported |
Y, wenn die Nummer portiert wurde; leer, wenn nicht verfügbar. |
String |
| InputNumber | In der Anfrage übermittelte Telefonnummer. | String |
| Carrier | Aktueller Carrier der Telefonnummer. | String |
| Location | Geografischer Standort, der der Telefonnummer zugeordnet ist. | String |
| OldCarrier | Vorheriger Carrier der Telefonnummer, sofern bekannt. | String |
| NumberFormatted | Telefonnummer, formatiert gemäß dem gewählten Format. | String |
| Type |
MOBILE oder FIXED_LINE oder leer. |
String |
Antwortbeispiel
Gültige Mobilfunknummer
{
"Found": 1,
"Phones": [
{
"IdError": "1",
"Ported": "",
"InputNumber": "0606060606",
"Carrier": "E*MESSAGE WIRELESS INFORMATION SERVICES FRANCE",
"Location": "METROPOLE",
"OldCarrier": "E*MESSAGE WIRELESS INFORMATION SERVICES FRANCE",
"NumberFormatted": "0606060606",
"Type": "MOBILE"
}
]
}
Fehler
| HTTP | Fehlertyp | Antworttext |
|---|---|---|
| 400 | Fehlender oder leerer Pflichtparameter (z. B. Number) |
{"status": 400, "message": "Missing parameters", "details": "Number", "error": "bad request"} |
| 401 | Ungültiger oder nicht autorisierter Lizenzschlüssel | {"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "deded", "error": "unauthorized_client"} |
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