.. _concepts-number-status-usage:

Number status and usage
-----------------------

.. _20.1.1|VOSS-651:
.. _20.1.1|EKB-6817:
.. _21.3|VOSS-950:
.. _21.3-PB1|VOSS-1072|EKB-12743:
.. _21.4-PB2|VOSS-1234:
.. _21.4-PB2|VOSS-1150:
.. _21.4-PB2|VOSS-1138:
.. _21.4-PB5|EKB-17836:
.. _25.2|EKB-23112:


Overview 
..........

Values in the **Status** and **Usage** columns in the number inventory allow administrators to understand how numbers are used at a
specific hierarchy level.

.. tip:: 

   :ref:`use-action-search-to-navigate-automate`

Status and Usage columns in the number inventory
.....................................................

The table describes values in the **Status** and **Usage** columns in the Number Inventory: 

.. tabularcolumns:: |p{3cm}|p{5cm}|p{2cm}|p{3cm}|p{2cm}|

+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| **Number Use**                    | **Device**                           | **Status**    | **Usage**              | **Vendor** [1]_                 |
+===================================+======================================+===============+========================+=================================+
| Not used by anything              | \-                                   | Available     | blank                  | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Phone Line [2]_                   | device/cucm/Phone                    | Used          | Device                 | blank                           |
|                                   | (line instance)                      |               |                        |                                 |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Device Profile Line               | device/cucm/DeviceProfile            | Used          | Device                 | blank                           |
|                                   | (line instance)                      |               |                        |                                 |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Remote Destination                | device/cucm/RemoteDestinationProfile | Used          | Device                 | blank                           |
| Profile Line                      | (line instance)                      |               |                        |                                 |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Hunt Pilot [2]_                   | device/cucm/HuntPilot                | Used-Utility  | Hunt_Pilot             | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Pickup Group Pilot                | device/cucm/CallPickupGroup          | Used-Utility  | Pickup_Group_Pilot     | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| System Call Handler               | device/cuc/Callhandler (System only) | Used-Utility  | Call_Handler_Pilot     | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Voicemail Pilot                   | device/cucm/VoicemailPilot           | Used-Utility  | Voicemail_Pilot        | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Meet Me                           | device/cucm/MeetMe                   | Used-Utility  | Meet_Me                | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| CTI Route Point                   | device/cucm/CtiRoutePoint            | Used-Utility  | CTI_RoutePoint         | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Call Park                         | device/cucm/CallPark                 | Used-Utility  | Call_Park              | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Directed Call Park                | device/cucm/DirectedCallPark         | Used-Utility  | Directed_Call_Park     | blank                           |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| VOSS Phone                        | data/PRS_MultiVendorPhone_DAT        | Used-Utility  | VOSS_Phone             | phoneVendor                     |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| MS Teams Line URI                 | device/msteamsonline/CsOnlineUser    | Used          | User                   | Microsoft                       |
|                                   | (LineURI)                            |               |                        |                                 |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Webex User                        | device/spark/Number                  | Used          | User                   | Webex Calling                   |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Number inactive                   |                                      | Inactive [3]_ | blank                  | Webex Calling                   |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| AudioCodes devices                | device/audiocodes                    | Used          | Device                 | AudioCodes [4]_                 |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Not used by anything              |                                      | Available     | blank                  | blank, Microsoft, Webex Calling |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+


.. tabularcolumns:: |p{3cm}|p{5cm}|p{2cm}|p{3cm}|p{2cm}|

+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| **Number Use**                    | **Device**                           | **Status**    | **Usage**              | **Vendor** [1]_                 |
+===================================+======================================+===============+========================+=================================+
| Number in cooling [5]_            |                                      | Cooling       | \-                     | blank, Microsoft, Webex Calling |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Number reserved [6]_              |                                      | Reserved      | \-                     | blank, Microsoft, Webex Calling |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Webex Calling ownerType is unset  | device/spark/Number                  | Available     | \-                     | Webex Calling                   |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Webex Calling ownerType is PEOPLE | device/spark/Number                  | Used          | User                   | Webex Calling                   |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+
| Webex Calling ownerType is *not*  | device/spark/Number                  | Used-Utility  | Matches the ownerType: | Webex Calling                   |
| unset or PEOPLE                   |                                      |               |                        |                                 |
|                                   |                                      |               | Usage: Matches the     |                                 |
|                                   |                                      |               | Webex ownerType (for   |                                 |
|                                   |                                      |               | example: Hunt_Group,   |                                 |
|                                   |                                      |               | Auto_Attendant,        |                                 |
|                                   |                                      |               | Call_Queue,            |                                 |
|                                   |                                      |               | Paging_Group,          |                                 |
|                                   |                                      |               | Voice_Messaging,       |                                 |
|                                   |                                      |               | Voicemail_Group)       |                                 |
+-----------------------------------+--------------------------------------+---------------+------------------------+---------------------------------+


