TWtwilio
LookupsV1PhoneNumber

Fetch information about a phone number

Fetch information about a phone number. You can use this endpoint to retrieve the carrier and caller name for a phone number, as well as any installed Add-ons.

get/v1/PhoneNumbers/{PhoneNumber}

Request

  • Base URL
    https://lookups.twilio.com
  • URL
    https://lookups.twilio.com/v1/PhoneNumbers/{PhoneNumber}
  • Auth
    HTTP basic

Path parameters

PhoneNumberstring required

The phone number to lookup in E.164 format, which consists of a + followed by the country code and subscriber number.

Query parameters

CountryCodestring

The ISO country code of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format.

Typestring[]

The type of information to return. Can be: carrier or caller-name. The default is null. To retrieve both types of information, specify this parameter twice; once with carrier and once with caller-name as the value.

AddOnsstring[]

The unique_name of an Add-on you would like to invoke. Can be the unique_name of an Add-on that is installed on your account. You can specify multiple instances of this parameter to invoke multiple Add-ons. For more information about Add-ons, see the Add-ons documentation.

AddOnsDataobject

Data specific to the add-on you would like to invoke. The content and format of this value depends on the add-on.

Response

OK

caller_nameunknown
country_codestring nullable

The ISO country code for the phone number.

phone_numberstring phone-number nullable

The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

national_formatstring nullable

The phone number, in national format.

carrierunknown
add_onsunknown
urlstring uri nullable

The absolute URL of the resource.

Changes

No operation changes recorded.