libphonenumber-csharp 9.0.36

C# port of Google's libphonenumber library.

The code was rewritten from the Java source mostly unchanged, please refer to the original documentation for sample code and API documentation.

The original Apache License 2.0 was preserved.

See this for details about the port.

Phone number metadata is updated in the Google repo approximately every two weeks. This library is automatically updated by a scheduled github action to include the latest metadata, usually within a day. See Metadata updates for how that works and how to run it manually.

Installation

Run the following command to add this library to your project

dotnet add package libphonenumber-csharp

Available on NuGet as package libphonenumber-csharp.

Examples

Parsing a phone number

using PhoneNumbers;

var phoneNumberUtil = PhoneNumberUtil.GetInstance();
var e164PhoneNumber = "+44 117 496 0123";
var nationalPhoneNumber = "2024561111";
var smsShortNumber = "83835";
var phoneNumber = phoneNumberUtil.Parse(e164PhoneNumber, null);
phoneNumber = phoneNumberUtil.Parse(nationalPhoneNumber, "US");
phoneNumber = phoneNumberUtil.Parse(smsShortNumber, "US");

Formatting a phone number

using PhoneNumbers;

var phoneNumberUtil = PhoneNumberUtil.GetInstance();
var phoneNumber = phoneNumberUtil.Parse("+14156667777", "US");
var formattedPhoneNumber = phoneNumberUtil.Format(phoneNumber, PhoneNumberFormat.INTERNATIONAL);
var formattedPhoneNumberNational = phoneNumberUtil.Format(phoneNumber, PhoneNumberFormat.NATIONAL);

Console.WriteLine(formattedPhoneNumber.ToString()); // +1 415-666-7777
Console.WriteLine(formattedPhoneNumberNational.ToString()); // (415) 666-7777

Check if a phone number is valid

using PhoneNumbers;

var phoneNumberUtil = PhoneNumberUtil.GetInstance();
var phoneNumber = phoneNumberUtil.Parse("+14156667777", "US");
var isValid = phoneNumberUtil.IsValidNumber(phoneNumber);

Console.WriteLine(isValid); // true

Get the type of a phone number

using PhoneNumbers;

var phoneNumberUtil = PhoneNumberUtil.GetInstance();
var phoneNumber = phoneNumberUtil.Parse("+14156667777", "US");
var numberType = phoneNumberUtil.GetNumberType(phoneNumber);

Console.WriteLine(numberType); // PhoneNumberType.FIXED_LINE_OR_MOBILE

See PhoneNumberType.cs for the various possible types of phone numbers

Get the region code for a phone number

using PhoneNumbers;

var phoneNumberUtil = PhoneNumberUtil.GetInstance();
var phoneNumber = phoneNumberUtil.Parse("+14156667777", null);
var regionCode = phoneNumberUtil.GetRegionCodeForNumber(phoneNumber);

Console.WriteLine(regionCode); // US

Get the time zones for a phone number

using PhoneNumbers;

var phoneNumberUtil = PhoneNumberUtil.GetInstance();
var timeZonesMapper = PhoneNumberToTimeZonesMapper.GetInstance();
var phoneNumber = phoneNumberUtil.Parse("+12128120000", null);
var timeZones = timeZonesMapper.GetTimeZonesForNumber(phoneNumber);

Console.WriteLine(string.Join(", ", timeZones)); // America/New_York

Returns a List<string> of IANA time zone identifiers. For numbers that span multiple time zones (e.g. a country-level lookup), the list will contain more than one entry. Returns ["Etc/Unknown"] for invalid or unrecognised numbers.

Use GetTimeZonesForGeographicalNumber instead if you have already validated the number and want to skip the internal type check.

Get the carrier name for a phone number

using PhoneNumbers;

var phoneNumberUtil = PhoneNumberUtil.GetInstance();
var carrierMapper = PhoneNumberToCarrierMapper.GetInstance();
var phoneNumber = phoneNumberUtil.Parse("+917503397672", null);
var carrierName = carrierMapper.GetNameForNumber(phoneNumber, Locale.English);

Console.WriteLine(carrierName); // Aircel

Note: Carrier data reflects the original network allocation. If the country supports mobile number portability, the number may have since moved to a different carrier. Use GetSafeDisplayName to return an empty string in those regions.

Features

