API Téléphone — Valider et standardiser un numéro

Support DQE
Support DQE
  • Mise à jour

Utilisez cet endpoint pour valider et formater un numéro de téléphone via l'endpoint /TEL/.

Documentation Téléphone associée :

Requête GET

Endpoint

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

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Valeur Description Obligatoire/Optionnel
SERVER_ADDRESS {SERVER_ADDRESS} Adresse du serveur DQE qui traitera les données. Obligatoire
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Pays {COUNTRY_CODE} Code pays ISO à 3 lettres. Obligatoire
Tel {TEL} Numéro de téléphone à valider. Obligatoire
Format {FORMAT} Niveau de formatage souhaité. Voir le tableau des valeurs de format ci-dessous. Optionnel
Status Y Active la vérification de niveau 2 pour les numéros de mobile français et renvoie les champs supplémentaires Status et LabelStatus. Optionnel
TimeOut {TIME} Temps de requête maximal pour la vérification, en secondes. Exemple : 0.5 pour 500 ms. Optionnel
Separator {SYMBOL} Caractère séparateur. Valeurs acceptées : - ou .. Ne fonctionne que sur les formats qui utilisent des espaces (1, 2, 3, 4, 6). Optionnel

Requête POST

Endpoint

https://{SERVER_ADDRESS}/TEL/

Envoyez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.

Paramètre Valeur Description Obligatoire/Optionnel
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Pays {COUNTRY_CODE} Code pays ISO à 3 lettres. Obligatoire
Tel {TEL} Numéro de téléphone à valider. Obligatoire
Format {FORMAT} Niveau de formatage souhaité. Voir le tableau des valeurs de format ci-dessous. Optionnel
Status Y Active la vérification de niveau 2 pour les numéros de mobile français et renvoie les champs supplémentaires Status et LabelStatus. Optionnel
TimeOut {TIME} Temps de requête maximal pour la vérification, en secondes. Exemple : 0.5 pour 500 ms. Optionnel
Separator {SYMBOL} Caractère séparateur. Valeurs acceptées : - ou .. Ne fonctionne que sur les formats qui utilisent des espaces (1, 2, 3, 4, 6). Optionnel

Valeurs de format

Les valeurs suivantes s'appliquent au paramètre Format dans les requêtes GET et POST.

Valeur
Description
Exemples (Allemagne / France / États-Unis)
0 Format national sans espaces 0301234567 / 0123456789 / (202)555-0123
1 Format national avec regroupement de chiffres propre au pays 030 1234567 / 01 23 45 67 89 / (202) 555-0123
2 Format international avec regroupement de chiffres propre au pays +49 30 1234567 / +33 1 23 45 67 89 / +1 202-555-0123
3 Format international avec espace entre l'indicatif pays et le numéro d'abonné +49 301234567 / +33 123456789 / +1 2025550123
4 Format international avec préfixe interurbain et numéro d'abonné compact +49 (0)301234567 / +33 (0)123456789 / +1 (0)2025550123
5 Format international sans espaces +49301234567 / +33123456789 / +12025550123
6 Format international avec préfixe interurbain et regroupement de chiffres propre au pays +49 (0) 30 1234567 / +33 (0) 1 23 45 67 89 / +1 (0) (202) 555-0123
7 Format national avec regroupement de chiffres propre au pays séparé par des points 030.1234567 / 01.23.45.67.89 / (202).555-0123
8 Format international avec regroupement de chiffres propre au pays séparé par des points +49.30.1234567 / +33.1.23.45.67.89 / +1.202-555-0123
9 Format international sans espaces et sans signe plus initial 49301234567 / 33123456789 / 1202-555-0123

Réponse

Réponse de succès

Vérification niveau 1

La vérification de niveau 1 valide l'existence et le format du numéro de téléphone.

La réponse JSON contient une clé 1 avec les champs suivants :

Clé Description Type
TelOrigine Numéro de téléphone analysé. STRING
Geolocation Lieu où le numéro a été initialement attribué. STRING
Tel Numéro de téléphone formaté selon le format sélectionné. STRING
Ported Vide en vérification de niveau 1. STRING
Operator Opérateur auquel le numéro de téléphone a été initialement attribué. STRING
IdError 2 : syntaxe valide ; 1 : valide et attribué ; 0 : numéro invalide ou inexistant. INTEGER
OldOperator Opérateur d'origine du numéro de téléphone. STRING
Type MOBILE ou FIXED_LINE ou FIXED_LINE_OR_MOBILE ou Vide STRING

Exemple :

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

Vérification niveau 2

Attention : l'information de joignabilité n'est plus fournie. Cette variable est conservée à titre historique.

La vérification de niveau 2 fournit le statut d'activité et les informations opérateur. Activez-la en passant Status=Y dans la requête. La réponse JSON contient les champs supplémentaires (ou mis à jour) suivants :

Clé Description Type
Ported Y si le numéro a été porté, N sinon. STRING(1)
Operator Opérateur actuel du numéro de téléphone. STRING
OldOperator Opérateur précédent lorsque le numéro a été porté. STRING
LabelStatus Reachable ou No reachable information (mobile uniquement). STRING
Status 0 : joignable ; 1 : aucune information de joignabilité. STRING

Exemple avec Status=Y :

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

Réponse d'erreur

Type d'erreur Type de réponse
Paramètre Licence manquant Erreur Licence Down dans la réponse JSON.
Paramètre Licence vide Erreur Licence Down dans la réponse JSON.
Numéro de licence incorrect Erreur Licence Down dans la réponse JSON.
Paramètre Tel manquant ou vide 400 Bad Request
Erreur de saisie dans un paramètre 400 Bad Request

Exemple d'erreur de licence :

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

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0