This page describes the JSON response returned by the /TEL/ endpoint used to validate and format phone numbers.
Related Phone documentation:
Phone request success
Level 1 verification
Level 1 verification validates the existence and format of the phone number.
The JSON response contains a key 1 with the following fields:
| Key | Description | Type |
|---|---|---|
| TelOrigine | Phone number analyzed. | STRING |
| Geolocation | Location where the number was initially assigned. | STRING |
| Tel | Phone number formatted according to the selected format. | STRING |
| Ported | Empty in level 1 verification. | STRING |
| Operator | Operator to whom the phone number was initially assigned. | STRING |
| IdError |
2: valid syntax; 1: valid and attributed; 0: invalid or non-existing number. |
INTEGER |
| OldOperator | Original operator of the phone number. | STRING |
| Type |
MOBILE or FIXED_LINE. |
STRING |
Example:
{
"1": {
"TelOrigine": "+12XXXXXXXXX",
"Geolocation": "UNITED STATES OF AMERICA",
"Tel": "+12345678910",
"Ported": "",
"Operator": "FIRST COMMUNICATIONS",
"IdError": 1,
"OldOperator": "FIRST COMMUNICATIONS",
"Type": "MOBILE"
}
}Level 2 verification
Warning: reachable information is no longer provided. This variable is retained for historical purposes.
Level 2 verification provides activity status and operator information.
The JSON response contains the following additional (or updated) fields to the first level verification:
| Key | Description | Type |
|---|---|---|
| Ported |
Y if the number has been ported, N otherwise. |
STRING(1) |
| Operator | Current operator of the phone number. | STRING |
| OldOperator | Previous operator when the number has been ported. | STRING |
| LabelStatus |
Reachable or Not Reachable (mobile only). |
STRING |
| Status |
0: reachable; 1: not reachable. |
STRING |
Example with Status=Y:
{
"1": {
"TelOrigine": "0XXXXXXXXX",
"Geolocation": "FRANCE",
"LabelStatus": "Not Reachable",
"Tel": "0XXXXXXXXX",
"Ported": "N",
"Status": "1",
"Operator": "ORANGE",
"IdError": 1,
"OldOperator": "",
"Type": "MOBILE"
}
}Phone request error
| Error type | Response type |
|---|---|
Missing Licence parameter |
Licence Down error in the JSON response. |
Empty Licence parameter |
Licence Down error in the JSON response. |
| Incorrect licence number |
Licence Down error in the JSON response. |
Missing or empty Tel parameter |
400 Bad Request |
| Parameter typo | 400 Bad Request |
Example of licence error:
{
"1": {
"TelOrigine": "06XXXXXXXX",
"Geolocation": "",
"Tel": "",
"Ported": "",
"Operator": "",
"IdError": 0,
"OldOperator": "",
"Error": "Licence Down"
}
}Related to