Numberlists
Numberlist is configuration object that allow to configure actions depends on Source or Destination number.
Depends on configuratio numberlist may act as blocklist and allowlist of phone numbers.
Numberlist object contains one or multiple Numberlist item to describe behavior for specific number.
Depends on how numberlist applied it may lookup Item by Source or Destination number.
Numberlist attributes
- Id
Unique identifier
- Name
Unique name
- Mode
Mode defines Numberlist item lookup algorithm.
- Strict number match
- In this mode Numberlist Item Key should contain full source (A) or destination (B) number of the call.
- Prefix match
- In this mode Numberlist Item Key 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
- Call will be rejected
- Allow call
- Call will be allowed and routing logic will continue.
- Default src rewrite rule/result
Rewrite rule and result for modification Source number(Number A).
- Default dst rewrite rule/result
Rewrite rule and result for modification Destination number(Number B).
WARNING
Read more about number rewrites at Number Translations guide
- Tag action/Tag action value
- Call tags modification logic. See Using Routing tags guide
- Variables
- Variables to assign to call processed by this Customer Auth object. For details read How to use variables Variables defined at numberlist level will be applied when no Item matched or matched item as action = Default.
- Created At
- Date and time of this Numberlist creation.
- Updated At
- Date and time of last updating of this Numberlist.
WARNING
Numberlist Default Action, default src rewrite rules, default dst rewrite rule, Tag action logic only works when no numberlist Item found or when matched Item has action = Default.
Numberlist Items
Numberlist items allow to apply difdo something with source or destination number or reject call in general before its routing and after rewriting on the level of Customer Auth <customer_auth>.
- Id
Unique Numberlist item's id.
- Numberlist
Numberlist where this item belongs to
- Key
Full number or Prefix. Interpretation of this field depends on Numberlist Mode setting.
- Action
This action will be applied to the call
- Default action
- Actions that is set for the Numberlist will be used. Yeti will not only apply Action itself(Allow/Reject), but SRC and DST rewrite rules, Tag action, Rewrite SS Status and Variables will be applied according to Numberlist configuration.
- Reject call
- Reject call in case of conformity source (A) or destination (B) number and the Key field (according to the Mode that was chosen in the
Numberlist <numberlists>). Action from theNumberlist <numberlists>) will be ignored in case of choosing this action. - Allow call
- Allow call in case of conformity source (A) or destination (B) number and the Key field (according to the Mode that was chosen in the
Numberlist <numberlists>). Action from theNumberlist <numberlists>) will be ignored in case of choosing this action.
- Src rewrite rule/Src rewrite result
Rewrite rules for SRC Number. See how to use POSIX Regular Expressions in Yeti.
- Dst rewrite rule/Dst rewrite result
Rewrite rules for Destination number. See how to use POSIX Regular Expressions in Yeti.
- Tag action/Tag action value
Call tags modification logic. See Using Routing tags guide
- Rewrite SS Status
This attribute allows overriding the original STIR/SHAKEN attestation level by redefining Customer Auth Rewrite SS Status value.
- Variables
Variables to assign to call processed by this Numberlist Item. For details read How to use variables
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). Usual use case is allow customer only use specific Source numbers(CLI) and reject calls with any other CLI.
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.