API Restful - Description - Phone - Response

Support DQE
Support DQE
  • Updated

Phone response success

The JSON response is a dictionary (object) containing two main keys:

  • "Found": an integer indicating the number of addresses found (e.g., 0 or 1),
  • "Phones": a list containing one or more address objects.

Each address object is itself a dictionary containing the following keys:

KeyDescriptionType
FoundNumber of results foundINTEGER
PhonesList of phone number validation results (only 1)ARRAY OF OBJECTS
IdErrorError identifier codeSTRING(2)
PortedIndicates if the number has been portedSTRING(10)
InputNumberPhone number sent as inputSTRING(20)
CarrierCurrent carrier of the phone numberSTRING(50)
LocationGeographic location (e.g., METROPOLE, DOM-TOM)STRING(50)
OldCarrierPrevious carrier (if the number was ported)STRING(50)
NumberFormattedReformatted phone numberSTRING(20)
TypePhone number type (MOBILE, FIXE, etc.)STRING(10)

Example:

{
    "Found": 1,
    "Phones": [
        {
            "IdError": "1",
            "Ported": "",
            "InputNumber": "06XXX",
            "Carrier": "SFR",
            "Location": "METROPOLE",
            "OldCarrier": "SFR",
            "NumberFormatted": "06XXX",
            "Type": "MOBILE"
        }
    ]
}

 

Phone response error

Error typeRequestResponse type
Missing “Licence” parameterhttps://{SERVER_ADDRESS}/{VERSION}/phonelookup/?Number=XXXXX&Country=FRA&Licenc=XXXX&Activity=Y{"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Empty “Licence” parameterhttps://{SERVER_ADDRESS}/{VERSION}/phonelookup/?Number=XXXXX&Country=FRA&Licence=&Activity=Y{"status": 400, "message": "Licence must be filled", "details": "", "error": "bad request"}

 

Related to

Was this article helpful?

0 out of 0 found this helpful