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.
The library does not:
- Yet support every country
- Provide certainty that a phone number is assigned and in use
- Include the original carrier for mobile phone numbers due to number portability in most countries
- Support extension numbers, although they are ignored if specified when parsing a value in RFC3966 format or in the older German style
0234/123456-10 - Support alphabetic mnemonic system/alphabetic phone-words (e.g. 123-PHONEME)
Install via nuget:
dotnet add package PhoneNumberParserAdd the namespace:
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.
There are 2 overloads for Parse:
// If the phone number string is in international format (e.g. +XXXXXXXXXXXX):
var phoneNumber = PhoneNumber.Parse("+441142726444");
// If the phone number string is not in international format:
// Specify the typed CountryInfo instance as the second parameter.
var phoneNumber = PhoneNumber.Parse("01142726444", CountryInfo.UnitedKingdom); // Alternatively the ISO 3166 Alpha-2 code for the country PhoneNumber.Parse("01142726444", "GB");There are 3 overloads for TryParse:
// If the phone number string is in international format (e.g. +XXXXXXXXXXXX):
PhoneNumber.TryParse("+442079813000", out PhoneNumber phoneNumber);
// If the phone number string is not in international format:
// Specify the typed CountryInfo instance for the country as the second parameter.
PhoneNumber.TryParse("01142726444", CountryInfo.UnitedKingdom, out PhoneNumber phoneNumber); // Alternatively the ISO 3166 Alpha-2 code PhoneNumber.TryParse("01142726444", "GB", out PhoneNumber phoneNumber);
// The phone number string is not in international format and the country code is not known:
PhoneNumber.TryParse("02079813000", out IEnumerable<PhoneNumber> phoneNumbers);The resulting PhoneNumber has the following properties:
// PhoneNumber properties:
phoneNumber.Country.AllowsLocalGeographicDialling; // true
phoneNumber.Country.CallingCode; // 44
phoneNumber.Country.Continent; // Europe
phoneNumber.Country.HasNationalDestinationCodes; // true
phoneNumber.Country.HasTrunkPrefix; // true
phoneNumber.Country.IsEuropeanUnionMember; // false
phoneNumber.Country.Iso3166Code; // GB
phoneNumber.Country.Name; // United Kingdom
phoneNumber.Country.SharesCallingCode; // true
phoneNumber.Country.TrunkPrefix; // 0
phoneNumber.Kind; // PhoneNumberKind.GeographicPhoneNumber
phoneNumber.NationalDestinationCode; // 114
phoneNumber.NationalSignificantNumber; // 1142726444
phoneNumber.SubscriberNumber; // 2726444
// There are 3 subclasses of PhoneNumber, the correct type to cast to
// can be determined by inspecting the phoneNumber.Kind property.
// if (phoneNumber.Kind == PhoneNumberKind.GeographicPhoneNumber)
var geographicPhoneNumber = (GeographicPhoneNumber)phoneNumber;
geographicPhoneNumber.GeographicArea; // Sheffield
// if (phoneNumber.Kind == PhoneNumberKind.MobilePhoneNumber)
var mobilePhoneNumber = (MobilePhoneNumber)phoneNumber;
mobilePhoneNumber.IsPager; // true/false
mobilePhoneNumber.IsVirtual; // true/false
// if (phoneNumber.Kind == PhoneNumberKind.NonGeographicPhoneNumber)
var nonGeographicPhoneNumber = (NonGeographicPhoneNumber)phoneNumber;
nonGeographicPhoneNumber.IsFreephone; // true/false
nonGeographicPhoneNumber.IsMachineToMachine; // true/false
nonGeographicPhoneNumber.IsPremiumRate; // true/false
nonGeographicPhoneNumber.IsSharedCost; // true/falseThe 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)The ParseOptions class can be used to control parsing, the defaults can be configured via:
ParseOptions.DefaultAt present, the only options available are which countries are parsed.
By default all countries supported by the library can be parsed and any future supported countries will be automatically included.
A ParseOptions instance may also be passed as a parameter to the Parse and TryParse methods, however this is only necessary to supply alternative options to the default ones.
To support parsing specific countries only, and ignore by default any new ones added in future versions of the library:
ParseOptions.Default.Countries.Clear():
ParseOptions.Default.Countries.Add(CountryInfo.X); // repeat per countryAlternatively there are additional country sets which can be allowed (any combination may be used):
// Add all countries supported by the library by continent:
ParseOptions.Default.AllowAfricanCountries();
ParseOptions.Default.AllowAsianCountries();
ParseOptions.Default.AllowEuropeanCountries();
ParseOptions.Default.AllowNorthAmericanCountries();
ParseOptions.Default.AllowOceanianCountries();
ParseOptions.Default.AllowSouthAmericanCountries();
// Add all countries supported by the library who are members of the same union:
ParseOptions.Default.AllowEuropeanUnionCountries();
// Add all countries supported by the library using the same numbering plan:
ParseOptions.Default.AllowNorthAmericanNumberingPlanCountries();
ParseOptions.Default.AllowUnitedKingdomNumberingPlanCountries(); // Countries.Add(CountryInfo.UnitedKingdom) doesn't include Guernsey, Isle of Man and Jersey which also use the same numbering plan.To out out of specific countries but still use any new ones added in future versions of the library:
ParseOptions.Default.Countries.Remove(CountryInfo.X);The library adheres to Semantic Versioning and release notes are provided for every published version.
Specific builds are included in the nuget package for:
- .NET 8.0
- .NET Standard 2.1 - supports .NET Core 3.0 or newer and .NET 5.0 or newer
- .NET Standard 2.0 - supports .NET Framework 4.6.2 or newer, however projects will need to be built with a minimum C# language version of 9.0 due to use of init only properties
The latest version of .NET will be used (excluding public betas), other versions of .NET and .NET Framework will retain support via the .NET Standard builds.
The library currently supports parsing phone numbers for the following countries and although best endeavours are made to adhere to published telephone numbering plans, depending on the accessibility of data there may be discrepancies. If you happen to find any, please raise an issue.
| Country | ISO 3166 Code | Calling Code | Trunk Prefix | Geographic | Mobile | Mobile (Pager) |
Mobile (Virtual) |
Non-Geographic | Non-Geographic (Freephone) |
Non-Geographic (Premium Rate) |
Non-Geographic (Shared Cost) |
Non-Geographic (M2M) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Egypt | EG | 20 | 0 | Yes | Yes | Yes | Yes | |||||
| Kenya | KE | 254 | 0 | Yes | Yes | Yes | ||||||
| Nigeria | NG | 234 | 0 | Yes | Yes | Yes | Yes | |||||
| South Africa | ZA | 27 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Tanzania | TZ | 255 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Country | ISO 3166 Code | Calling Code | Trunk Prefix | Geographic | Mobile | Mobile (Pager) |
Mobile (Virtual) |
Non-Geographic | Non-Geographic (Freephone) |
Non-Geographic (Premium Rate) |
Non-Geographic (Shared Cost) |
Non-Geographic (M2M) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Hong Kong | HK | 852 | Yes | Yes | Yes | Yes | Yes | |||||
| Macau | MO | 853 | Yes | Yes | ||||||||
| Singapore | SG | 65 | Yes | Yes | Yes | Yes | ||||||
| Turkey | TR | 90 | 0 | Yes | Yes | Yes | Yes | Yes | Yes |
| Country | ISO 3166 Code | Calling Code | Trunk Prefix | Geographic | Mobile | Mobile (Pager) |
Mobile (Virtual) |
Non-Geographic | Non-Geographic (Freephone) |
Non-Geographic (Premium Rate) |
Non-Geographic (Shared Cost) |
Non-Geographic (M2M) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Austria | AT | 43 | 0 | Yes | Yes | Yes | Yes | Yes | ||||
| Belarus | BY | 375 | 8 | Yes | Yes | Yes | Yes | Yes | ||||
| Belgium | BE | 32 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Bosnia and Herzegovina | BA | 387 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
| Bulgaria | BG | 359 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Croatia | HR | 385 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Cyprus | CY | 387 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Czech Republic | CZ | 420 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Denmark | DK | 45 | Yes | Yes | Yes | Yes | Yes | |||||
| Estonia | EE | 372 | Yes | Yes | Yes | Yes | Yes | Yes | ||||
| Finland | FI | 358 | 0 | Yes | Yes | Yes | Yes | Yes | ||||
| France | FR | 33 | 0 | Yes | Yes | Yes | Yes | Yes | ||||
| Germany | DE | 49 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |
| Gibraltar | GI | 350 | Yes | Yes | Yes | Yes | Yes | |||||
| Greece | GR | 30 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Guernsey | GG | 44 (UK) | 0 | Yes | Yes | |||||||
| Hungary | HU | 36 | 06 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Iceland | IS | 354 | Yes | Yes | Yes | Yes | Yes | Yes | ||||
| Ireland | IE | 353 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Isle of Man | IM | 44 (UK) | 0 | Yes | Yes | |||||||
| Italy | IT | 39 | Yes | Yes | Yes | Yes | Yes | Yes | ||||
| Jersey | JE | 44 (UK) | 0 | Yes | Yes | |||||||
| Kosovo | XK | 383 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Latvia | LV | 371 | Yes | Yes | Yes | Yes | Yes | Yes | ||||
| Lithuania | LT | 370 | 8 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Luxembourg | LU | 352 | Yes | Yes | Yes | Yes | Yes | |||||
| Malta | MT | 356 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Moldova | MD | 373 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Monaco | MC | 377 | Yes | Yes | Yes | |||||||
| Montenegro | ME | 382 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Netherlands | NL | 31 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| North Macedonia | MK | 389 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Norway | NO | 47 | Yes | Yes | Yes | |||||||
| Poland | PL | 48 | Yes | Yes | Yes | Yes | ||||||
| Portugal | PT | 351 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Romania | RO | 40 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| San Marino | SM | 378 | Yes | Yes | Yes | |||||||
| Serbia | RS | 381 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Slovakia | SK | 421 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Slovenia | SL | 386 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | |||
| Spain | ES | 34 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Sweden | SE | 46 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Switzerland | CH | 41 | 0 | Yes | Yes | Yes | Yes | |||||
| Ukraine | UA | 380 | 0 | Yes | Yes | Yes | Yes | Yes | ||||
| United Kingdom | GB | 44 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Country | ISO 3166 Code | Calling Code | Trunk Prefix | Geographic | Mobile | Mobile (Pager) |
Mobile (Virtual) |
Non-Geographic | Non-Geographic (Freephone) |
Non-Geographic (Premium Rate) |
Non-Geographic (Shared Cost) |
Non-Geographic (M2M) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Anguilla | AI | 1 264 (NANP) | Yes | |||||||||
| Antigua and Barbuda | AG | 1 268 (NANP) | ||||||||||
| Barbados | BB | 1 246 (NANP) | Yes | Yes | ||||||||
| Bermuda | BM | 1 441 (NANP) | Yes | |||||||||
| Bahamas | BS | 1 242 (NANP) | Yes | Yes | Yes | |||||||
| British Virgin Islands | VG | 1 284 (NANP) | Yes | Yes | ||||||||
| Canada | CA | 1 (NANP)_ | Yes | Yes | ||||||||
| Cayman Islands | KY | 1 345 (NANP) | Yes | Yes | Yes | |||||||
| Dominica | DM | 1 767 (NANP) | Yes | Yes | ||||||||
| Grenada | GD | 1 473 (NANP) | Yes | Yes | ||||||||
| Jamaica | JM | 1 658 / 876 (NANP) | Yes | |||||||||
| Montserrat | MS | 1 664 (NANP) | Yes | Yes | ||||||||
| Northern Mariana Island | MP | 1 670 (NANP) | Yes | |||||||||
| Puerto Rico | PR | 1 787 / 939 (NANP) | ||||||||||
| Saint Kitts and Nevis | KN | 1 869 (NANP) | Yes | Yes | ||||||||
| Saint Lucia | LC | 1 758 (NANP) | Yes | Yes | ||||||||
| Saint Vincent and the Grenadines | VC | 1 784 (NANP) | Yes | Yes | ||||||||
| Sint Maarten | SX | 1 721 (NANP) | Yes | Yes | Yes | |||||||
| Trinidad and Tobago | TT | 1 868 (NANP) | Yes | Yes | ||||||||
| Turks and Caicos Islands | TC | 1 649 (NANP) | Yes | Yes | Yes | |||||||
| United States | US | 1 (NANP) | Yes | Yes * | Yes | Yes * | Yes | |||||
| United States Virgin Islands | VI | 1 340 (NANP) |
| Country | ISO 3166 Code | Calling Code | Trunk Prefix | Geographic | Mobile | Mobile (Pager) |
Mobile (Virtual) |
Non-Geographic | Non-Geographic (Freephone) |
Non-Geographic (Premium Rate) |
Non-Geographic (Shared Cost) |
Non-Geographic (M2M) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| American Samoa | AS | 1 684 (NANP) | Yes | Yes | Yes | |||||||
| Australia | AU | 61 | 0 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ||
| Guam | GU | 1 671 (NANP) | ||||||||||
| Papua New Guinea | PG | 675 | Yes | Yes | Yes | Yes | Yes |
| Country | ISO 3166 Code | Calling Code | Trunk Prefix | Geographic | Mobile | Mobile (Pager) |
Mobile (Virtual) |
Non-Geographic | Non-Geographic (Freephone) |
Non-Geographic (Premium Rate) |
Non-Geographic (Shared Cost) |
Non-Geographic (M2M) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Brazil | BR | 55 | 0 | Yes | Yes | Yes | Yes | Yes | ||||
| Colombia | CO | 57 | Yes | Yes |
- For the United Kingdom:
- The ISO code is 'GB' rather than 'UK'.
- Covers England, Scotland, Wales and Northern Ireland.
- The Crown Dependencies Guernsey, Isle of Man and Jersey also use the same numbering plan but are separate countries.
- To avoid a legitimate UK phone number from being rejected by the library, consider using
ParseOptions.Default.AllowUnitedKingdomNumberingPlanCountries()if you are customising the countries used instead ofParseOptions.Countries.Add(CountryInfo.UnitedKingdom).
- Where possible, the geographic area name is in the language/locality of the country for the phone number (e.g. for an Italian phone number assigned to Florence, the geographic area will be set to
Firenze. - Within the North American Numbering Plan (NANP), which covers all countries with the calling code
1:- Geographically assigned numbers are currently only resolved within the country or state/region level, not at city level.
- Mobile numbers are geographically assigned and cannot be determined separately from landlines.
- Freephone numbers (with a few exceptions) are issued from a shared pool. This could mean a Canadian freephone number look up shows as belonging to a different country if parsed from the E.164 format (parsing from the national number format and country code will work as expected).
- Virtual (aka personal numbers) are issued from a shared pool and always show as belonging to the United States.
- Landline numbers can be ported in some countries and therefore although originally geographically assigned, they may no longer match the specified geographic area (Countries affected - Iceland)
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
