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.
http://www.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クエリーは電話番号の情報のタイプを特定します。
| Names in Node.js format | |
|---|---|
countryCode
オプション
|
オプション電話番号のISO国コード 番号が国際フォーマットで入力された時に利用されます。 |
type
オプション
|
Indicates the type of information you would like returned with your request. Possible values are |
addOns
オプション
|
Indicates the particular Add-on you would like to use to get more information. Possible values are the Add-on Unique Names of Add-ons installed on your account. You can specify multiple instances of this parameter to invoke different Add-ons. See Add-ons documentation for information on installing Add-ons. Add-on pricing is available in your list of Installed Add-ons in the Console. |
When you use AddOns, you can pass additional parameters to the Add-on(s):
| 名前 | 概要 |
|---|---|
| AddOns.add_on_unique_name.parameter_name | オプション。リクエスト時に追加データをアドオンに渡します。アドオンで追加パラメーターが必要かどうかは、コンソールのアドオンのドキュメントで確認してください。このアドオンは、上記の AddOns パラメーターを使用してこのリクエストで呼び出す必要があります。 |
リソースのプロパティ
下記のプロパティは常に返されます。
| Names in Node.js format | |
|---|---|
callerName
|
電話番号の所有者の名前を示す文字列。利用できない場合は、 |
countryCode
|
この電話番号のISO 国コードです。 |
phoneNumber
|
電話番号はE.154フォーマットです。（日本の場合"+81"). |
nationalFormat
|
国内番号フォーマットでの電話番号。 |
carrier
|
|
addOns
|
JSON ディクショナリーとして、リクエストで AddOn パラメーターを使用して指定したアドオンの結果。ディクショナリーのフォーマットについては、アドオンドキュメントのセクション 6 の「アドオンの使用」を参照してください。 |
url
|
|
情報を持ちうるできる番号（地域、長さ、プレフィックスの情報）はフォーマット化された結果を返します。存在しない番号のルックアップを試みた場合、HTTP404 エラーを返します。
キャリア情報
NOTE: For some regions, we are unable to return carrier and cellphone data by default. You need to contact our support team to switch on those regions. More information on our support site.
GETリクエスト中でキャリア情報をリクエストすると下記の追加情報が返却されます。
| 名前 | 概要 |
|---|---|
| MobileCountryCode | キャリアのモバイル国コード（携帯電話番号のみ対象） |
| MobileNetworkCode | キャリアのモバイルネットワークコード（携帯電話のみ対応） |
| 名前 | キャリア名キャリア名は頻繁に変わります。そのため Name も同様に変わります。 |
| Type | 電話番号タイプ取りうる値は、landline、mobileもしくはvoipです。詳しくは電話番号タイプをご覧ください。 |
| ErrorCode | このリクエストに関連するエラーコード |
電話番号タイプ
下記は'Type'プロパティで取りうる値です。
| Type | 概要 |
|---|---|
| landline | この電話番号は固定電話で、一般的にSMSを受信することはできません。 |
| 携帯電話 | この番号は携帯電話で、一般的にSMSを受信することができます。 |
| voip | インターネットをベースにした電話番号でSMSの受信は番号によります。例としてはGoogle Voiceがこれにあたります。 |
発信者の名前
GET リクエストで発信者名を要求した場合は、以下の追加のプロパティが返されます。
| 名前 | 概要 |
|---|---|
| CallerName | 電話番号の所有者の名前を示す文字列。利用できない場合は、 null 返します。 |
| CallerType | この発信者がビジネスなのか消費者なのかを示す文字列。 取りうる値は business および consumer です。使用できない場合は、 unavailable を返します。 |
| ErrorCode | このリクエストに関連するエラーコード |
米国の番号の発信者名ルックアップは、データがない場合でも、ルックアップごとに課金されます。現時点では、国際電話番号についての発信者名ルックアップをリクエストすると、値 null が返されますが、課金はされません。
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.
ヘルプが必要ですか？
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.