Advanced Number Insight (sync)
Provides advanced number insight information about a number synchronously, in the same way that the basic and standard endpoints do.
Vonage recommends accessing the Advanced API asynchronously using the /advanced/async endpoint, to avoid timeouts.
Note that this endpoint also supports POST requests.
Query parameters
A boolean to choose whether to get real time data back in the response.
A single phone number that you need insight about in national or international format.
If a number does not have a country code or is uncertain, set the two-character country code. This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US. If you set country and number is already in E.164 format, country must match the country code in number.
Indicates if the name of the person who owns the phone number should be looked up and returned in the response. Set to true to receive phone number owner name in the response. This features is available for US numbers only and incurs an additional charge.
This parameter is deprecated as we are no longer able to retrieve reliable IP data globally from carriers.
Response
OK
Example response
{
"caller_identity": {
"caller_name": "John Smith",
"caller_type": "consumer",
"first_name": "John",
"last_name": "Smith"
},
"country_code": "GB",
"country_code_iso3": "GBR",
"country_name": "United Kingdom",
"country_prefix": "44",
"current_carrier": {
"country": "GB",
"name": "Acme Inc",
"network_code": "12345",
"network_type": "mobile"
},
"international_format_number": "447700900000",
"lookup_outcome_message": "Success",
"national_format_number": "07700 900000",
"original_carrier": {
"country": "GB",
"name": "Acme Inc",
"network_code": "12345",
"network_type": "mobile"
},
"ported": "not_ported",
"reachable": "reachable",
"real_time_data": {
"active_status": "true",
"handset_status": "On"
},
"refund_price": "0.01500000",
"remaining_balance": "1.23456789",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_price": "0.04000000",
"roaming": {
"roaming_country_code": "US",
"roaming_network_code": "12345",
"roaming_network_name": "Acme Inc",
"status": "roaming"
},
"status_message": "Success",
"valid_number": "valid"
}