This is the third article in a step-by-step series on how to use Nexmo's Number Insight API within an ASP.NET web application.
In the first article, we walked through everything we need to know about Number Insight API, setting up the ASP.NET application and getting ready to explore how to get insights about a phone number.
Then we learnt how to use Number Insight Basic API in the second article in this series : How to Get Basic Number Insights Within an ASP.NET App.
In this article, we will explore Number Insight Standard API.
Number Insight Standard API is a synchronous, easy-to-use RESTful web service. For any phone number you can:
Retrieve the international and local format.
Know the country where the number is registered.
Line type detection (mobile/landline/virtual number/premium/toll-free).
Detect mobile country code (MCC) and mobile network code (MNC).
Detect if number is ported.
Identify caller name (USA only).
Check if phone number is reachable.
Hands on code
In order to get standard insights for a phone number, we will create a view where we can put a number. By clicking on the 'Submit' button, we are going to fetch standard insights then publish them on a results view.
Let's start by creating the method that would allow the navigation to the standard insights view in NumberInsightController.cs
[HttpGet]
public ActionResult Standard()
{
return View();
}
We will now add the view Standard.cshtml under the NumberInsight views folder.
@using (Html.BeginForm("Standard", "NumberInsight", FormMethod.Post))
{
<br>
<input type="text" name="number" id="number" placeholder="Phone Number">
<input type="submit" value="Get More Information">
}
Next, we are going to request standard insights from the API.
[HttpPost]
public ActionResult Standard(string number)
{
var results = Client.NumberInsight.RequestStandard(new NumberInsight.NumberInsightRequest()
{
Number = number,
});
Session["requestID"] = results.RequestId;
Session["iNumber"] = results.InternationalFormatNumber;
Session["nNumber"] = results.NationalFormatNumber;
Session["country"] = results.CallerName;
Session["countryCode"] = results.CountryCode;
Session["status"] = results.StatusMessage;
if (results.OriginalCarrier != null)
{
Session["originalCarrierName"] = results.OriginalCarrier.Name;
Session["originalCarrierCode"] = results.OriginalCarrier.NetworkCode;
Session["originalCarrierType"] = results.OriginalCarrier.NetworkType;
Session["originalCarrierCountry"] = results.OriginalCarrier.Country;
}
if (results.CurrentCarrier != null)
{
Session["currentCarrierName"] = results.CurrentCarrier.Name;
Session["currentCarrierCode"] = results.CurrentCarrier.NetworkCode;
Session["currentCarrierType"] = results.CurrentCarrier.NetworkType;
Session["currentCarrierCountry"] = results.CurrentCarrier.Country;
}
return RedirectToAction("StandardResults");
}
StandardResults() and StandardResults.cshtml will allow us to view the results.
[HttpGet]
public ActionResult StandardResults()
{
ViewBag.requestID = Session["requestID"];
ViewBag.iNumber = Session["iNumber"];
ViewBag.nNumber = Session["nNumber"];
ViewBag.status = Session["status"];
ViewBag.country = Session["country"];
ViewBag.countryCode = Session["countryCode"];
ViewBag.currentCarrierName = Session["currentCarrierName"];
ViewBag.currentCarrierCode = Session["currentCarrierCode"];
ViewBag.currentCarrierType = Session["currentCarrierType"];
ViewBag.currentCarrierCountry = Session["currentCarrierCountry"];
ViewBag.originalCarrierName = Session["originalCarrierName"];
ViewBag.originalCarrierCode = Session["originalCarrierCode"];
ViewBag.originalCarrierType = Session["originalCarrierType"];
ViewBag.originalCarrierCountry = Session["originalCarrierCountry"];
return View();
}
@{
<h1>Number Insight Standard Results</h1>
<hr style="height:2px; color:black">
<h2>Request ID: @ViewBag.requestID</h2>
<h2>Status: @ViewBag.status</h2>
<hr style="border:2px solid black">
<h2>International Number: @ViewBag.iNumber</h2>
<h2>National Number: @ViewBag.nNumber</h2>
<h2>Country: @ViewBag.country</h2>
<h2>Country Code: @ViewBag.countryCode</h2>
<hr style="border:2px solid black">
<h2>Current Carrier Name: @ViewBag.currentCarrierName</h2>
<h2>Current Carrier Code: @ViewBag.currentCarrierCode</h2>
<h2>Current Carrier Type: @ViewBag.currentCarrierType</h2>
<h2>Current Carrier Country: @ViewBag.currentCarrierCountry</h2>
<hr style="border:2px solid black">
<h2>Original Carrier Name: @ViewBag.originalCarrierName</h2>
<h2>Original Carrier Code: @ViewBag.originalCarrierCode</h2>
<h2>Original Carrier Type: @ViewBag.originalCarrierType</h2>
<h2>Original Carrier Country: @ViewBag.originalCarrierCountry</h2>
}
Now, let's run the app and try to get standard Number Insight. You can use one of the Nexmo numbers provided for testing.
Recap
In this article, we learnt how to use Nexmo’s Number Insight Standard API to retrieve the international and national formats of a phone number, the country where the number is registered and information about its portability and reachability. Then we showed this information on a view within an ASP.NET application. If you'd like to learn how to get Advanced Number Insights, then tune in to the next article in this series.
Nexmo Number Insight getting started guide for ASP.NET
How to Get Standard Number Insights within an ASP.NET app.
Rabeb was a Developer Advocate at Nexmo focusing on cloud communication APIs and helping developers get the best experience possible when building their apps. Other than writing code for a living, Rabeb advocates for bringing more women and minorities into tech, thus her involvement with Women Who Code and different tech communities. She leads the Women Who Code Network in Bristol.