[Index]

Model: device/cucm/DeviceProfileOptions

Model Details

Title Description Details
Return
  • Field Name: return
  • Type: Object
  • Cardinality: [1..1]
Device Profile
  • Field Name: deviceProfile
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Protocol Protocol option is read-only,except when creating a device.
  • Field Name: return.deviceProfile.protocol
  • Type: String
  • Cardinality: [0..1]
Always Use Prime Line For Voice Message
  • Field Name: return.deviceProfile.alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [0..1]
Softkey Template Name
  • Field Name: return.deviceProfile.softkeyTemplateName
  • Type: String
  • Cardinality: [0..1]
User Hold Moh Audio Source Id This tag is not valid for H323Phone,H323trunk and SIPTrunk
  • Field Name: return.deviceProfile.userHoldMohAudioSourceId
  • Type: String
  • Cardinality: [0..1]
Phone Template Name
  • Field Name: return.deviceProfile.phoneTemplateName
  • Type: String
  • 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
Directed Call Park Id Only the uuid attribute is read
  • Field Name: return.deviceProfile.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: return.deviceProfile.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dn Pattern
  • Field Name: return.deviceProfile.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Preemption This setting only affects devices that support MLPP.
  • Field Name: return.deviceProfile.preemption
  • Type: String
  • Cardinality: [0..1]
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]
Model Model ID string.
  • Field Name: return.deviceProfile.addOnModules.addOnModule.[n].model
  • Type: String
  • Cardinality: [0..1]
Single Button Barge This tag is valid only for devices that support SBB.
  • Field Name: return.deviceProfile.singleButtonBarge
  • Type: String
  • Cardinality: [0..1]
Feature Control Policy This tag is valid only for RT Phones.
  • Field Name: return.deviceProfile.featureControlPolicy
  • Type: String
  • Cardinality: [0..1]
Mlpp Indication Status This setting only affects devices that support MLPP.
  • Field Name: return.deviceProfile.mlppIndicationStatus
  • Type: String
  • Cardinality: [0..1]
Product Product ID string. read-only except when creating a device.
  • Field Name: return.deviceProfile.product
  • Type: String
  • Cardinality: [0..1]
User Locale
  • Field Name: return.deviceProfile.userLocale
  • Type: String
  • Cardinality: [0..1]
Join Across Lines This tag is valid only for devices that support JAL..
  • Field Name: return.deviceProfile.joinAcrossLines
  • Type: String
  • Cardinality: [0..1]
Services
  • Field Name: services
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Service
  • Field Name: service.[n]
  • Type: Array
Telecaster Service Name
  • Field Name: return.deviceProfile.services.service.[n].telecasterServiceName
  • Type: String
  • Cardinality: [0..1]
Class Class ID string. Class information is read-only except when creating a device.
  • Field Name: return.deviceProfile.class
  • Type: String
  • Cardinality: [0..1]
Dnd Option This tag is valid only for devices that support DND.
  • Field Name: return.deviceProfile.dndOption
  • Type: String
  • Cardinality: [0..1]
Dnd Ring Setting This tag is valid only for devices that support DND.
  • Field Name: return.deviceProfile.dndRingSetting
  • Type: String
  • Cardinality: [0..1]
Always Use Prime Line
  • Field Name: return.deviceProfile.alwaysUsePrimeLine
  • Type: String
  • Cardinality: [0..1]
Protocol Side Side information is read-only except when creating a device
  • Field Name: return.deviceProfile.protocolSide
  • Type: String
  • Cardinality: [0..1]
Call Info Privacy Status
  • Field Name: return.deviceProfile.callInfoPrivacyStatus
  • Type: String
  • Cardinality: [0..1]
Lines
  • Field Name: lines
  • Type: ["Object", "Null"]
  • 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
Ring Setting Active Pickup Alert Applicable only for IP Phones
  • Field Name: return.deviceProfile.lines.line.[n].ringSettingActivePickupAlert
  • Type: String
  • Cardinality: [0..1]
Mwl Policy
  • Field Name: return.deviceProfile.lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
Ring Setting Idle Pickup Alert Applicable only for IP Phones
  • Field Name: return.deviceProfile.lines.line.[n].ringSettingIdlePickupAlert
  • Type: String
  • Cardinality: [0..1]
Partition Usage This tag cannot be modified. It can only be specified in the add request.
  • Field Name: return.deviceProfile.lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
Ring Setting
  • Field Name: return.deviceProfile.lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
Recording Flag
  • Field Name: return.deviceProfile.lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
  • Field Name: return.deviceProfile.lines.line.[n].consecutiveRingSetting
  • Type: String
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: return.deviceProfile.lines.line.[n].monitoringCssName
  • Type: String
  • Cardinality: [0..1]
Recording Profile Name
  • Field Name: return.deviceProfile.lines.line.[n].recordingProfileName
  • Type: String
  • Cardinality: [0..1]
Recording Media Source
  • Field Name: return.deviceProfile.lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
  • Field Name: return.deviceProfile.lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Route Partition Name
  • Field Name: return.deviceProfile.lines.line.[n].dirn.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Line Identifier The lineIdentifier is a shorthand method that refers to a particular directory number.
  • Field Name: lineIdentifier.[n]
  • Type: Array
Login User Id
  • Field Name: return.deviceProfile.loginUserId
  • Type: String
  • Cardinality: [0..1]
Emcc Calling Search Space
  • Field Name: return.deviceProfile.emccCallingSearchSpace
  • Type: String
  • Cardinality: [0..1]
API reference for device/cucm/DeviceProfileOptions