[Index]

Model: device/cucm/UniversalDeviceTemplate

Universal Device Template

Full HTML Help

When the administrator or user self-provisions a phone, Cisco Unified Communications Manager deletes the auto-registered phone and adds the phone back into the database. The Universal Device Template (UDT) for the user's profile determines the various phone settings for the user's phone.

Perform these steps:

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

  2. Set the hierarchy path to the site node where you want to configure self-provisioning.

  3. Choose User Management > Self-Provisioning > Universal Device Template.

  4. Click Add.

  5. Enter the following required UDT information.

    Note

    These fields can be pre-populated, depending on customer, site, and dial plan configuration: Name, Location, Common Phone Profile, BLF Presence Group

Field Description
Name Enter the name of the UDT.
Location Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC regulates audio quality and video availability by limiting the amount of bandwidth 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.
Common Phone Profile Choose a common phone profile.
Phone Personalization Enable this setting to allow the UDT to work with Phone Designer, a Unified Communications widget. The widget lets a user customize the wallpaper and ringtones on a device.
Busy Trigger This setting, which works with Maximum Number of Calls and Call Forward Busy, determines the maximum number of calls to be presented at the line. If the busy trigger is set to 40, incoming call 41 is rejected with a busy cause (and is forwarded if Call Forward Busy is set). If this line is shared, all the lines must be busy before incoming calls are rejected.
Max Number Of Calls You can configure up to 200 calls for a line on a device. As you configure the number of calls for one line, the number calls that are available for another line decreases.
MultiLevel Precedence and Preemption This setting specifies whether a device that can preempt calls in progress uses the capability when it places an MLPP precedence call.
Do Not Disturb Option When you enable DND on the phone, this parameter allows you to specify how the DND features handle incoming calls.
Blf Presence Group Enter the presence group applicable for busy lamp field buttons.
Device Mobility Mode 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.
  1. Enter the following optional, but highly recommended information. These fields can be pre-populated, depending on customer, site, and dial plan configuration.
Field Description
Device Pool Enter a site-specific device pool.
Owner User ID The userid of the user associated with the phone. The recommended is Current Device Owner's User ID.
  1. Enter other optional settings, if applicable.
  2. Click Save.

Model Details: device/cucm/UniversalDeviceTemplate

Title Description Details
Services Provisioning * Default: Default
  • Field Name: servicesProvisioning
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Internal", "External URL", "Both", "Default"]
Secure Information Url
  • Field Name: secureInformationUrl
  • Type: String
  • Cardinality: [0..1]
Logged Into Hunt Group
  • Field Name: loggedIntoHuntGroup
  • Type: Boolean
  • Cardinality: [0..1]
Speeddials
  • Field Name: speeddials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Speeddial
  • Field Name: speeddial.[n]
  • Type: Array
Index *
  • Field Name: speeddials.speeddial.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Dirn *
  • Field Name: speeddials.speeddial.[n].dirn
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Label *
  • Field Name: speeddials.speeddial.[n].label
  • Type: String
  • Cardinality: [1..1]
Key Order Default: RSA Only
  • Field Name: keyOrder
  • Type: String
  • Cardinality: [0..1]
  • Default: RSA Only
  • Choices: ["RSA Only", "EC Only", "EC Preferred, RSA Backup"]
Always Use Prime Line For Voice Message * Default: Default
  • Field Name: alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Device Pool *
  • Field Name: devicePool
  • Type: String
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mlpp Preemption * Default: Default
  • Field Name: mlppPreemption
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Disabled", "Forceful", "Default"]
Mobility User Id
  • Field Name: mobilityUserId
  • Type: String
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Use Trusted Relay Point * Default: Default
  • Field Name: useTrustedRelayPoint
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Secure Idle Url
  • Field Name: secureIdleUrl
  • Type: String
  • Cardinality: [0..1]
Owner User Id
  • Field Name: ownerUserId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Aar Calling Search Space
  • Field Name: aarCallingSearchSpace
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
User Locale
  • Field Name: userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Busy Lamp Fields
  • Field Name: busyLampFields
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Busy Lamp Field
  • Field Name: busyLampField.[n]
  • Type: Array
