[Index]

Model: relation/HcsCucmCcTagREL

Agent Lines

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Prerequisites:

In order to have an application user available, add a Contact Center server and service:

  1. Under Services > Contact Center > Servers (default): add a server.

    Two SIP Trunks are needed, a CVP and CUBEE on the server.

  2. Under Services > Contact Center > Service (default): add a service using the above server. This step will create the application users needed when adding an Agent Line.

Perform these steps:

  1. From the Agent Lines form (default menu Subscriber Management > Agent Lines).

  2. Click Add to add a new agent line.

  3. Complete the mandatory fields, consider the following:

  4. Click Save to add the agent line.

Tag CTI Port as Contact Center Agent Line

Perform these steps:

  1. Choose Subscriber Management > Agent Lines.
  2. Choose Hierarchy Provider > Reseller > Customer > Site.
  3. Click Add to create a new CTI port.
  4. From the Device Type drop-down, choose Phone.
  5. From the Device Name drop-down, choose a port from the list of device names.
  6. From the Line drop-down, choose the Line.
  7. From the Application User drop-down, choose pguser.
  8. Click Save.
  9. Repeat the steps for both LCP and RCP ports.

Model Details: relation/HcsCucmCcTagREL

Title Description Details
Device Type * The type of device to be tagged for a Contact Center agent line
  • Field Name: tagType
  • Type: String
  • MaxLength: 15
  • Choices: ["Phone", "Device Profile"]
Device The name of the Phone or Device Profile
  • Field Name: deviceName
  • Type: String
  • MaxLength: 1024
Device Name The name of the Phone
  • Field Name: phoneName
  • Type: String
  • Target: device/cucm/Phone
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Profile User The ID of the end user
  • Field Name: endUser
  • Type: String
  • Target: device/cucm/User
  • Target attr: userid
  • MaxLength: 1024
  • Format: uri
EM Profile Name The name of the Device Profile
  • Field Name: emProfileName
  • Type: String
  • Target: device/cucm/DeviceProfile
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Line * The number of the phone line
  • Field Name: phoneLine
  • Type: String
  • Target: device/cucm/Line
  • Target attr: pattern
  • MaxLength: 1024
  • Format: uri
Application User * The JTAPI user associated with this device
  • Field Name: jtapiUser
  • Type: String
  • Target: device/cucm/AppUser
  • Target attr: userid
  • MaxLength: 1024
  • Format: uri
Agent Line Prefix * The line description prefix to indicate the line is an agent line Default: CC_Line
  • Field Name: lineTagPrefix
  • Type: String
  • Default: CC_Line
  • MaxLength: 1024
Hcs Cucm Cc Tag Phone
  • Field Name: hcsCucmCcTagPhone
  • Type: Object
Directory Enter the server from which the phone obtains directory information. Leave this field blank to accept the default setting. Note    If you set a Secured Directory URL enterprise parameter in the Enterprise Parameters Configuration window, that value overwrites the value of this field.
  • Field Name: hcsCucmCcTagPhone.directoryUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Device Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: hcsCucmCcTagPhone.protocol
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["SCCP", "Digital Access PRI", "H.225", "Analog Access", "Digital Access T1", "Route Point", "Unicast Bridge", "Multicast Point", "Inter-Cluster Trunk", "RAS", "Digital Access BRI", "SIP", "MGCP", "Static SIP Mobile Subscriber", "SIP Connector", "Remote Destination", "Mobile Smart Client", "Digital Access E1 R2", "CTI Remote Device", "Protocol Not Specified"]
Secure Information URL Enter the secure URL for the server location where the Cisco Unified IP Phone can find help text information. This information displays when the user presses the information (i) button or the question mark (?) button. Note    If you do not provide a Secure Information URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: hcsCucmCcTagPhone.secureInformationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Authentication Mode This field allows you to choose the authentication method that the phone uses during the CAPF certificate operation. From the drop-down list box, choose one of the following options: By Authentication String—Installs/upgrades, deletes, or troubleshoots a locally significant certificate only when the user enters the CAPF authentication string on the phone. By Null String— Installs/upgrades, deletes, or troubleshoots a locally significant certificate without user intervention. This option provides no security; Cisco strongly recommends that you choose this option only for closed, secure environments. By Existing Certificate (Precedence to LSC)—Installs/upgrades, deletes, or troubleshoots a locally significant certificate if a manufacture-installed certificate (MIC) or locally significant certificate (LSC) exists in the phone. If a LSC exists in the phone, authentication occurs via the LSC, regardless whether a MIC exists in the phone. If a MIC and LSC exist in the phone, authentication occurs via the LSC. If a LSC does not exist in the phone, but a MIC does exist, authentication occurs via the MIC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. At any time, the phone uses only one certificate to authenticate to CAPF even though a MIC and LSC can exist in the phone at the same time. If the primary certificate, which takes precedence, becomes compromised for any reason, or, if you want to authenticate via the other certificate, you must update the authentication mode. By Existing Certificate (Precedence to MIC)—Installs, upgrades, deletes, or troubleshoots a locally significant certificate if a LSC or MIC exists in the phone. If a MIC exists in the phone, authentication occurs via the MIC, regardless whether a LSC exists in the phone. If a LSC exists in the phone, but a MIC does not exist, authentication occurs via the LSC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. Note    The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. Default: By Null String
  • Field Name: hcsCucmCcTagPhone.authenticationMode
  • Type: String
  • Cardinality: [0..1]
  • Default: By Null String
  • Choices: ["By Authentication String", "By Null String", "By Existing Certificate (precedence to LSC)", "By Existing Certificate (precedence to MIC)"]
Require DTMF Reception For phones that are running SIP and SCCP, check this check box to require DTMF reception for this phone. Note    In configuring Cisco Unified Mobility features, when using intercluster DNs as remote destinations for an IP phone via SIP trunk (either intercluster trunk [ICT] or gateway), check this check box so that DTMF digits can be received out of band, which is crucial for Enterprise Feature Access midcall features.
  • Field Name: hcsCucmCcTagPhone.requireDtmfReception
  • Type: Boolean
  • Cardinality: [0..1]
