📞 Format International Phone Numbers

Component Type: Extension (XIF)
Purpose: Formats international phone numbers into the local display format used within each respective country.

🔹 Description

This component provides a method to format phone numbers into a readable format based on their international format and regional standards. If the phone number is already in international format (e.g., +442083661177), it will auto-detect the region. Otherwise, it uses the provided default region code.

⚙️ Method

FormatInternationalPhoneNumber

Component method UI

Formats a phone number according to the specified format and region settings.

🧾 Input Parameters

Name	Data Type	Mandatory	Description
`PhoneNumber`	Text	✅	Phone number to be formatted. If in international format (e.g., `+442083661177`), the region is auto-detected. Otherwise, the `DefaultRegion` value is used.
`PhoneFormat`	Integer	⬜	Format type: `0` or invalid = NATIONAL`1` = INTERNATIONAL`2` = E164`3` = RFC3966
`DefaultRegion`	Text	⬜	ISO 3166-1 alpha-2 country code used when the phone number is not in international format. Examples: `US` for United States`GB` for United Kingdom`BR` for Brazil`FR` for France`IN` for India`CA` for Canada
`SkipValidationErrors`	Boolean	⬜	If `True`, skips exceptions on invalid phone numbers. Output depends on `KeepOriginalIfInvalid`.
`KeepOriginalIfInvalid`	Boolean	⬜	If `False`, returns empty for invalid numbers. If `True`, returns the original input as-is.

📤 Output Parameters

Name	Data Type	Description
`PhoneNumberFormatted`	Text	Returns the formatted phone number as a text value.

🧪 Example App

Test app UI

In this example:

Input: 2015551234
Format: NATIONAL
Default Region: US
Output: (201) 555-1234

🧱 Logic Component Reference

Method and parameters

The FormatInternationalPhoneNumber logic node is available in the InternationalPhoneNumberFormatting extension and can be used in both reactive and traditional web apps.