Lookup API

The Lookup API provides a way to retrieve additional information about a phone number. Lookup currently supports the following types of data.

• Region-specific number formatting and validation
• キャリア情報
• 発信者の名前

You can specify one or more types of information you would like to purchase in the request, check the Lookup Product Page for pricing information.

API URL

All URLs referenced in the documentation use the following URL.

https://lookups.twilio.com/v1/PhoneNumbers/{PhoneNumber}

TwilioのREST APIはHTTPS経由で提供されます。 データのプライバシーを確保するため、暗号化されていないHTTPはサポートされません。

{PhoneNumber} is the phone number you are requesting information about. Phone numbers can be specified either in national formatting or in standard E.164 format. If providing a number in local national format, please also specify the country as an optional parameter. If no country is provided, this will default to US. Twilio will use libphonenumber, Google’s open source phone number handling library, to properly format possible phone numbers for a given region, using length and prefix.

認証

HTTP requests to the REST API are protected with HTTP Basic authentication. To learn more about how Twilio handles authentication, please refer to our security documentation. In short, you will use your Twilio account SID as the username and your auth token as the password for HTTP Basic authentication.

curl -G https://lookups.twilio.com/v1/PhoneNumbers/{PhoneNumber} \
    -u '[YOUR ACCOUNT SID]:[YOUR AUTH TOKEN]'

You can find your account SID and auth token in your console.

To learn more about authentication and interaction with the Twilio REST API, check out our documentation for requests to the API and Twilio's response.

Lookup a Phone Number

HTTP GET

Returns phone number information matching the specified request. Formatting information is standard. Carrier, Caller Name, and phone number type information can be requested, in addition to using Add-ons to access 3rd party data sources.

クエリーパラメーター

下記の標準的なGETクエリーは電話番号の情報のタイプを特定します。

リソースのプロパティ

下記のプロパティは常に返されます。

Using Add-ons with Lookup

Lookup also supports Twilio Add-ons, enabling you to retrieve information from a multitude of 3rd party data sources, available via the Twilio Marketplace.

You can add Lookup-supported add-ons by visiting the Twilio console to enabling the add-on, making sure you have 'Lookups' selected:

When you use AddOns, you can pass additional parameters to the Add-on(s):