Integrate Google's Libphonenumber In ASP.NET Core

Recently, I got a chance to work on a project in which we have to validate and parse phone numbers before storing them in the database and found Google's libphonenumber very effective for this purpose.

Let's discuss the libphonenumber features and its integration in ASP.NET Core C# project. 

After creating ASP.NET Core project using Visual Studio 2017 first we have to install ibphonenumber-csharp .

QUICK EXAMPLE: PARSE and VALID Number

To integrate this library we start by creating the instance. Then, using that, we can parse and validate the number by providing a telephone number and country code in ISO2 formate which returns the phoneNumber object as validation result and contains different properties such as IsValidNumber, IsValidNumberForRegion, GetRegionCodeForNumber, GetNumberType, and Formate method 

                  PhoneNumberUtil phoneUtil = PhoneNumberUtil.GetInstance();
                try
                {    string telephoneNumber = "03336323900";
                     string countryCode = "PK";
                    PhoneNumbers.PhoneNumber phoneNumber = phoneUtil.Parse(telephoneNumber, countryCode);

                    bool isMobile = false;
                    bool isValidNumber = phoneUtil.IsValidNumber(phoneNumber); // returns true for valid number

                    // returns trueor false w.r.t phone number region
                    bool isValidRegion = phoneUtil.IsValidNumberForRegion(phoneNumber, countryCode);

                    string region = phoneUtil.GetRegionCodeForNumber(phoneNumber); // GB, US , PK

                    var numberType = phoneUtil.GetNumberType(phoneNumber); // Produces Mobile , FIXED_LINE

                    string phoneNumberType = numberType.ToString();

                    if (!string.IsNullOrEmpty(phoneNumberType) && phoneNumberType == "MOBILE")
                    {
                        isMobile = true;
                    }

                    var originalNumber = phoneUtil.Format(phoneNumber, PhoneNumberFormat.E164); // Produces "[phone]"

                    var data = new ValidatePhoneNumberModel
   &nbfontsp;                {
                        FormattedNumber = originalNumber,
                        IsMobile = isMobile,
                        IsValidNumber = isValidNumber,
                        IsValidNumberForRegion = isValidRegion,
                        Region = region
                    };

                     returnResult = new GenericResponse<ValidatePhoneNumberModel>() { Data = data,
                     StatusCode = HttpStatusCode.OK, StatusMessage = "Success" };

                }
                catch (NumberParseException ex)
                {

                    String errorMessage = "NumberParseException was thrown: " + ex.Message.ToString();


                    returnResult = new GenericResponse<ValidatePhoneNumberModel>()
                    {
                        Message = errorMessage,
                        StatusCode = HttpStatusCode.BadRequest,
                        StatusMessage = "Failed"
                    };


                }

Display number in different formats

 

As we know, when we have to dial a number outside the country we have to use the national dialing according to the region.

The formatting method of libphone library helps us to display a number in local, international and outside country format.

string displayNumber = string.Empty;

PhoneNumberUtil phoneUtil = PhoneNumberUtil.GetInstance();
PhoneNumbers.PhoneNumber phoneNumber = phoneUtil.Parse(telephoneNumber, dialFrom);
// Produces 0333 6329900
displayNumber = phoneUtil.Format(phoneNumber, PhoneNumberFormat.NATIONAL);

// Produces International format: [phone]
displayNumber = phoneUtil.Format(phoneNumber, PhoneNumberFormat.INTERNATIONAL);

//Out - of - country format from US: 011 92 333 6323900
//Out - of - country format from UK: 00 92 333 6323900

displayNumber = phoneUtil.FormatOutOfCountryCallingNumber(phoneNumber, dialFrom);

You can get sample project from GITHUB REPOSITORY.