Index *
  • Field Name: 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: busyLampFields.busyLampField.[n].blfDest
  • Type: String
  • Cardinality: [1..1]
Associated Blf Sd Features
  • Field Name: associatedBlfSdFeatures
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Feature
  • Field Name: feature.[n]
  • Type: Array
Label
  • Field Name: busyLampFields.busyLampField.[n].label
  • Type: String
  • Cardinality: [0..1]
Route Partition
  • Field Name: busyLampFields.busyLampField.[n].routePartition
  • Type: String
  • Cardinality: [0..1]
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: busyLampFields.busyLampField.[n].blfDirn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Device Mobility Mode * Default: Default
  • Field Name: deviceMobilityMode
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Common Phone Profile *
  • Field Name: commonPhoneProfile
  • Type: String
  • Target: device/cucm/CommonPhoneConfig
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Outbound Call Rollover * Default: No Rollover
  • Field Name: outboundCallRollover
  • Type: String
  • Cardinality: [1..1]
  • Default: No Rollover
  • Choices: ["No Rollover", "Rollover Within Same DN", "Rollover to any line"]
Required Dtmf Reception
  • Field Name: requiredDtmfReception
  • Type: Boolean
  • Cardinality: [0..1]
Geo Location
  • Field Name: geoLocation
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Name *
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
Retry Video Call As Audio
  • Field Name: retryVideoCallAsAudio
  • Type: Boolean
  • Cardinality: [0..1]
Authentication Mode * Default: By Null String
  • Field Name: authenticationMode
  • Type: String
  • Cardinality: [1..1]
  • Default: By Null String
  • Choices: ["By Authentication String", "By Null String", "By Existing Certificate (precedence to LSC)", "By Existing Certificate (precedence to MIC)"]
User Hold Moh Audio Source
  • Field Name: userHoldMohAudioSource
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
Built In Bridge * Default: Default
  • Field Name: builtInBridge
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Aar Group
  • Field Name: aarGroup
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Protected Device
  • Field Name: protectedDevice
  • Type: Boolean
  • Cardinality: [0..1]
Calling Party Transformation CSS For Outbound Calls
  • Field Name: callingPartyTransformationCSSForOutboundCalls
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Key Size * Default: 2048
  • Field Name: keySize
  • Type: String
  • Cardinality: [1..1]
  • Default: 2048
  • Choices: ["512", "1024", "2048", "3072", "4096"]
Authentication String
  • Field Name: authenticationString
  • Type: String
  • Cardinality: [0..1]
Require Off Premise Location
  • Field Name: requireOffPremiseLocation
  • Type: Boolean
  • Cardinality: [0..1]
Use Device Pool Calling Party Transformation CS Sfor Inbound Calls
  • Field Name: useDevicePoolCallingPartyTransformationCSSforInboundCalls
  • Type: Boolean
  • Cardinality: [0..1]
Subscribe Calling Search Space Name
  • Field Name: subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Secure Dir Url
  • Field Name: secureDirUrl
  • Type: String
  • Cardinality: [0..1]
Rfc2833Disabled
  • Field Name: rfc2833Disabled
  • Type: Boolean
  • Cardinality: [0..1]
Hotline Device
  • Field Name: hotlineDevice
  • Type: Boolean
  • Cardinality: [0..1]
Mtp Preferred Originating Codec * Default: 711ulaw
  • Field Name: mtpPreferredOriginatingCodec
  • Type: String
  • Cardinality: [1..1]
  • Default: 711ulaw
  • Choices: ["711ulaw", "711alaw", "G729/G729a", "G729b/G729ab"]
Sip Dial Rules
  • Field Name: sipDialRules
  • Type: ["String", "Null"]
  • Target: device/cucm/SipDialRules
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Messages
  • Field Name: messages
  • Type: String
  • Cardinality: [0..1]
Secure Messages Url
  • Field Name: secureMessagesUrl
  • Type: String
  • Cardinality: [0..1]
Network Hold Moh Audio Source
  • Field Name: networkHoldMohAudioSource
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
Blf Presence Group *
  • Field Name: blfPresenceGroup
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Secure Shell Password
  • Field Name: secureShellPassword
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Dnd Incoming Call Alert
  • Field Name: dndIncomingCallAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Sip Profile *
  • Field Name: sipProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/SipProfile
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Services
  • Field Name: services
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Service
  • Field Name: service.[n]
  • Type: Array
Name *
  • Field Name: services.service.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 100
Url
  • Field Name: services.service.[n].url
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Service Name Ascii
  • Field Name: services.service.[n].serviceNameAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Url Button Index
  • Field Name: services.service.[n].urlButtonIndex
  • Type: Integer
  • Cardinality: [0..1]
Telecaster Service Name *
  • Field Name: services.service.[n].telecasterServiceName
  • Type: String
  • Cardinality: [1..1]
Url Label
  • Field Name: services.service.[n].urlLabel
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Device Security Profile *
  • Field Name: deviceSecurityProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/PhoneSecurityProfile
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Privacy * Default: Default
  • Field Name: privacy
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Single Button Barge * Default: Default
  • Field Name: singleButtonBarge
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "Barge", "CBarge", "Default"]
Mlpp Indication * Default: Off
  • Field Name: mlppIndication
  • Type: String
  • Cardinality: [1..1]
  • Default: Off
  • Choices: ["Off", "On", "Default"]
Enable Extension Mobility
  • Field Name: enableExtensionMobility
  • Type: Boolean
  • Cardinality: [0..1]
Softkey Template
  • Field Name: softkeyTemplate
  • Type: ["String", "Null"]
  • Target: device/cucm/SoftKeyTemplate
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Mlpp Domain
  • Field Name: mlppDomain
  • Type: String
  • Target: device/cucm/MlppDomain
  • Target attr: domainName
  • Cardinality: [0..1]
  • Format: uri
Location *
  • Field Name: location
  • Type: String
  • Target: device/cucm/Location
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Search Space
  • Field Name: callingSearchSpace
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Proxy Server
  • Field Name: proxyServer
  • Type: String
  • Cardinality: [0..1]
Allow Control Of Device From Cti
  • Field Name: allowControlOfDeviceFromCti
  • Type: Boolean
  • Cardinality: [0..1]
Join Across Lines * Default: Default
  • Field Name: joinAcrossLines
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Phone Personalization * Default: Default
  • Field Name: phonePersonalization
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Disabled", "Enabled", "HTTPS Only", "Default"]
Network Locale
  • Field Name: 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"]
Secure Authentication Url
  • Field Name: secureAuthenticationUrl
  • Type: String
  • Cardinality: [0..1]
Unattended Port
  • Field Name: unattendedPort
  • Type: Boolean
  • Cardinality: [0..1]
Idle
  • Field Name: idle
  • Type: String
  • Cardinality: [0..1]
Secure Shell User
  • Field Name: secureShellUser
  • Type: String
  • Cardinality: [0..1]
Media Termination Point Required
  • Field Name: mediaTerminationPointRequired
  • Type: Boolean
  • Cardinality: [0..1]
Use Device Pool Calling Party Transformation CS Sfor Outbound Calls
  • Field Name: useDevicePoolCallingPartyTransformationCSSforOutboundCalls
  • Type: Boolean
  • Cardinality: [0..1]
Ec Key Size
  • Field Name: ecKeySize
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["256", "384", "521"]
Phone Button Template *
  • Field Name: phoneButtonTemplate
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
  • Choices: ["Universal Device Template Button Layout"]
