[Index]

Model: device/cucm/PhoneOptions

Model Details

Title Description Details
Return
  • Field Name: return
  • Type: Object
  • Cardinality: [1..1]
Phone
  • Field Name: phone
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Protocol Protocol option is read-only,except when creating a device.
  • Field Name: return.phone.protocol
  • Type: String
  • Cardinality: [0..1]
Always Use Prime Line For Voice Message
  • Field Name: return.phone.alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [0..1]
Device Trust Mode This tag is valid only for TIP endpoints
  • Field Name: return.phone.deviceTrustMode
  • Type: String
  • Cardinality: [0..1]
Geo Location Filter Name
  • Field Name: return.phone.geoLocationFilterName
  • Type: String
  • Cardinality: [0..1]
Authentication Mode authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
  • Field Name: return.phone.authenticationMode
  • Type: String
  • Cardinality: [0..1]
Always Use Prime Line
  • Field Name: return.phone.alwaysUsePrimeLine
  • Type: String
  • Cardinality: [0..1]
Phone Service Display
  • Field Name: return.phone.phoneServiceDisplay
  • Type: String
  • Cardinality: [0..1]
Key Order keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
  • Field Name: return.phone.keyOrder
  • Type: String
  • Cardinality: [0..1]
User Hold Moh Audio Source Id This tag is not valid for H323Phone,H323trunk and SIPTrunk
  • Field Name: return.phone.userHoldMohAudioSourceId
  • Type: String
  • Cardinality: [0..1]
Key Size keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
  • Field Name: return.phone.keySize
  • Type: String
  • Cardinality: [0..1]
Phone Template Name
  • Field Name: return.phone.phoneTemplateName
  • Type: String
  • Cardinality: [0..1]
Sip Profile Name This Tag is valid only for SIP Phones and SIP Trunks
  • Field Name: return.phone.sipProfileName
  • Type: String
  • Cardinality: [0..1]
Calling Search Space Name
  • Field Name: return.phone.callingSearchSpaceName
  • Type: String
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..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
Directed Call Park Id Only the uuid attribute is read
  • Field Name: return.phone.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.phone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dn Pattern
  • Field Name: return.phone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
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.
  • Field Name: return.phone.networkLocation
  • Type: String
  • Cardinality: [0..1]
Ring Setting Idle Blf Audible Alert
  • Field Name: return.phone.ringSettingIdleBlfAudibleAlert
  • Type: String
  • Cardinality: [0..1]
Preemption This setting only affects devices that support MLPP.
  • Field Name: return.phone.preemption
  • Type: String
  • Cardinality: [0..1]
Add On Modules Additional modules attached to the Phone.There can be 0,1, 2 or 3.
  • Field Name: addOnModules
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Add On Module
  • Field Name: addOnModule.[n]
  • Type: Array
  • Cardinality: [0..3]
Model Model ID string.
  • Field Name: return.phone.addOnModules.addOnModule.[n].model
  • Type: String
  • Cardinality: [0..1]
Use Trusted Relay Point
  • Field Name: return.phone.useTrustedRelayPoint
  • Type: String
  • Cardinality: [0..1]
Single Button Barge This tag is valid only for devices that support SBB.
  • Field Name: return.phone.singleButtonBarge
  • Type: String
  • Cardinality: [0..1]
Call Info Privacy Status
  • Field Name: return.phone.callInfoPrivacyStatus
  • Type: String
  • Cardinality: [0..1]
Feature Control Policy This tag is valid only for RT Phones.
  • Field Name: return.phone.featureControlPolicy
  • Type: String
  • Cardinality: [0..1]
Common Device Config Name
  • Field Name: return.phone.commonDeviceConfigName
  • Type: String
  • Cardinality: [0..1]
Network Locale
  • Field Name: return.phone.networkLocale
  • Type: String
  • Cardinality: [0..1]
Mlpp Indication Status This setting only affects devices that support MLPP.
  • Field Name: return.phone.mlppIndicationStatus
  • Type: String
  • Cardinality: [0..1]
Media Resource List Name
  • Field Name: return.phone.mediaResourceListName
  • Type: String
  • Cardinality: [0..1]
Packet Capture Mode
  • Field Name: return.phone.packetCaptureMode
  • Type: String
  • Cardinality: [0..1]
Mra Service Domain
  • Field Name: return.phone.mraServiceDomain
  • Type: String
  • Cardinality: [0..1]
Ring Setting Busy Blf Audible Alert
  • Field Name: return.phone.ringSettingBusyBlfAudibleAlert
  • Type: String
  • Cardinality: [0..1]
Product Product ID string. read-only except when creating a device.
  • Field Name: return.phone.product
  • Type: String
  • Cardinality: [0..1]
Owner User Name Read-only for IP Phones.
  • Field Name: return.phone.ownerUserName
  • Type: String
  • Cardinality: [0..1]
Phone Suite If a blank tag is passed ,the value of the default is inserted into the database.
  • Field Name: return.phone.phoneSuite
  • Type: String
  • Cardinality: [0..1]
Subscribe Calling Search Space Name Support for this tag has been removed for IMS phones from 9.0
  • Field Name: return.phone.subscribeCallingSearchSpaceName
  • Type: String
  • Cardinality: [0..1]
Cgpn Ingress DN
  • Field Name: return.phone.cgpnIngressDN
  • Type: String
  • Cardinality: [0..1]
