Response
Response Examples
Success Response Attributes
These attributes are returned for success response:
| Name | Type | Description |
|---|---|---|
| api_id | string | Uniquely identifies the request. |
| phone_number | string | The phone number that was looked up in the API request in E.164 format. |
| country | dict | Three key-value pairs that provide information regarding the country: • name (string): The name of the country to which this number belongs. • iso2 (string): The two-letter country code defined in ISO 3166-1. • iso3 (string): The three-letter country code defined in ISO 3166-1. |
| format | dict | Four key-value pairs that provide different number formats: • e164 (string): Number in E.164 format. Example: “+12045551111” • national (string): Number in national format. Example: “(204) 555-1111” • international (string): Number in international format. Example: “+1 204-555-1111” • rfc3966 (string): Number in RFC 3966 format. Example: “tel:+1-204-555-1111” |
| carrier | dict | Contains five key-value pairs related to the carrier: • mobile_country_code (string): Mobile country code (MCC); for fixed numbers, this is empty_string.• mobile_network_code (string): Mobile network code (MNC); for fixed numbers, this is empty_string.• name (string): Carrier name; if unknown, set as empty_string.• type (string): Type of number: fixed, mobile, voip, toll-free, or unknown.• ported (string): Indicates if the number is ported: yes, no, or unknown (only available for USA and Canada). |
| resource_uri | string | The URI that can be used to look up the same phone number again. |
Error Response Attributes
These attributes are returned for error responses:
| Name | Type | Description |
|---|---|---|
| api_id | string | Uniquely identifies the request. |
| error_code | integer | Indicates an error and provides the error code. |
| message | string | Provides error information regarding the request — given only when there’s an error. |
Note: Only possible numbers (for a given region, using length and prefix information) will return formatting results. For further information about error codes in error responses, refer to the Troubleshooting page.