[Index]

Model: relation/HcsDpSiteShortCodeREL

Short Code

Site short codes work the same for deployments that use shared lines across sites as they do for "real site" deployments. That is, short codes can be added to a site to allow shorter, convenient numbers to be dialed that are transformed into longer directory numbers. Normally, short codes are added to real sites that contain devices in order to allow users of those devices to dial shorter numbers to reach exiting directory numbers.

Because the inventory site doesn't contain devices, but only line inventory, site codes don't need to be added to the inventory site. Short code translation patterns are created on a site's Allow Internal (AInt) route partition.

Configure Short Code

Before You Begin

You must add a Site Dial Plan before configuring Short Code. Refer to Create a Site Dial Plan.

Use this procedure to configure Short Codes. Short codes are used for abbreviated dialing to other extensions and services.

Procedure

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

    Warning:

    When adding a Short Code, ensure that you select a valid site under your customer in the hierarchy node breadcrumb at the top of the view. If you attempt to add a Short Code at any other node in the hierarchy, you will receive an error indicating that you must be at a site.

  2. Choose Dial Plan Management > Site > Short Code.

  3. Click Add to add a Short Code.

  4. Enter a Short Code in the Short Code field using up to 16 characters with the following format:

    Example:

    *2.XXX

  5. From the Short Code Type drop-down, choose one of:

    Option Description
    Called Mask The called mask maps to the Short Code. Valid entries include the digits 0 through 9; the international escape character + and the wildcard character X. For example, a called mask of 567XXX using Short Code *2.123 converts to 567123.
    Directory Number The directory number maps to the Short Code. Valid entries are digits 0 through 9.
    Pre-dot with Called Prefix The called prefix maps to the Short Code.
  6. Enter the value for the Short Code Type in the Value field.

  7. Select the Use Originator's Calling Search Space check box to indicate that the Short Code will use the originator's calling search space for routing a call rather than an explicit customer CSS.

    If the originating device is a phone, the originator's calling search space is a combination of the device calling search space configured on their phone and line calling search space configured on the originating line.

  8. Click Save to add the Short Code that you defined. The new Short Code appears in the table of Short Codes and it can be edited or deleted as required.

Model Details

Title Description Details
Site Name * Default: {{ macro.HcsDpSiteName }}
  • Field Name: siteName
  • Type: String
  • Target: data/BaseSiteDAT
  • Target attr: SiteName
  • Default: {{ macro.HcsDpSiteName }}
  • MaxLength: 1024
  • Format: uri
Short Code * Short code number. Enter the abbreviated number to be supported by the site. This number can include wildcards (do not use spaces). Valid characters include 0 through 9, *, #, uppercase A, B, C, and D and \+, which represents the international escape character +.
  • Field Name: shortCode
  • Type: String
  • MaxLength: 48
  • Pattern: ^(\\\+)?[\[\]!\?\-\^0-9A-D\*#X]*\.?[\[\]!\?\-\^0-9A-D\*#X]*$
Short Code Type * The type of short code. Default: calledMask
  • Field Name: type
  • Type: String
  • Default: calledMask
  • MaxLength: 1024
  • Choices: ["Directory Number", "Called Mask", "Pre-dot with Called Prefix"]
Value * If Short Code Type is Directory Number, the directory number to which this short code maps. If Short Code Type is Called Mask, the called mask to which this short code maps. If Short Code Type is Pre-Dot with Called Prefix, the called prefix to which this short code maps.
  • Field Name: value
  • Type: String
  • MaxLength: 16
  • Pattern: ^\+?[0-9X*#]+$
Use Originator's Calling Search Space If enabled, this short code will use the originator's calling search space to route the short code rather than an explicit CSS.
  • Field Name: useOrigCss
  • Type: Boolean
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024
API reference for relation/HcsDpSiteShortCodeREL