Phone API — Eine Telefonnummer validieren und standardisieren

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um eine Telefonnummer über den Endpunkt /TEL/ zu validieren und zu formatieren.

Verwandte Telefon-Dokumentation:

GET-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Tel={TEL}&Format={FORMAT}&Status=Y&TimeOut={TIME}&Separator={SYMBOL}&Licence={LICENCE_CODE}

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
Pays {COUNTRY_CODE} ISO-3-Buchstaben-Ländercode. Pflicht
Tel {TEL} Zu validierende Telefonnummer. Pflicht
Format {FORMAT} Gewünschte Formatierungsstufe. Siehe die Tabelle der Formatwerte unten. Optional
Status Y Aktiviert die Stufe-2-Prüfung für französische Mobilfunknummern und gibt die zusätzlichen Felder Status und LabelStatus zurück. Optional
TimeOut {TIME} Maximale Abfragezeit für die Überprüfung, in Sekunden. Beispiel: 0.5 für 500 ms. Optional
Separator {SYMBOL} 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

https://{SERVER_ADDRESS}/TEL/

Senden Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded.

Parameter Wert Beschreibung Pflicht/Optional
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
Pays {COUNTRY_CODE} ISO-3-Buchstaben-Ländercode. Pflicht
Tel {TEL} Zu validierende Telefonnummer. Pflicht
Format {FORMAT} Gewünschte Formatierungsstufe. Siehe die Tabelle der Formatwerte unten. Optional
Status Y Aktiviert die Stufe-2-Prüfung für französische Mobilfunknummern und gibt die zusätzlichen Felder Status und LabelStatus zurück. Optional
TimeOut {TIME} Maximale Abfragezeit für die Überprüfung, in Sekunden. Beispiel: 0.5 für 500 ms. Optional
Separator {SYMBOL} 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

Erfolgsantwort

Stufe-1-Prüfung

Die Stufe-1-Prüfung validiert die Existenz und das Format der Telefonnummer.

Die JSON-Antwort enthält einen Schlüssel 1 mit den folgenden Feldern:

Schlüssel Beschreibung Typ
TelOrigine Analysierte Telefonnummer. STRING
Geolocation Ort, an dem die Nummer ursprünglich zugewiesen wurde. STRING
Tel Telefonnummer, formatiert gemäß dem gewählten Format. STRING
Ported Leer bei der Stufe-1-Prüfung. STRING
Operator Betreiber, dem die Telefonnummer ursprünglich zugewiesen wurde. STRING
IdError 2: gültige Syntax; 1: gültig und zugewiesen; 0: ungültige oder nicht existierende Nummer. INTEGER
OldOperator Ursprünglicher Betreiber der Telefonnummer. STRING
Type MOBILE oder FIXED_LINE oder FIXED_LINE_OR_MOBILE oder leer STRING

Beispiel:

{
  "1": {
    "TelOrigine": "+12XXXXXXXXX",
    "Geolocation": "UNITED STATES OF AMERICA",
    "Tel": "+12345678910",
    "Ported": "",
    "Operator": "FIRST COMMUNICATIONS",
    "IdError": 1,
    "OldOperator": "FIRST COMMUNICATIONS",
    "Type": "MOBILE"
  }
}

Stufe-2-Prüfung

Warnung: Informationen zur Erreichbarkeit werden nicht mehr bereitgestellt. Diese Variable wird aus historischen Gründen beibehalten.

Die Stufe-2-Prüfung liefert Informationen zum Aktivitätsstatus und zum Betreiber. Aktivieren Sie sie, indem Sie Status=Y in der Anfrage übergeben. Die JSON-Antwort enthält die folgenden zusätzlichen (oder aktualisierten) Felder:

Schlüssel Beschreibung Typ
Ported Y, wenn die Nummer portiert wurde, andernfalls N. STRING(1)
Operator Aktueller Betreiber der Telefonnummer. STRING
OldOperator Vorheriger Betreiber, wenn die Nummer portiert wurde. STRING
LabelStatus Reachable oder No reachable information (nur bei Mobilfunknummern). STRING
Status 0: erreichbar; 1: keine Erreichbarkeitsinformation. STRING

Beispiel mit Status=Y:

{
  "1": {
    "TelOrigine": "0XXXXXXXXX",
    "Geolocation": "FRANCE",
    "LabelStatus": "Not Reachable",
    "Tel": "0XXXXXXXXX",
    "Ported": "N",
    "Status": "1",
    "Operator": "ORANGE",
    "IdError": 1,
    "OldOperator": "",
    "Type": "MOBILE"
  }
}

Fehlerantwort

Fehlertyp Antworttyp
Fehlender Parameter Licence Fehler Licence Down in der JSON-Antwort.
Leerer Parameter Licence Fehler Licence Down in der JSON-Antwort.
Falsche Lizenznummer Fehler Licence Down in der JSON-Antwort.
Fehlender oder leerer Parameter Tel 400 Bad Request
Tippfehler im Parameter 400 Bad Request

Beispiel für einen Lizenzfehler:

{
  "1": {
    "TelOrigine": "06XXXXXXXX",
    "Geolocation": "",
    "Tel": "",
    "Ported": "",
    "Operator": "",
    "IdError": 0,
    "OldOperator": "",
    "Error": "Licence Down"
  }
}

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich