[Index]

Model: device/cucm/DeviceProfile

Model Details: device/cucm/DeviceProfile

Title Description Details
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: 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: alwaysUsePrimeLineForVoiceMessage
  • 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: mlppDomainId
  • Type: String
  • Target: device/cucm/MlppDomain
  • Target attr: domainId
  • Cardinality: [0..1]
  • MaxLength: 128
  • Pattern: ^[0-9a-fA-F]{6}|-1$
  • Format: uri
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: 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: 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: 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: 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", "Null"]
  • Target: device/cucm/DirectedCallPark
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Label
  • Field Name: blfDirectedCallParks.blfDirectedCallPark.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
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: 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: addOnModules.addOnModule.[n].loadInformation
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Model * Model ID string. Default: 7914 14-Button Line Expansion Module
  • Field Name: 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"]
Module1 You can configure one or two expansion modules for this device profile by choosing phone templates from the expansion module drop-down lists in the expansion module fields. Note    You can view a phone button list at any time by choosing the View button list link next to the phone button template fields. A separate dialog box pops up and displays the phone buttons for that particular expansion module. Choose the appropriate expansion module or None.
  • Field Name: 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: 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: 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: 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: 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]
Call Pickup
  • Field Name: busyLampFields.busyLampField.[n].callPickup
  • Type: Boolean
Label
  • Field Name: busyLampFields.busyLampField.[n].label
  • Type: String
  • Cardinality: [0..1]
Route Partition
  • Field Name: 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: busyLampFields.busyLampField.[n].blfDirn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Type Device profile Type string. Read Only
  • Field Name: type
  • Type: String
  • Cardinality: [0..1]
Product * Product ID string. read-only except when creating a device.
  • Field Name: 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: description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Trace Flag
  • Field Name: 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: 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: 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: 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: 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]
Class * Class ID string. Class information is read-only except when creating a device. Default: Device Profile
  • Field Name: 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: 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: dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Name * The device name,using only URL-friendly characters
  • Field Name: 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: 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: 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: 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: callInfoPrivacyStatus
  • 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: 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: 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: 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: 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: lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/RecordingProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Index
  • Field Name: 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: 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: lines.line.[n].line_link
  • Type: String
  • Format: link
Label
  • Field Name: lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
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"]
Max Num Calls Default: 2
  • Field Name: 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: 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: 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: lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
E164Mask
  • Field Name: lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: 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: 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
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Inventory Filter Default: default
  • Field Name: lines.line.[n].dirn.line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers (Site Only)", "Show Unused Numbers", "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: 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
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"]
Busy Trigger Default: 1
  • Field Name: lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
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"]
Display
  • Field Name: lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
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
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: 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: emccCallingSearchSpace
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri