Numberlists

Numberlist is configuration object that allow to configure actions depends on Source or Destination number. Depends on configuration numberlist may act as blocklist and allowlist of phone numbers.

Numberlist object contains one or multiple Numberlist items to describe behavior for specific number.

Numberlist’s attributes

Id

Unique Numberlist’s id.

Name

Unique Numberlist’s name.

Mode

Mode defines Numberlist item key lookup logic.

Strict number match - In this mode Key field of Numberlist item should contain full source (A) or destination (B) number of the call.

Prefix match - In this mode Key field of Numberlist item should contain Prefix. Only in case of matching Prefix with first symbols of the source (A) or destination (B) number - according action will be applied to the call.

Random - Numberlist Item will be randomly selected. In this mode Numberlist Item always will be matched(if there are at least one Item in this Numberlist)

Default action

Default action will be applied in case when Numberlist Item was not found.

Reject call - Reject call in case of Numberlist item is not found

Allow call - Allow call in case of Numberlist item is not found

Default src rewrite rule

Pattern parameter of regexp_replace function from the POSIX Regular Expressions. As Source parameter of regexp_replace function is used source number (number A), as a Replacement parameter of regexp_replace function is used value from Default src rewrite result bellow. Returned value of regexp_replace function will be used as source number (number A) for the call during future routing. It helps to change format of the source number for providing compatibility. This field is used only in case of missing specific Numberlist item for the call in the framework of this Numberlist. See how to use POSIX Regular Expressions in Yeti.

Default src rewrite result

Replacement parameter of regexp_replace function from the POSIX Regular Expressions. As Source parameter of regexp_replace function is used source number (number A), as a Pattern parameter of regexp_replace function is used value from Default src rewrite rule above. Returned value of regexp_replace function will be used as source number (number A) for the call during future routing. It helps to change format of the source number for providing compatibility. This field is used only in case of missing specific Numberlist item for the call in the framework of this Numberlist. See how to use POSIX Regular Expressions in Yeti.

Default dst rewrite rule

Pattern parameter of regexp_replace function from the POSIX Regular Expressions. As Source parameter of regexp_replace function is used destination number (number B), as a Replacement parameter of regexp_replace function is used value from Default dst rewrite result bellow. Returned value of regexp_replace function will be used as destination number (number B) for the call during future routing. It helps to change format of the destination number for providing compatibility. This field is used only in case of missing specific Numberlist item for the call in the framework of this Numberlist. See how to use POSIX Regular Expressions in Yeti.

Default dst rewrite result

Replacement parameter of regexp_replace function from the POSIX Regular Expressions. As Source parameter of regexp_replace function is used destination number (number B), as a Pattern parameter of regexp_replace function is used value from Default dst rewrite rule above. Returned value of regexp_replace function will be used as destination number (number B) for the call during future routing. It helps to change format of the destination number for providing compatibility. This field is used only in case of missing specific Numberlist item for the call in the framework of this Numberlist. See how to use POSIX Regular Expressions in Yeti.

Tag action

Describes one of the possible actions that could be applied to the current set of Routing Tags that are applied for the call with using Tag action value below. Numberlist it is second step (after Authentication) where Routing Tags can be added to (or removed from) the call. Destination Numberlist is processed before the Source Numberlist. This field and field bellow are used only in case of missing specific Numberlist item for the call in the framework of this Numberlist. Following actions can be selected in this field:

  • Clear tags. Removes all Routing Tags from the call (if any were added early);

  • Remove selected tags. Removes only Routing Tags that were chosen in the Tag action value field bellow (if any were chosen) from the call;

  • Append selected tags. Appends Routing Tags that were chosen in the Tag action value field bellow (if any were chosen) to the call;

  • Intersection with selected tags. Yeti leaves as is Routing Tags that were chosen in the Tag action value field bellow (if any were chosen) in the call in case of their presence in the current set of Routing Tags and removes any other Routing Tags from the call.

Tag action value

In this field Routing Tags for making some Tag action above could be chosen.

Created At

Date and time of this Numberlist creation.

Updated At

Date and time of last updating of this Numberlist.

Numberlist’ Usage

Numberlist may be used in Customer Auth object as SRC or DST Numberlist. In this case it will be used before call routing(during Customer auth processing).

  • For SRC numberlist system will try to find Numberlist Item by key, comparing it with SRC number.

  • For DST numberlist system will try to find Numberlist Item by key, comparing it with DST number.

Numberlist may be used in Routing Plan as SRC or DST Numberlist. Routing plan Numberlist processing processed on next step after Customer Auth Numberlist. Usual use case for Routing Plan Numberlist is global call blocking to/from some numbers.

Numberlist may be used in termination gateways. In this mode it is possible to skip termination gw during routing process depends on numberlist item matching results.