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 items <numberlist_items> to describe behavior for specific number.

Depends on how numberlist applied it may lookup Item by Source or Destination number.

Numberlist's attributes

Id

Unique Numberlist's id.

Name

Unique Numberlist's name.

Mode

Mode defines Numberlist item lookup algorithm.

Strict number match: In this mode Key <numberlist_items_key> field of Numberlist item <numberlist_items> should contain full source (A) or destination (B) number of the call.
Prefix match: In this mode Key <numberlist_items_key>field of Numberlist item <numberlist_items> 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.

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

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.