Semarchy Phone extractor

The Semarchy Phone extractor extracts a list of phone numbers from an input text.

Plugin ID

Semarchy 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.

This plugin is thread-safe and supports parallel execution.

Plugin parameters

The following table lists the plugin 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 value), 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.

Plugin inputs

The following table lists the plugin inputs.

Input 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.

If this input is unused, phone numbers must adhere to the international format—​meaning they should start with a plus sign followed by the country code and the rest of the phone number—​for the enricher to detect any numbers in the input text.

Plugin outputs

The following table lists the plugin outputs.

Output name Type Description

Extracted Phone List

String

List of phone numbers extracted.

Phone 1 to Phone 5

String

First to fifth extracted phone number in the list.