.. _ms-blocked-calling-numbers:

MS Blocked Calling Numbers
--------------------------

.. _24.2|VOSS-1420:

VOSS Automate allows for the management of 
Microsoft Call Blocking features if the **Global**
setting for **Tenant Call Blocking** is enabled at tenant level (:ref:`ms-tenant-blocked-calling`).

The functionality will then be available to administrators:

* Menu: **MS Blocked Calling Numbers**
* Dashboards: the **MS Blocked Calling Numbers** widget on
  ``MVS-Operations-CallBarring-Blocking-Dashboard`` and ``MVS-MSDialPlan-Dashboard``

Administrators can then:

* List all blocked and exempt number patterns added to the tenant list,
  including Name, Description, Enabled (True/False), and Pattern.
* Add a blocked or exempt number pattern to the tenant list.
* Remove (exempt) a blocked number pattern from the tenant list.
* Modify one or more parameters of a blocked or exempt number pattern in the tenant list.
* Test whether calls from a given phone number will be blocked (:ref:`ms-test-ibn-pattern`).

.. note::

   If the same number pattern is present in both the blocked
   and exempt pattern lists, numbers matching these patterns
   will be considered to have been unset, i.e. neither blocked nor exempt.


.. _ms-tenant-blocked-calling:

Tenant Blocked Calling
......................

This list view shows the inbound block number patterns and the inbound exempt number patterns parameters
by **Enabled** status of the **Global** blocked number list setting at a particular hierarchy, as shown
in the **Located At** column of the list.

.. _ms-inbound-blocked-number-patterns:
  
Inbound Blocked Number Patterns
................................

The list view of all blocked number patterns according to hierarchy, showing whether the
filter is enabled as well as its pattern and any details added.

* **Identity** is a unique identifier to specify the blocked number pattern to be created.
* **Description** is a friendly description for the blocked number pattern.
* **Enabled** is a parameter set to True or False, indicating if numbers matching the pattern will be blocked.
* **Pattern**: A regular expression to match the calling number, for example the pattern ``^\+11234567890`` blocks numbers
  starting with a ``+`` followed by the specified digits. It is best practice to start a regular expression with
  the caret (``^``) character and end it with the dollar (``$``) character to indicate the start and end of the pattern.

Entries can be added and modified from this list.  

.. _ms-inbound-exempt-number-patterns:

Inbound Exempt Number Patterns
................................

The list view of all exempt numbers patterns according to hierarchy, showing whether the
filter is enabled as well as its pattern and any details added.

* **Identity** is a unique identifier to specify the exempt number pattern to be created.
* **Description** is a friendly description for the exempt number pattern.
* **Enabled** is a parameter set to True or False, indicating if numbers matching the pattern will be exempt.
* **Pattern**: A regular expression to match the calling number, for example the pattern ``^\+?1312555888[2|3]$``
  exempts numbers optionally starting with a ``+`` followed by the specified digits and ending with either ``2`` or ``3``.

Entries can be added and modified from this list.  

.. _ms-test-ibn-pattern:

Test IBN Pattern
................

Enter a number to test if it will be blocked or exempt for inbound calls by currently enabled patterns.