[Index]

Model: data/InternalNumberInventory

Internal Number Inventory

Functionality is available to add, delete or modify a single directory number (DN) or range of DNs for your site. The directory numbers can be selected when adding new lines.

The Lines concept maps to device/cucm/Line and the Lines menu item under Subscriber Management. A sync of device/cucm/Line from the Unified CM will result in various line types being brought in - including lines assigned to devices, CTI devices, etc. - essentially anything that would be seen under Directory Numbers in Unified CM.

The number inventory can exist at a different level to the lines for users and devices that consume the numbers. For example, Lines (device/cucm/Line) are typically at the site level with the user, service or device they are on. However, the inventory can exist at the customer level.

If the Internal Number Inventory (INI) feature has been enabled by an administrator, lines are no longer added in the conventional sense of the word. They are instead selected from an existing drop-down list of available numbers - from the INI.

The Internal Number Inventory is used to manage ranges of internal numbers that are available for use at a hierarchy level. Additional fields are available to provide further information on a range when listing the numbers. Administrators are responsible for manually updating these fields.

It is recommended to run an Overbuild before adding numbers and ranges, so that numbers in Unified CM are imported and marked as used.

Ranges

Ranges can be created from a Start Number to an End Number and can be set to be available or in use. When a range is created, the list of numbers is shown on the list view. Individual numbers can also be set to be Used or Available.

When a range is added that includes existing numbers, these will not be modified. The new unused numbers would be added only to complete the range. In other words, the range will show up as complete, with unused numbers in between numbers imported from Unified CM.

Number ranges can also be deleted. Numbers in the range that are in use or are unavailable will be ignored and will not be deleted. If these are modified to be available and not in use, they can also be deleted. The Used and Available status of directory numbers can also be modified manually once they are added.

Add and Delete

When a line is added and selected from the drop-down list of available numbers, it is marked as Used. If the line is used by a device or service that does not allow a shared line (for example, a Hunt Pilot), then it is marked as not Available.

Deleted numbers, e.g. as a result of a subscriber or phone delete are automatically placed into a cooling period for a predetermined amount of time as specified in the Global Settings. During this period the number is unavailable and cannot be used, i.e. assigned to a subscriber, phone, device, etc.

Cooling

The Cooling End Date (yyyy-mm-dd) displays the date on which the cooling period elapses, at which time the number becomes available in the list of available numbers.

Numbers in the cooling period can also be manually removed from the cooling period, and reintroduced into the list of available numbers. See also Number Inventory Cooling.

Notes

Add, Delete and Modify Internal Number Inventory Range

  1. Navigate to a required site hierarchy node, or select it from the Hierarchy drop-down popup screen when choosing Internal Number Inventory Management > Maintain Internal Number Inventory Range
  2. From the Operation drop-down, choose if an existing range will be deleted, modified or if a new range will be added. When adding, the range is Available by default. When modifiying, the Used and Available settings will be applied to the selected range. When deleting, lines cannot be marked as Used or Available, because these check boxes are hidden. A range can also be marked as Used when adding it.
  3. Enter the first number for the Directory Number (DN) range in the Start Number field.
  4. Enter the last number for the DN range in the End Number field. The maximum allowed range is 1000 for a single action. The start number should always be smaller than the end number. If you are adding or deleting a single DN, the ending number is the same as the starting number. If existing, used numbers are in the range, these will not be affected - only non-existing numbers will be added.
  5. When adding or modifying the Internal Number Inventory, use the following fields to input additional information for the range: Description, E164Number, Extra1 to Extra3. With the exception of the E164Number, these fields allow free text.
  6. Click Save to save the single DN or DN range you added, modified or deleted. If a number in a deleted range was set as Used, it will not be deleted.

The status of a Number Inventory for a site can be inspected by choosing Internal Number Inventory Management > Internal Number Inventory and inspecting the internal numbers for the site hierarchy.

Internal numbers are available when using Subscriber Management > Subscribers, Quick Add Subscriber or Smart Subscriber.

The DataModel that V4UC uses to manage INI items.

Model Details

Title Description Details
Base Group Assigned by FDP
  • Field Name: Base
  • Type: Object
Internal Number *
  • Field Name: Base.internal_number
  • Type: String
Status *
  • Field Name: Base.status
  • Type: String
  • Choices: ["Available", "Used", "Used-Utility", "Reserved", "Cooling"]
Usage
  • Field Name: Base.usage
  • Type: String
Reservation notes
  • Field Name: Base.reservation_notes
  • Type: String
Release Date A value indicates that the number is in temporary 'cooldown' isolation (and therefore also temporarily unavailable until the cooling duration expires, refer to global settings).
  • Field Name: Base.release_date
  • Type: String
Tag
  • Field Name: Base.tag
  • Type: String
Description
  • Field Name: Base.description
  • Type: String
Extra1
  • Field Name: Base.extra1
  • Type: String
Extra2
  • Field Name: Base.extra2
  • Type: String
Extra3
  • Field Name: Base.extra3
  • Type: String
API reference for data/InternalNumberInventory