Dial Rules Name
  • Field Name: return.phone.dialRulesName
  • Type: String
  • Cardinality: [0..1]
User Locale
  • Field Name: return.phone.userLocale
  • Type: String
  • Cardinality: [0..1]
Geo Location Name
  • Field Name: return.phone.geoLocationName
  • Type: String
  • Cardinality: [0..1]
Wifi Hotspot Profile
  • Field Name: return.phone.wifiHotspotProfile
  • Type: String
  • Cardinality: [0..1]
Device Mobility Mode Specifies if the phone is configured for device mobility or not.
  • Field Name: return.phone.deviceMobilityMode
  • Type: String
  • Cardinality: [0..1]
Built In Bridge Status
  • Field Name: return.phone.builtInBridgeStatus
  • Type: String
  • Cardinality: [0..1]
Elin Group
  • Field Name: return.phone.elinGroup
  • Type: String
  • Cardinality: [0..1]
Join Across Lines This tag is valid only for devices that support JAL..
  • Field Name: return.phone.joinAcrossLines
  • Type: String
  • Cardinality: [0..1]
Certificate Operation
  • Field Name: return.phone.certificateOperation
  • 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.phone.services.service.[n].telecasterServiceName
  • Type: String
  • Cardinality: [0..1]
Outbound Call Rollover This tag is valid only for devices that Automatic Outbound Callrollover
  • Field Name: return.phone.outboundCallRollover
  • Type: String
  • Cardinality: [0..1]
Class Class ID string. Class information is read-only except when creating a device.
  • Field Name: return.phone.class
  • Type: String
  • Cardinality: [0..1]
Primary Phone Name
  • Field Name: return.phone.primaryPhoneName
  • Type: String
  • Cardinality: [0..1]
Dnd Option This tag is valid only for devices that support DND.
  • Field Name: return.phone.dndOption
  • Type: String
  • Cardinality: [0..1]
Aar Neighborhood Name
  • Field Name: return.phone.aarNeighborhoodName
  • Type: String
  • Cardinality: [0..1]
Security Profile Name
  • Field Name: return.phone.securityProfileName
  • Type: String
  • Cardinality: [0..1]
Presence Group Name
  • Field Name: return.phone.presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dnd Ring Setting This tag is valid only for devices that support DND.
  • Field Name: return.phone.dndRingSetting
  • Type: String
  • Cardinality: [0..1]
Softkey Template Name
  • Field Name: return.phone.softkeyTemplateName
  • Type: String
  • Cardinality: [0..1]
Reroute Calling Search Space Name
  • Field Name: return.phone.rerouteCallingSearchSpaceName
  • Type: String
  • Cardinality: [0..1]
Protocol Side Side information is read-only except when creating a device
  • Field Name: return.phone.protocolSide
  • Type: String
  • Cardinality: [0..1]
Wireless Lan Profile Group
  • Field Name: return.phone.wirelessLanProfileGroup
  • Type: String
  • Cardinality: [0..1]
Common Phone Config Name
  • Field Name: return.phone.commonPhoneConfigName
  • Type: String
  • Cardinality: [0..1]
Network Hold Moh Audio Source Id This tag is not valid for H323Phone,H323trunk and SIPTrunk
  • Field Name: return.phone.networkHoldMohAudioSourceId
  • Type: String
  • Cardinality: [0..1]
Mtp Prefered Codec This field is applicable only to SIP phones.
  • Field Name: return.phone.mtpPreferedCodec
  • Type: String
  • Cardinality: [0..1]
Location Name
  • Field Name: return.phone.locationName
  • Type: String
  • Cardinality: [0..1]
Cgpn Transformation Css Name
  • Field Name: return.phone.cgpnTransformationCssName
  • Type: String
  • Cardinality: [0..1]
Automated Alternate Routing Css Name
  • Field Name: return.phone.automatedAlternateRoutingCssName
  • Type: String
  • Cardinality: [0..1]
Device Pool Name
  • Field Name: return.phone.devicePoolName
  • Type: String
  • Cardinality: [0..1]
Ec Key Size ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
  • Field Name: return.phone.ecKeySize
  • 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.phone.lines.line.[n].ringSettingActivePickupAlert
  • Type: String
  • Cardinality: [0..1]
Mwl Policy
  • Field Name: return.phone.lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
Ring Setting Idle Pickup Alert Applicable only for IP Phones
  • Field Name: return.phone.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.phone.lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
Ring Setting
  • Field Name: return.phone.lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
Recording Flag
  • Field Name: return.phone.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.phone.lines.line.[n].consecutiveRingSetting
  • Type: String
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: return.phone.lines.line.[n].monitoringCssName
  • Type: String
  • Cardinality: [0..1]
Recording Profile Name
  • Field Name: return.phone.lines.line.[n].recordingProfileName
  • Type: String
  • Cardinality: [0..1]
Recording Media Source
  • Field Name: return.phone.lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
  • Field Name: return.phone.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.phone.lines.line.[n].dirn.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Line Identifier The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
  • Field Name: lineIdentifier.[n]
  • Type: Array
Mobility User Id Name The userid of the mobility user for this phone.Nullable.
  • Field Name: return.phone.mobilityUserIdName
  • Type: String
  • Cardinality: [0..1]
Default Profile Name The name of the default profile for this device.Not Nullable.
  • Field Name: return.phone.defaultProfileName
  • Type: String
  • Cardinality: [0..1]
API reference for device/cucm/PhoneOptions