RELAY RESTPhone Number Lookup

Phone Number Lookup

View as Markdown
This endpoint allows you to look up validity and formatting information about a number. You can optionally lookup additional information about the number such as carrier and caller ID data. #### Permissions No API token scope is required to make a successful request to this endpoint. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

e164_numberstringRequired
The phone number in E.164 format.

Query parameters

includestringOptional

Further number information to include in the response, some of which are billable. You can specify: carrier (Lookup full carrier information for the number), cnam (Lookup Caller ID information for the number). Separate multiple values with a comma: include=carrier,cnam.

Response

The request has succeeded.
country_code_numberinteger or null
The Country code associated with the number.
national_numberstring or null
Number in the countries national format.
possible_numberboolean or null
Whether the number supplied is a possible number.
valid_numberboolean or null
Whether the number supplied is a valid number.
national_number_formattedstring or null
The E164 number formatted in national format.
international_number_formattedstring or null
The E164 number formatted in international format.
e164string or null
The number in E164 format.
locationstring or null
The location of the number based on its area code and NPA.
country_codestring or null
The ISO3166 alpha 2 country code associated with the number.
timezoneslist of strings or null
The time zones associated with the number.
number_typestring or null
The type of number based on its area code and NPA.
carrierobject or null

Carrier information. Adding include=carrier to your request will do a live lookup to determine the current carrier information about this number.

cnamobject or null

Caller ID information. Adding include=cnam to your request will do a live lookup to determine the current caller ID information about this number.

Errors