Always Use Prime Line for Voice Message From the drop-down list box, choose one of the following options: On—If the phone is idle, the primary line on the phone becomes the active line for retrieving voice messages when the phone user presses the Messages button on the phone. Off—If the phone is idle, pressing the Messages button on the phone automatically dials the voice-messaging system from the line that has a voice message. Cisco Unified CM always selects the first line that has a voice message. If no line has a voice message, the primary line gets used when the phone user presses the Messages button. Default—Cisco Unified CM uses the configuration from the Always Use Prime Line for Voice Message service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: hcsCucmCcTagPhone.alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Search Space From the drop-down list box, choose the appropriate calling search space (CSS). A calling search space comprises a collection of partitions that are searched to determine how a dialed number should be routed. The calling search space for the device and the calling search space for the directory number get used together. The directory number CSS takes precedence over the device CSS. Note    When set to <none>, Unified CM uses the device mobility calling search space, which is configured on the device pool.
  • Field Name: hcsCucmCcTagPhone.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Mra Service Domain
  • Field Name: hcsCucmCcTagPhone.mraServiceDomain
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Calling Party Transformation CSS From the drop-down list box, choose the calling search space (CSS) that contains the calling party transformation pattern that you want to apply on the calling number when this phone initiates a call. Cisco Unified CM transforms the calling party using the digit transformations configured on the matching calling party transformation pattern when this phone initiates a call. This setting allows you to transform the calling party number before Cisco Unified CM routes the call. For example, a transformation pattern can change a phone extension to an E.164 number. This setting is generally configured when a user dials using a URI instead of digits. Cisco Unified CM allows calling party transformations on various patterns when dialing using digits, this setting provides similar transformation provision even when dialing using a URI.
  • Field Name: hcsCucmCcTagPhone.cgpnIngressDN
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Use Trusted Relay Point * From the drop-down list box, enable or disable whether Cisco Unified CM inserts a trusted relay point (TRP) device with this media endpoint. Choose one of the following values: Default—If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates. Off—Choose this value to disable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. On—Choose this value to enable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. A Trusted Relay Point (TRP) device designates an MTP or transcoder device that is labeled as Trusted Relay Point. Cisco Unified CM places the TRP closest to the associated endpoint device if more than one resource is needed for the endpoint (for example, a transcoder or RSVPAgent). If both TRP and MTP are required for the endpoint, TRP gets used as the required MTP. If both TRP and RSVPAgent are needed for the endpoint, Cisco Unified CM first tries to find an RSVPAgent that can also be used as a TRP. If both TRP and transcoder are needed for the endpoint, Cisco Unified CM first tries to find a transcoder that is also designated as a TRP. Default: Default
  • Field Name: hcsCucmCcTagPhone.useTrustedRelayPoint
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Network Locale From the drop-down list box, choose the locale that is associated with the phone. The network locale contains a definition of the tones and cadences that the phone in a specific geographic area uses. Cisco Unified CM makes this field available only for phone models that support localization. Note    If no network locale is specified, Cisco Unified CM uses the network locale that is associated with the device pool. If users require that country-specific tones be played (on the phone), verify that the locale is installed before configuring the network locale. See the Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: hcsCucmCcTagPhone.networkLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/Country
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["Argentina", "Australia", "Austria", "Belgium", "Brazil", "Canada", "China", "Colombia", "Cyprus", "Czech Republic", "Denmark", "Egypt", "Finland", "France", "Germany", "Ghana", "Greece", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Japan", "Jordan", "Kenya", "Korea Republic", "Lebanon", "Luxembourg", "Malaysia", "Mexico", "Nepal", "Netherlands", "New Zealand", "Nigeria", "Norway", "Pakistan", "Panama", "Peru", "Philippines", "Poland", "Portugal", "Russian Federation", "Saudi Arabia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sweden", "Switzerland", "Taiwan", "Thailand", "Turkey", "United Kingdom", "United States", "Venezuela", "Zimbabwe", "Itu", "Chile", "Bulgaria", "Croatia", "Romania", "Serbia and Montenegro", "United Arab Emirates", "Oman", "Kuwait", "Algeria", "Bahrain", "Iraq", "Mauritania", "Republic of Montenegro", "Morocco", "Qatar", "Republic of Serbia", "Sudan", "Tunisia", "Vietnam", "Yemen", "Lithuania", "Latvia", "Estonia", "Ukraine"]
BLF Audible Alert Setting (Phone Busy) This setting determines the BLF audible alert setting when at least one active call exists on the BLF DN, but no call pickup alerts exist: On—An audible alert sounds. Off—No audible alert sounds. Default—The configuration in the Service Parameters Configuration window determines the alert option. Default: Default
  • Field Name: hcsCucmCcTagPhone.ringSettingBusyBlfAudibleAlert
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Msisdn Mobile Subscriber ISDN
  • Field Name: hcsCucmCcTagPhone.msisdn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
User Locale From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information to support users, including language and font. Cisco Unified CM makes this field available only for phone models that support localization. Note    If no user locale is specified, Cisco Unified Communications Manager uses the user locale that is associated with the common device configurations. If the users require that information be displayed (on the phone) in any language other than English, verify that the locale installer is installed before configuring user locale. See the Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: hcsCucmCcTagPhone.userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Device Mobility Mode * From the drop-down list box, turn the device mobility feature on or off for this device or choose Default to use the default device mobility mode. Default setting uses the value for the Device Mobility Mode service parameter for the device. Click View Current Device Mobility Settings to display the current values of these device mobility parameters: Cisco Unified Communications Manager Group Roaming Device Pool Location Region Network Locale AAR Group AAR Calling Search Space Device Calling Search Space Media Resource Group List SRST Default: Default
  • Field Name: hcsCucmCcTagPhone.deviceMobilityMode
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Elin Group
  • Field Name: hcsCucmCcTagPhone.elinGroup
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Outbound Call Rollover Use this setting for the Cisco Unified IP Phone 7931. No Rollover—Conference and transfer will not work in this mode. If a user attempts to use either of these features, the phone status displays as "Error Pass Limit." Choose this setting only if you need to support CTI applications. Rollover Within Same DN—Conferences and call transfers complete by using the same directory number (on different lines). For example, consider a phone that has directory number 1506 that is assigned to both Line 6 and 7. The user has an active call on Line 6 and decides to transfer the call. When the user presses the Transfer button, the call on Line 6 gets placed on hold, and a new call initiates on Line 7 to complete the transfer. Rollover to any line—Conferences and call transfers complete by using a different directory number and line than the original call. For example, consider a phone that has directory number 1507 assigned to Line 8 and directory number 1508 assigned to Line 9. The user has an active call on Line 8 and decides to transfer the call. When the user presses the Transfer button, the call on Line 8 gets placed on hold, and a new call initiates on Line 9 to complete the transfer. Default: No Rollover
  • Field Name: hcsCucmCcTagPhone.outboundCallRollover
  • Type: String
  • Cardinality: [0..1]
  • Default: No Rollover
  • Choices: ["No Rollover", "Rollover Within Same DN", "Rollover to any line"]
IP Address IP address of the phone
  • Field Name: hcsCucmCcTagPhone.ip_address
  • Type: String
Primary Phone * Choose the physical phone that will be associated with the application, such as IP communicator or Cisco Unified Personal Communicator. When you choose a primary phone, the application consumes fewer device license units and is considered an "adjunct" license (to the primary phone).
  • Field Name: hcsCucmCcTagPhone.primaryPhoneName
  • Type: ["String", "Null"]
  • Target: device/cucm/Phone
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Device Name * Enter a name to identify software-based telephones, H.323 clients, and CTI ports. For device names that are not based on a MAC address, as a general rule, you can enter 1 to 15 characters comprised of alphanumeric characters (a-z, A-D, 0-9). In most cases you can use dot (.), dash (-), and underscore (_) as well. Tip    Because the rules for the device name field depend on the device type, Cisco recommends that you see the product documentation to determine which character set is valid for your device, as well as the number of characters allowed. For example, when you configure the device name for the Cisco Unified Personal Communicator, make sure that the name starts with UPC. Note    Ensure that the device name of a Cisco Unified Mobile Communicator does not exceed 15 characters. If the device name of a Cisco Unified Mobile Communicator exceeds 15 characters, migration of this device will fail upon upgrade to a different release of Cisco Unified Communications Manager. If an existing Cisco Unified Mobile Communicator device name specifies a longer name, shorten the device name to 15 or fewer characters. Cisco Unified Mobile Communicator supports dual mode phones. The preceding limit of 15 characters also applies to Cisco Unified Mobile Communicator dual mode. When the MI for a dual mode phone is longer than 15 characters, the cellular network rejects the phone registration.
  • Field Name: hcsCucmCcTagPhone.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Retry Video Call as Audio This check box applies only to video endpoints that receive a call. If this phone receives a call that does not connect as video, the call tries to connect as an audio call. By default, the system checks this check box to specify that this device should immediately retry a video call as an audio call (if it cannot connect as a video call) prior to sending the call to call control for rerouting. If you uncheck this check box, a video call that fails to connect as video does not try to establish as an audio call. The call then fails to call control, and call control routes the call via automatic alternate routing (AAR) and/or route/hunt list. Default: True
  • Field Name: hcsCucmCcTagPhone.retryVideoCallAsAudio
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Privacy For each phone that wants Privacy, choose On in the Privacy drop-down list box. Default: Default
  • Field Name: hcsCucmCcTagPhone.callInfoPrivacyStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Geo Location Filter Name
  • Field Name: hcsCucmCcTagPhone.geoLocationFilterName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocationFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Services Provisioning From the drop-down list box, choose how the phone will support the services: Internal—The phone uses the phone configuration file to support the service. Choose this option or Both for Cisco-provided default services where the Service URL has not been updated; that is, the service URL indicates Application:Cisco/<name of service>; for example, Application:Cisco/CorporateDirectory. Choose Internal or Both for Cisco-signed Java MIDlets because Cisco-signed Java MIDlets are provisioned in the configuration file. External URL—Choosing External URL indicates that the phone ignores the services in the phone configuration file and retrieves the services from a Service URL. If you configured a custom Service URL for a service, including a Cisco-provided default service, you must choose either External URL or Both; if you choose Internal in this case, the services that are associated with the custom URLs do not work on the phone. Both—Choosing Both indicates that the phone support both the services that are defined in the configuration file and external applications that are retrieved from service URLs. Default: Default
  • Field Name: hcsCucmCcTagPhone.phoneServiceDisplay
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Internal", "External URL", "Both", "Default"]
Key Order keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot. Default: RSA Only
  • Field Name: hcsCucmCcTagPhone.keyOrder
  • Type: String
  • Cardinality: [0..1]
  • Default: RSA Only
  • Choices: ["RSA Only", "EC Only", "EC Preferred, RSA Backup"]
Secure Directory URL Enter the secure URL for the server from which the phone obtains directory information. This parameter specifies the URL that secured Cisco Unified IP Phones use when you press the Directory button. Note    If you do not provide a Secure Directory URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. Leave this field blank to accept the default setting. Maximum length: 255
  • Field Name: hcsCucmCcTagPhone.secureDirectoryUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Phone Button Template * Choose the appropriate phone button template. The phone button template determines the configuration of buttons on a phone and identifies which feature (line, speed dial, and so on) is used for each button. Cisco Unified CM does not make this field available for H.323 clients or CTI ports.
  • Field Name: hcsCucmCcTagPhone.phoneTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/PhoneButtonTemplate
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mtp Required This field is applicable only to SIP phones.
  • Field Name: hcsCucmCcTagPhone.mtpRequired
  • Type: Boolean
  • Cardinality: [0..1]
Secure Messages URL Enter the secure URL for the messages server. The Cisco Unified IP Phone contacts this URL when the user presses the Messages button. Note    If you do not provide a Secure Messages URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: hcsCucmCcTagPhone.secureMessageUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Key Size (Bits) For this setting that is used for CAPF, choose the key size for the certificate from the drop-down list box. The default setting equals 1024. Other options include 512 and 2048. If you choose a higher key size than the default setting, the phones take longer to generate the entropy that is required to generate the keys. Key generation, which is set at low priority, allows the phone to function while the action occurs. Depending on the phone model, you may notice that key generation takes up to 30 or more minutes to complete. Note    The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. Default: 2048
  • Field Name: hcsCucmCcTagPhone.keySize
  • Type: String
  • Cardinality: [0..1]
  • Default: 2048
  • Choices: ["512", "1024", "2048", "3072", "4096"]
Proxy Server Enter the host and port (for example, proxy.cisco.com:80) that are used to proxy HTTP requests for access to non-local host addresses from the phone HTTP client. The rule contains two parts for when to use the proxy server parameter: The hostname contains a "." The hostname specifies an IP address in any form. If you do not configure this URL, the phone attempts to connect directly to the URL. To accept the default setting, leave this field blank.
  • Field Name: hcsCucmCcTagPhone.proxyServerUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Add On Modules Additional modules attached to the Phone.There can be 0,1, 2 or 3.
  • Field Name: addOnModules
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Add On Module
  • Field Name: addOnModule.[n]
  • Type: Array
  • Cardinality: [0..3]
Module 3 Load Name * Enter the custom software for the appropriate expansion module, if applicable. The value that you enter overrides the default value for the current model. Ensure the firmware load matches the module load.
  • Field Name: hcsCucmCcTagPhone.addOnModules.addOnModule.[n].loadInformation
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Model * Model ID string. Default: 7914 14-Button Line Expansion Module
  • Field Name: hcsCucmCcTagPhone.addOnModules.addOnModule.[n].model
  • Type: String
  • Cardinality: [1..1]
  • Default: 7914 14-Button Line Expansion Module
  • Choices: ["Cisco 30 SP+", "Cisco 12 SP+", "Cisco 12 SP", "Cisco 12 S", "Cisco 30 VIP", "Cisco 7910", "Cisco 7960", "Cisco 7940", "Cisco 7935", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco ATA 186", "EMCC Base Phone", "SCCP Phone", "Analog Access", "Digital Access", "Digital Access+", "Digital Access WS-X6608", "Analog Access WS-X6624", "VGC Gateway", "Conference Bridge", "Conference Bridge WS-X6608", "Cisco IOS Conference Bridge (HDV2)", "Cisco Conference Bridge (WS-SVC-CMM)", "H.323 Phone", "H.323 Gateway", "Music On Hold", "Device Pilot", "CTI Port", "CTI Route Point", "Voice Mail Port", "Cisco IOS Software Media Termination Point (HDV2)", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Video Conference Bridge (IPVC-35xx)", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Route List", "Load Simulator", "Media Termination Point", "Media Termination Point Hardware", "Cisco IOS Media Termination Point (HDV2)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco 7941", "Cisco 7971", "MGCP Station", "MGCP Trunk", "GateKeeper", "7914 14-Button Line Expansion Module", "Trunk", "Tone Announcement Player", "SIP Trunk", "SIP Gateway", "WSM Trunk", "Remote Destination Profile", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "CKEM 36-Button Line Expansion Module", "SPA8800", "Unknown MGCP Gateway", "Unknown", "Cisco 7985", "Cisco 7911", "Cisco 7961G-GE", "Cisco 7941G-GE", "Motorola CN622", "Third-party SIP Device (Basic)", "Cisco 7931", "Cisco Unified Personal Communicator", "Cisco 7921", "Cisco 7906", "Third-party SIP Device (Advanced)", "Cisco TelePresence", "Nokia S60", "Cisco 7962", "Cisco 3951", "Cisco 7937", "Cisco 7942", "Cisco 7945", "Cisco 7965", "Cisco 7975", "Cisco 3911", "Cisco Unified Mobile Communicator", "Cisco TelePresence 1000", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 500-37", "Cisco 7925", "Cisco 9971", "Cisco 6921", "Cisco 6941", "Cisco 6961", "Cisco Unified Client Services Framework", "Cisco TelePresence 1300-65", "Cisco TelePresence 1100", "Transnova S3", "BlackBerry MVS VoWifi", "Cisco 9951", "Cisco 8961", "Cisco 6901", "Cisco 6911", "Cisco ATA 187", "Cisco TelePresence 200", "Cisco TelePresence 400", "Cisco Dual Mode for iPhone", "Cisco 6945", "Cisco Dual Mode for Android", "Cisco 7926", "Cisco E20", "Generic Single Screen Room System", "Generic Multiple Screen Room System", "Cisco TelePresence EX90", "Cisco 8945", "Cisco 8941", "Generic Desktop Video Endpoint", "Cisco TelePresence 500-32", "Cisco TelePresence 1300-47", "Cisco 3905", "Cisco Cius", "VKEM 36-Button Line Expansion Module", "Cisco TelePresence TX1310-65", "Cisco TelePresence MCU", "Ascom IP-DECT Device", "Cisco TelePresence Exchange System", "Cisco TelePresence EX60", "Cisco TelePresence Codec C90", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C40", "Cisco TelePresence Quick Set C20", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence MX200", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco 7821", "Cisco 7841", "Cisco 7861", "Cisco TelePresence SX20", "Cisco TelePresence MX300", "IMS-integrated Mobile (Basic)", "Third-party AS-SIP Endpoint", "Cisco Cius SP", "Cisco TelePresence Profile 42 (C40)", "Cisco VXC 6215", "CTI Remote Device", "Usage Profile", "Carrier-integrated Mobile", "Universal Device Template", "Cisco DX650", "Cisco Unified Communications for RTX", "Cisco Jabber for Tablet", "Cisco 8831", "Cisco ATA 190", "Cisco TelePresence SX10", "Cisco 8841", "Cisco 8851", "Cisco 8861", "Cisco TelePresence SX80", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300 G2", "Cisco 7905", "Cisco 7920", "Cisco 7970", "Cisco 7912", "Cisco 7902", "Cisco IP Communicator", "Cisco 7961", "Cisco 7936", "Analog Phone", "ISDN BRI Phone", "SCCP gateway virtual phone", "IP-STE", "Cisco TelePresence Conductor", "Cisco DX80", "Cisco DX70", "BEKEM 36-Button Line Expansion Module", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence IX5000", "Cisco 7811", "Cisco 8821", "Cisco 8811", "Interactive Voice Response", "Cisco 8845", "Cisco 8865", "Cisco TelePresence MX800 Dual", "Cisco 8851NR", "Cisco Spark Remote Device", "Cisco Webex DX80", "Cisco TelePresence DX70", "Cisco 7832", "Cisco 8865NR", "Cisco Meeting Server", "Cisco Webex Room Kit", "Cisco Webex Room 55", "Cisco Webex Room Kit Plus", "CP-8800-Video 28-Button Key Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "Cisco 8832", "Cisco Webex Room 70 Single", "Cisco 8832NR", "Cisco ATA 191", "Cisco Collaboration Mobile Convergence", "Cisco Webex Room 70 Dual", "Cisco Webex Room Kit Pro", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Single G2", "Cisco Webex Room 70 Dual G2", "SIP Station", "Cisco Webex Room Kit Mini", "Cisco Webex VDI Svc Framework", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex Desk Pro", "Cisco Webex Room Panorama", "Cisco Webex Room 70 Panorama", "Cisco Webex Room Phone", "Cisco 860", "Cisco Webex Desk LE"]
Module 3 Choose the appropriate expansion module or none.
  • Field Name: hcsCucmCcTagPhone.addOnModules.addOnModule.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Authentication String If you chose the By Authentication String option in the Authentication Mode drop-down list box, this field applies. Manually enter a string or generate a string by clicking the Generate String button. Ensure that the string contains 4 to 10 digits. To install, upgrade, delete, or troubleshoot a locally significant certificate, the phone user or administrator must enter the authentication string on the phone.
  • Field Name: hcsCucmCcTagPhone.authenticationString
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 10
  • Pattern: ^[0-9]{4,10}$
Require off-premise location Check this check box if the device inserted requires off-premise location update upon registration. Off-premise location update is required when the device location cannot be detected automatically by Cisco Emergency Responder. Check this check box only for remote or mobile devices that change locations frequently.
  • Field Name: hcsCucmCcTagPhone.requireOffPremiseLocation
  • Type: Boolean
  • Cardinality: [0..1]
Phone Activation Code The provisioning code which must be entered on the phone
  • Field Name: hcsCucmCcTagPhone.phoneActivationCode
  • Type: ["String"]
Protected Device Check this check box to designate a phone as protected, which enables the phone to play a 2-second tone to notify the user when a call is encrypted and both phones are configured as protected devices. The tone plays for both parties when the call is answered. The tone does not play unless both phones are protected and the call occurs over encrypted media. Checking this check box represents only one of several configuration requirements for the secure indication tone to play. For a detailed description of the secure indication tone feature and the configuration requirements, see the Cisco Unified Communications Manager Security Guide . If you check this check box and the system determines that the call is not encrypted, the phone plays nonsecure indication tone to alert the user that the call is not protected.
  • Field Name: hcsCucmCcTagPhone.isProtected
  • Type: Boolean
  • Cardinality: [0..1]
SUBSCRIBE Calling Search Space Supported with the Presence feature, the SUBSCRIBE calling search space determines how Cisco Unified CM routes presence requests that come from the phone. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the phone. From the drop-down list box, choose the SUBSCRIBE calling search space to use for presence requests for the phone. All calling search spaces that you configure in Cisco Unified Communications Manager Administration display in the SUBSCRIBE Calling Search Space drop-down list box. If you do not select a different calling search space for the end user from the drop-down list, the SUBSCRIBE calling search space defaults to None. To configure a SUBSCRIBE calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces.
  • Field Name: hcsCucmCcTagPhone.subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
MLPP Preemption Be aware that this setting is not available on all devices. If available, this setting specifies whether a device that can preempt calls in progress will use the capability when it places an MLPP precedence call. From the drop-down list box, choose a setting to assign to this device from the following options: Default—This device inherits its MLPP preemption setting from the common device configuration. Disabled—This device does not allow preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Forceful—This device allows preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Note    Do not configure a device with the following combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is set to Forceful. Default: Default
  • Field Name: hcsCucmCcTagPhone.preemption
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Disabled", "Forceful", "Default"]
RFC2833 Disabled For phones that are running SCCP, check this check box to disable RFC2833 support.
  • Field Name: hcsCucmCcTagPhone.rfc2833Disabled
  • Type: Boolean
  • Cardinality: [0..1]
Hlog Status
  • Field Name: hcsCucmCcTagPhone.hlogStatus
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Off", "On", "Default"]
Operation Completes By The completion deadline for the operation (CCYY:MM:DD:HH:MM)
  • Field Name: hcsCucmCcTagPhone.upgradeFinishTime
  • Type: String
  • Cardinality: [0..1]
  • Pattern: ^[0-9]{4}:[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}$|::::00
Is Active The Device Is Active message in the Phone Configuration window in Cisco Unified Communications Manager Administration displays when a phone consumes device license units and when a phone can register with Cisco Unified CM. For a phone that uses a real MAC address, not the dummy MAC address that is created via BAT, the Device Is Active message displays, which indicates that the phone uses device license units and can register with Cisco Unified Communications Manager. For a phone that uses the dummy MAC address that is created via BAT, the Device Is Active message does not display. If you manually convert the dummy MAC address to a real MAC address in the Phone Configuration window, the Device Is Active message displays after you save the configuration; this ensures that the phone can register with Cisco Unified Communications Manager and that licensing consumes device license units for the phone. Default: True
  • Field Name: hcsCucmCcTagPhone.isActive
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Allow iX Applicable Media This field is applicable only for Third-party AS-SIP Endpoint.
  • Field Name: hcsCucmCcTagPhone.allowiXApplicableMedia
  • Type: Boolean
  • Cardinality: [0..1]
Hot line Device This tag is applicable for PLAR-supporting SIP/SCCP phones only
  • Field Name: hcsCucmCcTagPhone.hotlineDevice
  • Type: Boolean
  • Cardinality: [0..1]
Digest User This field is applicable only to SIP phones.
  • Field Name: hcsCucmCcTagPhone.digestUser
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • MaxLength: 255
  • Format: uri
DND Incoming Call Alert When you enable the DND Ringer Off or Call Reject option, this parameter specifies how a call displays on a phone. From the drop-down list, choose one of the following options: None—This option specifies that the DND Incoming Call Alert setting from the Common Phone Profile window gets used for this device. Disable—This option disables both beep and flash notification of a call, but, for the DND Ringer Off option, incoming call information still gets displayed. For the DND Call Reject option, no call alerts display, and no information gets sent to the device. Beep Only—For an incoming call, this option causes the phone to play a beep tone only. Flash Only—For an incoming call, this option causes the phone to display a flash alert.
  • Field Name: hcsCucmCcTagPhone.dndRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: hcsCucmCcTagPhone.protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
MLPP Domain ID Choose an MLPP domain from the drop-down list box for the MLPP domain that is associated with this device. If you leave the None value, this device inherits its MLPP domain from the value that was set in the common device configuration. If the common device configuration does not have an MLPP domain setting, this device inherits its MLPP domain from the value that was set for the MLPP Domain Identifier enterprise parameter.
  • Field Name: hcsCucmCcTagPhone.mlppDomainId
  • Type: ["String", "Null"]
  • Target: device/cucm/MlppDomain
  • Target attr: domainId
  • Cardinality: [0..1]
  • MaxLength: 6
  • Pattern: ^[0-9a-fA-F]{6}|-1$
  • Format: uri
AAR Group Choose the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. If no AAR group is specified, Cisco Unified CM uses the AAR group that is associated with Device Pool or Line.
  • Field Name: hcsCucmCcTagPhone.aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Location * Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC enables you to regulate audio quality and video availability by limiting the amount of bandwidth that is available for audio and video calls over links between locations. The location specifies the total bandwidth that is available for calls to and from this location. From the drop-down list box, choose the appropriate location for this Cisco Unified IP Phone. A location setting of Hub_None means that the locations feature does not keep track of the bandwidth that this Cisco Unified IP Phone consumes. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP. To configure a new location, use the System > Location menu option.
  • Field Name: hcsCucmCcTagPhone.locationName
  • Type: String
  • Target: device/cucm/Location
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Media Resource Group List Choose the appropriate Media Resource Group List. A Media Resource Group List comprises a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List. If you choose <None>, Cisco Unified CM uses the Media Resource Group List that is defined in the device pool.
  • Field Name: hcsCucmCcTagPhone.mediaResourceListName
  • Type: ["String", "Null"]
  • Target: device/cucm/MediaResourceList
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Pool * Choose the device pool to which you want this phone assigned. The device pool defines sets of common characteristics for devices, such as region, date/time group, and softkey template.
  • Field Name: hcsCucmCcTagPhone.devicePoolName
  • Type: String
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Is Dual Mode Read-only tag.
  • Field Name: hcsCucmCcTagPhone.isDualMode
  • Type: Boolean
  • Cardinality: [0..1]
Vendor Config
  • Field Name: vendorConfig.[n]
  • Type: Array
Key
  • Field Name: hcsCucmCcTagPhone.vendorConfig.[n].key
  • Type: String
Value
  • Field Name: hcsCucmCcTagPhone.vendorConfig.[n].value
  • Type: Any
Authentication Server Enter the URL that the phone uses to validate requests that are made to the phone web server. If you do not provide an authentication URL, the advanced features on the Cisco Unified IP Phone that require authentication will not function. By default, this URL accesses a Cisco Unified Communications Self Care Portal window that was configured during installation. Leave this field blank to accept the default setting.
  • Field Name: hcsCucmCcTagPhone.authenticationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Services
  • Field Name: services
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Service
  • Field Name: service.[n]
  • Type: Array
Name *
  • Field Name: hcsCucmCcTagPhone.services.service.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 100
Url
  • Field Name: hcsCucmCcTagPhone.services.service.[n].url
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Service Name Ascii
  • Field Name: hcsCucmCcTagPhone.services.service.[n].serviceNameAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Url Button Index
  • Field Name: hcsCucmCcTagPhone.services.service.[n].urlButtonIndex
  • Type: Integer
  • Cardinality: [0..1]
Telecaster Service Name *
  • Field Name: hcsCucmCcTagPhone.services.service.[n].telecasterServiceName
  • Type: String
  • Target: device/cucm/IpPhoneServices
  • Target attr: serviceName
  • Cardinality: [1..1]
  • Format: uri
Url Label
  • Field Name: hcsCucmCcTagPhone.services.service.[n].urlLabel
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
User Hold MOH Audio Source To specify the audio source that plays when a user initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, Cisco Unified CM uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. Note    You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: hcsCucmCcTagPhone.userHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
EM Profile The name of the default profile for this device.Not Nullable.
  • Field Name: hcsCucmCcTagPhone.defaultProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/DeviceProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Enable Call Routing To Rd When None Is Active Determines whether calls should be routed to all remote destinations when the active remote destination is not set. Check this check box to receive calls during network connection outage or to use a third-party voicemail system. Note    This field appears only on a CTI remote device type.
  • Field Name: hcsCucmCcTagPhone.enableCallRoutingToRdWhenNoneIsActive
  • Type: Boolean
  • Cardinality: [0..1]
SIP Profile Choose the default SIP profile or a specific profile that was previously created. SIP profiles provide specific SIP information for the phone such as registration and keepalive timers, media ports, and do not disturb control.
  • Field Name: hcsCucmCcTagPhone.sipProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/SipProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Allow Control of Device from CTI Check this check box to allow CTI to control and monitor this device. If the associated directory number specifies a shared line, the check box should be enabled as long as at least one associated device specifies a combination of device type and protocol that CTI supports.
  • Field Name: hcsCucmCcTagPhone.allowCtiControlFlag
  • Type: Boolean
  • Cardinality: [0..1]
Single Button Barge From the drop-down list box, enable or disable the Single Button Barge/cBarge feature for this device or choose Default to use the service parameter setting. Off—This setting disables the Single Button Barge/cBarge feature; however, the regular Barge or cBarge features will still work. Barge—This setting enables the Single Button Barge feature. CBarge—This setting enables the Single Button cBarge feature. Default—Uses the Single Button Barge/cBarge setting that is in the service parameter. Default: Default
  • Field Name: hcsCucmCcTagPhone.singleButtonBarge
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "Barge", "CBarge", "Default"]
Messages Leave this field blank (not used by Cisco Unified Communications Manager).
  • Field Name: hcsCucmCcTagPhone.messagesUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Enable Extension Mobility Check this check box if this phone supports extension mobility.
  • Field Name: hcsCucmCcTagPhone.enableExtensionMobility
  • Type: Boolean
  • Cardinality: [0..1]
Common Device Configuration Choose the common device configuration to which you want this phone assigned. The common device configuration includes the attributes (services or features) that are associated with a particular user. Configure the common device in the Common Device Configuration window. To see the common device configuration settings, click the View Details link.
  • Field Name: hcsCucmCcTagPhone.commonDeviceConfigName
  • Type: ["String", "Null"]
  • Target: device/cucm/CommonDeviceConfig
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Early Offer support for voice and video calls (insert MTP if needed) This field is applicable only for Third-party AS-SIP Endpoint.
  • Field Name: hcsCucmCcTagPhone.earlyOfferSupportForVoiceCall
  • Type: Boolean
  • Cardinality: [0..1]
Information This field displays the name of the active firmware load if the Cisco Unified IP Phone has registered with Cisco Unified Communications Manager. In some cases, the Active Load ID field displays "Unknown." For example, Cisco Unified Communications Manager Administration might display "Unknown" in the Active Load ID field for any of the following circumstances: For SCCP phones, when the phone is a Cisco Unified IP Phone 7940 (SCCP), 7960 (SCCP), or 7985 (SCCP), because these phone models do not support the necessary version of SCCP. For SCCP and SIP phones, when the phone is any third-party phone. When Cisco Unified Communications Manager cannot determine the status of the phone.
  • Field Name: hcsCucmCcTagPhone.informationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Secure Authentication URL Enter the secure URL that the phone uses to validate requests that are made to the phone web server. Note    If you do not provide a Secure Authentication URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. By default, this URL accesses a Cisco Unified Communications Self Care Portal window that was configured during installation. Leave this field blank to accept the default setting. Maximum length: 255
  • Field Name: hcsCucmCcTagPhone.secureAuthenticationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Block Incoming Calls while Roaming
  • Field Name: hcsCucmCcTagPhone.blockIncomingCallsWhenRoaming
  • Type: Boolean
  • Cardinality: [0..1]
Secure Idle URL Enter the secure URL for the information that displays on the Cisco Unified IP Phone display when the phone is idle, as specified in Idle Timer field. For example, you can display a logo on the LCD when the phone has not been used for 5 minutes. Note    If you do not provide a Secure Idle URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: hcsCucmCcTagPhone.secureIdleUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Use Device Pool Calling Party Transformation CSS (Device Mobility Related Information) Default: True
  • Field Name: hcsCucmCcTagPhone.useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Home Network ID This tag is only valid when value of blockIncomingCallsWhenRoaming is true
  • Field Name: hcsCucmCcTagPhone.homeNetworkId
  • Type: String
  • Cardinality: [0..1]
Trace Flag
  • Field Name: hcsCucmCcTagPhone.traceFlag
  • Type: Boolean
  • Cardinality: [0..1]
Phone Personalization The Phone Personalization setting allows you to enable a Cisco Unified IP Phone, so it works with Phone Designer, a Cisco Unified Communications widget that allows a phone user to customize the wallpaper and ring tones on the phone. From the Phone Personalization drop-down list box, choose one of the following options: Disabled-The user cannot customize the Cisco Unified IP Phone by using Phone Designer. Enabled-The user can use Phone Designer to customize the phone. Default-The phone uses the configuration from the Phone Personalization enterprise parameter if you choose Default in both the Phone Configuration and Common Phone Profile Configuration windows. If you choose Default in the Common Phone Profile Configuration window but not in the Phone Configuration window, the phone uses the configuration that you specify in the Phone Configuration window. You must install and configure Phone Designer, so the phone user can customize the phone. Before you install and configure Phone Designer, identify which Cisco Unified IP Phone models work with Phone Designer, as described in the Phone Designer documentation. For more information on Phone Designer, see the Phone Designer documentation. Default: Default
  • Field Name: hcsCucmCcTagPhone.phoneSuite
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Disabled", "Enabled", "HTTPS Only", "Default"]
Geolocation From the drop-down list box, choose a geolocation. You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation. You can also choose a geolocation that has been configured with the System > Geolocation Configuration menu option.
  • Field Name: hcsCucmCcTagPhone.geoLocationName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Security Profile Choose the security profile to apply to the device. You must apply a security profile to all phones that are configured in Cisco Unified Communications Manager Administration. Installing Cisco Unified Communications Manager provides a set of predefined, nonsecure security profiles for auto-registration. To enable security features for a phone, you must configure a new security profile for the device type and protocol and apply it to the phone. If the phone does not support security, choose a nonsecure profile. To identify the settings that the profile contains, choose System > Security Profile > Phone Security Profile. Note    The CAPF settings that are configured in the profile relate to the Certificate Authority Proxy Function settings that display in the Phone Configuration window. You must configure CAPF settings for certificate operations that involve manufacturer-installed certificates (MICs) or locally significant certificates (LSC). See the Cisco Unified Communications Manager Security Guide for more information about how CAPF settings that you update in the phone configuration window affect security profile CAPF settings.
  • Field Name: hcsCucmCcTagPhone.securityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/PhoneSecurityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Join Across Lines From the drop-down list box, enable or disable the Join Across Lines feature for this device or choose Default to use the service parameter setting. Off—This setting disables the Join Across Lines feature. On—This setting enables the Join Across Lines feature. Default—This setting uses the Join Across Lines setting that is in the service parameter. Default: Default
  • Field Name: hcsCucmCcTagPhone.joinAcrossLines
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Speeddials
  • Field Name: speeddials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Speeddial
  • Field Name: speeddial.[n]
  • Type: Array
Index
  • Field Name: hcsCucmCcTagPhone.speeddials.speeddial.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Dirn *
  • Field Name: hcsCucmCcTagPhone.speeddials.speeddial.[n].dirn
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Label
  • Field Name: hcsCucmCcTagPhone.speeddials.speeddial.[n].label
  • Type: String
  • Cardinality: [1..1]
Do Not Disturb Check this check box to enable Do Not Disturb on the phone.
  • Field Name: hcsCucmCcTagPhone.dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Wireless Lan Profile Group Select a wireless LAN profile group from the drop-down list box. You may also click View Details to display the settings for this wireless LAN profile group. Note    You can specify the Wireless LAN Profile Group at the Device Pool level or the individual phone level. Note    This field does not apply to all phone models.
  • Field Name: hcsCucmCcTagPhone.wirelessLanProfileGroup
  • Type: ["String", "Null"]
  • Target: device/cucm/WlanProfileGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Hold MOH Audio Source To specify the audio source that is played when the network initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, Cisco Unified CM uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. Note    You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: hcsCucmCcTagPhone.networkHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Network Location The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable. Default: Use System Default
  • Field Name: hcsCucmCcTagPhone.networkLocation
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["OnNet", "OffNet", "Use System Default"]
Unattended Port Check this check box to indicate an unattended port on this device.
  • Field Name: hcsCucmCcTagPhone.unattendedPort
  • Type: Boolean
  • Cardinality: [0..1]
Calling Party Transformation CSS From the drop-down list box, choose the calling search space (CSS) that contains the calling party transformation pattern that you want to apply on the calling number when this phone initiates a call. Cisco Unified CM transforms the calling party using the digit transformations configured on the matching calling party transformation pattern when this phone initiates a call. This setting allows you to transform the calling party number before Cisco Unified CM routes the call. For example, a transformation pattern can change a phone extension to an E.164 number. This setting is generally configured when a user dials using a URI instead of digits. Cisco Unified CM allows calling party transformations on various patterns when dialing using digits, this setting provides similar transformation provision even when dialing using a URI.
  • Field Name: hcsCucmCcTagPhone.cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Mobility User ID From the drop-down list box, choose the user ID of the person to whom this dual-mode phone is assigned. Note    The Mobility User ID configuration gets used for the Cisco Unified Mobility and Mobile Voice Access features for dual-mode phones. The Owner User ID and Mobility User ID can differ.
  • Field Name: hcsCucmCcTagPhone.mobilityUserIdName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Ec Key Size ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
  • Field Name: hcsCucmCcTagPhone.ecKeySize
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["256", "384", "521"]
Version Stamp UUID changed each time device is updated
  • Field Name: hcsCucmCcTagPhone.versionStamp
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Device Trust Mode Select whether the device is trusted or not trusted. You can configure this setting for analog phones using SCCP, and for some third-party endpoints. Default: Not Trusted
  • Field Name: hcsCucmCcTagPhone.deviceTrustMode
  • Type: String
  • Cardinality: [0..1]
  • Default: Not Trusted
  • Choices: ["Not Trusted", "Trusted"]
Idle Timer (seconds) Enter the time (in seconds) that you want to elapse before the URL that is specified in the Idle field displays. To accept the value of the Idle URL Timer enterprise parameter, leave this field blank.
  • Field Name: hcsCucmCcTagPhone.idleTimeout
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Third-party Registration Required
  • Field Name: hcsCucmCcTagPhone.requireThirdPartyRegistration
  • Type: Boolean
  • Cardinality: [0..1]
Always Use Prime Line From the drop-down list box, choose one of the following options: Off—When the phone is idle and receives a call on any line, the phone user answers the call from the line on which the call is received. On—When the phone is idle (off hook) and receives a call on any line, the primary line gets chosen for the call. Calls on other lines continue to ring, and the phone user must select those other lines to answer these calls. Default— Cisco Unified Communications Manager uses the configuration from the Always Use Prime Line service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: hcsCucmCcTagPhone.alwaysUsePrimeLine
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Idle This setting determines the busy lamp field (BLF) audible alert setting when no current call exists on the BLF DN: On—An audible alert sounds. Off—No audible alert sounds. Default—The configuration in the Service Parameters Configuration window determines the alert option.
  • Field Name: hcsCucmCcTagPhone.idleUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Blf Directed Call Parks
  • Field Name: blfDirectedCallParks
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Blf Directed Call Park
  • Field Name: blfDirectedCallPark.[n]
  • Type: Array
Index
  • Field Name: hcsCucmCcTagPhone.blfDirectedCallParks.blfDirectedCallPark.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Label
  • Field Name: hcsCucmCcTagPhone.blfDirectedCallParks.blfDirectedCallPark.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Directed Call Park Id Only the uuid attribute is read
  • Field Name: hcsCucmCcTagPhone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkId
  • Type: String
  • Cardinality: [0..1]
  • Pattern: \{........-....-....-....-............\}
Directed Call Park Dn And Partition
  • Field Name: directedCallParkDnAndPartition
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Route Partition Name
  • Field Name: hcsCucmCcTagPhone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dn Pattern *
  • Field Name: hcsCucmCcTagPhone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: ["String", "Null"]
  • Target: device/cucm/DirectedCallPark
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Secure Shell Password This tag is applicable only to thosedevices that support ssh feature.
  • Field Name: hcsCucmCcTagPhone.sshPwd
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
BLF Audible Alert Setting (Phone Idle) This setting determines the busy lamp field (BLF) audible alert setting when no current call exists on the BLF DN: On—An audible alert sounds. Off—No audible alert sounds. Default—The configuration in the Service Parameters Configuration window determines the alert option. Default: Default
  • Field Name: hcsCucmCcTagPhone.ringSettingIdleBlfAudibleAlert
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Built In Bridge * Enable or disable the built-in conference bridge for the barge feature by using the Built In Bridge drop-down list box (choose On, Off, or Default). Note    Cisco Unified IP Phones 7940 and 7960 cannot support two media stream encryptions or SRTP streams simultaneously. To prevent instability due to this condition, the system automatically disables the built-in bridge for 7940 and 7960 phones when the device security mode is set to encrypted. Default: Default
  • Field Name: hcsCucmCcTagPhone.builtInBridgeStatus
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Packet Capture Duration This setting exists for troubleshooting encryption only; packet capturing may cause high CPU usage or call-processing interruptions. This field specifies the maximum number of minutes that is allotted for one session of packet capturing. The default setting equals 0, although the range exists from 0 to 300 minutes. To initiate packet capturing, enter a value other than 0 in the field. After packet capturing completes, the value, 0, displays. For more information on packet capturing, see the Cisco Unified Communications Manager Troubleshooting Guide .
  • Field Name: hcsCucmCcTagPhone.packetCaptureDuration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Wifi Hotspot Profile
  • Field Name: hcsCucmCcTagPhone.wifiHotspotProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/WifiHotspot
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Use Device Pool Calling Party Transformation CSS (Caller ID For Calls From This Phone) Default: True
  • Field Name: hcsCucmCcTagPhone.useDevicePoolCgpnIngressDN
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Allow Presentation Sharing using BFCP This field is applicable only for Third-party AS-SIP Endpoint.
  • Field Name: hcsCucmCcTagPhone.AllowPresentationSharingUsingBfcp
  • Type: Boolean
  • Cardinality: [0..1]
Services From the drop-down list box, choose how the phone will support the services: Internal—The phone uses the phone configuration file to support the service. Choose this option or Both for Cisco-provided default services where the Service URL has not been updated; that is, the service URL indicates Application:Cisco/<name of service>; for example, Application:Cisco/CorporateDirectory. Choose Internal or Both for Cisco-signed Java MIDlets because Cisco-signed Java MIDlets are provisioned in the configuration file. External URL—Choosing External URL indicates that the phone ignores the services in the phone configuration file and retrieves the services from a Service URL. If you configured a custom Service URL for a service, including a Cisco-provided default service, you must choose either External URL or Both; if you choose Internal in this case, the services that are associated with the custom URLs do not work on the phone. Both—Choosing Both indicates that the phone support both the services that are defined in the configuration file and external applications that are retrieved from service URLs.
  • Field Name: hcsCucmCcTagPhone.servicesUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Feature Control Policy From the drop-down list box, you can choose a feature control policy that has already been configured in the Feature Control Policy configuration window (Device > Device Settings > Feature Control Policy).
  • Field Name: hcsCucmCcTagPhone.featureControlPolicy
  • Type: ["String", "Null"]
  • Target: device/cucm/FeatureControlPolicy
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
MLPP Indication If available, this setting specifies whether a device that can play precedence tones will use the capability when it places an MLPP precedence call. From the drop-down list box, choose a setting to assign to this device from the following options: Default—This device inherits its MLPP indication setting from the common device configuration. Off—This device does not handle nor process indication of an MLPP precedence call. On—This device does handle and process indication of an MLPP precedence call. Note    Do not configure a device with the following combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is set to Forceful. Turning on MLPP Indication (at the enterprise parameter or device level) disables normal Ring Setting behavior for the lines on a device, unless MLPP Indication is turned off (overridden) for the device. Default: Off
  • Field Name: hcsCucmCcTagPhone.mlppIndicationStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Off
  • Choices: ["Off", "On", "Default"]
Busy Lamp Fields
  • Field Name: busyLampFields
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Busy Lamp Field
  • Field Name: busyLampField.[n]
  • Type: Array
Index
  • Field Name: hcsCucmCcTagPhone.busyLampFields.busyLampField.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Blf Dest Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: hcsCucmCcTagPhone.busyLampFields.busyLampField.[n].blfDest
  • Type: String
  • Cardinality: [1..1]
Call Pickup
  • Field Name: hcsCucmCcTagPhone.busyLampFields.busyLampField.[n].callPickup
  • Type: Boolean
Label
  • Field Name: hcsCucmCcTagPhone.busyLampFields.busyLampField.[n].label
  • Type: String
  • Cardinality: [0..1]
Route Partition
  • Field Name: hcsCucmCcTagPhone.busyLampFields.busyLampField.[n].routePartition
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Blf Dirn Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: hcsCucmCcTagPhone.busyLampFields.busyLampField.[n].blfDirn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Enable Activation ID This boolean setting, when set to true, indicates that the phone should use activation code based registration
  • Field Name: hcsCucmCcTagPhone.enableActivationID
  • Type: Boolean
  • Cardinality: [0..1]
Packet Capture Mode * This setting exists for troubleshooting encryption only; packet capturing may cause high CPU usage or call-processing interruptions. Choose one of the following options from the drop-down list box: None—This option, which serves as the default setting, indicates that no packet capturing is occurring. After you complete packet capturing, configure this setting. Batch Processing Mode—Cisco Unified CM writes the decrypted or nonencrypted messages to a file, and the system encrypts each file. On a daily basis, the system creates a new file with a new encryption key. Cisco Unified CM, which stores the file for seven days, also stores the keys that encrypt the file in a secure location. Cisco Unified CM stores the file in the PktCap virtual directory. A single file contains the time stamp, source IP address, source IP port, destination IP address, packet protocol, message length, and the message. The TAC debugging tool uses HTTPS, administrator username and password, and the specified day to request a single encrypted file that contains the captured packets. Likewise, the tool requests the key information to decrypt the encrypted file. For more information on packet capturing, see the Troubleshooting Guide for Cisco Unified Communications Manager . Default: None
  • Field Name: hcsCucmCcTagPhone.packetCaptureMode
  • Type: String
  • Cardinality: [1..1]
  • Default: None
  • Choices: ["None", "Batch Processing Mode"]
Registration Status Registration status of the phone
  • Field Name: hcsCucmCcTagPhone.status
  • Type: String
Phone Load Name Enter the custom software for the Cisco Unified IP Phone. The value that you enter overrides the default value for the current model. For more information about Cisco Unified IP Phone software and configuration, see the Cisco Unified IP Phone Administration Guide for Cisco Unified Communications Manager, which is specific to the phone model and Unified CM release.
  • Field Name: hcsCucmCcTagPhone.loadInformation
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Product * Product ID string. read-only except when creating a device.
  • Field Name: hcsCucmCcTagPhone.product
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["7914 14-Button Line Expansion Module", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "AIM-VOICE-30", "Analog Phone", "Annunciator", "BEKEM 36-Button Line Expansion Module", "C881V", "C887VA-V", "CKEM 36-Button Line Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "CP-8800-Video 28-Button Key Expansion Module", "CTI Port", "CTI Remote Device", "CTI Route Point", "Carrier-integrated Mobile", "Cisco IAD2400", "Cisco 12 S", "Cisco 12 SP", "Cisco 12 SP+", "Cisco 1751", "Cisco 1760", "Cisco 1861", "Cisco 269X", "Cisco 26XX", "Cisco 2801", "Cisco 2811", "Cisco 2821", "Cisco 2851", "Cisco 2901", "Cisco 2911", "Cisco 2921", "Cisco 2951", "Cisco 30 SP+", "Cisco 30 VIP", "Cisco 362X", "Cisco 364X", "Cisco 366X", "Cisco 3725", "Cisco 3745", "Cisco 3825", "Cisco 3845", "Cisco 3905", "Cisco 3911", "Cisco 3925", "Cisco 3925E", "Cisco 3945", "Cisco 3945E", "Cisco 3951", "Cisco 6901", "Cisco 6911", "Cisco 6921", "Cisco 6941", "Cisco 6945", "Cisco 6961", "Cisco 7811", "Cisco 7821", "Cisco 7832", "Cisco 7841", "Cisco 7861", "Cisco 7902", "Cisco 7905", "Cisco 7906", "Cisco 7910", "Cisco 7911", "Cisco 7912", "Cisco 7920", "Cisco 7921", "Cisco 7925", "Cisco 7926", "Cisco 7931", "Cisco 7935", "Cisco 7936", "Cisco 7937", "Cisco 7940", "Cisco 7941", "Cisco 7941G-GE", "Cisco 7942", "Cisco 7945", "Cisco 7960", "Cisco 7961", "Cisco 7961G-GE", "Cisco 7962", "Cisco 7965", "Cisco 7970", "Cisco 7971", "Cisco 7975", "Cisco 7985", "Cisco 860", "Cisco 881", "Cisco 8811", "Cisco 8821", "Cisco 8831", "Cisco 8832", "Cisco 8832NR", "Cisco 8841", "Cisco 8845", "Cisco 8851", "Cisco 8851NR", "Cisco 8861", "Cisco 8865", "Cisco 8865NR", "Cisco 888/887/886", "Cisco 8941", "Cisco 8945", "Cisco 8961", "Cisco 9951", "Cisco 9971", "Cisco ATA 186", "Cisco ATA 187", "Cisco ATA 190", "Cisco ATA 191", "Cisco C8200/L-1N-4T", "Cisco C8300-1N1S-4T2X", "Cisco C8300-1N1S-6T", "Cisco C8300-2N2S-4T2X/6T", "Cisco Catalyst 4000 Access Gateway Module", "Cisco Catalyst 4224 Voice Gateway Switch", "Cisco Catalyst 6000 12 port FXO Gateway", "Cisco Catalyst 6000 24 port FXS Gateway", "Cisco Catalyst 6000 E1 VoIP Gateway", "Cisco Catalyst 6000 T1 VoIP Gateway", "Cisco Cius", "Cisco Cius SP", "Cisco Collaboration Mobile Convergence", "Cisco Conference Bridge (WS-SVC-CMM)", "Cisco Conference Bridge Hardware", "Cisco Conference Bridge Software", "Cisco DX650", "Cisco DX70", "Cisco DX80", "Cisco Dual Mode for Android", "Cisco Dual Mode for iPhone", "Cisco E20", "Cisco ENCS 5400 ISRV", "Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge", "Cisco IOS Enhanced Media Termination Point", "Cisco IOS Enhanced Software Media Termination Point", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Cisco IOS Media Termination Point", "Cisco IP Communicator", "Cisco ISR 4321", "Cisco ISR 4331", "Cisco ISR 4351", "Cisco ISR 4431", "Cisco ISR 4451", "Cisco ISR 4461", "Cisco Jabber for Tablet", "Cisco MGCP BRI Port", "Cisco MGCP E1 Port", "Cisco MGCP FXO Port", "Cisco MGCP FXS Port", "Cisco MGCP T1 Port", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco Media Termination Point Hardware", "Cisco Media Termination Point Software", "Cisco Meeting Server", "Cisco SIP FXS Port", "Cisco Spark Remote Device", "Cisco TelePresence", "Cisco TelePresence 1000", "Cisco TelePresence 1100", "Cisco TelePresence 1300-47", "Cisco TelePresence 1300-65", "Cisco TelePresence 200", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 400", "Cisco TelePresence 500-32", "Cisco TelePresence 500-37", "Cisco TelePresence Codec C40", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C90", "Cisco TelePresence Conductor", "Cisco TelePresence DX70", "Cisco TelePresence EX60", "Cisco TelePresence EX90", "Cisco TelePresence Exchange System", "Cisco TelePresence IX5000", "Cisco TelePresence MCU", "Cisco TelePresence MX200", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300", "Cisco TelePresence MX300 G2", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence MX800 Dual", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C40)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence Quick Set C20", "Cisco TelePresence SX10", "Cisco TelePresence SX20", "Cisco TelePresence SX80", "Cisco TelePresence TX1310-65", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco Unified Client Services Framework", "Cisco Unified Communications for RTX", "Cisco Unified Mobile Communicator", "Cisco Unified Personal Communicator", "Cisco VG200", "Cisco VG248 Gateway", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco VGD-1T3", "Cisco VXC 6215", "Cisco Video Conference Bridge(IPVC-35xx)", "Cisco Voice Mail Port", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex DX80", "Cisco Webex Desk LE", "Cisco Webex Desk Pro", "Cisco Webex Room 55", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Dual", "Cisco Webex Room 70 Dual G2", "Cisco Webex Room 70 Panorama", "Cisco Webex Room 70 Single", "Cisco Webex Room 70 Single G2", "Cisco Webex Room Kit", "Cisco Webex Room Kit Mini", "Cisco Webex Room Kit Plus", "Cisco Webex Room Kit Pro", "Cisco Webex Room Panorama", "Cisco Webex Room Phone", "Cisco Webex VDI Svc Framework", "Communication Media Module", "EMCC Base Phone", "FLEX_SLOT", "Gatekeeper", "Generic Desktop Video Endpoint", "Generic Multiple Screen Room System", "Generic Single Screen Room System", "H.225 Trunk (Gatekeeper Controlled)", "H.323 Client", "H.323 Gateway", "Hunt List", "IAD2400_ANALOG", "IAD2400_DIGITAL", "IMS-integrated Mobile (Basic)", "IP-STE", "ISDN BRI Phone", "Inter-Cluster Trunk (Gatekeeper Controlled)", "Inter-Cluster Trunk (Non-Gatekeeper Controlled)", "Interactive Voice Response", "Load Simulator", "Motorola CN622", "Music On Hold", "NM-1V", "NM-2V", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT", "NM-HDV2-2PORT", "Nokia S60", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "Pilot", "Remote Destination Profile", "Route List", "SCCP Device", "SCCP gateway virtual phone", "SIP Trunk", "SIP WSM Connection", "SPA8800", "Third-party AS-SIP Endpoint", "Third-party SIP Device (Advanced)", "Third-party SIP Device (Basic)", "Transnova S3", "Universal Device Template", "Unknown", "VG202", "VG204", "VG224", "VG310", "VG320", "VG350", "VG400", "VG420", "VG450", "VGC Port", "VIC_SLOT", "VKEM 36-Button Line Expansion Module", "VNM-HDA", "VWIC_SLOT", "WS-SVC-CMM-MS", "WS-X6600"]
Description Identify the purpose of the device. You can enter the user name (such as John Smith) or the phone location (such as Lobby) in this field. For Cisco VG248 gateways, begin the description with VGC<mac address>. The description can include up to 128 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), back-slash (\), or angle brackets (<>).
  • Field Name: hcsCucmCcTagPhone.description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Allow Mra Mode
  • Field Name: hcsCucmCcTagPhone.allowMraMode
  • Type: Boolean
  • Cardinality: [0..1]
Send Geo Location
  • Field Name: hcsCucmCcTagPhone.sendGeoLocation
  • Type: Boolean
  • Cardinality: [0..1]
Owner User ID From the drop-down list box, choose the user ID of the assigned phone user. The user ID gets recorded in the call detail record (CDR) for all calls made from this device. Assigning a user ID to the device also moves the device from "Unassigned Devices" to "Users" in the License Usage Report.
  • Field Name: hcsCucmCcTagPhone.ownerUserName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Ignore Presentation Indicators (internal calls only) Check this check box to configure call display restrictions on a call-by-call basis. When this check box is checked, Cisco Unified CM ignores any presentation restriction that is received for internal calls. Use this configuration in combination with the calling line ID presentation and connected line ID presentation configuration at the translation pattern level. Together, these settings allow you to configure call display restrictions to selectively present or block calling and/or connected line display information for each call. See the translation configuration settings for more information about the calling line ID presentation and the connected line ID presentation parameters.
  • Field Name: hcsCucmCcTagPhone.ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
Phone Activation Code Expiry The provisioning code expiry datetime
  • Field Name: hcsCucmCcTagPhone.phoneActivationCodeExpiry
  • Type: ["String"]
Secure Services URL Enter the secure URL for Cisco Unified IP Phone services. The is the location that the secure Cisco Unified IP Phone contacts when the user presses the Services button. Note    If you do not provide a Secure Services URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: hcsCucmCcTagPhone.secureServicesUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Certificate Operation * From the drop-down list box, choose one of the following options: No Pending Operation—Displays when no certificate operation is occurring (default setting). Install/Upgrade—Installs a new or upgrades an existing locally significant certificate in the phone. Delete—Deletes the locally significant certificate that exists in the phone. Troubleshoot—Retrieves the locally significant certificate (LSC) or the manufacture installed certificate (MIC), so you can view the certificate credentials in the CAPF trace file. If both certificate types exist in the phone, Cisco Unified CM creates two trace files, one for each certificate type. By choosing the Troubleshooting option, you can verify that an LSC or MIC exists in the phone. For more information on CAPF operations, see the Cisco Unified Communications Manager Security Guide . Default: No Pending Operation
  • Field Name: hcsCucmCcTagPhone.certificateOperation
  • Type: String
  • Cardinality: [1..1]
  • Default: No Pending Operation
  • Choices: ["No Pending Operation", "Install/Upgrade", "Delete", "Troubleshoot"]
Secure Shell User Enter a user ID for the secure shell user. You can enter any alphanumeric or special characters up to 50 characters. Invalid characters include”, %, &, <, >, and \. This field displays when the phone device that you are configuring supports SSH access. Cisco Technical Assistance Center (TAC) uses secure shell for troubleshooting and debugging. Contact TAC for further assistance. See the Cisco Unified Communications Manager Security Guide for this release for information about how to configure encrypted phone configuration files to ensure that Cisco Unified CM does not send SSH credentials to the phone in the clear.
  • Field Name: hcsCucmCcTagPhone.sshUserId
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Class * Class ID string. Class information is read-only except when creating a device. Default: Phone
  • Field Name: hcsCucmCcTagPhone.class
  • Type: String
  • Cardinality: [1..1]
  • Default: Phone
  • Choices: ["Phone", "Gateway", "Conference Bridge", "Media Termination Point", "Route List", "Voice Mail", "CTI Route Point", "Music On Hold", "Simulation", "Pilot", "GateKeeper", "Add-on modules", "Hidden Phone", "Trunk", "Tone Announcement Player", "Remote Destination Profile", "EMCC Base Phone Template", "EMCC Base Phone", "Remote Destination Profile Template", "Gateway Template", "UDP Template", "Phone Template", "Device Profile", "Invalid", "Interactive Voice Response"]
DND Option When you enable DND on the phone, this parameter allows you to specify how the DND features handle incoming calls: Call Reject—This option specifies that no incoming call information gets presented to the user. Depending on how you configure the DND Incoming Call Alert parameter, the phone may play a beep or display a flash notification of the call. Ringer Off—This option turns off the ringer, but incoming call information gets presented to the device, so the user can accept the call. Use Common Phone Profile Setting—This option specifies that the DND Option setting from the Common Phone Profile window will get used for this device. Note    For 7940/7960 phones that are running SCCP, you can only choose the Ringer Off option. For mobile devices and dual-mode phones, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. Default: Ringer Off
  • Field Name: hcsCucmCcTagPhone.dndOption
  • Type: String
  • Cardinality: [0..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
BLF Presence Group
  • Field Name: hcsCucmCcTagPhone.presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Rerouting Calling Search Space From the drop-down list box, choose a calling search space to use for rerouting. The rerouting calling search space of the referrer gets used to find the route to the refer-to target. When the Refer fails due to the rerouting calling search space, the Refer Primitive rejects the request with the "405 Method Not Allowed" message. The redirection (3xx) primitive and transfer feature also uses the rerouting calling search space to find the redirect-to or transfer-to target.
  • Field Name: hcsCucmCcTagPhone.rerouteCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Common Phone Profile * From the drop-down list box, choose a common phone profile from the list of available common phone profiles.
  • Field Name: hcsCucmCcTagPhone.commonPhoneConfigName
  • Type: String
  • Target: device/cucm/CommonPhoneConfig
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Lines
  • Field Name: lines
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Line An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
  • Field Name: line.[n]
  • Type: Array
Display Ascii
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].displayAscii
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Associated Endusers
  • Field Name: associatedEndusers
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Enduser
  • Field Name: enduser.[n]
  • Type: Array
User Id *
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
Ring Setting Default: Ring
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].consecutiveRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Recording Profile Name
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/RecordingProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Index
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].ringSettingActivePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Link To Line Link to the line resource
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].line_link
  • Type: String
  • Format: link
Label
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Partition Usage This tag cannot be modified. It can only be specified in the add request. Default: General
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Recording Flag Default: Call Recording Disabled
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
  • Default: Call Recording Disabled
  • Choices: ["Call Recording Disabled", "Automatic Call Recording Enabled", "Selective Call Recording Enabled"]
Speed Dial
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
E164Mask
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Caller Number
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Inventory Filter Default: default
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].dirn.line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Pattern *
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mwl Policy Default: Use System Policy
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Policy
  • Choices: ["Use System Policy", "Light and Prompt", "Prompt Only", "Light Only", "None"]
Ring Setting Idle Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].ringSettingIdlePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: hcsCucmCcTagPhone.lines.line.[n].display
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
MTP Preferred Originating Codec From the drop-down list box, choose the codec to use if a media termination point is required for SIP calls. Default: 711ulaw
  • Field Name: hcsCucmCcTagPhone.mtpPreferedCodec
  • Type: String
  • Cardinality: [0..1]
  • Default: 711ulaw
  • Choices: ["711ulaw", "711alaw", "G729/G729a", "G729b/G729ab"]
Softkey Template Choose the appropriate softkey template. The softkey template determines the configuration of the softkeys on Cisco Unified IP Phones. Leave this field blank if the common device configuration contains the assigned softkey template.
  • Field Name: hcsCucmCcTagPhone.softkeyTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/SoftKeyTemplate
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Remote Device If you are experiencing delayed connect times over SCCP pipes to remote sites, check the Remote Device check box in the Phone Configuration window. Checking this check box tells Cisco Unified CM to allocate a buffer for the phone device when it registers and to bundle SCCP messages to the phone. Tip    Because this feature consumes resources, be sure to check this check box only when you are experiencing signaling delays for phones that are running SCCP. Most users do not require this option. Cisco Unified CM sends the bundled messages to the phone when the station buffer is full, as soon as it receives a media-related message, or when the Bundle Outbound SCCP Messages timer expires. To specify a setting other than the default setting (100 msec) for the Bundle Outbound SCCP Messages timer, configure a new value in the Service Parameters Configuration window for the Cisco CallManager service. Although 100 msec specifies the recommended setting, you may enter 15 msec to 500 msec. The phone must support SCCP version 9 to use this option. The following phones do not support SCCP message optimization: Cisco Unified IP Phone 7935/7936. This feature may require a phone reset after update.
  • Field Name: hcsCucmCcTagPhone.remoteDevice
  • Type: Boolean
  • Cardinality: [0..1]
AAR Calling Search Space Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR). The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.
  • Field Name: hcsCucmCcTagPhone.automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
SIP Dial Rules If required, choose the appropriate SIP dial rule. SIP dial rules provide local dial plans for Cisco Unified IP Phones 7905, 7912, 7940, and 7960, so users do not have to press a key or wait for a timer before the call gets processed. Leave the SIP Dial Rules field set to <None> if you do not want dial rules to apply to the IP phone that is running SIP. This means that the user must use the Dial softkey or wait for the timer to expire before the call gets processed.
  • Field Name: hcsCucmCcTagPhone.dialRulesName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Hcs Cucm Cc Tag Line
  • Field Name: hcsCucmCcTagLine
  • Type: Object
External Presentation Info
  • Field Name: externalPresentationInfo
  • Type: Object
  • Cardinality: [0..1]
Is Anonymous
  • Field Name: hcsCucmCcTagLine.externalPresentationInfo.isAnonymous
  • Type: Boolean
  • Cardinality: [0..1]
Presentation Info
  • Field Name: presentationInfo
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
External Presentation Number
  • Field Name: hcsCucmCcTagLine.externalPresentationInfo.presentationInfo.externalPresentationNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
External Presentation Name
  • Field Name: hcsCucmCcTagLine.externalPresentationInfo.presentationInfo.externalPresentationName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Party Entrance Tone From the Party Entrance Tone drop-down list box, choose one of the following options: Default—Use the value that you configured in the Party Entrance Tone service parameter. On—A tone plays on the phone when a basic call changes to a multi-party call; that is, a barge call, cBarge call, ad hoc conference, meet-me conference, or a joined call. In addition, a different tone plays when a party leaves the multi-party call. If the controlling device, that is, the originator of the multi-party call has a built-in bridge, the tone gets played to all parties if you choose On for the controlling device. When the controlling device leaves the call, Cisco Unified Communications Manager identifies whether another device on the call can play the tone; if another device on the call can play the tone, Cisco Unified Communications Manager plays the tone. If the controlling device cannot play the tone, Cisco Unified Communications Manager does not play the tone even if you enable the party entrance tone feature. Off—A tone does not play on the phone when a basic call changes to a multi-party call. Default: Default
  • Field Name: hcsCucmCcTagLine.partyEntranceTone
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Search Space Activation Policy Three possible values exist for this option: Use System Default With Configured CSS With Activating Device/Line CSS If you select the With Configured CSS option, the Forward All Calling Search Space that is explicitly configured in the Directory Number Configuration window controls the forward all activation and call forwarding. If the Forward All Calling Search Space is set to None, no CSS gets configured for Forward All. A forward all activation attempt to any directory number with a partition will fail. No change in the Forward All Calling Search Space and Secondary Calling Search Space for Forward All occurs during the forward all activation. If you prefer to utilize the combination of the Directory Number Calling Search Space and Device Calling Search Space without explicitly configuring a Forward All Calling Search Space, select With Activating Device/Line CSS for the Calling Search Space Activation Policy. With this option, when Forward All is activated from the phone, the Forward All Calling Search Space and Secondary Calling Search Space for Forward All automatically gets populated with the Directory Number Calling Search Space and Device Calling Search Space for the activating device. With this configuration (Calling Search Space Activation Policy set to With Activating Device/Line), if the Forward All Calling Search Space is set to None, when forward all is activated through the phone, the combination of Directory Number Calling Search Space and activating Device Calling Search Space gets used to verify the forward all attempt. If you configure the Calling Search Space Activation Policy to Use System Default, then the CFA CSS Activation Policy cluster-wide service parameter determines which Forward All Calling Search space will be used. If the CFA CSS Activation Policy service parameter gets set to With Configured CSS, then Forward All Calling Search Space and Secondary Calling Search Space for Forward All will be used for Call Forwarding. If CFA CSS Activation Policy service parameter gets set to With Activating Device/Line CSS, then Forward All Calling Search Space and Secondary Calling Search Space for Forward All will be automatically populated with the Directory Number Calling Search Space and Device Calling Search Space for the activating device. CFA CSS Activation Policy Service Parameter: Ensure the CFA CSS Activation Policy service parameter that displays in the Clusterwide Parameters (Feature - Forward) section of the Service Parameter Configuration window is set correctly for call forward all to work as intended. The parameter includes two possible values: With Configured CSS (default) With Activating Device/Line CSS When the Calling Search Space Activation Policy is set to Use System Default, the value of the CFA CSS Activation Policy service parameter gets used to determine the Call Forward All CSS. When the option With Configured CSS is selected, the primary and secondary CFA Calling Search Space get used. When the option With Activating Device/Line CSS is selected, the primary and secondary CFA Calling Search Space get updated with primary line Calling Search Space and activating Device Calling Search Space. By default, the value of the CFA CSS Activation Policy service parameter is set to With Configured CSS. Roaming: When a device is roaming in the same device mobility group, Cisco Unified Communications Manager uses the Device Mobility CSS to reach the local gateway. If a user sets Call Forward All at the phone, the CFA CSS is set to None, and the CFA CSS Activation Policy is set to With Activating Device/Line CSS, then: The Device CSS and Line CSS get used as the CFA CSS when the device is in its home location. If the device is roaming within the same device mobility group, the Device Mobility CSS from the Roaming Device Pool and the Line CSS get used as the CFA CSS. If the device is roaming within a different device mobility group, the Device CSS and Line CSS get used as the CFA CSS. Default: Use System Default
  • Field Name: hcsCucmCcTagLine.cfaCssPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "With Configured CSS", "With Activating Device/Line CSS"]
Associated Devices
  • Field Name: associatedDevices
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Associated Devices
  • Field Name: device.[n]
  • Type: Array
Auto Answer Choose one of the following options to activate the Auto Answer feature for this directory number: Auto Answer Off <Default> Auto Answer with Headset Auto Answer with Speakerphone Note    Make sure that the headset or speakerphone is not disabled when you choose Auto Answer with headset or Auto Answer with speakerphone. Note    Do not configure Auto Answer for devices that have shared lines. Default: Auto Answer Off
  • Field Name: hcsCucmCcTagLine.autoAnswer
  • Type: String
  • Cardinality: [0..1]
  • Default: Auto Answer Off
  • Choices: ["Auto Answer Off", "Auto Answer with Headset", "Auto Answer with Speakerphone"]
User Hold MOH Audio Source Choose the audio source that plays when a user initiates a hold action.
  • Field Name: hcsCucmCcTagLine.userHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Call Pickup Group Choose the number that can be dialed to answer calls to this directory number (in the specified partition).
  • Field Name: hcsCucmCcTagLine.callPickupGroupName
  • Type: ["String", "Null"]
  • Target: device/cucm/CallPickupGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Call Forward Not Registered Int
  • Field Name: callForwardNotRegisteredInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Call Forward Unregistered Internal Destination Mask This field applies to unregistered internal DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: hcsCucmCcTagLine.callForwardNotRegisteredInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Call Forward Unregistered Internal voice Mail Enabled This field applies to unregistered internal DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: hcsCucmCcTagLine.callForwardNotRegisteredInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward Unregistered CSS Internal * This field applies to unregistered internal DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: hcsCucmCcTagLine.callForwardNotRegisteredInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Route Partition Choose the partition to which the directory number belongs. Make sure that the directory number that you enter in the Directory Number field is unique within the partition that you choose. If you do not want to restrict access to the directory number, choose <None> for the partition. You can configure the number of partitions that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Partitions window, then find and choose a partition name. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters.
  • Field Name: hcsCucmCcTagLine.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Call Forward On Failure
  • Field Name: callForwardOnFailure
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Device Failure Directory Number This field applies only to CTI route points and CTI ports. The settings in this row specify the forwarding treatment for external calls to this CTI route point or CTI port if the CTI route point or CTI port fails. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: hcsCucmCcTagLine.callForwardOnFailure.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward CTI Failure Voice Mail Enabled DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
  • Field Name: hcsCucmCcTagLine.callForwardOnFailure.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Device Failure Calling Search Space * This field applies only to CTI route points and CTI ports. The settings in this row specify the forwarding treatment for external calls to this CTI route point or CTI port if the CTI route point or CTI port fails. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: hcsCucmCcTagLine.callForwardOnFailure.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Reject Anonymous Calls Check this check box to reject all anonymous calls for the DN. Anonymous calls are calls with no caller ID or that have caller ID blocked.
  • Field Name: hcsCucmCcTagLine.rejectAnonymousCall
  • Type: Boolean
  • Cardinality: [0..1]
Retain this destination in the call forwarding history This setting determines whether the AAR leg of the call will be present in the call forwarding history. If you uncheck the check box, the AAR leg of the call is not present in the call history. If you check the check box, the AAR leg of the call will be present in the call history. By default, the directory number configuration retains the AAR leg of the call in the call history, which ensures that the AAR forward to voice-messaging system will prompt the user to leave a voice message.
  • Field Name: hcsCucmCcTagLine.aarKeepCallHistory
  • Type: Boolean
  • Cardinality: [0..1]
Calling Search Space From the drop-down list box, choose the appropriate calling search space. A calling search space comprises a collection of partitions that are searched for numbers that are called from this directory number. The value that you choose applies to all devices that are using this directory number. Changes result in an update of the numbers that the Call Pickup Group field lists. You can configure calling search space for Forward All, Forward Busy, Forward No Answer, Forward No Coverage, and Forward on CTI Failure directory numbers. The value that you choose applies to all devices that are using this directory number. You must configure either primary Forward All Calling Search Space or Secondary Forward All Calling Search Space or both for Call Forward All to work properly. The system uses these concatenated fields (Primary CFA CSS + Secondary CFA CSS) to validate the CFA destination and forward the call to the CFA destination. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the other call forward calling search spaces as well. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. When you forward calls by using the CFwdAll softkey on the phone, the automatic combination of the line CSS and device CSS does not get used. Only the configured Primary CFA CSS and Secondary CFA CSS get used. If both of these fields are None, the combination results in two null partitions, which may cause the operation to fail. If you want to restrict users from forwarding calls on their phones, you must choose a restrictive calling search space from the Forward All Calling Search Space field.
  • Field Name: hcsCucmCcTagLine.shareLineAppearanceCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
AAR Destination Mask The settings in this row of fields specify treatment of calls for which insufficient bandwidth exists to reach the destination. Automated alternate routing (AAR) handles these calls that are routed to the AAR Destination Mask or Voice Mail. Configure the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Coverage/Destination box and Calling Search Space. AAR Destination Mask—Use this setting instead of the external phone number mask to determine the AAR Destination to be dialed. AAR Group—This setting provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None indicates that no rerouting of blocked calls will be attempted.
  • Field Name: hcsCucmCcTagLine.aarDestinationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 24
  • Pattern: ^[0-9*#+X]{0,24}$
Call Forward Busy
  • Field Name: callForwardBusy
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward Busy External Destination The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for external calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When the Voice Mail check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for external calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy external Calling Search Space is used to forward the call to the Forward Busy External destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: hcsCucmCcTagLine.callForwardBusy.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward Busy Voice Mail Enabled The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for external calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When the Voice Mail check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for external calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy external Calling Search Space is used to forward the call to the Forward Busy External destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: hcsCucmCcTagLine.callForwardBusy.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward Busy External Calling Search Space * The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for external calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When the Voice Mail check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for external calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy external Calling Search Space is used to forward the call to the Forward Busy External destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: hcsCucmCcTagLine.callForwardBusy.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Directory Number * Enter a dialable phone number. Values can include route pattern wildcards and numeric characters (0 through 9). Special characters such as a question mark (?), exclamation mark (!), backslash (\), brackets ([ ]), plus sign (+), dash (-), asterisk (*), caret (^), pound sign (#), and an X are also allowable. Special characters that are not allowed are a period (.), at sign (@), dollar sign ($), and percent sign (%). At the beginning of the pattern, enter \+ if you want to use the international escape character +. For this field, \+ does not represent a wildcard; instead, entering \+ represents a dialable digit. Note    When a pattern is used as a directory number, the display on the phone and the caller ID that displays on the dialed phone will both contain characters other than digits. To avoid this, Cisco recommends that you provide a value for Display (Internal Caller ID), Line text label, and External phone number mask. The directory number that you enter can appear in more than one partition. If you configure this field under Call Routing > Directory Number, you can enter insert directory numbers in bulk by entering a range (that is, by entering the beginning directory number in the first field and by entering the ending directory number in the second field); by using this method, you can create up to 500 directory numbers at a time.
  • Field Name: hcsCucmCcTagLine.pattern
  • Type: String
  • Cardinality: [1..1]
Pattern Precedence Default: Default
  • Field Name: hcsCucmCcTagLine.patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
BLF Presence Group Configure this field with the BLF Presence feature. From the drop-down list box, choose a BLF Presence group for this directory number. The selected group specifies the devices, end users, and application users that can monitor this directory number. The default value for BLF Presence Group specifies Standard Presence group, configured with installation. Presence groups that are configured in Cisco Unified Communications Manager Administration also appear in the drop-down list box. BLF Presence authorization works with presence groups to allow or block presence requests between groups.
  • Field Name: hcsCucmCcTagLine.presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Call Forward No Answer
  • Field Name: callForwardNoAnswer
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Duration Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswer.duration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Forward No Answer External Destination The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an external call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer external Calling Search Space is used to forward the call to the Forward No Answer external destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswer.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Answer Voice Mail Enabled The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an external call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer external Calling Search Space is used to forward the call to the Forward No Answer external destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswer.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Answer External Calling Search Space * The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an external call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer external Calling Search Space is used to forward the call to the Forward No Answer external destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswer.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Hold Reversion Notification Interval (seconds) Enter a number from 0 to 1200 (inclusive) to specify the interval time in seconds for sending periodic reminder alerts to the holding party phone. If you enter a value of 0, Cisco Unified Communications Manager does not send reminder alerts. At installation, this field remains blank. If you leave this setting blank, the Hold Reversion Notification Interval timer setting for the cluster applies. Note    SCCP phones support a minimum Hold Reversion Notification Interval (HRNI) of 5 seconds, whereas SIP phones support a minimum of 10 seconds. SCCP phones set for the minimum HRNI of 5 seconds may experience a Hold Reversion Notification ring delay of 10 seconds when handling calls involving SIP phones.
  • Field Name: hcsCucmCcTagLine.hrInterval
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Call Forward No Coverage
  • Field Name: callForwardNoCoverage
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward No Coverage External Destination The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage external Calling Search Space is used to forward the call to the Forward No Coverage external destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoCoverage.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Coverage External Enabled The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage external Calling Search Space is used to forward the call to the Forward No Coverage external destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoCoverage.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Coverage External Calling Search Space * The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage external Calling Search Space is used to forward the call to the Forward No Coverage external destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoCoverage.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Call Forward Not Registered
  • Field Name: callForwardNotRegistered
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Call Forward Unregistered External Destination This field applies to unregistered external DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: hcsCucmCcTagLine.callForwardNotRegistered.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Call Forward Unregistered External Voice Mail Enabled This field applies to unregistered external DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: hcsCucmCcTagLine.callForwardNotRegistered.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Call Forward Unregistered CSS External * This field applies to unregistered external DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: hcsCucmCcTagLine.callForwardNotRegistered.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Usage * For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
  • Field Name: hcsCucmCcTagLine.usage
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["CallPark", "Conference", "Device", "Translation", "Call Pick Up Group", "Route", "Message Waiting", "Hunt Pilot", "Voice Mail Port", "Domain Routing", "IPAddress Routing", "Device template", "Directed Call Park", "Device Intercom", "Translation Intercom", "Translation Calling Party Number", "Mobility Handoff", "Mobility Enterprise Feature Access", "Mobility IVR", "Device Intercom Template", "Called Party Number Transformation", "Call Control Discovery Learned Pattern", "Uri Routing", "ILS Learned Enterprise Number", "ILS Learned E164 Number", "ILS Learned Enterprise Numeric Pattern", "ILS Learned E164 Numeric Pattern", "Alternate Number", "ILS Learned URI", "ILS Learned PSTN Failover Rule", "ILS Imported E164 Number", "Centralized Conference Number", "Emergency Location ID Number"]
Hold Reversion Ring Duration (seconds) Enter a number from 0 to 1200 (inclusive) to specify the wait time in seconds before issuing a reverted call alert to the holding party phone. If you enter a value of 0, Cisco Unified Communications Manager does not invoke the reverted call feature for a held call. At installation, this field remains blank. If you leave this setting blank, the Hold Reversion Duration timer setting for the cluster applies.
  • Field Name: hcsCucmCcTagLine.hrDuration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Park Mon Forward No Retrieve Vm Enabled When the parkee is an external party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an external party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: hcsCucmCcTagLine.parkMonForwardNoRetrieveVmEnabled
  • Type: Boolean
  • Cardinality: [0..1]
Alerting Name Enter a name that you want to display on the phone of the caller when the called phone is ringing. This setting, which supports the Identification Services for the QSIG protocol, applies to shared and nonshared directory numbers. When the phone rings at the terminating PINX, if you configured an alerting name for a directory number with shared-line appearances, the system performs the following tasks: Forwards the alerting name of the called party, if configured, to the caller. Applies the Connected Name Restrictions (CONR) that are configured for the translation pattern (if restrictions exist) Depending on the state of the call and your configuration, the alerting name, directory number, or display (internal caller ID) configuration may display on the phone, as described in the following bullets. Alerting state—The alerting name displays, as configured in the Directory Number window. Connected state—If you configure the Display (Internal Caller ID) and the Alerting Name fields, the display (internal caller ID) name displays. Connected State—If you configured the Alerting Name field but not the Display (Internal Caller ID) field, the directory number displays. If you set the Always Display Original Dialed Number service parameter to True, the original dialed number and the alerting name displays during the call. You can choose if the alerting name for the original dialed number or the translated dialed number is displayed using the Cisco CallManager service parameter called Name Display for Original Dialed Number When Translated. The default setting displays the alerting name of the original dialed number before translation. Caution    Do not use the following strings anywhere in your Alerting Name or ASCII Alerting Name: Alert(—Use of "Alert(" returns a security protocol error. Voicemail—Use of this word can cause Cisco Unity Connection to process the call as a direct call rather than as a forwarded one.
  • Field Name: hcsCucmCcTagLine.alertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Description Enter a description of the directory number and route partition. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), or angle brackets (<>).
  • Field Name: hcsCucmCcTagLine.description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Directory UR Is While updating, send all the URIs
  • Field Name: directoryURIs
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Directory Uri
  • Field Name: directoryUri.[n]
  • Type: Array
Is Primary *
  • Field Name: hcsCucmCcTagLine.directoryURIs.directoryUri.[n].isPrimary
  • Type: Boolean
  • Cardinality: [1..1]
Uri *
  • Field Name: hcsCucmCcTagLine.directoryURIs.directoryUri.[n].uri
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Advertise Globally Via Ils Default: True
  • Field Name: hcsCucmCcTagLine.directoryURIs.directoryUri.[n].advertiseGloballyViaIls
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Partition *
  • Field Name: hcsCucmCcTagLine.directoryURIs.directoryUri.[n].partition
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
AAR Voice Mail Enabled The settings in this row of fields specify treatment of calls for which insufficient bandwidth exists to reach the destination. Automated alternate routing (AAR) handles these calls that are routed to the AAR Destination Mask or Voice Mail. Configure the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Coverage/Destination box and Calling Search Space. AAR Destination Mask—Use this setting instead of the external phone number mask to determine the AAR Destination to be dialed. AAR Group—This setting provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None indicates that no rerouting of blocked calls will be attempted.
  • Field Name: hcsCucmCcTagLine.aarVoiceMailEnabled
  • Type: Boolean
  • Cardinality: [0..1]
Call Control Agent Profile Select the Call Control Agent Profile to associate to the directory number user. Configure a Call Control Agent Profile from the Advanced Features > Call Control Agent Profile menu.
  • Field Name: hcsCucmCcTagLine.callControlAgentProfile
  • Type: String
  • Cardinality: [0..1]
Calling Search Space No Retrieve Internal When the parkee is an internal party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an internal party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: hcsCucmCcTagLine.parkMonForwardNoRetrieveIntCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Park Monitoring Forward No Retrieve Destination External When the parkee is an external party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an external party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: hcsCucmCcTagLine.parkMonForwardNoRetrieveDn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
Allow Control of Device from CTI Check this check box to allow CTI to control and monitor a line on a device with which this directory number is associated If the directory number specifies a shared line, ensure the check box is enabled as long as at least one associated device specifies a combination of device type and protocol that CTI supports. Default: True
  • Field Name: hcsCucmCcTagLine.allowCtiControlFlag
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Default Activated Device Name This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
  • Field Name: hcsCucmCcTagLine.defaultActivatedDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Park Monitoring Reversion Timer This parameter determines the number of seconds that Cisco Unified Communications Manager waits before prompting the user to retrieve a call that the user parked. This timer starts when the user presses the Park softkey on the phone, and a reminder is issued when the timer expires. The default is 60 seconds. Note    If you configure a non-zero value, this value overrides the value of this parameter set in the Service Parameters window. However, if you configure a value of 0 here, then the value in the Service Parameters window will be used.
  • Field Name: hcsCucmCcTagLine.parkMonReversionTimer
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Release Clause Default: No Error
  • Field Name: hcsCucmCcTagLine.releaseClause
  • Type: String
  • Cardinality: [0..1]
  • Default: No Error
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
E164Alt Num Applicable only for Update and Get Request
  • Field Name: e164AltNum
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Num Mask
  • Field Name: hcsCucmCcTagLine.e164AltNum.numMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Add Local Route Partition
  • Field Name: hcsCucmCcTagLine.e164AltNum.addLocalRoutePartition
  • Type: Boolean
  • Cardinality: [0..1]
Advertise Globally Ils Default: True
  • Field Name: hcsCucmCcTagLine.e164AltNum.advertiseGloballyIls
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Route Partition
  • Field Name: hcsCucmCcTagLine.e164AltNum.routePartition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Is Urgent
  • Field Name: hcsCucmCcTagLine.e164AltNum.isUrgent
  • Type: Boolean
  • Cardinality: [0..1]
Call Forward All
  • Field Name: callForwardAll
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Secondary Calling Search Space for Forward All Because call forwarding is a line-based feature, in cases where the device calling search space is unknown, the system uses only the line calling search space to forward the call. If the line calling search space is restrictive and not routable, the forward attempt fails. Addition of a secondary calling search space for Call Forward All provides a solution to enable forwarding. The primary calling search space for Call Forward All and secondary calling search space for Call Forward All get concatenated (Primary CFA CSS + Secondary CFA CSS). Cisco Unified Communications Manager uses this combination to validate the CFA destination and to forward the call. See the description for the Calling Search Space field for information about how the combination of Primary and Secondary CFA CSSs works
  • Field Name: hcsCucmCcTagLine.callForwardAll.secondaryCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Forward All Destination The settings in this row of fields specify the forwarding treatment for calls to this directory number if the directory number is set to forward all calls. The Calling Search Space field gets used to validate the Forward All destination that is entered when the user activates Call Forward All from the phone. This field also gets used to redirect the call to the Call Forward All destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting indicates the directory number to which all calls are forwarded. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: hcsCucmCcTagLine.callForwardAll.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward All Voice Mail Enabled The settings in this row of fields specify the forwarding treatment for calls to this directory number if the directory number is set to forward all calls. The Calling Search Space field gets used to validate the Forward All destination that is entered when the user activates Call Forward All from the phone. This field also gets used to redirect the call to the Call Forward All destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting indicates the directory number to which all calls are forwarded. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: hcsCucmCcTagLine.callForwardAll.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward All Calling Search Space * The settings in this row of fields specify the forwarding treatment for calls to this directory number if the directory number is set to forward all calls. The Calling Search Space field gets used to validate the Forward All destination that is entered when the user activates Call Forward All from the phone. This field also gets used to redirect the call to the Call Forward All destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting indicates the directory number to which all calls are forwarded. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: hcsCucmCcTagLine.callForwardAll.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Search Space No Retrieve External When the parkee is an external party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an external party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: hcsCucmCcTagLine.parkMonForwardNoRetrieveCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Active To view this check box on the Directory Number Configuration window, access an unassigned directory number from the Route Plan Report window. Checking this check box allows calls to this DN to be forwarded (if forwarding is configured). If check box is not checked, Cisco Unified Communications Manager ignores the DN. Default: True
  • Field Name: hcsCucmCcTagLine.active
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Voice Mail Profile Choose from list of Voice Mail Profiles that the Voice Mail Profile Configuration defines. The first option specifies <None>, which represents the current default Voice Mail Profile that is configured in the Voice Mail Profile Configuration.
  • Field Name: hcsCucmCcTagLine.voiceMailProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/VoiceMailProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Use Enterprise Alt Num Click Add Enterprise Alternate Number to add an enterprise alternate number and associate it to this directory number. Click Add +E.164 Alternate Number to add an +E.164 alternate number and associate it to this directory number.
  • Field Name: hcsCucmCcTagLine.useEnterpriseAltNum
  • Type: Boolean
  • Cardinality: [0..1]
Pstn Failover
  • Field Name: hcsCucmCcTagLine.pstnFailover
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["", "Enterprise Number", "+E.164 Number"]
Park Monitoring Forward No Retrieve Destination Internal When the parkee is an internal party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an internal party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: hcsCucmCcTagLine.parkMonForwardNoRetrieveIntDn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
Enterprise Alt Num Applicable only for Update and Get Request
  • Field Name: enterpriseAltNum
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Num Mask
  • Field Name: hcsCucmCcTagLine.enterpriseAltNum.numMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Add Local Route Partition
  • Field Name: hcsCucmCcTagLine.enterpriseAltNum.addLocalRoutePartition
  • Type: Boolean
  • Cardinality: [0..1]
Advertise Globally Ils Default: True
  • Field Name: hcsCucmCcTagLine.enterpriseAltNum.advertiseGloballyIls
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Route Partition
  • Field Name: hcsCucmCcTagLine.enterpriseAltNum.routePartition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Is Urgent
  • Field Name: hcsCucmCcTagLine.enterpriseAltNum.isUrgent
  • Type: Boolean
  • Cardinality: [0..1]
Call Forward Busy Int
  • Field Name: callForwardBusyInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward Busy Internal Destination The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for internal calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for internal calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy internal Calling Search Space is used to forward the call to the Forward Busy Internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: hcsCucmCcTagLine.callForwardBusyInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward Busy Internal Enabled The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for internal calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for internal calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy internal Calling Search Space is used to forward the call to the Forward Busy Internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: hcsCucmCcTagLine.callForwardBusyInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward Busy Internal Calling Search Space * The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for internal calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for internal calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy internal Calling Search Space is used to forward the call to the Forward Busy Internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: hcsCucmCcTagLine.callForwardBusyInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Call Forward No Answer Int
  • Field Name: callForwardNoAnswerInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
No Answer Ring Duration (seconds) Used in conjunction with Call Forward No Answer Destination, this field sets the timer for how long the phone will ring before it gets forwarded. Leave this setting blank to use the value that is set in the Cisco CallManager service parameter, Forward No Answer Timer. Caution    By default, Cisco Unified Communications Manager makes the time for the T301 timer longer than the No Answer Ring Duration time; if the set time for the T301 timer expires before the set time for the No Answer Ring Duration expires, the call ends, and no call forwarding can occur. If you choose to do so, you can configure the time for the No Answer Ring Duration to be greater than the time for the T301 timer. For information on the T301 timer, choose System > Service Parameters; choose the server, the Cisco CallManager service, and then the parameter in the window that displays.
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswerInt.duration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Forward No Answer Internal Destination
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswerInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Answer Internal Enabled The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an internal call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer internal Calling Search Space is used to forward the call to the Forward No Answer internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswerInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Answer Internal Calling Search Space * The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an internal call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer internal Calling Search Space is used to forward the call to the Forward No Answer internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoAnswerInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
ASCII Alerting Name This field provides the same information as the Alerting Name field, but you must limit input to ASCII characters. Devices that do not support Unicode (internationalized) characters display the content of the Alerting Name ASCII field. Caution    Do not use the following strings anywhere in your Alerting Name or ASCII Alerting Name: Alert(—Use of "Alert(" returns a security protocol error. Voicemail—Use of this word can cause Cisco Unity Connection to process the call as a direct call rather than as a forwarded one.
  • Field Name: hcsCucmCcTagLine.asciiAlertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 32
Network Hold MOH Audio Source Choose the audio source that plays when the network initiates a hold action.
  • Field Name: hcsCucmCcTagLine.networkHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Pattern Urgency If the dial plan contains overlapping patterns, Cisco Unified Communications Manager does not route the call to the device associated with the directory number until the interdigit timer expires (even if the directory number is a better match for the sequence of digits dialed as compared to the overlapping pattern). Check this check box to interrupt interdigit timing when Cisco Unified Communications Manager must route a call immediately to the device associated with the directory number. By default, the Urgent Priority check box is unchecked.
  • Field Name: hcsCucmCcTagLine.patternUrgency
  • Type: Boolean
  • Cardinality: [0..1]
AAR Group The settings in this row of fields specify treatment of calls for which insufficient bandwidth exists to reach the destination. Automated alternate routing (AAR) handles these calls that are routed to the AAR Destination Mask or Voice Mail. Configure the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Coverage/Destination box and Calling Search Space. AAR Destination Mask—Use this setting instead of the external phone number mask to determine the AAR Destination to be dialed. AAR Group—This setting provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None indicates that no rerouting of blocked calls will be attempted.
  • Field Name: hcsCucmCcTagLine.aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Park Mon Forward No Retrieve Int Vm Enabled When the parkee is an internal party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an internal party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: hcsCucmCcTagLine.parkMonForwardNoRetrieveIntVmEnabled
  • Type: Boolean
  • Cardinality: [0..1]
Call Forward No Coverage Int
  • Field Name: callForwardNoCoverageInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward No Coverage Internal Destination The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage internal Calling Search Space is used to forward the call to the Forward No Coverage internal destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoCoverageInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Coverage Internal Enabled The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage internal Calling Search Space is used to forward the call to the Forward No Coverage internal destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: hcsCucmCcTagLine.callForwardNoCoverageInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Coverage Internal Calling Search Space *
  • Field Name: hcsCucmCcTagLine.callForwardNoCoverageInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Call Forward Alternate Party
  • Field Name: callForwardAlternateParty
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
MLPP No Answer Ring Duration (seconds) Enter the number of seconds (between 4 and 60) after which an MLPP precedence call will be directed to this directory number alternate party if this directory number and its call-forwarding destination have not answered the precedence call. Leave this setting blank to use the value that is set in the Cisco Unified Communications Manager enterprise parameter, Precedence Alternate Party Timeout.
  • Field Name: hcsCucmCcTagLine.callForwardAlternateParty.duration
  • Type: Integer
  • Cardinality: [0..1]
Target (Destination) Enter the number to which MLPP precedence calls should be diverted if this directory number receives a precedence call and neither this number nor its call forward destination answers the precedence call. Values can include numeric characters, octothorpe (#), and asterisk (*).
  • Field Name: hcsCucmCcTagLine.callForwardAlternateParty.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
MLPP Calling Search Space * From the drop-down list box, choose the calling search space to associate with the MLPP alternate party target (destination) number.
  • Field Name: hcsCucmCcTagLine.callForwardAlternateParty.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Use E164Alt Num In the text box, enter a number mask for the enterprise alternate number or +E.164 alternate number. This field can contain only digits 0-9, X and the plus sign (+). If the Number Mask contains a plus sign, the plus sign must be the first character in the mask. Refer to the Alternate Number field to see how the alternate number appears after the mask is applied. Cisco Unified Communications Manager applies the mask to the directory number and creates an enterprise alternate number or +E.164 alternate number that acts as an alias for the directory number. Other phones can dial this directory number by dialing the enterprise number. Enterprise Alternate Number Example If you apply a number mask of 8XXXX to directory number 2000, Cisco Unified Communications Manager creates an enterprise alternate number 82000 as an alias of directory number 2000. If the dialed digits of an incoming call are 82000, Cisco Unified Communications Manager routes the call to the user that is registered to directory number 2000. +E.164 Alternate Number Example If you apply a number mask of 1972515XXXX to directory number 2000, Cisco Unified Communications Manager creates an +E.164 alternate number 19725152000 as an alias of directory number 2000. If the dialed digits of an incoming call are 19725152000, Cisco Unified Communications Manager routes the call to the user that is registered to directory number 2000.
  • Field Name: hcsCucmCcTagLine.useE164AltNum
  • Type: Boolean
  • Cardinality: [0..1]
Calling Id Presentation When Diverted Default: Default
  • Field Name: hcsCucmCcTagLine.callingIdPresentationWhenDiverted
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
External Call Control Profile
  • Field Name: hcsCucmCcTagLine.externalCallControlProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/ExternalCallControlProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Hcs Cucm Cc Tag App User
  • Field Name: hcsCucmCcTagAppUser
  • Type: Object
Password Valid range is 1-127 characters.
  • Field Name: hcsCucmCcTagAppUser.password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Presence Group Name
  • Field Name: hcsCucmCcTagAppUser.presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Accept Presence Subscription
  • Field Name: hcsCucmCcTagAppUser.acceptPresenceSubscription
  • Type: Boolean
  • Cardinality: [0..1]
Password Credentials Not Applicable for Add. Credential configuration for password
  • Field Name: passwordCredentials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pwd Cred User Must Change
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdCredUserMustChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred User Cant Change
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdCredUserCantChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Time Changed Read Only
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdCredTimeChanged
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Time Admin Lockout Read Only
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdCredTimeAdminLockout
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pwd Cred Policy Name
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdCredPolicyName
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Locked By Administrator
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdCredLockedByAdministrator
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Reset Hack Count The tag will be ignored in add, while update you can reset the hack count.
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdResetHackCount
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Does Not Expire
  • Field Name: hcsCucmCcTagAppUser.passwordCredentials.pwdCredDoesNotExpire
  • Type: Boolean
  • Cardinality: [0..1]
Userid *
  • Field Name: hcsCucmCcTagAppUser.userid
  • Type: String
  • Cardinality: [1..1]
Accept Out Of Dialog Refer
  • Field Name: hcsCucmCcTagAppUser.acceptOutOfDialogRefer
  • Type: Boolean
  • Cardinality: [0..1]
Associated Devices Also known as controlled devices.
  • Field Name: associatedDevices
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Device Name of device.
  • Field Name: device.[n]
  • Type: Array
Cti Controlled Device Profiles
  • Field Name: ctiControlledDeviceProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Device Profile
  • Field Name: deviceProfile.[n]
  • Type: Array
Accept Unsolicited Notification
  • Field Name: hcsCucmCcTagAppUser.acceptUnsolicitedNotification
  • Type: Boolean
  • Cardinality: [0..1]
Allow Replace Header
  • Field Name: hcsCucmCcTagAppUser.allowReplaceHeader
  • Type: Boolean
  • Cardinality: [0..1]
Digest Credentials Valid range is 1-42 characters.
  • Field Name: hcsCucmCcTagAppUser.digestCredentials
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Associated Groups
  • Field Name: associatedGroups
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
User Group
  • Field Name: userGroup.[n]
  • Type: Array
Name * Name of User Group
  • Field Name: hcsCucmCcTagAppUser.associatedGroups.userGroup.[n].name
  • Type: ["String", "Null"]
  • Target: device/cucm/UserGroup
  • Target attr: name
  • Cardinality: [1..1]
  • MaxLength: 100
  • Format: uri
User Roles
  • Field Name: userRoles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
User Role READ ONLY: Name of the User role associated with the user group will be taken
  • Field Name: userRole.[n]
  • Type: Array
Hcs Cucm Cc Tag Dev Prof
  • Field Name: hcsCucmCcTagDevProf
  • Type: Object
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: hcsCucmCcTagDevProf.protocol
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["SCCP", "Digital Access PRI", "H.225", "Analog Access", "Digital Access T1", "Route Point", "Unicast Bridge", "Multicast Point", "Inter-Cluster Trunk", "RAS", "Digital Access BRI", "SIP", "MGCP", "Static SIP Mobile Subscriber", "SIP Connector", "Remote Destination", "Mobile Smart Client", "Digital Access E1 R2", "CTI Remote Device", "Protocol Not Specified"]
Always Use Prime Line For Voice Message From the drop-down list box, choose one of the following options: On—If the phone is idle, the primary line on the phone becomes the active line for retrieving voice messages when the phone user presses the Messages button on the phone. Off—If the phone is idle, pressing the Messages button on the phone automatically dials the voice-messaging system from the line that has a voice message. Cisco Unified Communications Manager always selects the first line that has a voice message. If no line has a voice message, the primary line gets used when the phone user presses the Messages button. Default— Cisco Unified Communications Manager uses the configuration from the Always Use Prime Line for Voice Message service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: hcsCucmCcTagDevProf.alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Lines
  • Field Name: lines
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Line An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
  • Field Name: line.[n]
  • Type: Array
Display Ascii
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].displayAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Associated Endusers
  • Field Name: associatedEndusers
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Enduser
  • Field Name: enduser.[n]
  • Type: Array
User Id *
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
Ring Setting Default: Ring
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].consecutiveRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Recording Profile Name
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/RecordingProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Index
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].ringSettingActivePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Link To Line Link to the line resource
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].line_link
  • Type: String
  • Format: link
Label
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Partition Usage This tag cannot be modified. It can only be specified in the add request. Default: General
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Recording Flag Default: Call Recording Disabled
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
  • Default: Call Recording Disabled
  • Choices: ["Call Recording Disabled", "Automatic Call Recording Enabled", "Selective Call Recording Enabled"]
Speed Dial
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
E164Mask
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Caller Number
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Inventory Filter Default: default
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].dirn.line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Pattern *
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mwl Policy Default: Use System Policy
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Policy
  • Choices: ["Use System Policy", "Light and Prompt", "Prompt Only", "Light Only", "None"]
Ring Setting Idle Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].ringSettingIdlePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: hcsCucmCcTagDevProf.lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Vendor Config
  • Field Name: vendorConfig
  • Type: ["Object", "Any"]
  • Cardinality: [0..1]
Always Use Prime Line From the drop-down list box, choose one of the following options: Off—When the phone is idle and receives a call on any line, the phone user answers the call from the line on which the call is received. On—When the phone is idle (off hook) and receives a call on any line, the primary line gets chosen for the call. Calls on other lines continue to ring, and the phone user must select those other lines to answer these calls. Default— Cisco Unified Communications Manager uses the configuration from the Always Use Prime Line service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: hcsCucmCcTagDevProf.alwaysUsePrimeLine
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
User Hold MOH Audio Source To specify the audio source that plays when a user initiates a hold action, choose an audio source from the User Hold MOH Audio Source drop-down list box. If you do not choose an audio source, Cisco Unified Communications Manager uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. Note    You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: hcsCucmCcTagDevProf.userHoldMohAudioSourceId
  • Type: ["Integer", "String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Phone Button Template * From the Phone Button Template drop-down list, choose a phone button template. Tip    If you want to configure BLF/SpeedDials for the profile for presence monitoring, choose a phone button template that you configured for BLF/SpeedDials. After you save the configuration, the Add a New BLF SD link displays in the Association Information pane. For more information on BLF/SpeedDials, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: hcsCucmCcTagDevProf.phoneTemplateName
  • Type: String
  • Target: device/cucm/PhoneButtonTemplate
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Blf Directed Call Parks
  • Field Name: blfDirectedCallParks
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Blf Directed Call Park
  • Field Name: blfDirectedCallPark.[n]
  • Type: Array
Index
  • Field Name: hcsCucmCcTagDevProf.blfDirectedCallParks.blfDirectedCallPark.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Label
  • Field Name: hcsCucmCcTagDevProf.blfDirectedCallParks.blfDirectedCallPark.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Directed Call Park Dn And Partition
  • Field Name: directedCallParkDnAndPartition
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Route Partition Name
  • Field Name: hcsCucmCcTagDevProf.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dn Pattern *
  • Field Name: hcsCucmCcTagDevProf.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: ["String", "Null"]
  • Target: device/cucm/DirectedCallPark
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
MLPP Preemption If this user device profile will be used for MLPP precedence calls, assign an MLPP Preemption setting to the device profile. This setting specifies whether a device that can preempt calls in progress will use the capability when it places an MLPP precedence call. From the drop-down list box, choose a setting to assign to this device profile from the following options: Default—This device profile inherits its MLPP preemption setting from the device pool of the associated device. Disabled—This device does not allow preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Forceful—This device allows preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Note    Do not configure a device profile with the following combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is set to Forceful. Default: Default
  • Field Name: hcsCucmCcTagDevProf.preemption
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Disabled", "Forceful", "Default"]
Add On Modules Additional modules attached to the Phone.There can be 0,1 or 2.
  • Field Name: addOnModules
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Add On Module
  • Field Name: addOnModule.[n]
  • Type: Array
  • Cardinality: [0..2]
Load Information * Load Information is either the module's specific load information or the default load information.If any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
  • Field Name: hcsCucmCcTagDevProf.addOnModules.addOnModule.[n].loadInformation
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Model * Model ID string. Default: 7914 14-Button Line Expansion Module
  • Field Name: hcsCucmCcTagDevProf.addOnModules.addOnModule.[n].model
  • Type: String
  • Cardinality: [1..1]
  • Default: 7914 14-Button Line Expansion Module
  • Choices: ["Cisco 30 SP+", "Cisco 12 SP+", "Cisco 12 SP", "Cisco 12 S", "Cisco 30 VIP", "Cisco 7910", "Cisco 7960", "Cisco 7940", "Cisco 7935", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco ATA 186", "EMCC Base Phone", "SCCP Phone", "Analog Access", "Digital Access", "Digital Access+", "Digital Access WS-X6608", "Analog Access WS-X6624", "VGC Gateway", "Conference Bridge", "Conference Bridge WS-X6608", "Cisco IOS Conference Bridge (HDV2)", "Cisco Conference Bridge (WS-SVC-CMM)", "H.323 Phone", "H.323 Gateway", "Music On Hold", "Device Pilot", "CTI Port", "CTI Route Point", "Voice Mail Port", "Cisco IOS Software Media Termination Point (HDV2)", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Video Conference Bridge (IPVC-35xx)", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Route List", "Load Simulator", "Media Termination Point", "Media Termination Point Hardware", "Cisco IOS Media Termination Point (HDV2)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco 7941", "Cisco 7971", "MGCP Station", "MGCP Trunk", "GateKeeper", "7914 14-Button Line Expansion Module", "Trunk", "Tone Announcement Player", "SIP Trunk", "SIP Gateway", "WSM Trunk", "Remote Destination Profile", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "CKEM 36-Button Line Expansion Module", "SPA8800", "Unknown MGCP Gateway", "Unknown", "Cisco 7985", "Cisco 7911", "Cisco 7961G-GE", "Cisco 7941G-GE", "Motorola CN622", "Third-party SIP Device (Basic)", "Cisco 7931", "Cisco Unified Personal Communicator", "Cisco 7921", "Cisco 7906", "Third-party SIP Device (Advanced)", "Cisco TelePresence", "Nokia S60", "Cisco 7962", "Cisco 3951", "Cisco 7937", "Cisco 7942", "Cisco 7945", "Cisco 7965", "Cisco 7975", "Cisco 3911", "Cisco Unified Mobile Communicator", "Cisco TelePresence 1000", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 500-37", "Cisco 7925", "Cisco 9971", "Cisco 6921", "Cisco 6941", "Cisco 6961", "Cisco Unified Client Services Framework", "Cisco TelePresence 1300-65", "Cisco TelePresence 1100", "Transnova S3", "BlackBerry MVS VoWifi", "Cisco 9951", "Cisco 8961", "Cisco 6901", "Cisco 6911", "Cisco ATA 187", "Cisco TelePresence 200", "Cisco TelePresence 400", "Cisco Dual Mode for iPhone", "Cisco 6945", "Cisco Dual Mode for Android", "Cisco 7926", "Cisco E20", "Generic Single Screen Room System", "Generic Multiple Screen Room System", "Cisco TelePresence EX90", "Cisco 8945", "Cisco 8941", "Generic Desktop Video Endpoint", "Cisco TelePresence 500-32", "Cisco TelePresence 1300-47", "Cisco 3905", "Cisco Cius", "VKEM 36-Button Line Expansion Module", "Cisco TelePresence TX1310-65", "Cisco TelePresence MCU", "Ascom IP-DECT Device", "Cisco TelePresence Exchange System", "Cisco TelePresence EX60", "Cisco TelePresence Codec C90", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C40", "Cisco TelePresence Quick Set C20", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence MX200", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco 7821", "Cisco 7841", "Cisco 7861", "Cisco TelePresence SX20", "Cisco TelePresence MX300", "IMS-integrated Mobile (Basic)", "Third-party AS-SIP Endpoint", "Cisco Cius SP", "Cisco TelePresence Profile 42 (C40)", "Cisco VXC 6215", "CTI Remote Device", "Usage Profile", "Carrier-integrated Mobile", "Universal Device Template", "Cisco DX650", "Cisco Unified Communications for RTX", "Cisco Jabber for Tablet", "Cisco 8831", "Cisco ATA 190", "Cisco TelePresence SX10", "Cisco 8841", "Cisco 8851", "Cisco 8861", "Cisco TelePresence SX80", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300 G2", "Cisco 7905", "Cisco 7920", "Cisco 7970", "Cisco 7912", "Cisco 7902", "Cisco IP Communicator", "Cisco 7961", "Cisco 7936", "Analog Phone", "ISDN BRI Phone", "SCCP gateway virtual phone", "IP-STE", "Cisco TelePresence Conductor", "Cisco DX80", "Cisco DX70", "BEKEM 36-Button Line Expansion Module", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence IX5000", "Cisco 7811", "Cisco 8821", "Cisco 8811", "Interactive Voice Response", "Cisco 8845", "Cisco 8865", "Cisco TelePresence MX800 Dual", "Cisco 8851NR", "Cisco Spark Remote Device", "Cisco Webex DX80", "Cisco TelePresence DX70", "Cisco 7832", "Cisco 8865NR", "Cisco Meeting Server", "Cisco Webex Room Kit", "Cisco Webex Room 55", "Cisco Webex Room Kit Plus", "CP-8800-Video 28-Button Key Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "Cisco 8832", "Cisco Webex Room 70 Single", "Cisco 8832NR", "Cisco ATA 191", "Cisco Collaboration Mobile Convergence", "Cisco Webex Room 70 Dual", "Cisco Webex Room Kit Pro", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Single G2", "Cisco Webex Room 70 Dual G2", "SIP Station", "Cisco Webex Room Kit Mini", "Cisco Webex VDI Svc Framework", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex Desk Pro", "Cisco Webex Room Panorama", "Cisco Webex Room 70 Panorama", "Cisco Webex Room Phone", "Cisco 860", "Cisco Webex Desk LE"]
Module2 Choose the appropriate expansion module or None.
  • Field Name: hcsCucmCcTagDevProf.addOnModules.addOnModule.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Single Button Barge From the drop-down list box, choose from the following options: Off—This device does not allow users to use the Single Button Barge/cBarge feature. Barge—Choosing this option allows users to press the Single Button Barge shared-line button on the phone to barge into a call using Barge. Default—This device inherits the Single Button Barge/cBarge setting from the service parameter and device pool settings. Note    If the server parameter and device pool settings are different, the device will inherit the setting from the service parameter setting. For more information, see the Cisco Unified Communications Manager Features and Services Guide. Default: Default
  • Field Name: hcsCucmCcTagDevProf.singleButtonBarge
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "Barge", "CBarge", "Default"]
Feature Control Policy This tag is valid only for RT Phones.
  • Field Name: hcsCucmCcTagDevProf.featureControlPolicy
  • Type: ["String", "Null"]
  • Target: device/cucm/FeatureControlPolicy
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
MLPP Indication If this user device profile will be used for MLPP precedence calls, assign an MLPP Indication setting to the device profile. This setting specifies whether a device that can play precedence tones will use the capability when it places an MLPP precedence call. From the drop-down list box, choose a setting to assign to this device profile from the following options: Default—This device profile inherits its MLPP indication setting from the device pool of the associated device. Off—This device does not handle nor process indication of an MLPP precedence call. On—This device profile does handle and process indication of an MLPP precedence call. Note    Do not configure a device profile with the following combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is set to Forceful. Default: Off
  • Field Name: hcsCucmCcTagDevProf.mlppIndicationStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Off
  • Choices: ["Off", "On", "Default"]
Busy Lamp Fields
  • Field Name: busyLampFields
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Busy Lamp Field
  • Field Name: busyLampField.[n]
  • Type: Array
Index
  • Field Name: hcsCucmCcTagDevProf.busyLampFields.busyLampField.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Blf Dest Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: hcsCucmCcTagDevProf.busyLampFields.busyLampField.[n].blfDest
  • Type: String
  • Cardinality: [1..1]
Call Pickup
  • Field Name: hcsCucmCcTagDevProf.busyLampFields.busyLampField.[n].callPickup
  • Type: Boolean
Label
  • Field Name: hcsCucmCcTagDevProf.busyLampFields.busyLampField.[n].label
  • Type: String
  • Cardinality: [0..1]
Route Partition
  • Field Name: hcsCucmCcTagDevProf.busyLampFields.busyLampField.[n].routePartition
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Blf Dirn Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: hcsCucmCcTagDevProf.busyLampFields.busyLampField.[n].blfDirn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Type Device profile Type string. Read Only
  • Field Name: hcsCucmCcTagDevProf.type
  • Type: String
  • Cardinality: [0..1]
Product * Product ID string. read-only except when creating a device.
  • Field Name: hcsCucmCcTagDevProf.product
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["7914 14-Button Line Expansion Module", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "AIM-VOICE-30", "Analog Phone", "Annunciator", "BEKEM 36-Button Line Expansion Module", "C881V", "C887VA-V", "CKEM 36-Button Line Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "CP-8800-Video 28-Button Key Expansion Module", "CTI Port", "CTI Remote Device", "CTI Route Point", "Carrier-integrated Mobile", "Cisco IAD2400", "Cisco 12 S", "Cisco 12 SP", "Cisco 12 SP+", "Cisco 1751", "Cisco 1760", "Cisco 1861", "Cisco 269X", "Cisco 26XX", "Cisco 2801", "Cisco 2811", "Cisco 2821", "Cisco 2851", "Cisco 2901", "Cisco 2911", "Cisco 2921", "Cisco 2951", "Cisco 30 SP+", "Cisco 30 VIP", "Cisco 362X", "Cisco 364X", "Cisco 366X", "Cisco 3725", "Cisco 3745", "Cisco 3825", "Cisco 3845", "Cisco 3905", "Cisco 3911", "Cisco 3925", "Cisco 3925E", "Cisco 3945", "Cisco 3945E", "Cisco 3951", "Cisco 6901", "Cisco 6911", "Cisco 6921", "Cisco 6941", "Cisco 6945", "Cisco 6961", "Cisco 7811", "Cisco 7821", "Cisco 7832", "Cisco 7841", "Cisco 7861", "Cisco 7902", "Cisco 7905", "Cisco 7906", "Cisco 7910", "Cisco 7911", "Cisco 7912", "Cisco 7920", "Cisco 7921", "Cisco 7925", "Cisco 7926", "Cisco 7931", "Cisco 7935", "Cisco 7936", "Cisco 7937", "Cisco 7940", "Cisco 7941", "Cisco 7941G-GE", "Cisco 7942", "Cisco 7945", "Cisco 7960", "Cisco 7961", "Cisco 7961G-GE", "Cisco 7962", "Cisco 7965", "Cisco 7970", "Cisco 7971", "Cisco 7975", "Cisco 7985", "Cisco 860", "Cisco 881", "Cisco 8811", "Cisco 8821", "Cisco 8831", "Cisco 8832", "Cisco 8832NR", "Cisco 8841", "Cisco 8845", "Cisco 8851", "Cisco 8851NR", "Cisco 8861", "Cisco 8865", "Cisco 8865NR", "Cisco 888/887/886", "Cisco 8941", "Cisco 8945", "Cisco 8961", "Cisco 9951", "Cisco 9971", "Cisco ATA 186", "Cisco ATA 187", "Cisco ATA 190", "Cisco ATA 191", "Cisco C8200/L-1N-4T", "Cisco C8300-1N1S-4T2X", "Cisco C8300-1N1S-6T", "Cisco C8300-2N2S-4T2X/6T", "Cisco Catalyst 4000 Access Gateway Module", "Cisco Catalyst 4224 Voice Gateway Switch", "Cisco Catalyst 6000 12 port FXO Gateway", "Cisco Catalyst 6000 24 port FXS Gateway", "Cisco Catalyst 6000 E1 VoIP Gateway", "Cisco Catalyst 6000 T1 VoIP Gateway", "Cisco Cius", "Cisco Cius SP", "Cisco Collaboration Mobile Convergence", "Cisco Conference Bridge (WS-SVC-CMM)", "Cisco Conference Bridge Hardware", "Cisco Conference Bridge Software", "Cisco DX650", "Cisco DX70", "Cisco DX80", "Cisco Dual Mode for Android", "Cisco Dual Mode for iPhone", "Cisco E20", "Cisco ENCS 5400 ISRV", "Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge", "Cisco IOS Enhanced Media Termination Point", "Cisco IOS Enhanced Software Media Termination Point", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Cisco IOS Media Termination Point", "Cisco IP Communicator", "Cisco ISR 4321", "Cisco ISR 4331", "Cisco ISR 4351", "Cisco ISR 4431", "Cisco ISR 4451", "Cisco ISR 4461", "Cisco Jabber for Tablet", "Cisco MGCP BRI Port", "Cisco MGCP E1 Port", "Cisco MGCP FXO Port", "Cisco MGCP FXS Port", "Cisco MGCP T1 Port", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco Media Termination Point Hardware", "Cisco Media Termination Point Software", "Cisco Meeting Server", "Cisco SIP FXS Port", "Cisco Spark Remote Device", "Cisco TelePresence", "Cisco TelePresence 1000", "Cisco TelePresence 1100", "Cisco TelePresence 1300-47", "Cisco TelePresence 1300-65", "Cisco TelePresence 200", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 400", "Cisco TelePresence 500-32", "Cisco TelePresence 500-37", "Cisco TelePresence Codec C40", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C90", "Cisco TelePresence Conductor", "Cisco TelePresence DX70", "Cisco TelePresence EX60", "Cisco TelePresence EX90", "Cisco TelePresence Exchange System", "Cisco TelePresence IX5000", "Cisco TelePresence MCU", "Cisco TelePresence MX200", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300", "Cisco TelePresence MX300 G2", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence MX800 Dual", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C40)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence Quick Set C20", "Cisco TelePresence SX10", "Cisco TelePresence SX20", "Cisco TelePresence SX80", "Cisco TelePresence TX1310-65", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco Unified Client Services Framework", "Cisco Unified Communications for RTX", "Cisco Unified Mobile Communicator", "Cisco Unified Personal Communicator", "Cisco VG200", "Cisco VG248 Gateway", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco VGD-1T3", "Cisco VXC 6215", "Cisco Video Conference Bridge(IPVC-35xx)", "Cisco Voice Mail Port", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex DX80", "Cisco Webex Desk LE", "Cisco Webex Desk Pro", "Cisco Webex Room 55", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Dual", "Cisco Webex Room 70 Dual G2", "Cisco Webex Room 70 Panorama", "Cisco Webex Room 70 Single", "Cisco Webex Room 70 Single G2", "Cisco Webex Room Kit", "Cisco Webex Room Kit Mini", "Cisco Webex Room Kit Plus", "Cisco Webex Room Kit Pro", "Cisco Webex Room Panorama", "Cisco Webex Room Phone", "Cisco Webex VDI Svc Framework", "Communication Media Module", "EMCC Base Phone", "FLEX_SLOT", "Gatekeeper", "Generic Desktop Video Endpoint", "Generic Multiple Screen Room System", "Generic Single Screen Room System", "H.225 Trunk (Gatekeeper Controlled)", "H.323 Client", "H.323 Gateway", "Hunt List", "IAD2400_ANALOG", "IAD2400_DIGITAL", "IMS-integrated Mobile (Basic)", "IP-STE", "ISDN BRI Phone", "Inter-Cluster Trunk (Gatekeeper Controlled)", "Inter-Cluster Trunk (Non-Gatekeeper Controlled)", "Interactive Voice Response", "Load Simulator", "Motorola CN622", "Music On Hold", "NM-1V", "NM-2V", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT", "NM-HDV2-2PORT", "Nokia S60", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "Pilot", "Remote Destination Profile", "Route List", "SCCP Device", "SCCP gateway virtual phone", "SIP Trunk", "SIP WSM Connection", "SPA8800", "Third-party AS-SIP Endpoint", "Third-party SIP Device (Advanced)", "Third-party SIP Device (Basic)", "Transnova S3", "Universal Device Template", "Unknown", "VG202", "VG204", "VG224", "VG310", "VG320", "VG350", "VG400", "VG420", "VG450", "VGC Port", "VIC_SLOT", "VKEM 36-Button Line Expansion Module", "VNM-HDA", "VWIC_SLOT", "WS-SVC-CMM-MS", "WS-X6600"]
Description Enter a description of the device profile. For text, use anything that describes this particular user device profile.
  • Field Name: hcsCucmCcTagDevProf.description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Trace Flag
  • Field Name: hcsCucmCcTagDevProf.traceFlag
  • Type: Boolean
  • Cardinality: [0..1]
Ignore Presentation Indicators (internal calls only) To configure call display restrictions and ignore any presentation restriction that is received for internal calls, check the "Ignore Presentation Indicators (internal calls only)" check box. Tip    Use this configuration in combination with the calling line ID presentation and connected line ID presentation configuration at the translation pattern level. Together, these settings allow you to configure call display restrictions to selectively present or block calling and/or connected line display information for each call. For more information about call display restrictions, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: hcsCucmCcTagDevProf.ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
User Locale From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information, including language and font, to support users. Cisco Unified Communications Manager makes this field available only for phone models that support localization. Note    If no user locale is specified, Cisco Unified Communications Manager uses the user locale that is associated with the device pool. Note    If the users require information to display (on the phone) in any language other than English, verify that the locale installer is installed before configuring user locale. See the Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: hcsCucmCcTagDevProf.userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Join Across Lines From the drop-down list box, choose from the following options: Off—This device does not allow users to use the Join Across Lines feature. On—This device allows users to join calls across multiple lines. Default—This device inherits the Join Across Lines setting from the service parameter and device pool settings. Note    If the server parameter and device pool settings are different, the device will inherit the setting from the service parameter setting. For more information, see the Cisco Unified Communications Manager System Guide. Default: Default
  • Field Name: hcsCucmCcTagDevProf.joinAcrossLines
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Speeddials
  • Field Name: speeddials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Speeddial
  • Field Name: speeddial.[n]
  • Type: Array
Index
  • Field Name: hcsCucmCcTagDevProf.speeddials.speeddial.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Dirn *
  • Field Name: hcsCucmCcTagDevProf.speeddials.speeddial.[n].dirn
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Label
  • Field Name: hcsCucmCcTagDevProf.speeddials.speeddial.[n].label
  • Type: String
  • Cardinality: [1..1]
Class * Class ID string. Class information is read-only except when creating a device. Default: Device Profile
  • Field Name: hcsCucmCcTagDevProf.class
  • Type: String
  • Cardinality: [1..1]
  • Default: Device Profile
  • Choices: ["Phone", "Gateway", "Conference Bridge", "Media Termination Point", "Route List", "Voice Mail", "CTI Route Point", "Music On Hold", "Simulation", "Pilot", "GateKeeper", "Add-on modules", "Hidden Phone", "Trunk", "Tone Announcement Player", "Remote Destination Profile", "EMCC Base Phone Template", "EMCC Base Phone", "Remote Destination Profile Template", "Gateway Template", "UDP Template", "Phone Template", "Device Profile", "Invalid", "Interactive Voice Response"]
DND Option When you enable DND on the phone, this parameter allows you to specify how the DND feature handles incoming calls: Call Reject—This option specifies that no incoming call information gets presented to the user. Depending on how you configure the DND Incoming Call Alert parameter, the phone may play a beep or display a flash notification of the call. Ringer Off—This option turns off the ringer, but incoming call information gets presented to the device, so that the user can accept the call. Use Common Phone Profile Setting—This option specifies that the DND Option setting from the Common Phone Profile window will get used for this device. Note    For 7940/7960 phones that are running SCCP, you can only choose the Ringer Off option. For mobile devices and dual-mode phones, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. Default: Ringer Off
  • Field Name: hcsCucmCcTagDevProf.dndOption
  • Type: String
  • Cardinality: [0..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
Do Not Disturb Check this check box to enable Do Not Disturb.
  • Field Name: hcsCucmCcTagDevProf.dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Name * The device name,using only URL-friendly characters
  • Field Name: hcsCucmCcTagDevProf.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
DND Incoming Call Alert When you enable the DND Ringer Off or Call Reject option, this parameter specifies how a call displays on a phone. From the drop-down list, choose one of the following options: None—This option specifies that the DND Incoming Call Alert setting from the Common Phone Profile window will get used for this device. Disable—This option disables both beep and flash notification of a call but for the DND Ringer Off option, incoming call information still gets displayed. For the DND Call Reject option, no call alerts display and no information gets sent to the device. Beep Only—For an incoming call, this option causes the phone to play a beep tone only. Flash Only—For an incoming call, this option causes the phone to display a flash alert.
  • Field Name: hcsCucmCcTagDevProf.dndRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["Beep Only", "Flash Only", "Disable"]
Softkey Template From the Softkey Template drop-down list box, choose the softkey template from the list that displays.
  • Field Name: hcsCucmCcTagDevProf.softkeyTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/SoftKeyTemplate
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: hcsCucmCcTagDevProf.protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
Privacy From the Privacy drop-down list box, choose On for each phone on which you want privacy. For more information, see the Cisco Unified Communications Manager Features and Services Guide. Default: Default
  • Field Name: hcsCucmCcTagDevProf.callInfoPrivacyStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
MLPP Domain ID If this user device profile will be used for MLPP precedence calls, choose the MLLP Domain from the drop-down list box. Note    You define MLPP domains in the MLPP Domain Configuration window. For access, choose System > MLPP Domain.
  • Field Name: hcsCucmCcTagDevProf.mlppDomainId
  • Type: String
  • Target: device/cucm/MlppDomain
  • Target attr: domainId
  • Cardinality: [0..1]
  • MaxLength: 128
  • Pattern: ^[0-9a-fA-F]{6}|-1$
  • Format: uri
Services
  • Field Name: services
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Service
  • Field Name: service.[n]
  • Type: Array
Name *
  • Field Name: hcsCucmCcTagDevProf.services.service.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 100
Url
  • Field Name: hcsCucmCcTagDevProf.services.service.[n].url
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Service Name Ascii
  • Field Name: hcsCucmCcTagDevProf.services.service.[n].serviceNameAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Url Button Index
  • Field Name: hcsCucmCcTagDevProf.services.service.[n].urlButtonIndex
  • Type: Integer
  • Cardinality: [0..1]
Telecaster Service Name *
  • Field Name: hcsCucmCcTagDevProf.services.service.[n].telecasterServiceName
  • Type: String
  • Cardinality: [1..1]
Url Label
  • Field Name: hcsCucmCcTagDevProf.services.service.[n].urlLabel
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Login User Id From the Login User ID drop-down list box, choose a valid login user ID. Note    If the device profile is used as a logout profile, specify the login user ID that will be associated with the phone. After the user logs out from this user device profile, the phone will automatically log in to this login user ID.
  • Field Name: hcsCucmCcTagDevProf.loginUserId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Extension Mobility Cross Cluster CSS From the drop-down list box, choose an existing Calling Search Space (CSS) to use for this device profile for the Extension Mobility Cross Cluster feature. (To configure a new CSS or modify an existing CSS, choose Call Routing > Class of Control > Calling Search Space in Cisco Unified Communications Manager Administration.) Default value specifies None. The home administrator specifies this CSS, which gets used as the device CSS that gets assigned to the phone when the user logs in to this remote phone. For more information, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: hcsCucmCcTagDevProf.emccCallingSearchSpace
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Hcs Cucm Cc Tag End User
  • Field Name: hcsCucmCcTagEndUser
  • Type: Object
Confirm MLPP Password Confirm the MLPP password. Note    To confirm that you entered the MLPP Password correctly, re-enter the password in this field.
  • Field Name: hcsCucmCcTagEndUser.mlppPassword
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
  • MaxLength: 20
  • Pattern: ^[0-9]{4,20}$
Associated Pc This required field applies for Cisco IP Softphone users.
  • Field Name: hcsCucmCcTagEndUser.associatedPc
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Convert LDAP Synchronized User to Local User This check box appears for LDAP synchronized end users. Check this check box then save changes to convert an LDAP synchronized user to a local user.
  • Field Name: hcsCucmCcTagEndUser.convertUserAccount
  • Type: String
  • Cardinality: [0..1]
Customer Name This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
  • Field Name: hcsCucmCcTagEndUser.customerName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Confirm PIN Enter the PIN again.
  • Field Name: hcsCucmCcTagEndUser.pin
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Enable User for Unified CM IM and Presence (Configure IM and Presence in the associated UC Service Profile) Check this check box to enable the end user (on the home cluster) for IM and Presence. Configure IM and Presence in the associated service profile. Note    IM and Presence does not function properly if an end user is assigned to more than one home cluster. Note    You must install a Unified Communications Manager IM and Presence node along with this Unified Communications Manager cluster. Use the User Management > User Settings > UC Services menu to configure the IM and Presence service.
  • Field Name: hcsCucmCcTagEndUser.imAndPresenceEnable
  • Type: Boolean
  • Cardinality: [0..1]
Calendar Presence
  • Field Name: hcsCucmCcTagEndUser.calendarPresence
  • Type: Boolean
  • Cardinality: [0..1]
Associated Devices Also known as controlled devices.
  • Field Name: associatedDevices
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Device Name of device.
  • Field Name: device.[n]
  • Type: Array
Pager Number Enter the end user pager number. You may use the following special characters: (,), and -.
  • Field Name: hcsCucmCcTagEndUser.pagerNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Manager Enter the user ID of the end user manager ID. Tip    The manager user ID that you enter does not have to exist in the same cluster as the end user; therefore, Unified CM does not require that you enter a user ID that already exists in the database.
  • Field Name: hcsCucmCcTagEndUser.manager
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
SUBSCRIBE Calling Search Space Supported with the BLF Presence feature, the SUBSCRIBE calling search space determines how Unified Communications Manager routes presence requests that come from the end user. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the end user. From the drop-down list box, choose the SUBSCRIBE calling search space to use for presence requests for the end user. All calling search spaces that you configure in Cisco Unified CM Administration appear in the SUBSCRIBE Calling Search Space drop-down list box. If you do not select a different calling search space for the end user from the drop-down list box, the SUBSCRIBE calling search space defaults to None. To configure a SUBSCRIBE calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces.
  • Field Name: hcsCucmCcTagEndUser.subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
IPCC Extension From the drop-down list box, choose an IPCC extension for this end user. Note    This field appears only if the IPCC Express Installed enterprise parameter is set to True.
  • Field Name: hcsCucmCcTagEndUser.ipccExtension
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Home Cluster Check this check box if the end user is homed to this cluster. The end user should only be homed to one cluster within the enterprise. Note    After an upgrade to Unified Communications Manager Release 10.0(1), when new users are synced from LDAP, the home cluster is not enabled. You must modify your existing LDAP synchronization agreement and add a Feature Group Template which has the home cluster enabled. Default: True
  • Field Name: hcsCucmCcTagEndUser.homeCluster
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Maximum Wait Time for Desk Pickup Enter the maximum time in milliseconds that is permitted to pass before the user must pick up a call that is transferred from the mobile phone to desktop phone. Default: 10000
  • Field Name: hcsCucmCcTagEndUser.maxDeskPickupWaitTime
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 10000
Primary Extension Only DNs associated with the associatedDevices of the User can be used as primary extension.
  • Field Name: primaryExtension
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pattern * DN or Pattern
  • Field Name: hcsCucmCcTagEndUser.primaryExtension.pattern
  • Type: String
  • Target: device/cucm/Line
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Route Partition Name * Route Partition to which the DN is associated.
  • Field Name: hcsCucmCcTagEndUser.primaryExtension.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • MaxLength: 50
  • Format: uri
Directory Uri Enter the directory URI that you want to associate to this end user. A directory URI looks like an email address and follows the user@host format. For information about valid formats for directory URIs, see Directory URI formats in the "Intercluster Directory URI" chapter of the Cisco Unified Communications Manager Administrative Guide. Note    If you enter a directory URI and also enter a directory number in the Primary Extension field, this directory URI automatically becomes the primary directory URI that is associated to that directory number.
  • Field Name: hcsCucmCcTagEndUser.directoryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 254
  • Pattern: ^[^@]{1,47}@[^@]+$
Title
  • Field Name: hcsCucmCcTagEndUser.title
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Middle Name Enter the end user middle name.
  • Field Name: hcsCucmCcTagEndUser.middleName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
MLPP Precedence Authorization Level Set the MLPP Precedence Authorization Level. The following precedence levels indicate the priority level that is associated with a call: 0: Flash Override (highest) 1: Flash 2: Immediate 3: Priority 4: Routine (lowest) You can set the Precedence Authorization Level to any standard precedence level from Routine to Executive Override. Calls of equal or lower precedence are authorized to be originated by the user. Default: Default
  • Field Name: hcsCucmCcTagEndUser.patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Associated Headsets Contains headset that are associated to user.
  • Field Name: associatedHeadsets
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Headset Name of headset.
  • Field Name: headset.[n]
  • Type: Array
  • Cardinality: [0..15]
Attendees Access Code Set the Attendees Access Code for a secure conference call. The access code can be modified in the Self Care Portal. For more information on how to modify the access code, see the Cisco Unified Communications Self Care Portal User Guide.
  • Field Name: hcsCucmCcTagEndUser.attendeesAccessCode
  • Type: String
  • Cardinality: [0..1]
Home Number Enter the end user home number. You may use the following special characters: (,), and -.
  • Field Name: hcsCucmCcTagEndUser.homeNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ipcc Route Partition Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs with ipccExtension tag only.
  • Field Name: hcsCucmCcTagEndUser.ipccRoutePartition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Department Enter the end user department information (for example, the department number or name).
  • Field Name: hcsCucmCcTagEndUser.department
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ldap Directory Name
  • Field Name: hcsCucmCcTagEndUser.ldapDirectoryName
  • Type: ["String", "Null"]
  • Target: device/cucm/LdapDirectory
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Confirm Digest Credentials To confirm that you entered the digest credentials correctly, re-enter the credentials in this field.
  • Field Name: hcsCucmCcTagEndUser.digestCredentials
  • Type: ["String", "Null"]
  • Is Password: True
  • Cardinality: [0..1]
Associated Groups
  • Field Name: associatedGroups
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
User Group
  • Field Name: userGroup.[n]
  • Type: Array
Groups * Name of User Group
  • Field Name: hcsCucmCcTagEndUser.associatedGroups.userGroup.[n].name
  • Type: String
  • Target: device/cucm/UserGroup
  • Target attr: name
  • Cardinality: [1..1]
  • MaxLength: 100
  • Format: uri
User Roles
  • Field Name: userRoles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Roles READ ONLY: Name of the User Role associated with the user group will be taken.
  • Field Name: userRole.[n]
  • Type: Array
Self Service The Meeting Number is generated automatically when the Self-Service User ID field is configured.
  • Field Name: hcsCucmCcTagEndUser.selfService
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#]{0,27}$
Enable Mobility Check this check box to activate Cisco Unified Mobility, which allows the user to manage calls by using a single phone number and to pick up in-progress calls on the desktop phone and cellular phone. Checking this check box triggers licensing to consume device license units for Cisco Unified Mobility.
  • Field Name: hcsCucmCcTagEndUser.enableMobility
  • Type: Boolean
  • Cardinality: [0..1]
Enable Extension Mobility Cross Cluster Check this box to enable this end user to use the Cisco Extension Mobility Cross Cluster feature. For more information about the Cisco Extension Mobility Cross Cluster feature, see the Feature Configuration Guide for Cisco Unified Communications Manager.
  • Field Name: hcsCucmCcTagEndUser.enableEmcc
  • Type: Boolean
  • Cardinality: [0..1]
Password Credentials Not Applicable for Add. Credential configuration for password.
  • Field Name: passwordCredentials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pwd Cred User Must Change
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdCredUserMustChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred User Cant Change
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdCredUserCantChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Time Changed
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdCredTimeChanged
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Time Admin Lockout
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdCredTimeAdminLockout
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pwd Cred Policy Name
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdCredPolicyName
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Locked By Administrator
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdCredLockedByAdministrator
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Reset Hack Count The tag will be ignored in add, while update you can reset the hack count.
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdResetHackCount
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Does Not Expire
  • Field Name: hcsCucmCcTagEndUser.passwordCredentials.pwdCredDoesNotExpire
  • Type: Boolean
  • Cardinality: [0..1]
MLPP User ID This pane displays the Instance ID from the CAPF Profile that you configured for this user. To view or update the profile, double-click the Instance ID or click the Instance ID to highlight it; then, click View Details. The End User CAPF Profile Configuration window displays with the current settings. Note    The MLPP User Identification number must comprise 6 - 20 numeric characters. For information on how to configure the End User CAPF Profile, see the Cisco Unified Communications Manager Security Guide.
  • Field Name: hcsCucmCcTagEndUser.numericUserId
  • Type: String
  • Cardinality: [0..1]
  • Pattern: ^[0-9]{6,20}$
Enable User To Host Conference Now Check this check box to allow End User to host Conference Now.
  • Field Name: hcsCucmCcTagEndUser.enableUserToHostConferenceNow
  • Type: Boolean
  • Cardinality: [0..1]
User Locale From the drop-down list box, choose the locale that is associated with the end user. The user locale identifies a set of detailed information to support end users, including language and font. Unified Communications Manager uses this locale for extension mobility and the Cisco Unified Communications Self Care Portal. For Cisco Extension Mobility login, the locale that is specified takes precedence over the device and device profile settings. For Cisco Extension Mobility logout, Unified Communications Manager uses the end user locale that the default device profile specifies. Note    If you do not choose an end user locale, the locale that is specified in the Cisco CallManager service parameters as Default User Locale applies.
  • Field Name: hcsCucmCcTagEndUser.userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Allow Control of Device from CTI If this check box is checked, when the user logs in to a device, the AllowCTIControlFlag device property becomes active, which allows control of the device from CTI applications. Until the user logs in to a device, this setting has no effect. Note    The Allow Control of Device from CTI setting in the end user configuration overrides the AllowCTIControlFlag device property of the device to which the user logs in. Default: True
  • Field Name: hcsCucmCcTagEndUser.enableCti
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Mailid Enter the end user e-mail address.
  • Field Name: hcsCucmCcTagEndUser.mailid
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Phone Profiles
  • Field Name: phoneProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Profile Name
  • Field Name: profileName.[n]
  • Type: Array
  • Cardinality: [1..n]
Associated Remote Destination Profiles Read-Only.These groups automatically get added once the user is associated with a Remote Destination Profile.
  • Field Name: associatedRemoteDestinationProfiles
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Remote Destination Profiles This field lists the remote destination profiles that were created for this user. To view the details of a particular remote destination profile, choose a remote destination profile in the list and click the View Details link.
  • Field Name: remoteDestinationProfile.[n]
  • Type: Array
Name Dialing
  • Field Name: hcsCucmCcTagEndUser.nameDialing
  • Type: String
  • Cardinality: [0..1]
Enable Mobile Voice Access Check this check box to allow the user to access the Mobile Voice Access integrated voice response (IVR) system to initiate Cisco Unified Mobility calls and activate or deactivate Cisco Unified Mobility capabilities.
  • Field Name: hcsCucmCcTagEndUser.enableMobileVoiceAccess
  • Type: Boolean
  • Cardinality: [0..1]
Confirm Password This field does not display for LDAP Synchronized users if LDAP Authentication is enabled. Enter the end user password again.
  • Field Name: hcsCucmCcTagEndUser.password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Default Profile From the drop-down list box, choose a default extension mobility profile for this end user.
  • Field Name: hcsCucmCcTagEndUser.defaultProfile
  • Type: String
  • Cardinality: [0..1]
Display Name This field appears for local end users as well as LDAP synchronized end users. You can specify a display name for the local end users. For LDAP synchronized end users, this field appears if Microsoft Active Directory is used as the corporate directory. It displays the display name of the end user as specified in Microsoft Active Directory. Note    This field is supported on Administrative XML (AXL) and Bulk Administration Tool (BAT).
  • Field Name: hcsCucmCcTagEndUser.displayName
  • Type: String
  • Cardinality: [0..1]
Telephone Number Enter the end user work number. You may use the following special characters: (, ), and -.
  • Field Name: hcsCucmCcTagEndUser.telephoneNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Mobile Number Enter the end user mobile number. You may use the following special characters: (,), and -.
  • Field Name: hcsCucmCcTagEndUser.mobileNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Zero Hop If zeroHop value is false pin will be synchronized with UCxN, if synchronization is enabled for Unity Connection server and if zeroHop is true pin will not be synchronized with UCxN. This tage is supported only for updateUser api
  • Field Name: hcsCucmCcTagEndUser.zeroHop
  • Type: Boolean
  • Cardinality: [0..1]
First Name Enter the end user first name.
  • Field Name: hcsCucmCcTagEndUser.firstName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Last Name * Enter the end user last name.
  • Field Name: hcsCucmCcTagEndUser.lastName
  • Type: String
  • Cardinality: [1..1]
UC Service Profile To revert to the System Default Service Profile value, select any value from the drop-down, blank it (i.e. delete ALL text) and submit.
  • Field Name: hcsCucmCcTagEndUser.serviceProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/ServiceProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Userid * Enter the unique end user identification name. You can enter any character, including alphanumeric and special characters. No character restrictions exist for this field. You can modify the user ID only for local users. For LDAP synchronized users, you can view the user ID, but you cannot modify it. Note    We recommend that you do not use a slash (/) in the User ID field. Cisco User Data Services will not function properly for the user when the User ID contains a slash.
  • Field Name: hcsCucmCcTagEndUser.userid
  • Type: String
  • Cardinality: [1..1]
Em Max Login Time
  • Field Name: hcsCucmCcTagEndUser.emMaxLoginTime
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Cti Controlled Device Profiles
  • Field Name: ctiControlledDeviceProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Controlled Profiles This drop-down list box displays the CTI-controlled profiles that are available for association with an end user who is configured for CTI.
  • Field Name: profileName.[n]
  • Type: Array
  • Cardinality: [1..n]
Extensions Info These tags are for Quick User/Phone Add page
  • Field Name: extensionsInfo
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Extension These tags are for Quick User/Phone Add page
  • Field Name: extension.[n]
  • Type: Array
Pattern *
  • Field Name: hcsCucmCcTagEndUser.extensionsInfo.extension.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Partition
  • Field Name: hcsCucmCcTagEndUser.extensionsInfo.extension.[n].partition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Line Primary Uri
  • Field Name: hcsCucmCcTagEndUser.extensionsInfo.extension.[n].linePrimaryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Sort Order
  • Field Name: hcsCucmCcTagEndUser.extensionsInfo.extension.[n].sortOrder
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Route Partition
  • Field Name: hcsCucmCcTagEndUser.extensionsInfo.extension.[n].routePartition
  • Type: String
  • Cardinality: [0..1]
User Identity Value should be of of the format user@domain
  • Field Name: hcsCucmCcTagEndUser.userIdentity
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Garbage Collection Status Garbage Collection Status
  • Field Name: hcsCucmCcTagEndUser.status
  • Type: Integer
  • Cardinality: [0..1]
Remote Destination Limit Enter the maximum number of phones to which the user is permitted to transfer calls from the desktop phone. Default: 4
  • Field Name: hcsCucmCcTagEndUser.remoteDestinationLimit
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 4
Custom User Fields
  • Field Name: customUserFields
  • Type: Object
  • Cardinality: [0..1]
Custom User Field This Tag is valid only for GetUser
  • Field Name: customUserField.[n]
  • Type: Array
  • Cardinality: [0..5]
Name
  • Field Name: hcsCucmCcTagEndUser.customUserFields.customUserField.[n].name
  • Type: String
  • Cardinality: [0..1]
Value
  • Field Name: hcsCucmCcTagEndUser.customUserFields.customUserField.[n].value
  • Type: String
  • Cardinality: [0..1]
Pin Credentials Not Applicable for add. These groups get automatically added once an user is added.
  • Field Name: pinCredentials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pin Reset Hack Count The tag will be ignored in add, while update you can reset the hack count.
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinResetHackCount
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Locked By Administrator
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinCredLockedByAdministrator
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Time Admin Lockout
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinCredTimeAdminLockout
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pin Cred Does Not Expire
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinCredDoesNotExpire
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Policy Name
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinCredPolicyName
  • Type: String
  • Cardinality: [0..1]
Pin Cred User Cant Change
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinCredUserCantChange
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Time Changed
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinCredTimeChanged
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred User Must Change
  • Field Name: hcsCucmCcTagEndUser.pinCredentials.pinCredUserMustChange
  • Type: Boolean
  • Cardinality: [0..1]
Line Appearance Association For Presences Applicable for Controlled Devices
  • Field Name: lineAppearanceAssociationForPresences
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Appearance Association For Presence
  • Field Name: lineAppearanceAssociationForPresence.[n]
  • Type: Array
Laap Product Type
  • Field Name: hcsCucmCcTagEndUser.lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapProductType
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Associate
  • Field Name: hcsCucmCcTagEndUser.lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapAssociate
  • Type: String
  • Cardinality: [0..1]
Laap Device Name
  • Field Name: hcsCucmCcTagEndUser.lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDeviceName
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Partition
  • Field Name: hcsCucmCcTagEndUser.lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapPartition
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Directory
  • Field Name: hcsCucmCcTagEndUser.lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDirectory
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Description
  • Field Name: hcsCucmCcTagEndUser.lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDescription
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
BLF Presence Group * Use this field to configure the BLF Presence feature. From the drop-down list box, choose a BLF presence group for the end user. The selected group specifies the destinations that the end user can monitor. The default value for BLF Presence Group specifies Standard Presence group, configured with installation. BLF Presence Groups that are configured in Cisco Unified Administration also appear in the drop-down list box. BLF Presence Group authorization works with BLF Presence Groups to allow or block presence requests between groups.
  • Field Name: hcsCucmCcTagEndUser.presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
User Profile
  • Field Name: hcsCucmCcTagEndUser.userProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/UserProfileProvision
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri