[Index]

Model: data/InternalNumberInventory

Directory Number Inventory

The number inventory can exist at a different level to the lines for users and devices that consume (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.

Use this procedure to add a single directory number (DN) or range of DNs for your customer. The DNs (extensions) you specify are validated against the Dial Plan type (Type 1 to 4). The extension length assigned to the site is enforced for site location code (SLC)-based dial plans. The maximum number of directory numbers you can add at a time is 1,000. For more information on Type 1 to Type 4 dial plans, see Directory Numbers Classification.

If the allocation and availability of numbers is not site specific, for example E164 dial plan/Type 4 flat dial plan, then generally it is easier to have the inventory at the customer level. This saves moving numbers around sites to increase availability and keeps a more central inventory of available numbers. It is also key if numbers are going to be shared across sites.

If the number allocation is site specific, for example site code+ext dial plan, local breakout if E164 dial plan, then these numbers can be added or assigned to a site level.

Number inventory cannot exist at a intermediate node - only provider, customer, or site.

Number inventory is not partition or cluster aware. If the same numbers are used multiple times but in different partitions, then these all map to the same inventory number. This should be taken into account when thinking about the hierarchy level that the number inventory exists.

Also, not being cluster aware, if the same number exists on different clusters, this again will map back to the same inventory value unless numbers are assigned to the site level.

Since the inventory is not partition aware, if the same directory number is used on a cluster but in different partitions, then VOSS-4-UC workflows will update the inventory when any of those instances are changed - for instance, if there is a directory number 1111 in Cluster X partition and a directory number 1111 in Cluster Y partition, and the inventory entry is marked used.

If one of those instances are deleted, we check to see if there are other instances of that line based on the number only (not partition), before clearing the "used" flag. In this case, the other instance will be found and the inventory will stay marked as "used".

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. allocated to a subscriber, phone, device, etc.

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

Note

View Directory Number Inventory

Use this procedure to view the range of directory numbers that have been defined for a site.

Note

In VOSS-4-UC, an * can appear before a directory number in a Type 4 dial plan.

Procedure

  1. Log in as provider, reseller, or customer administrator.

  2. Choose an available site from the hierarchy node breadcrumb at the top of the interface.

  3. Choose Dial Plan Management > Number Management > Directory Number Inventory.

    The list of all directory numbers (DNs) configured for the site appears. You can view the list of DN numbers or delete a DN number from this page. To filter the list of directory numbers, click the up arrow beside the title of the Internal Number column. Enter the Search String you want to locate, and all directory numbers that match the search string appear.

    When a DN is first added to the inventory, the Used column is blank, and the Available column shows 'true.' The Used column changes to 'true' when the DN is put into use when a line is created and associated to a phone or subscriber. The Available column indicates that the DN is used by a device or service that does not allow a shared line (for example, a Hunt Pilot).

    The E164Number column and value on an instance form displays as in the examples below for E164 Associations (N to 1 DN), depending on the number of E164's being associated and whether a primary E164 is set or not.

    Note that the first example display is also the display for E164 Associations (N to N DN):

    Directory numbers that begin with a * (asterisk), denote DNs that are used with hunt groups, assistant lines, Contact Center lines, and so on. This type of directory number cannot be reached from an outside line. Typically, a DN with the * prefix is not called from another line (user), but is tied to a service feature such as call pickup, hunt groups, or contact center.

    Note

    Adding a new DN to inventory on VOSS-4-UC does not add a directory number on Cisco Unified Communications Manager until it is associated to a line on VOSS-4-UC.

    The Directory Number Inventory entries appear in other end-user provisioning tasks in VOSS-4-UC as described in the table that follows. For more information on provisioning each of these tasks, refer to the VOSS-4-UC Core Feature Guide.

    Task VOSS-4-UC + Location Notes
    Lines Subscriber Management > Lines

    When lines are added through phones and subscriber, line details can be modified.

    The DN for the line cannot be modified; if you attempt to change the DN assigned to the line, the operation fails.

    Phones Subscriber Management > Phones > Lines tab > Dirn > Pattern

    The Dirn > Pattern contains a list of available directory numbers.

    DNs that are used are marked as "true" in the Directory Number Inventory.

    Only available DNs are listed.

    Subscribers Subscriber Management > Subscribers > Phones > Lines > Dirn

    The Dirn > Pattern contains a list of available directory numbers.

    DNs that are used are marked as "true" in the Directory Number Inventory.

    Only available DNs are listed.

      Subscriber Management > Subscribers > Voicemail The "Voicemail Line" list contains DNs provisioned to lines.
    Quick Add Subscribers Subscriber Management > Quick Add Subscriber > Lines > Directory Number

    The Directory Number list contains available directory numbers.

    DNs that are used are marked as "true" in the Directory Number Inventory.

    Only available DNs are listed.

    PLAR (Hotdial) Subscriber Management > PLAR (Hotdial) DNs provisioned to lines are displayed in the Hotdial Destination Pattern list
    Hunt Groups Subscriber Management > Hunt Groups > Members> Directory Number DNs provisioned to lines are displayed in the Pattern list
    Call Pickup Groups Subscriber Management > Call Pickup Groups > Call Pickup Group > Line DNs provisioned to member lines are displayed in the Pattern list

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
Available * Default: true
  • Field Name: Base.available
  • Type: Boolean
  • Default: true
Used * Default: false
  • Field Name: Base.used
  • Type: Boolean
  • Default: false
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