Blf Audible Alert Setting Phone Idle * Default: Default
  • Field Name: blfAudibleAlertSettingPhoneIdle
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Always Use Prime Line * Default: Default
  • Field Name: alwaysUsePrimeLine
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Blf Audible Alert Setting Phone Busy * Default: Default
  • Field Name: blfAudibleAlertSettingPhoneBusy
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
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: blfDirectedCallParks.blfDirectedCallPark.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Directed Call Park Dn And Partition
  • Field Name: directedCallParkDnAndPartition
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Route Partition Name
  • Field Name: blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dn Pattern *
  • Field Name: blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Directed Call Park Id Only the uuid attribute is read
  • Field Name: blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkId
  • Type: String
  • Cardinality: [0..1]
  • Pattern: \{........-....-....-....-............\}
Label
  • Field Name: blfDirectedCallParks.blfDirectedCallPark.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Information
  • Field Name: information
  • Type: String
  • Cardinality: [0..1]
Common Device Configuration
  • Field Name: commonDeviceConfiguration
  • Type: ["String", "Null"]
  • Target: device/cucm/CommonDeviceConfig
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Packet Capture Duration
  • Field Name: packetCaptureDuration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Services Url
  • Field Name: servicesUrl
  • Type: String
  • Cardinality: [0..1]
Feature Control Policy
  • Field Name: featureControlPolicy
  • Type: ["String", "Null"]
  • Target: device/cucm/FeatureControlPolicy
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Media Resource Group List
  • Field Name: mediaResourceGroupList
  • Type: ["String", "Null"]
  • Target: device/cucm/MediaResourceList
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Idle Timer
  • Field Name: idleTimer
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Packet Capture Mode * Default: None
  • Field Name: packetCaptureMode
  • Type: String
  • Cardinality: [1..1]
  • Default: None
  • Choices: ["None", "Batch Processing Mode"]
Device Description
  • Field Name: deviceDescription
  • Type: String
  • Cardinality: [0..1]
Do Not Disturb
  • Field Name: doNotDisturb
  • Type: Boolean
  • Cardinality: [0..1]
Ignore Presentation Indicators
  • Field Name: ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
Secure Services Url
  • Field Name: secureServicesUrl
  • Type: String
  • Cardinality: [0..1]
Certificate Operation * Default: No Pending Operation
  • Field Name: certificateOperation
  • Type: String
  • Cardinality: [1..1]
  • Default: No Pending Operation
  • Choices: ["No Pending Operation", "Install/Upgrade", "Delete", "Troubleshoot"]
Dnd Option * Default: Ringer Off
  • Field Name: dndOption
  • Type: String
  • Cardinality: [1..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
Lines
  • Field Name: lines
  • Type: 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
Index *
  • Field Name: lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Max Num Calls Default: 2
  • Field Name: lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Mwl Policy Default: Use System Policy
  • Field Name: 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: 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"]
Display
  • Field Name: lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Ring Setting Default: Ring
  • Field Name: lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: 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"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: 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"]
Label
  • Field Name: lines.line.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
E164Mask
  • Field Name: lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Recording Profile Name
  • Field Name: lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Missed Call Logging Default: True
  • Field Name: lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Recording Media Source Default: Gateway Preferred
  • Field Name: lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Monitoring Css Name
  • Field Name: lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Recording Flag Default: Call Recording Disabled
  • Field Name: 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"]
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Pattern *
  • Field Name: lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Line Identifier The lineIdentifier is a shorthand method that refers to a particular directory number.
  • Field Name: lineIdentifier.[n]
  • Type: Array
Directory Number *
  • Field Name: lines.lineIdentifier.[n].directoryNumber
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Route Partition Name *
  • Field Name: lines.lineIdentifier.[n].routePartitionName
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
  • MaxLength: 50
Rerouting Calling Search Space
  • Field Name: reroutingCallingSearchSpace
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Remote Device
  • Field Name: remoteDevice
  • Type: Boolean
  • Cardinality: [0..1]
Directory
  • Field Name: directory
  • Type: String
  • Cardinality: [0..1]
Authentication Server
  • Field Name: authenticationServer
  • Type: String
  • Cardinality: [0..1]
Calling Party Transformation CSS For Inbound Calls
  • Field Name: callingPartyTransformationCSSForInboundCalls
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri