这份文档还在翻译中,预期年底前完成。欢迎您提供宝贵的意见及建议。
Number Insight Standard
The Number Insight Standard API provides all the information from the Number Insight Basic API together with the following additional data:
- The line type (mobile/landline/virtual number/premium/toll-free)
- The Mobile Country Code (MCC) and Mobile Network Code (MNC)
- The name of the caller (USA only)
Use this information to determine the best type of communication for a number (SMS or voice) and block virtual numbers.
Before attempting to run the code examples, replace the variable placeholders:
`Key | Description |
---|---|
VONAGE_API_KEY |
Your Vonage API key (see it on your dashboard). |
VONAGE_API_SECRET |
Your Vonage API secret (also available on your dashboard). |
INSIGHT_NUMBER |
The number you want to retrieve insight information for. |
.
Write the code
Add the following to ni-standard.sh
:
curl "https://api.nexmo.com/ni/standard/json?api_key=$VONAGE_API_KEY&api_secret=$VONAGE_API_SECRET&number=$INSIGHT_NUMBER"
Run your code
Save this file to your machine and run it:
sh ni-standard.sh
Prerequisites
npm install @vonage/server-sdk
Create a file named ni-standard.js
and add the following code:
const Vonage = require('@vonage/server-sdk');
const vonage = new Vonage({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET
});
Write the code
Add the following to ni-standard.js
:
vonage.numberInsight.get({level: 'standard', number: INSIGHT_NUMBER}, (error, result) => {
if(error) {
console.error(error);
}
else {
console.log(result);
}
});
Run your code
Save this file to your machine and run it:
node ni-standard.js
Prerequisites
Add the following to `build.gradle`:
compile 'com.vonage:client:5.5.0'
Create a class named StandardInsight
and add the following code to the main
method:
VonageClient client = VonageClient.builder().apiKey(VONAGE_API_KEY).apiSecret(VONAGE_API_SECRET).build();
Write the code
Add the following to the main
method of the StandardInsight
class:
StandardInsightResponse response = client.getInsightClient().getStandardNumberInsight(INSIGHT_NUMBER);
System.out.println("BASIC INFO:");
System.out.println("International format: " + response.getInternationalFormatNumber());
System.out.println("National format: " + response.getNationalFormatNumber());
System.out.println("Country: " + response.getCountryName() + " (" + response.getCountryCodeIso3() + ", +"
+ response.getCountryPrefix() + ")");
System.out.println();
System.out.println("CARRIER INFO:");
System.out.println("Current carrier: " + response.getCurrentCarrier().getName());
System.out.println("Original carrier: " + response.getOriginalCarrier().getName());
Run your code
We can use the application
plugin for Gradle to simplify the running of our application.
Update your build.gradle
with the following:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''
Run the following gradle
command to execute your application, replacing com.vonage.quickstart.insight
with the package containing StandardInsight
:
gradle run -Pmain=com.vonage.quickstart.insight.StandardInsight
Prerequisites
Install-Package Vonage
Create a file named StandardInsights.cs
and add the following code:
using Vonage;
using Vonage.NumberInsights;
using Vonage.Request;
Add the following to StandardInsights.cs
:
var creds = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(creds);
Write the code
Add the following to StandardInsights.cs
:
var request = new StandardNumberInsightRequest() { Number = INSIGHT_NUMBER};
var response = client.NumberInsightClient.GetNumberInsightStandard(request);
Prerequisites
composer require vonage/client
Write the code
Add the following to standard.php
:
$basic = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client($basic);
$insights = $client->insights()->standard(INSIGHT_NUMBER);
Run your code
Save this file to your machine and run it:
php standard.php
Prerequisites
pip install vonage pprint
Write the code
Add the following to ni-standard.py
:
client = vonage.Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
insight_json = client.get_standard_number_insight(number=INSIGHT_NUMBER)
pprint(insight_json)
Run your code
Save this file to your machine and run it:
python ni-standard.py
Prerequisites
gem install vonage
Create a file named ni-standard.rb
and add the following code:
client = Vonage::Client.new(
api_key: VONAGE_API_KEY,
api_secret: VONAGE_API_SECRET
)
Write the code
Add the following to ni-standard.rb
:
insight = client.number_insight.standard(
number: SEARCH_NUMBER
)
puts insight.inspect
Run your code
Save this file to your machine and run it:
ruby ni-standard.rb
The response from the API contains the following data:
{
"status": 0,
"status_message": "Success",
"request_id": "e98e0dfb-c485-491b-8d2a-283f35e21d04",
"international_format_number": "447700900000",
"national_format_number": "07700 900000",
"country_code": "GB",
"country_code_iso3": "GBR",
"country_name": "United Kingdom",
"country_prefix": "44",
"request_price": "0.00500000",
"remaining_balance": "10.000000",
"current_carrier": {
"network_code": "23420",
"name": "Hutchison 3G Ltd",
"country": "GB",
"network_type": "mobile"
},
"original_carrier": {
"network_code": "23410",
"name": "Telefonica UK Limited",
"country": "GB",
"network_type": "mobile"
},
"ported": "assumed_ported",
"roaming": { "status": "unknown" }
}
For a description of each returned field and to see all possible values, see the Number Insights API documentation