Semarchy Phone Enricher
The Semarchy Phone Enricher standardizes and improves phone numbers formatting.
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.
This plug-in is thread-safe and supports parallel execution. |
Plug-in Inputs
The following table lists the plug-in inputs.
Input 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 |
Region of Origin |
No |
String |
Formats the phone output for international dialing from the country or region provided in this input. E.g.: |
Phone Formats
The following standards are supported to format the enriched phone number:
-
E123_INTERNATIONAL
andE123_NATIONAL
refer to the ITU-T Recommendation E.123 for national and international phone numbers. -
INTERNATIONAL
andNATIONAL
use a format similar to the ITU-T Recommendation E.123 for national and international phone numbers, but use hyphens to separate blocks of numbers. -
E164
refers to the ITU-T Recommendation E.164. -
RFC3966
refers to the IETF 3966 RFC.
Phone Format Examples:
-
E123_NATIONAL
(E.123 - National Notation): (042) 123 4594 -
E123_INTERNATIONAL
(E.123 - International Notation): +31 42 123 4567 -
NATIONAL
(E.123 - National Notation with hyphens): (042) 123-4594 -
INTERNATIONAL
(E.123 - International Notation with hyphens): +31 42-123-4567 -
E.164
(E.164 - International Notation): +31421234567 (equivalent to E.123 with no formatting) -
RFC3966
(RFC3966 - International Notation): +31-42-123-4567 (equivalent to E.123 with hyphens instead of spaces)
Plug-in Outputs
The following table lists the plug-in outputs.
Output 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. More details about the 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 a 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 |
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 explanation of why a phone number is a possible number or not. Possible values are |
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 : |
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: |
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. |