Phone API — Eine Telefonnummer validieren (REST)

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um Festnetz- oder Mobiltelefonnummern über den Endpunkt /phonelookup zu validieren und zu formatieren.

Verwandte Telefon-Dokumentation:

GET-Anfrage

Endpunkt

GET https://{SERVER_ADDRESS}/{VERSION}/phonelookup?country={COUNTRY_CODE}&phone={PHONE}&format={FORMAT}&status={STATUS}&timeout={TIMEOUT}&separator={SEPARATOR}

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

Parameter Beschreibung Pflicht/Optional
country ISO-3-Buchstaben-Ländercode. Pflicht
phone Zu validierende Telefonnummer. Pflicht
format Gewünschtes Ausgabeformat. Siehe die Tabelle der Formatwerte unten. Optional
status Auf true setzen, um eine zusätzliche Statusprüfung zu aktivieren, sofern verfügbar. Optional
timeout Maximale Abfragezeit für die Überprüfung, in Sekunden. 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

POST-Anfrage

Endpunkt

POST https://{SERVER_ADDRESS}/{VERSION}/phonelookup

Senden Sie die folgenden Parameter im Anfragetext als JSON.

Parameter Beschreibung Pflicht/Optional
country ISO-3-Buchstaben-Ländercode. Pflicht
phone Zu validierende Telefonnummer. Pflicht
format Gewünschtes Ausgabeformat. Siehe die Tabelle der Formatwerte unten. Optional
status Auf true setzen, um eine zusätzliche Statusprüfung zu aktivieren, sofern verfügbar. Optional
timeout Maximale Abfragezeit für die Überprüfung, in Sekunden. 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

Beispiel

{
  "country": "FRA",
  "phone": "0611223344",
  "format": 2,
  "status": true,
  "timeout": 0.5,
  "separator": "."
}

Formatwerte

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

Erfolgsantwort

Schlüssel Beschreibung Typ
IdError 2: gültige Syntax; 1: gültig und zugewiesen; 0: ungültige oder nicht existierende Nummer. INTEGER
Error Fehlermeldung im Zusammenhang mit dem Validierungsergebnis. STRING
Formatted Formatierte Telefonnummer gemäß dem gewählten Format. STRING
International Telefonnummer im internationalen Format. STRING
National Telefonnummer im nationalen Format. STRING
E164 Telefonnummer im E.164-Format. STRING
Country ISO-3-Buchstaben-Ländercode. STRING
CountryCode Internationale Vorwahl. STRING
NationalNumber Nationale signifikante Nummer. STRING
Type MOBILE oder FIXED_LINE oder FIXED_LINE_OR_MOBILE oder leer STRING
Operator Telekommunikationsbetreiber, sofern verfügbar. STRING
IsValid Gibt an, ob die Telefonnummer gültig ist. BOOLEAN
IsMobile Gibt an, ob es sich um eine Mobilfunknummer handelt. BOOLEAN
Status Von der optionalen Statusprüfung zurückgegebener Status. STRING

Beispiel

{
  "IdError": 0,
  "Error": "",
  "Formatted": "+33 6 11 22 33 44",
  "International": "+33611223344",
  "National": "06 11 22 33 44",
  "E164": "+33611223344",
  "Country": "FRA",
  "CountryCode": "33",
  "NationalNumber": "611223344",
  "Type": "Mobile",
  "Operator": "Orange",
  "IsValid": true,
  "IsMobile": true,
  "Status": "ACTIVE"
}

Fehlerantwort

Fehlertyp Antworttyp
Fehlende oder ungültige Authentifizierung 401 Unauthorized
Fehlender Parameter phone 400 Bad Request
Ungültige Telefonnummer Validierungsfehlerantwort

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich