International Phone Numbers Plug-In

The International Phone Numbers Plug-In for Convergence for MDM provides two features:

Convergence Phone Enricher

Plug-in ID

Convergence Phone Enricher - com.semarchy.engine.plugins.convergence.phone

Description

This enricher takes as the Input Phone Number either an international phone number (with the international prefix), or a national phone number provided with a Region Code. It returns a standardized Enriched Phone Number in the Enriched Phone Format. Geocoding Data is also returned and includes (depending on the country) the country, the region/state and the city name.

If a phone number is not valid, the enricher returns the original phone value in the Enriched Phone Number, a Status Code as well as a Status Text describing the issue with the input phone number.

Plug-in Parameters

This plug-in does not use any parameter.

Plug-in Inputs

The following table lists the plug-in inputs.

Parameter Name Mandatory Type Description
Input Phone Number Yes String Input Phone Number.
Region Code No String Two letters region code for a national phone number, according to the ISO 3166-1 standard. If this parameter is left empty, the phone number provided in the Input Phone Number should include the international country calling code.
Enriched Phone Format No String Format of the Enriched Phone Number. Possible values are INTERNATIONAL (default), NATIONAL , E164 and RFC3966. See below for a description of the phone formats.
Region of Origin No String Formats the phone output for international dialing from the country or region provided in this input. E.g.: US, FR, GB, DE. Use ZZ for unknown region. See this link for the list of codes.

Phone Formats

The following standards are supported to format the enriched phone number:

Phone Format Examples:

Plug-in Outputs

The following table lists the plug-in outputs.

Parameter Name Type Description
Enriched Phone Number String Phone number returned by the enricher in the format specified in the Enriched Phone Format input. This string is null if the enricher was not able to process the input phone number. The Status Code and Status Text value help troubleshooting such issues.
Geocoding Data String Geocoding data computed for a given number and country. Depending on the country and phone number, this value includes the country, region/state and city information. This string is null if the enricher was not able to process the input phone number. The Status Code and Status Text value help troubleshooting such issues.
Status Code String Return code for the phone number processing. See below for a list of status codes.
Status Text String Text explaining the status code.
International Phone Prefix String International Phone Prefix for worldwide dialing.
National Number String National number part of an phone number in International format. It is often the International number without the Country Prefix.
Extension String Extension part of the phone number.
Country Code Source String Explains how the Country Code was retrieved. Possible values are FROM_NUMBER_WITH_PLUS_SIGN, FROM_NUMBER_WITH_IDD, FROM_NUMBER_WITHOUT_PLUS_SIGN and FROM_DEFAULT_COUNTRY.
Leading Zero String Returns 0 or 1 to specify if leading zero is mandatory for foreign calls.
Possible Phone Number String Returns 0 or 1 to indicate whether a phone number is a possible number, and the region where the number could be dialed from.
Possible Phone Number Reason String Detailed explaination of why a phone number is a possible number or not. Possible values are INVALID_COUNTRY_CODE, IS_POSSIBLE, TOO_LONG and TOO_SHORT.
Valid Phone Number String Returns 0 or 1 to indicate whether a phone number matches a valid pattern.
Valid Phone Number For Region String Returns 0 or 1 to indicate that a phone number is valid for the specified Region Code.
Phone Line Type String Provides the line type of a phone number. Possible values are : FIXED_LINE, FIXED_LINE_OR_MOBILE, MOBILE, PAGER, PERSONAL_NUMBER, PREMIUM_RATE, SHARED_COST, TOLL_FREE, UAN, UNKNOWN and VOIP
Region Code String Returns the region code for the Phone Number. See this link for the list of codes.
International Phone Number String Phone number formatted for international dialing.
Time Zones String List of corresponding time zones for a given number. For example: Europe/Paris. If the timezone is unknown, returns Etc/Unknown
First Time Zone String First time zone from the list of corresponding time zones for a given number.
Carrier Name String Name of the carrier for the phone number.

Status Codes

The following status codes are returned by the enricher:

Convergence Phone Extractor

Plug-in ID

Convergence Phone Extractor - com.semarchy.engine.plugins.convergence.phone.extractor

Description

This enricher extracts a list of phone numbers from an Input Text and returns them as a Phone List, in a given Extraction Format.

Plug-in Parameters

The following table lists the plug-in parameters.

Parameter Name Mandatory Type Description
Matching Leniency No String Defines the phone number extraction leniency. Possible values are POSSIBLE (default), VALID_FOR_REGION (according to the “Accepted Region” ) and VALID .
Extraction Format No String Format of the extracted phone numbers. Possible values are RAW (default), INTERNATIONAL , NATIONAL , E164 and RFC3966 .
List Separator No String Define the separator character used in the extracted phones list.
Maximum Invalid Numbers No String Maximum number of invalid numbers allowed before stopping to process the text. This is to cover cases where the text contains a lot of false positives.

Plug-in Inputs

The following table lists the plug-in inputs.

Parameter Name Mandatory Type Description
Input Text Yes String Input text to search for phone numbers.
Accepted Region No String Defines the region used when Matching Leniency is set to VALID_FOR_REGION.

Plug-in Outputs

The following table lists the plug-in outputs.

Parameter Name Type Description
Extracted Phone List String List of phone numbers extracted.
Phone 1..5 String First, second... extracted phone number in the list.

Convergence Phone Validator

Plug-in ID

Convergence Phone Validator - com.semarchy.engine.plugins.convergence.phone

Description

This validator takes as the Input Phone Number either an international phone number (with the international prefix), or a national phone number provided with a Country Code. The validator checks whether this phone number is a valid international or national phone number.

Plug-in Parameters

The following table lists the plug-in parameters.

Parameter Name Mandatory Type Description
Validation Leniency No String Precise validation leniency for possible phone numbers. Value may be VALID (default), POSSIBLE or VALID_FOR_REGION.

Plug-in Inputs

The following table lists the plug-in inputs.

Parameter Name Mandatory Type Description
Input Phone Number Yes String Input Phone Number.
Country Code No String Two letters country code for a national phone number, according to the ISO 3166-1 standard. If this parameter is left empty, the phone number provided in the Input Phone Number should include the international country calling code.