[Index]

Model: view/HcsDNMgmtVIEW

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

Add Directory Number Inventory

Note

You must deploy a customer and site dial plan before performing this procedure.

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

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

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

  4. From the Site drop-down menu, choose the site for which you are adding directory numbers. Leave this field empty to add customer level directory numbers.

    Note:

    Customer level directory numbers can only be created for dial plans that do not use site location codes (flat dial plans). Attempting to create customer level directory numbers for site location code-based dial plans result in an error instructing you to specify a site when adding new DN inventory.

  5. Using the Extension Length, Site Location Code, and ISP read-only fields as a guide for the site, enter the first number for the DN range in the Starting Extension field.

    Note:

    For a Type 4 dial plan (no SLCs), the Starting and Ending Extension fields must contain no more than 16 digits each, including the + sign before the DN number, if used. For Types 1 to 3 dial plans, the Starting and Ending Extension fields must be less than or equal to the site Extension Length. If the Starting or Ending Extension field length is less than the site Extension Length, the DN number is padded with zeroes until its length equals that of the site Extension Length.

    For a Type 4 dial plan (no SLCs), the Starting and Ending Extension fields may contain a * prefix (asterisk) before the 15-digit directory number. The * prefix denotes 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 and cannot be associated with E.164 numbers. 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.

    Example: If the Extension Length field shows four digits for a Type 3 Dial Plan, ensure that you enter a number containing four digits or less in the Starting Extension field. For example, DN 1234. If you enter DN 123, the extension number is created as DN 0123.

  6. (Optional). Using the Extension Length, Site Location Code, and ISP read-only fields as a guide for the site, enter the last number for the DN range in the Ending Extension field. If you are adding a single DN, the ending number is the same as the starting number.

    Note:

    The maximum number of directory numbers you can add is 1,000 at a time. If you need more than 1,000 directory numbers, repeat this procedure as required to add ranges.

  7. Enter a Tag name for the entered range to allow for tag filtering of the inventory list available from Dial Plan management > Number Management > Directory Number Inventory.

  8. Use the following fields to input additional information (free text) for: Description, Extra1 to Extra3.

    The E164Number field is disabled for manual input (but can be bulk loaded). It is automatically populated when E164 numbers are associated with Directory Numbers from Dial Plan Management > Number Management > E164 Associations (N to N DN) or Dial Plan Management > Number Management > E164 Associations (N to 1 DN).

    The E164Number 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):

  9. Click Save to save the single DN or DN range.

Note

You can verify that the directory number or numbers were added correctly by navigating to Dial Plan Management > Number Management > Directory Number Inventory.

Columns for the Tag, E164Number and other additional information fields are also shown.

Model Details

Title Description Details
Site Please choose Site to Provision DNs. If site not specified, inventory will be added to the current hierarhcy node if allowed.
  • Field Name: site_hn
  • Type: String
  • Choices: [" "]
Starting Extension * Starting Number for the DN Mgmt Range
  • Field Name: startNum
  • Type: String
  • Pattern: ^(\*|\+)?[0-9]*$
Ending Extension Ending Number for the DN Mgmt Range
  • Field Name: endNum
  • Type: String
  • Pattern: ^(\*|\+)?[0-9]*$
Extension Length Extension Length for the Site
  • Field Name: extLen
  • Type: String
Site Location Code Site Location Code for the Site
  • Field Name: slc
  • Type: String
ISP ISP for the Customer
  • Field Name: isp
  • Type: String
Site-Location Code (SLC) based Site Location Code Based true or false Default: {{ data.DpCustomer.slcBased }}
  • Field Name: slcBased
  • Type: Boolean
  • Default: {{ data.DpCustomer.slcBased }}
Tag Tag used for filtering INI numbers. This can be any free text to identify or comment a range of internal numbers.
  • Field Name: tag
  • Type: String
Description Description field
  • Field Name: description
  • Type: String
E164Number Number in E164 format
  • Field Name: e164number
  • Type: String
  • Pattern: ^\+?[1-9]\d{1,14}$
Extra 1 Extra Field 1
  • Field Name: extra1
  • Type: String
Extra 2 Extra field 2
  • Field Name: extra2
  • Type: String
Extra 3 Extra field 3
  • Field Name: extra3
  • Type: String
Extra 4 Extra field 4
  • Field Name: extra4
  • Type: String
Extra 5 Extra field 5
  • Field Name: extra5
  • Type: String
Extra 6 Extra field 6
  • Field Name: extra6
  • Type: String
Extra 7 Extra field 7
  • Field Name: extra7
  • Type: String
Extra 8 Extra field 8
  • Field Name: extra8
  • Type: String
Extra 9 Extra field 9
  • Field Name: extra9
  • Type: String
API reference for view/HcsDNMgmtVIEW