Skip to Content
DocsFunctionsPrebuilt FunctionsPhone Functions

Phone Functions

/phone/check/possibleNumber

Applies isPossibleNumber function from Google libphonenumber  to the input string.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/check/validNumber

Applies isValidNumber function from Google libphonenumber  to the input string.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/format/E164

Applies format function from Google libphonenumber  to the input string with format PhoneNumberFormat.E164.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/format/international

Applies format function from Google libphonenumber  to the input string with format PhoneNumberFormat.INTERNATIONAL.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/format/national

Applies format function from Google libphonenumber  to the input string with format PhoneNumberFormat.NATIONAL.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/get/areaCode

Returns the area code from the input string. More specifically, it first parses the input string into a number using parseAndKeepRawInput function from Google libphonenumber . Then it applies getNationalSignificantNumber to the number. Then returns N first characters from the result where N is the result of applying getLengthOfGeographicalAreaCode to the number. Returns null if N = 0.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/get/countryCode

Returns the country code from the input string. More specifically, it first parses the input string into a number using parseAndKeepRawInput function from Google libphonenumber . Then it returns the result of applying getCountryCode to the number.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/get/extension

Returns the phone extension from the input string. More specifically, it first parses the input string into a number using parseAndKeepRawInput function from Google libphonenumber . Then it returns the result of applying getExtension to the number.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/get/nationalSignificantNumber

Returns Gets the national significant number from the input string. More specifically, it first parses the input string into a number using parseAndKeepRawInput function from Google libphonenumber . Then it returns the result of applying getNationalSignificantNumber to the number.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }

/phone/get/subscriberNumber

Returns the subsriber number from the input string. More specifically, it first parses the input string into a number using parseAndKeepRawInput function from Google libphonenumber . Then it applies getNationalSignificantNumber to the number. Then from the result it returns all characters after area code where the length of area code is returned by getLengthOfGeographicalAreaCode. Returns the national significant number if the area code length = 0.

Extra Parameters:

{ "defaultRegion": "<default region; 'US' by default>" }
Last updated on