Phone request success
Json description
- Level 1 verification only indicates whether the phone number exists.
The JSON response is a dictionary with a key "1" and its value is a dictionary containing the following keys:
| Key | Value | France | International |
| TelOrigine | Phone number analyzed | STRING(20) | STRING(30) |
| Geolocation | Location when the number was first assigned | STRING | STRING |
| Tel | Phone number in expected format | STRING(20) | STRING(30) |
| Ported | EMPTY | NA | NA |
| Operator | Operator to whom the phone number was initially assigned | STRING | STRING |
| IdError |
"2": Syntax of the phone number is valid "1": Phone number valid and active "0": Phone number not existing |
INTEGER(1) | INTEGER(1) |
| OldOperator | Operator to whom the phone number was initially assigned | STRING | STRING |
| Type |
« FIXED_LINE »: The phone number is a landline « MOBILE »: The phone number is a mobile |
STRING(6) | STRING(6) |
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 is used to obtain phone activity as well as operator data.
In level 2, it is necessary to distinguish 2 different versions that depend on the products subscribed:
- Verification only on international mobile phone
AND/OR
- Verification only on international landline phone
The JSON response is a dictionary whose key is "1" and is itself a JSON object containing the following keys:
| Key | Value | France | International |
| TelOrigine | Phone number analyzed | STRING(20) | STRING(30) |
| Geolocation |
Country of phone number If the phone number is a landline, the city is filled in. |
STRING(50) | STRING(50) |
| Tel | Phone number in expected format | STRING(20) | STRING(30) |
| Ported |
« Y »: Phone number has been ported « N »: Phone number has not been ported |
STRING(1) | STRING(1) |
| Operator | Current operator of the phone number | STRING(50) | STRING(50) |
| IdError |
"2": Phone number valid and not currently "1": Phone number valid and active "0": Phone number not existing |
INTEGER(1) | INTEGER(1) |
| OldOperator |
Mobile: Old operator (only when Ported = Y) Landline: Operator to whom the phone number was initially assigned |
STRING(50) | STRING(50) |
| Type |
« MOBILE »: The phone number is a mobile « FIXED_LINE »: The phone number is a landline |
STRING(6) | STRING(50) |
|
LabelStatus (Mobile phone only) |
"Reachable": indicates that the phone is reachable. "Not Reachable": indicates that the phone is not reachable |
STRING(13) | STRING(13) |
|
Status (Mobile phone only) |
"0": indicates that the phone is reachable. "1": indicates that the phone is not reachable |
STRING(2) | STRING(2) |
Example : (with Status=Y in the request):
{
"1": {
"TelOrigine": "0XXXXXXXXXXX",
"Geolocation": "FRANCE",
"LabelStatus": "Not Reachable",
"Tel": "0XXXXXXXXXXX",
"Ported": "N",
"Status": "1",
"Operator": "ORANGE",
"IdError": 1,
"OldOperator": "",
"Type": "MOBILE"
}
}
Phone request error
| Error type | Request | Response type |
| Missing “Licence” parameter | https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Tel={TEL}&Format={FORMAT} |
Empty response with error code « Licence Down » : {
|
|
Empty “Licence” parameter |
https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Tel={TEL}&Format={FORMAT}&Licence= | |
| Incorrect Licence number (expired, out of scope, nonexistent) | https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Tel={TEL}&Format={FORMAT}&Licence={INCORRECT_LICENCE_CODE} | |
| Missing or Empty “Tel” parameter |
https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Format={FORMAT}&Licence={LICENCE_CODE} https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Tel=&Format={FORMAT}&Licence={LICENCE_CODE} |
400 Bad Request Error |
| Error on a parameter | https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Tl={TEL}&Format={FORMAT}&Licence={LICENCE_CODE} | 400 Bad Request Error |
Related to