• Parsing/formatting/validating phone numbers for all countries/regions of the world.
• GetNumberType - gets the type of the number based on the number itself; able to distinguish Fixed-line, Mobile, Toll-free, Premium Rate, Shared Cost, VoIP and Personal Numbers (whenever feasible).
• IsNumberMatch - gets a confidence level on whether two numbers could be the same.
• GetExampleNumber/GetExampleNumberByType - provides valid example numbers for 218 countries/regions, with the option of specifying which type of example phone number is needed.
• IsPossibleNumber - quickly guessing whether a number is a possible phone number by using only the length information, much faster than a full validation.
• AsYouTypeFormatter - formats phone numbers on-the-fly when users enter each digit.
• FindNumbers - finds numbers in text input
• PhoneNumberToCarrierMapper - looks up the carrier name originally assigned to a mobile or pager number, with locale-aware output and a safe-display mode for regions with mobile number portability.

See PhoneNumberUtil.cs for the various methods and properties available.

Why keep libphonenumber-csharp up to date?

A lot of the functionality depends on updated metadata that is published by the google repository, see example here.

This means that if you don't keep the package up to date, methods like IsValidNumber will return false for newer numbers that rely on the updated metadata

Therefore, we recommend you keep this nuget package as up to date as possible using automated means (such as dependabot) as metadata changes published by the google repository is frequent, usually a few times a month.

For more information on metadata usage, please refer to the main repository faq

ToDo

• update / add / port new unit tests and logging from java source

How to unfold automatic generated files

• Install Jetbrains - Resharper for Visual Studio
• File by file, right click and "Cleanup code"
• Check the unfolded file

Running tests locally

dotnet test csharp/PhoneNumbers.sln

Metadata updates

The create_new_release_on_new_metadata_update workflow runs daily and drives lib/github-actions-metadata-update.sh. When the latest google/libphonenumber release is newer than the published NuGet package, it copies the upstream resources/, regenerates csharp/PhoneNumbers/LocaleData.cs, builds and tests, then commits, pushes and creates a matching GitHub release.

Before doing any of that it inspects the upstream diff and stops if it contains .java or .proto files, because changes to the Java sources may need porting by hand and an unattended metadata bump would silently skip them.

Skipping the java (or proto) check

If you have reviewed the upstream diff and the Java changes don't need porting (for example test-only or build-file changes), you can run the update anyway:

• From the Actions UI — open create_new_release_on_new_metadata_update, click Run workflow, and tick skip_java_check (and/or skip_proto_check). Scheduled runs always leave both unticked.

• Locally — pass the flag or set the environment variable:

  bash lib/github-actions-metadata-update.sh --skip-java-check "$GITHUB_TOKEN"
  # or
  SKIP_JAVA_CHECK=true bash lib/github-actions-metadata-update.sh "$GITHUB_TOKEN"
  

  --skip-proto-check / SKIP_PROTO_CHECK work the same way, and --help lists every option.

Skipping a check means the release ships upstream metadata from a version whose Java-side changes were not ported, so read the upstream diff first — the script prints the offending filenames before it stops.

Dry runs

--dry-run (or the dry_run workflow input) runs every read-only step — version lookups, repository checks, the upstream diff gates, the upstream clone — reports what a real run would do, and stops before the first change to the working tree. Nothing is copied, generated, committed, pushed or released, no token is required, and the clean-main requirement is relaxed to a warning so it works from a feature branch:

# what would tonight's scheduled run do?
bash lib/github-actions-metadata-update.sh --dry-run

UPSTREAM_TAG and DEPLOYED_VERSION override the two version lookups, which lets you replay any historical release pair — useful for seeing how a given release trips the gates:

UPSTREAM_TAG=v9.0.33 DEPLOYED_VERSION=9.0.32 \
  bash lib/github-actions-metadata-update.sh --dry-run

Running it against a fork

Nothing about the target repository is hard-coded. The script commits and pushes through whatever checkout it runs in, and takes the repository to release from GITHUB_REPOSITORY — set automatically by GitHub Actions, and otherwise derived from the origin remote. So a fork releases to itself, and the dry-run summary names the repository it would publish to. UPSTREAM_REPOSITORY (default google/libphonenumber) and NUGET_PACKAGE_ID (default libphonenumber-csharp) are overridable the same way.

Contributing

See CONTRIBUTING.md

Donations