A library for parsing phone numbers, providing a number of benefits over a regular expression. For example greater validity of phone numbers including national destination codes (area codes) and subscriber numbers based upon published numbering plans for each country. Additional attributes such as the kind of phone number (Mobile, Geographic or Non-Geographic) are also included, and all parsing is performed locally within the library using embedded in-memory data files.
Get Started
$ dotnet add package PhoneNumberParserReadme
Phone Number Parser
A library for parsing phone numbers, providing validity of phone numbers including national destination codes (aka area codes) and subscriber numbers (aka line numbers) based upon published numbering plans for each country. Additional attributes such as the kind of phone number (Mobile, Geographic or Non-Geographic) are also included, and all parsing is performed locally within the library using embedded in-memory data files.
using PhoneNumbers;
// Parsing a phone number is achieved via the `PhoneNumber.Parse` method (or alternatively via `PhoneNumber.TryParse`). Any formatting (e.g. spaces or hyphens) in the input string is ignored.
var phoneNumber = PhoneNumber.Parse("+441142726444"); // or Parse("01142726444", CountryInfo.UnitedKingdom) or Parse("01142726444", "GB")
phoneNumber.NationalDestinationCode; // 114 (aka area code)
phoneNumber.SubscriberNumber; // 2726444 (aka line number)
// Country specific information is accessible via the Country property, for example:
phoneNumber.Country.CallingCode; // 44
phoneNumber.Country.Iso3166Code; // GB
phoneNumber.Country.Name; // United Kingdom
phoneNumber.Country.TrunkPrefix; // 0
// There are 3 subclasses of PhoneNumber, the correct type to cast to can be determined by inspecting the phoneNumber.Kind property. Cast as appropriate to access additional properties.
var geographicPhoneNumber = (GeographicPhoneNumber)phoneNumber;
geographicPhoneNumber.GeographicArea; // Sheffield
// The phone number can be formatted in the following ways, the default format output can be round tripped via `PhoneNumber.Parse()` to easily support persistence and serialization use cases.
phoneNumber.ToString(); // +441142726444 (defaults to E.164 format)
phoneNumber.ToString("E.164"); // +441142726444 (E.164 format)
phoneNumber.ToString("E.123"); // +44 114 272 6444 (E.123 international format)
phoneNumber.ToString("N"); // (0114) 272 6444 (E.123 national notation format)
phoneNumber.ToString("RFC3966"); // tel:+44-114-272-644 (RFC3966 format)
phoneNumber.ToString("U"); // 01142726444 (the unformatted national notation)
// The dial helper extension provides the appropriate number for a caller to dial, either based upon their country:
phoneNumber.NumberToDialFrom(CountryInfo.France); // 00441142726444
phoneNumber.NumberToDialFrom(CountryInfo.HongKong); // 001441142726444
phoneNumber.NumberToDialFrom(CountryInfo.Nigeria); // 009441142726444
// or their own phone number:
phoneNumber.NumberToDialFrom(PhoneNumber.Parse("+33140477283")); // 00441142726444