API Téléphone — Valider un numéro de téléphone (REST)

Support DQE
Support DQE
  • Mise à jour

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

Documentation Téléphone associée :

Requête GET

Endpoint

https://{SERVER_ADDRESS}/phonelookup?country={COUNTRY}&phone={PHONE}&format={FORMAT}&status={STATUS}&timeout={TIME}&separator={SYMBOL}
Paramètre Description Obligatoire/Optionnel
country Code pays ISO à 3 lettres. Obligatoire
phone Numéro de téléphone à valider. Obligatoire
format Niveau de formatage souhaité. Voir le tableau des valeurs de format ci-dessous. Optionnel
status Définir sur true pour activer la vérification de statut supplémentaire lorsqu'elle est disponible. Optionnel
timeout Temps de requête maximal pour la vérification, en secondes. Optionnel
separator Caractère séparateur utilisé dans le numéro de téléphone formaté. Valeurs acceptées : - et .. Ne fonctionne que sur les formats qui utilisent des espaces (1, 2, 3, 4, 6). Optionnel

Requête POST

Endpoint

https://{SERVER_ADDRESS}/phonelookup

Envoyez les paramètres suivants dans le corps de la requête au format JSON.

Paramètre Description Obligatoire/Optionnel
country Code pays ISO à 3 lettres. Obligatoire
phone Numéro de téléphone à valider. Obligatoire
format Niveau de formatage souhaité. Voir le tableau des valeurs de format ci-dessous. Optionnel
status Définir sur true pour activer la vérification de statut supplémentaire lorsqu'elle est disponible. Optionnel
timeout Temps de requête maximal pour la vérification, en secondes. Optionnel
separator Caractère séparateur utilisé dans le numéro de téléphone formaté. Optionnel

Exemple de corps de requête :

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

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

Clé Description Type
IdError 2 : syntaxe valide ; 1 : valide et attribué ; 0 : numéro invalide ou inexistant. INTEGER
Error Message d'erreur associé au résultat de la validation. STRING
Formatted Numéro de téléphone formaté selon le format sélectionné. STRING
International Numéro de téléphone au format international. STRING
National Numéro de téléphone au format national. STRING
E164 Numéro de téléphone au format E.164. STRING
Country Nom du pays. STRING
CountryCode Indicatif téléphonique international. STRING
NationalNumber Numéro de téléphone sans l'indicatif pays. STRING
Type MOBILE ou FIXED_LINE ou FIXED_LINE_OR_MOBILE ou Vide STRING
Operator Opérateur télécom lorsque disponible. STRING
IsValid true ou false. BOOLEAN
IsMobile true ou false. BOOLEAN
Status Statut renvoyé par la vérification de statut optionnelle. STRING

Exemple de réponse :

{
  "IdError": 1,
  "Error": "",
  "Formatted": "06.11.22.33.44",
  "International": "+33 6 11 22 33 44",
  "National": "06 11 22 33 44",
  "E164": "+33611223344",
  "Country": "FRANCE",
  "CountryCode": "33",
  "NationalNumber": "611223344",
  "Type": "MOBILE",
  "Operator": "ORANGE",
  "IsValid": true,
  "IsMobile": true,
  "Status": ""
}

Réponse d'erreur

Type d'erreur Type de réponse
Authentification manquante ou invalide 401 Unauthorized
Paramètre phone manquant 400 Bad Request
Numéro de téléphone invalide Réponse d'erreur de validation

Voir aussi

Associé à

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

Utilisateurs qui ont trouvé cela utile : 0 sur 0