The response is a JSON whose keys are defined below :
| Key | Description | Format |
| status | « error » | STRING (5) |
| error_type | Error label: details in the following table | STRING (250) |
| error_id | Error code: details in the following table | STRING (2) |
| info | Contains all the keys described in the "info" table | JSON OBJECT |
Elements of the "info" key :
| Key | Value | France | International |
| telorigine | Phone number analyzed | STRING(20) | STRING(30) |
| geolocation | Location when the number was first assigned | STRING (50) | STRING (50) |
| tel | Phone number in expected format | STRING(20) | STRING(30) |
| ported |
"Y": The telephone number has been ported. "N": Telephone number not ported |
STRING(1) | STRING(1) |
| operator | Operator to whom the phone number was initially assigned | STRING (50) | STRING (50) |
| idError |
" 2 " : The line is built, but there is no confirmation that the line is being used. " 1 " : The line is built, confirmation that the line has recently been used |
INTEGER(1) | INTEGER(1) |
| oldoperator |
Mobile: Old operator (only filled when Ported = Y) Fixed: Operator to which the phone number was originally assigned |
STRING(50) | STRING(50) |
| type |
"MOBILE": The telephone number is a cell phone. "FIXED_LINE": The phone number is a landline. |
STRING(50) | STRING(50) |
Error code details (error_id key) :
| error_id | error_type | Description |
| 01 | invalid request | The request is not valid |
| 02 | invalid licence key | The license is not valid |
| 04 | invalid scope | Invalid scope |
| 05 | missing or empty parameter (user_infos) for this scope | A parameter is missing for the scope called |
| 06 | bad parameter format (user_infos) is not a valid JSON | The "user_infos" parameter is not a valid json |
| 07 | missing mandatory key in user informations (phone) | The missing "phone" key in the "user_infos" parameter is mandatory for this operator [SFR]. |
| 09 | ineligible phone number | Number not eligible for the solution |
| 10 | invalid phone number | The phone number does not exist |
| 11 | phone number is empty | The phone number is empty |
| 12 | phone check failed | The operator verification did not work |
| 13 | operator [Operator Name] not found | The operator is not found |
| 14 | operator [Operator Name] not authorized for this licence | Your license is not open on this operator |
| 15 | operator [Operator Name] not supported yet | The solution is not yet available on the requested solution |
| 16 | operator [Operator Name] unreachable | Impossible to contact the operator |
| 17 | scope not supported by this operator [Operator Name] yet | This scope is not supported by the operator |
| 30 | invalid or expired token | The token has expired |
Response examples:
error_id : 01
{
"status" : "error",
"error_id" : "01",
"error_type" : "invalid request"
}
error_id : 02
{
"status" : "error",
"error_id" : "02",
"error_type" : "invalid credentials"
}
error_id : 04
{
"status" : "error",
"error_id" : "04",
"error_type" : "invalid or unauthorized scope"
}
error_id : 05
{
"status" : "error",
"error_id" : "05",
"error_type" : "missing or empty parameter (user_infos) for this scope",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "ORANGE",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 06
{
"status" : "error",
"error_id" : "06",
"error_type" : "bad parameter format (user_infos) is not a valid JSON",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "ORANGE",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 07
{
"status" : "error",
"error_id" : "07",
"error_type" : "missing mandatory key in user informations (phone)",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "ORANGE",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 08
{
"status" : "error",
"error_id" : "08",
"error_type" : "invalid mixed scope"
}
error_id : 09
{
"status" : "error",
"error_id" : "09",
"error_type" : "ineligible phone number for (matching,simswap)",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "ORANGE",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 10
{
"status" : "error",
"error_id" : "10",
"error_type" : "invalid phone number"
}
error_id : 11
{
"status" : "error",
"error_id" : "11",
"error_type" : "phone number is empty"
}
error_id : 12
{
"status" : "error",
"error_id" : "12",
"error_type" : "phone check failed"
}
error_id : 13
{
"status" : "error",
"error_id" : "13",
"error_type" : "operator not found",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 14
{
"status" : "error",
"error_id" : "14",
"error_type" : "operator (ORANGE) not authorized for this licence",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "ORANGE",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 15
{
"status" : "error",
"error_id" : "15",
"error_type" : "operator (FREE) not supported yet",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "FREE",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 16
{
"status" : "error",
"error_id" : "16",
"error_type" : "operator (SFR) unreachable",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "SFR",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 17
{
"status" : "error",
"error_id" : "17",
"error_type" : "(FREE) does not support this scope yet",
"info" : {
"telorigine": "06XXXXXX36",
"geolocation": "FRANCE",
"tel": "06XXXXXX36",
"ported": "N",
"operator": "FREE",
"iderror": "1",
"oldoperator": "",
"type": "MOBILE"
}
}
error_id : 30
{
"status" : "error",
"error_id" : "30",
"error_type" : "invalid or expired token"
}