Comment intégrer notre solution LIVE ENSOPHONE

Historique

DateNumber of versionDescription
28/02/20221.0Version 1 – lancement de l’API EnsoPhone 
11/05/20221.1Version 1.1 – Ajout du paramètre country_code param comme obligatoire  – EnsoPhone

L’utilisation de plusieurs niveaux de contrôle et de validation des numéros de téléphone vous garantit une qualité nouvelle de votre base de données en apportant des informations complémentaires :

Authentification

Afin d’accéder à nos services, il est indispensable de s’authentifier via une clé unique sécurisé (ou token) qui vous est fourni par Data Enso. Votre token doit être intégré dans le header sous le paramètre « api_key » et présent lors de chaque appel à l’API EnsoPhone.

Appels sur les Servers Data Enso

Les appels au service EnsoPhone doivent être réalisés sur l’URL suivante :

				
					https://api.dataenso.com/phone
				
			

Faire un appel à l’API ENSOPHONE

Afin de vérifier un numéro de téléphone en temps réel et obtenir des résultats fiables, voici la liste des champs disponibles pour composer votre recherche.

ChampStatusTypeExempleCommentaires
Api_keyRequiredStringyour-api-keyToken généré par Data Enso
numberRequiredString0623470248Numéro de téléphone à vérifier
country_codeRequiredStringFRPour une validation de numéro de téléphone dans son format local, il est impératif d’ajouter le code pays à 2 chiffres

Bien qu’il soit plus efficace de fournir des numéros de téléphone dans un format strictement numérique (par exemple 441179287870), l’API DataEnso est capable de traiter des numéros contenant des caractères spéciaux (par exemple +33 (0) 6 23 47 02 48).

Réponse de l’appel API

Après avoir réalisé l’appel à nos services, voici les champs disponibles en retour:

ChampTypeExempleCommentaires
validStringTrueRenvoie true si le numéro de téléphone est valide.
numberInteger330624473647Numéro de téléphone recherché sans caractères spéciaux
local_formatInteger0624473647PNuméro de téléphone recherché au format local (national)
international_formatString+33624473647Numéro de téléphone recherché au format international
country_prefixString+33Préfixe de numérotation international du pays
country_codeStringFRCode pays à 2 lettres attribué au numéro de téléphone recherché
country_nameStringFranceNom complet du pays attribué au numéro de téléphone
locationStringIle de FranceSi disponible, renvoie l’emplacement (ville, état ou comté) attribué au numéro de téléphone recherché
carrierStringSociete Francaise de Radiotelephone SA (SFR)Nom de l’opérateur auprès duquel le numéro de téléphone est enregistré
line_typeStringmobileType de ligne du numéro de téléphone recherché : mobile, landline, special_services (ex : Police), toll_free (ex : hôtels) , premium_rate (hotline), satellite, paging (messagerie)

Exemples

				
					https://api.dataenso.com/phone/?nb=0624473647&country_code=FR&format=2\
-h "api_key:your-token"
				
			

Réponse:

				
					{

    “valid”: true,

    “number”: “330624473647”,

    “local_format”: “0624473647”,

    “international_format”: “+33624473647”,

    “country_prefix”: “+33”,

    “country_code”: “FR”,

    “country_name”: “France”,

    “location”: “”,

    “carrier”: “Societe Francaise de Radiotelephone SA (SFR)”,

    “line_type”: “mobile”

}
				
			

Exemples codes retour

Type

Message

Description

404

« 404_not_found »

Ressource non existante

101

« missing_access_key »

API Key non renseignée

101

« invalid_access_key »

Api Key invalide

210

« no_phone_number_provided »

Pas de numéro de téléphone dans la requête

211

« non_numeric_phone_number_provided »

Pas de numéro de téléphone numérique.

310

« invalid_country_code »

Code pays à 2 lettres non valide.

Pour recevoir par mail nos différentes Doc API merci de remplir le formulaire ci-dessous