How to integrate our LIVE ENSOPHONE solution
History
| Date | Number of version | Description |
| 28/02/2022 | 1.0 | Version 1 - EnsoPhone API launch |
| 11/05/2022 | 1.1 | Version 1.1 - Country_code param added as mandatory - EnsoPhone |
The use of several levels of control and validation of telephone numbers guarantees the new quality of your database by providing additional information:
- Phone number format
- Validity of telephone numbers
- Local information (telephone operator for mobile lines, landline geolocation)
Authentication
In order to access our services, you must authenticate yourself via a unique secure key (or token) provided by Data Enso. Your token must be integrated into the header under the "api_key" parameter and present for each call to the EnsoPhone API.
Calls to Data Enso Servers
Calls to the EnsoPhone service should be made to the following URL:
https://api.dataenso.com/phone
Call the ENSOPHONE API
To check a phone number in real time and obtain reliable results, here's the list of fields available for composing your search.
| Field | Status | Type | Example | Comments |
| Api_key | Required | String | your-api-key | Token generated by Data Enso |
| number | Required | String | 0623470248 | Check phone number |
| country_code | Required | String | FR | To validate a telephone number in its local format, it is imperative to add the 2-digit country code |
Although it's more efficient to provide phone numbers in a strictly numeric format (e.g. 441179287870), the DataEnso API is able to handle numbers containing special characters (e.g. +33 (0) 6 23 47 02 48).
API call response
Once you've made the call to our services, here are the fields available in return:
| Field | Type | Example | Comments |
| valid | String | True | Returns true if the phone number is valid. |
| number | Integer | 330624473647 | Search phone number without special characters |
| local_format | Integer | 0624473647P | Phone number required in local (national) format |
| international_format | String | +33624473647 | Phone number required in international format |
| country_prefix | String | +33 | International country code prefix |
| country_code | String | FR | 2-letter country code assigned to the phone number you are looking for |
| country_name | String | France | Full country name assigned to phone number |
| rental | String | Ile de France | If available, returns the location (city, state or county) assigned to the phone number searched. |
| carrier | String | Societe Francaise de Radiotelephone SA (SFR) | Name of the operator with which the phone number is registered |
| line_type | String | mobile | Type of phone number: mobile, landline, special_services (e.g. Police), toll_free (e.g. hotels) , premium_rate (hotline), satellite, paging (messaging) |
Examples
https://api.dataenso.com/phone/?nb=0624473647&country_code=FR&format=2\
-h "api_key:your-token"
Answer:
{
“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”
}
Examples of return codes
Type | Message | Description |
404 | "404_not_found | Non-existent resource |
101 | "missing_access_key" | API Key not specified |
101 | "invalid_access_key | Invalid Api Key |
210 | "no_phone_number_provided" | No phone number in query |
211 | "non_numeric_phone_number_provided" | No digital phone number. |
310 | "invalid_country_code" | Invalid 2-letter country code. |
To receive our various API Docs by e-mail, please fill in the form below
