[Index]

Model: device/cucm/H323Phone

Model Details: device/cucm/H323Phone

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"]
Elin Group
  • Field Name: elinGroup
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Mtp Required
  • Field Name: mtpRequired
  • Type: Boolean
  • Cardinality: [0..1]
Wait For Far End H245Terminal Set
  • Field Name: waitForFarEndH245TerminalSet
  • Type: Boolean
  • Cardinality: [0..1]
Always Use Prime Line Default: Default
  • Field Name: alwaysUsePrimeLine
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Line Id Presentation Default: Default
  • Field Name: callingLineIdPresentation
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Always Use Prime Line For Voice Message Default: Default
  • Field Name: alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Search Space Name
  • Field Name: callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Description Optional description of the device
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Signaling Port * Default: 1720
  • Field Name: signalingPort
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 1720
Use Trusted Relay Point * Default: Default
  • Field Name: useTrustedRelayPoint
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Caller Id Dn
  • Field Name: callerIdDn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Redirect Outbound Number Ie
  • Field Name: redirectOutboundNumberIe
  • Type: Boolean
  • Cardinality: [0..1]
Calling Party Selection Default: Originator
  • Field Name: callingPartySelection
  • Type: String
  • Cardinality: [0..1]
  • Default: Originator
  • Choices: ["Originator", "First Redirect Number", "Last Redirect Number", "First Redirect Number (External)", "Last Redirect Number (External)"]
Common Device Config Name
  • Field Name: commonDeviceConfigName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Mtp Preferred Codec Applicable only for H323Phones Default: 711ulaw
  • Field Name: mtpPreferredCodec
  • Type: String
  • Cardinality: [0..1]
  • Default: 711ulaw
  • Choices: ["711ulaw", "711alaw", "G729/G729a", "G729b/G729ab"]
Cgpn Transformation Css Name
  • Field Name: cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Use Device Pool Cgpn Transform Css Default: True
  • Field Name: useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
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"]
Media Resource List Name
  • Field Name: mediaResourceListName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Trace Flag
  • Field Name: traceFlag
  • Type: Boolean
  • Cardinality: [0..1]
Ignore Presentation Indicators The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
  • Field Name: ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
Subscribe Calling Search Space Name
  • Field Name: subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Geo Location Name
  • Field Name: geoLocationName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Owner User Name
  • Field Name: ownerUserName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Hlog Status
  • Field Name: hlogStatus
  • Type: Boolean
  • Cardinality: [0..1]
Display IE Delivery
  • Field Name: displayIEDelivery
  • Type: Boolean
  • Cardinality: [0..1]
Redirect Inbound Number Ie
  • Field Name: redirectInboundNumberIe
  • Type: Boolean
  • Cardinality: [0..1]
Class * Class ID string. Class information is read-only except when creating a device.
  • Field Name: class
  • Type: String
  • Cardinality: [1..1]
  • 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"]
Srtp Allowed
  • Field Name: srtpAllowed
  • Type: Boolean
  • Cardinality: [0..1]
Presence Group Name
  • Field Name: presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Name * The device name,using only URL-friendly characters
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Retry Video Call As Audio Default: True
  • Field Name: retryVideoCallAsAudio
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
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"]
Common Phone Config Name *
  • Field Name: commonPhoneConfigName
  • Type: String
  • Cardinality: [1..1]
Mlpp Domain Id Use -1 to set to null
  • Field Name: mlppDomainId
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Gate Keeper Info
  • Field Name: gateKeeperInfo
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Gate Keeper Name *
  • Field Name: gateKeeperInfo.gateKeeperName
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Technology Prefix *
  • Field Name: gateKeeperInfo.technologyPrefix
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50
E164 *
  • Field Name: gateKeeperInfo.e164
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
  • MaxLength: 50
Zone *
  • Field Name: gateKeeperInfo.zone
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50
Aar Neighborhood Name
  • Field Name: aarNeighborhoodName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Location Name *
  • Field Name: locationName
  • Type: String
  • Cardinality: [1..1]
Unattended Port Applicable only for H323Phones and H323Trunks.Not for Gateways.
  • Field Name: unattendedPort
  • Type: Boolean
  • Cardinality: [0..1]
Remote Device
  • Field Name: remoteDevice
  • Type: Boolean
  • Cardinality: [0..1]
Automated Alternate Routing Css Name
  • Field Name: automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Device Pool Name *
  • Field Name: devicePoolName
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
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
Display Ascii
  • Field Name: lines.line.[n].displayAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
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"]
Busy Trigger Default: 1
  • Field Name: lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Label
  • Field Name: lines.line.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Display
  • Field Name: lines.line.[n].display
  • 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]
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
  • Cardinality: [1..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"]
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
Ascii Label
  • Field Name: lines.line.[n].asciiLabel
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
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
Monitoring Css Name
  • Field Name: lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Speed Dial
  • Field Name: lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
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