[Index]

Model: data/DpSite

Contains site specific information for dial plan.

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
Customer Specify the customer that owns this site Default: {{ macro.HcsDpCustomerName }}
  • Field Name: custName
  • Type: String
  • Target: data/BaseCustomerDAT
  • Target attr: CustomerName
  • Default: {{ macro.HcsDpCustomerName }}
  • MaxLength: 1024
  • Format: uri
External breakout number The external breakout number for the country associated with this site.
  • Field Name: ext
  • Type: String
  • MaxLength: 1
  • Pattern: ^$|^[0-9]*$
Site location code Site location code can have a maximum of 8 digits.
  • Field Name: slc
  • Type: String
  • MaxLength: 8
  • Pattern: ^$|^[0-9]+$
Extension length * Extensions can be from 1 to 30 digits in length. Default: 4
  • Field Name: extLen
  • Type: String
  • Default: 4
  • MaxLength: 2
  • Pattern: ^([1-9]|[12][0-9]|[3][0])$
Extension prefix required? Indicates that this site will use the extension prefix as specified in the customer dial plan. If the extension prefix is not specified in the customer dial plan, this setting has no effect. Default: false
  • Field Name: extPrefixReq
  • Type: Boolean
  • Default: false
Area Codes Specify one or more area codes for this site.
  • Field Name: areaCodeArray.[n]
  • Type: Array
Area Code * An area code associated with this site.
  • Field Name: areaCodeArray.[n].areaCode
  • Type: String
  • MaxLength: 8
  • Pattern: ^[0-9#*]+$
Local Number Length * Length of the local numbers associated with this area code.
  • Field Name: areaCodeArray.[n].locNumLen
  • Type: String
  • MaxLength: 2
Area Code Used for Local Dialing Indicates whether area code is needed for local dialing.
  • Field Name: areaCodeInLocalDialing
  • Type: Boolean
Published number The site published number is the default E164 mask when a line is associated to a phone, device profile, or remote destination profile at a particular site. The default CUCM phone line E164 mask, default CUCM device profile line E164 mask, and the default CUCM remote destination profile line E164 mask in the site default doc are updated with this number, unless those default values in the site defaults doc have been manually updated to some other number. Furthermore, if any existing subscribers are using the site published number in their phone line E164 mask, device profile line E164 mask, or remote destination profile line E164 mask, that value is updated as well.
  • Field Name: pubNumber
  • Type: String
  • MaxLength: 1024
  • Pattern: ^$|^(\\\+)?[0-9]+$|^\+?[0-9]+$
Emergency number The site emergency callback number is the calling number when initiating an outgoing emergency call. If you change the emergency callback number, the following calling party transformation patterns are updated to use the new value: *{{ macro.HcsDpSiteId}}*! and *{{ macro.HcsDpSiteId}}*\+!
  • Field Name: emerNumber
  • Type: String
  • MaxLength: 1024
  • Pattern: ^$|^(\\\+)?[0-9]+$|^\+?[0-9]+$
Site ID * Unique ID for this site Default: {{ macro.HcsDpSiteId }}
  • Field Name: siteId
  • Type: String
  • Default: {{ macro.HcsDpSiteId }}
  • MaxLength: 1024
Site Active Enable to activate the site. Default: false
  • Field Name: active
  • Type: Boolean
  • Default: false
Site-Location Code (SLC) Based Dial Plan * Indicates whether or not Site Location Code is required for this customer. This value for this field taken from Customer Dial Plan model. Default: {{ data.DpCustomer.slcBased }}
  • Field Name: slcBased
  • Type: Boolean
  • Default: {{ data.DpCustomer.slcBased }}
Debug Info Used to store store debug info and on-screen help information. Default: Default debug info
  • Field Name: debug
  • Type: String
  • Default: Default debug info
  • MaxLength: 1024
Use DDI for emergency calls Use DDI for emergency calls when user is at home location
  • Field Name: createEmerPattern
  • Type: Boolean
API reference for data/DpSite