For further details on Vendor and Internal Number Type fields – see :ref:`number-inventory-vendor-specific-guidance`.

.. rubric:: Footnotes

.. [1] Default vendor value is blank (for Cisco).

.. [2] If a number is used by both a Phone and Hunt Pilot then the **Usage** column
       will display both usage values, i.e. ``Device,Hunt_Pilot``. This could be the case if
       you change the Partition and enter the DN manually so that they share the same DN.
       
       However, the **Status** column will display only *one* status: the status triggered
       by the most recent transaction.  The Status would change from Used to Used-Utility if you
       added the Hunt Pilot last. If it was already a Hunt Pilot and then you added it to a Phone,
       then Status would change from Used-Utility to Used.

       Numbers can also be shared between Call Handlers and one or more device types. Status 
       depends on whether Call Handler or devices were added first to the number. Usage 
       will typically be ``Call_Handler_Pilot,Device``. 
.. [3] Status is Inactive by adding a number in Number Range Management, where **Vendor** is Webex Calling and
       **Push as Active** is *unchecked* on the **Webex Control Hub** frame on the input form.
       
       Modifying the number in a range by setting the status as Available will activate
       it in the Webex Control Hub and update its status.
.. [4] For AudioCodes, see the AudioCodes topic in the Core Feature Guide.
.. [5] If a number is currently in **Cooling**, the release date indicates when
       the number will come out of cooling.
.. [6] If a number is currently **Reserved**, you can enter an optional **Tag**
       to identify the user for which the number is reserved. An optional **Reservation
       notes** field is also available to allow you to enter additional information
       regarding the reserved number.



.. rubric:: Related Topics 

.. raw:: latex

   For details on call handlers and shared numbers, see Auto-Attendant Call Handler in the Core Feature Guide.

.. raw:: html
 
   For details on call handlers and shared numbers, see <a href="concepts-aa-call-handler.html">Auto-Attendant Call Handler</a>.




Webex Calling owner type mapping behavior
..........................................

For Webex Calling numbers (``device/spark/Number``), VOSS determines the
Status and Usage values based on the Webex number ``ownerType``.

This evaluation occurs:

* When numbers are first discovered during sync
* When an existing number changes ownership in the Webex Control Hub

.. rubric:: Related topics

* For details on how these values are populated during synchronization, see *Add VOSS over an existing Webex organization*


Owner type mappings
''''''''''''''''''''''''

* PEOPLE
  
  * Status: Used
  * Usage: User

* PLACE
  
  * Status: Used
  * Usage: Device

* VIRTUAL_LINE
  
  * Status: Used
  * Usage: User

* HUNT_GROUP
  
  * Status: Used-Utility
  * Usage: Hunt_Group

* AUTO_ATTENDANT
  
  * Status: Used-Utility
  * Usage: Auto_Attendant

* CALL_QUEUE
  
  * Status: Used-Utility
  * Usage: Call_Queue

* PAGING_GROUP
  
  * Status: Used-Utility
  * Usage: Paging_Group

* OFFICE_ANYWHERE
  
  * Status: Used-Utility
  * Usage: Office_Anywhere

* VOICE_MESSAGING
  
  * Status: Used-Utility
  * Usage: Voice_Messaging

* VOICEMAIL_GROUP
  
  * Status: Used-Utility
  * Usage: Voicemail_Group


Update behavior during synchronization
''''''''''''''''''''''''''''''''''''''''

If the owner type of a Webex Calling number changes (for example, a number is reassigned from a 
user to a Hunt Group), VOSS recalculates the **Status** and **Usage** values during the next 
Webex synchronization.

This ensures the Internal Number Inventory always reflects the current functional role of the number.
