International Phone Numbers Plug-In | ||
---|---|---|
Previous | Next | |
Text Normalization and Transliteration | Email Plug-In |
The International Phone Numbers Plug-In for Convergence for MDM provides two features:
Convergence Phone Enricher - com.semarchy.engine.plugins.convergence.phone
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 Country 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 a null 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 does not use any parameter.
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. |
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.
|
The following standards are supported to format the enriched phone number:
INTERNATIONAL
and
NATIONAL
refer to the
ITU-T Recommendation E.123 for national and international phone numbers.
E164
refers to the
ITU-T Recommendation E.164.
RFC3966
refers to the
IETF 3966 RFC.
Phone Format Examples:
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. |
The following status codes are returned by the enricher:
0 - OK
: Optimal execution. No error detected.
1 - INPUT_WAS_NULL
: Input phone number was not set.
2 - PARSING FAILED
: The string supplied did not seem to be a phone number. Review the Status text for more information.
Convergence Phone Validator - com.semarchy.engine.plugins.convergence.phone
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.
This plug-in does not use any parameter.
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. |
Previous | Top | Next |
Text Normalization and Transliteration | Email Plug-In |