Phonenumber Lookup Object
The Phonenumber Lookup object provides detailed information about a given phone number, including its country code, formatting, carrier data, CNAM, and location routing number (LRN). This data can be used for call routing optimization, identity verification, or number validation.
Phonenumber Lookup Object Attributes
The fields listed in the table below will be returned in a JSON object when a successful request has been made.
| Attribute | Data Type | Description |
|---|---|---|
| country_code read only | string | The ISO 3166-1 alpha-3 code of the country. |
| details read only | object | The detail object contains |
| e164_format read only | string | The DID in the E.164 format. |
| in_country_format read only | string | The DID in a national format. |
| international_format read only | string | The DID in an international format. |
| phonenumber read only | string | The phone number. |
| state read only | string | Geographic area codes of this DID (for the US DIDs only). |
| timezone read only | string | The estimated IANA time zone associated with the phone number. The value is derived using the libphonenumber database and represents the most likely geographic time zone for the number's numbering range. Because numbering ranges may span multiple geographic regions, the returned value should be treated as an approximation rather than an exact location indicator. Example values include:
|
| timestamp_offset read only | string | The UTC offset for the returned Example values include:
Note that this value is derived from the estimated time zone above and should be considered informational. |
Phonenumber Lookup Detail Object
The Phonenumber Lookup Detail object contains granular data about the carrier, caller name (CNAM), and routing information for a specific phone number.
| Attribute | Data Type | Description |
|---|---|---|
| carrier read only | object | The carrier information for the phone number. Refer to the carrier table for more information. |
| cnam read only | object | The cnam information for the phone number. Refer to the cnam table for more information. |
| lrn read only | string | The location routing number. |
Phonenumber Lookup Detail Carrier Object
The Phonenumber Lookup Detail Carrier object defines the network operator details associated with a given phone number.
| Attribute | Data Type | Description |
|---|---|---|
| mcc read only | integer | The mobile country code. |
| mnc read only | integer | The mobile network code. |
| name read only | string | The carrier name. |
| type read only | string | The type of the DID. Values accepted in this field are: |
Phonenumber Lookup Detail Cnam Object
The Phonenumber Lookup Detail Cnam object provides the caller name and type data returned by the CNAM database for a specific phone number.
| Attribute | Data Type | Description |
|---|---|---|
| name read only | string | The caller name. |
| type read only | string | The caller type. |
Sample Phonenumber Lookup Object
{
"country_code": "USA",
"details": {
"carrier": {
"mcc": null,
"mnc": null,
"name": null,
"type": null
},
"cnam": {
"name": "",
"type": null
},
"lrn": "6466531111"
},
"e164_format": "+15162065319",
"in_country_format": "(516) 206-5319",
"international_format": "+1 516-206-5319",
"phonenumber": "15162065319",
"state": "NY",
"timezone": "America/New_York",
"timezone_offset": "-05:00"
}