Operations on certain device models affect dependent device models.
These are indicated as operations and list of descendants.
GET http://[host-proxy]/api/device/cucm/Phone/schema/?hierarchy=[hierarchy]&format=json&schema=1
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"directoryUrl": {
"description": " Enter the server from which the phone obtains directory information. Leave this field blank to accept the default setting. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you set a Secured Directory URL enterprise parameter in the Enterprise Parameters Configuration window, that value overwrites the value of this field. \n \n \n ",
"title": "Directory",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"protocol": {
"description": "Protocol option is read-only,except when creating a device.",
"title": "Device Protocol",
"minItems": 1,
"required": true,
"choices": [
{
"value": "SCCP",
"title": "SCCP"
},
{
"value": "Digital Access PRI",
"title": "Digital Access PRI"
},
{
"value": "H.225",
"title": "H.225"
},
{
"value": "Analog Access",
"title": "Analog Access"
},
{
"value": "Digital Access T1",
"title": "Digital Access T1"
},
{
"value": "Route Point",
"title": "Route Point"
},
{
"value": "Unicast Bridge",
"title": "Unicast Bridge"
},
{
"value": "Multicast Point",
"title": "Multicast Point"
},
{
"value": "Inter-Cluster Trunk",
"title": "Inter-Cluster Trunk"
},
{
"value": "RAS",
"title": "RAS"
},
{
"value": "Digital Access BRI",
"title": "Digital Access BRI"
},
{
"value": "SIP",
"title": "SIP"
},
{
"value": "MGCP",
"title": "MGCP"
},
{
"value": "Static SIP Mobile Subscriber",
"title": "Static SIP Mobile Subscriber"
},
{
"value": "SIP Connector",
"title": "SIP Connector"
},
{
"value": "Remote Destination",
"title": "Remote Destination"
},
{
"value": "Mobile Smart Client",
"title": "Mobile Smart Client"
},
{
"value": "Digital Access E1 R2",
"title": "Digital Access E1 R2"
},
{
"value": "CTI Remote Device",
"title": "CTI Remote Device"
},
{
"value": "Protocol Not Specified",
"title": "Protocol Not Specified"
}
],
"maxItems": 1,
"type": "string"
},
"secureInformationUrl": {
"description": " Enter the secure URL for the server location where the \n Cisco Unified IP Phone can find help text information. This information displays when the user presses the information (i) button or the question mark (?) button. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you do not provide a Secure Information URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. \n \n \n To accept the default setting, leave this field blank. Maximum length: 255 ",
"title": "Secure Information URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"authenticationMode": {
"description": " This field allows you to choose the authentication method that the phone uses during the CAPF certificate operation. From the drop-down list box, choose one of the following options: \n \n \n By Authentication String\u2014Installs/upgrades, deletes, or troubleshoots a locally significant certificate only when the user enters the CAPF authentication string on the phone. \n \n By Null String\u2014 Installs/upgrades, deletes, or troubleshoots a locally significant certificate without user intervention. This option provides no security; Cisco strongly recommends that you choose this option only for closed, secure environments. \n \n By Existing Certificate (Precedence to LSC)\u2014Installs/upgrades, deletes, or troubleshoots a locally significant certificate if a manufacture-installed certificate (MIC) or locally significant certificate (LSC) exists in the phone. If a LSC exists in the phone, authentication occurs via the LSC, regardless whether a MIC exists in the phone. If a MIC and LSC exist in the phone, authentication occurs via the LSC. If a LSC does not exist in the phone, but a MIC does exist, authentication occurs via the MIC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. At any time, the phone uses only one certificate to authenticate to CAPF even though a MIC and LSC can exist in the phone at the same time. If the primary certificate, which takes precedence, becomes compromised for any reason, or, if you want to authenticate via the other certificate, you must update the authentication mode. \n \n By Existing Certificate (Precedence to MIC)\u2014Installs, upgrades, deletes, or troubleshoots a locally significant certificate if a LSC or MIC exists in the phone. If a MIC exists in the phone, authentication occurs via the MIC, regardless whether a LSC exists in the phone. If a LSC exists in the phone, but a MIC does not exist, authentication occurs via the LSC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. \n \n \n ",
"title": "Authentication Mode",
"minItems": 0,
"required": false,
"choices": [
{
"value": "By Authentication String",
"title": "By Authentication String"
},
{
"value": "By Null String",
"title": "By Null String"
},
{
"value": "By Existing Certificate (precedence to LSC)",
"title": "By Existing Certificate (precedence to LSC)"
},
{
"value": "By Existing Certificate (precedence to MIC)",
"title": "By Existing Certificate (precedence to MIC)"
}
],
"default": "By Null String",
"maxItems": 1,
"type": "string"
},
"requireDtmfReception": {
"description": " For phones that are running SIP and SCCP, check this check box to require DTMF reception for this phone. \n \n \n \n Note\u00a0\u00a0\u00a0 \n In configuring \n Cisco Unified Mobility features, when using intercluster DNs as remote destinations for an IP phone via SIP trunk (either intercluster trunk [ICT] or gateway), check this check box so that DTMF digits can be received out of band, which is crucial for Enterprise Feature Access midcall features. \n \n \n ",
"title": "Require DTMF Reception",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"phoneTemplateName": {
"description": " Choose the appropriate phone button template. The phone button template determines the configuration of buttons on a phone and identifies which feature (line, speed dial, and so on) is used for each button. Cisco Unified CM does not make this field available for H.323 clients or CTI ports. ",
"title": "BAT Phone Template",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/PhoneButtonTemplate/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/PhoneButtonTemplate",
"choices": []
},
"callingSearchSpaceName": {
"description": " From the drop-down list box, choose the appropriate calling search space (CSS). A calling search space comprises a collection of partitions that are searched to determine how a dialed number should be routed. The calling search space for the device and the calling search space for the directory number get used together. The directory number CSS takes precedence over the device CSS. \n \n \n \n Note\u00a0\u00a0\u00a0 \n When set to <none>, Unified CM uses the device mobility calling search space, which is configured on the device pool. \n \n \n ",
"title": "Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Css",
"choices": []
},
"mraServiceDomain": {
"title": "MRA Service Domain",
"minItems": 0,
"required": false,
"readonly": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"cgpnIngressDN": {
"description": " From the drop-down list box, choose the calling search space (CSS) that contains the calling party transformation pattern that you want to apply on the calling number when this phone initiates a call. Cisco Unified CM transforms the calling party using the digit transformations configured on the matching calling party transformation pattern when this phone initiates a call. This setting allows you to transform the calling party number before Cisco Unified CM routes the call. For example, a transformation pattern can change a phone extension to an E.164 number. This setting is generally configured when a user dials using a URI instead of digits. Cisco Unified CM allows calling party transformations on various patterns when dialing using digits, this setting provides similar transformation provision even when dialing using a URI. ",
"title": "Calling Party Transformation CSS",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"useTrustedRelayPoint": {
"description": " From the drop-down list box, enable or disable whether Cisco Unified CM inserts a trusted relay point (TRP) device with this media endpoint. Choose one of the following values: \n \n \n Default\u2014If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates. \n \n Off\u2014Choose this value to disable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. \n \n On\u2014Choose this value to enable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. \n A Trusted Relay Point (TRP) device designates an MTP or transcoder device that is labeled as Trusted Relay Point. Cisco Unified CM places the TRP closest to the associated endpoint device if more than one resource is needed for the endpoint (for example, a transcoder or RSVPAgent). If both TRP and MTP are required for the endpoint, TRP gets used as the required MTP. If both TRP and RSVPAgent are needed for the endpoint, Cisco Unified CM first tries to find an RSVPAgent that can also be used as a TRP. If both TRP and transcoder are needed for the endpoint, Cisco Unified CM first tries to find a transcoder that is also designated as a TRP. ",
"title": "Use Trusted Relay Point",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"networkLocale": {
"description": " From the drop-down list box, choose the locale that is associated with the phone. The network locale contains a definition of the tones and cadences that the phone in a specific geographic area uses. Cisco Unified CM makes this field available only for phone models that support localization. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If no network locale is specified, Cisco Unified CM uses the network locale that is associated with the device pool. If users require that country-specific tones be played (on the phone), verify that the locale is installed before configuring the network locale. See the \n Cisco Unified Communications Manager Locale Installer documentation. \n \n \n ",
"title": "Network Locale",
"minItems": 0,
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Country/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Country"
},
"ringSettingBusyBlfAudibleAlert": {
"description": " This setting determines the BLF audible alert setting when at least one active call exists on the BLF DN, but no call pickup alerts exist: \n \n \n On\u2014An audible alert sounds. \n \n Off\u2014No audible alert sounds. \n \n Default\u2014The configuration in the Service Parameters Configuration window determines the alert option. \n ",
"title": "BLF Audible Alert Setting (Phone Busy)",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"msisdn": {
"description": "Mobile Subscriber ISDN",
"title": "Msisdn",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": [
"string",
"null"
]
},
"userLocale": {
"description": " 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 to support users, including language and font. Cisco Unified CM makes this field available only for phone models that support localization. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If no user locale is specified, Cisco Unified Communications Manager uses the user locale that is associated with the common device configurations. If the users require that information be displayed (on the phone) in any language other than English, verify that the locale installer is installed before configuring user locale. See the \n Cisco Unified Communications Manager Locale Installer documentation. \n \n \n ",
"title": "User Locale",
"minItems": 0,
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/UserLocale/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/UserLocale"
},
"deviceMobilityMode": {
"description": " From the drop-down list box, 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. Click View Current Device Mobility Settings to display the current values of these device mobility parameters: \n \n \n \n Cisco Unified Communications Manager Group \n \n Roaming Device Pool \n \n Location \n \n Region \n \n Network Locale \n \n AAR Group \n \n AAR Calling Search Space \n \n Device Calling Search Space \n \n Media Resource Group List \n \n SRST \n ",
"title": "Device Mobility Mode",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"elinGroup": {
"title": "Elin Group",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"outboundCallRollover": {
"description": " Use this setting for the \n Cisco Unified IP Phone 7931. \n \n \n No Rollover\u2014Conference and transfer will not work in this mode. If a user attempts to use either of these features, the phone status displays as \"Error Pass Limit.\" Choose this setting only if you need to support CTI applications. \n \n Rollover Within Same DN\u2014Conferences and call transfers complete by using the same directory number (on different lines). For example, consider a phone that has directory number 1506 that is assigned to both Line 6 and 7. The user has an active call on Line 6 and decides to transfer the call. When the user presses the Transfer button, the call on Line 6 gets placed on hold, and a new call initiates on Line 7 to complete the transfer. \n \n Rollover to any line\u2014Conferences and call transfers complete by using a different directory number and line than the original call. For example, consider a phone that has directory number 1507 assigned to Line 8 and directory number 1508 assigned to Line 9. The user has an active call on Line 8 and decides to transfer the call. When the user presses the Transfer button, the call on Line 8 gets placed on hold, and a new call initiates on Line 9 to complete the transfer. \n ",
"title": "Outbound Call Rollover",
"minItems": 0,
"required": false,
"choices": [
{
"value": "No Rollover",
"title": "No Rollover"
},
{
"value": "Rollover Within Same DN",
"title": "Rollover Within Same DN"
},
{
"value": "Rollover to any line",
"title": "Rollover to any line"
}
],
"default": "No Rollover",
"maxItems": 1,
"type": "string"
},
"ip_address": {
"type": "string",
"description": "IP address of the phone",
"title": "IP Address"
},
"primaryPhoneName": {
"description": " Choose the physical phone that will be associated with the application, such as IP communicator or Cisco Unified Personal Communicator. When you choose a primary phone, the application consumes fewer device license units and is considered an \"adjunct\" license (to the primary phone). ",
"title": "Primary Phone",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Phone",
"choices": []
},
"name": {
"description": " Enter a name to identify software-based telephones, H.323 clients, and CTI ports. For device names that are not based on a MAC address, as a general rule, you can enter 1 to 15 characters comprised of alphanumeric characters (a-z, A-D, 0-9). In most cases you can use dot (.), dash (-), and underscore (_) as well. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n Because the rules for the device name field depend on the device type, Cisco recommends that you see the product documentation to determine which character set is valid for your device, as well as the number of characters allowed. For example, when you configure the device name for the \n Cisco Unified Personal Communicator, make sure that the name starts with UPC. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Ensure that the device name of a \n Cisco Unified Mobile Communicator does not exceed 15 characters. If the device name of a \n Cisco Unified Mobile Communicator exceeds 15 characters, migration of this device will fail upon upgrade to a different release of \n Cisco Unified Communications Manager. If an existing \n Cisco Unified Mobile Communicator device name specifies a longer name, shorten the device name to 15 or fewer characters. \n Cisco Unified Mobile Communicator supports dual mode phones. The preceding limit of 15 characters also applies to \n Cisco Unified Mobile Communicator dual mode. When the MI for a dual mode phone is longer than 15 characters, the cellular network rejects the phone registration. \n \n \n ",
"title": "Device Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"retryVideoCallAsAudio": {
"description": " This check box applies only to video endpoints that receive a call. If this phone receives a call that does not connect as video, the call tries to connect as an audio call. By default, the system checks this check box to specify that this device should immediately retry a video call as an audio call (if it cannot connect as a video call) prior to sending the call to call control for rerouting. If you uncheck this check box, a video call that fails to connect as video does not try to establish as an audio call. The call then fails to call control, and call control routes the call via automatic alternate routing (AAR) and/or route/hunt list. ",
"title": "Retry Video Call as Audio",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"callInfoPrivacyStatus": {
"description": " For each phone that wants Privacy, choose On in the Privacy drop-down list box. ",
"title": "Privacy",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"geoLocationFilterName": {
"title": "Geo Location Filter Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/GeoLocationFilter/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/GeoLocationFilter",
"choices": []
},
"phoneServiceDisplay": {
"description": " From the drop-down list box, choose how the phone will support the services: \n \n \n Internal\u2014The phone uses the phone configuration file to support the service. Choose this option or Both for Cisco-provided default services where the Service URL has not been updated; that is, the service URL indicates Application:Cisco/<name of service>; for example, Application:Cisco/CorporateDirectory. Choose Internal or Both for Cisco-signed Java MIDlets because Cisco-signed Java MIDlets are provisioned in the configuration file. \n \n External URL\u2014Choosing External URL indicates that the phone ignores the services in the phone configuration file and retrieves the services from a Service URL. If you configured a custom Service URL for a service, including a Cisco-provided default service, you must choose either External URL or Both; if you choose Internal in this case, the services that are associated with the custom URLs do not work on the phone. \n \n Both\u2014Choosing Both indicates that the phone support both the services that are defined in the configuration file and external applications that are retrieved from service URLs. \n ",
"title": "Services Provisioning",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Internal",
"title": "Internal"
},
{
"value": "External URL",
"title": "External URL"
},
{
"value": "Both",
"title": "Both"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"keyOrder": {
"description": "keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.",
"title": "Key Order",
"minItems": 0,
"required": false,
"choices": [
{
"value": "RSA Only",
"title": "RSA Only"
},
{
"value": "EC Only",
"title": "EC Only"
},
{
"value": "EC Preferred, RSA Backup",
"title": "EC Preferred, RSA Backup"
}
],
"default": "RSA Only",
"maxItems": 1,
"type": "string"
},
"secureDirectoryUrl": {
"description": " Enter the secure URL for the server from which the phone obtains directory information. This parameter specifies the URL that secured \n Cisco Unified IP Phones use when you press the Directory button. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you do not provide a Secure Directory URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. \n \n \n Leave this field blank to accept the default setting. Maximum length: 255 ",
"title": "Secure Directory URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"alwaysUsePrimeLineForVoiceMessage": {
"description": " From the drop-down list box, choose one of the following options: \n \n \n On\u2014If 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. \n \n Off\u2014If 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 CM 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. \n \n Default\u2014Cisco Unified CM uses the configuration from the Always Use Prime Line for Voice Message service parameter, which supports the Cisco CallManager service. \n ",
"title": "Always Use Prime Line for Voice Message",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"mtpRequired": {
"description": "This field is applicable only to SIP phones.",
"title": "Mtp Required",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"secureMessageUrl": {
"description": " Enter the secure URL for the messages server. The \n Cisco Unified IP Phone contacts this URL when the user presses the Messages button. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you do not provide a Secure Messages URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. \n \n \n To accept the default setting, leave this field blank. Maximum length: 255 ",
"title": "Secure Messages URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"keySize": {
"description": " For this setting that is used for CAPF, choose the key size for the certificate from the drop-down list box. The default setting equals 1024. Other options include 512 and 2048. If you choose a higher key size than the default setting, the phones take longer to generate the entropy that is required to generate the keys. Key generation, which is set at low priority, allows the phone to function while the action occurs. Depending on the phone model, you may notice that key generation takes up to 30 or more minutes to complete. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. \n \n \n ",
"title": "Key Size (Bits)",
"minItems": 0,
"required": false,
"choices": [
{
"value": "512",
"title": "512"
},
{
"value": "1024",
"title": "1024"
},
{
"value": "2048",
"title": "2048"
},
{
"value": "3072",
"title": "3072"
},
{
"value": "4096",
"title": "4096"
}
],
"default": "2048",
"maxItems": 1,
"type": "string"
},
"proxyServerUrl": {
"description": " Enter the host and port (for example, proxy.cisco.com:80) that are used to proxy HTTP requests for access to non-local host addresses from the phone HTTP client. \n \n The rule contains two parts for when to use the proxy server parameter: \n \n \n The hostname contains a \".\" \n \n The hostname specifies an IP address in any form. \n \n If you do not configure this URL, the phone attempts to connect directly to the URL. To accept the default setting, leave this field blank. ",
"title": "Proxy Server",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"addOnModules": {
"description": "Additional modules attached to the Phone.There can be 0,1, 2 or 3.",
"title": "Add On Modules",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"null",
"object"
],
"properties": {
"addOnModule": {
"name": "addOnModule",
"title": "Add On Module",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"loadInformation": {
"description": " Enter the custom software for the appropriate expansion module, if applicable. The value that you enter overrides the default value for the current model. Ensure the firmware load matches the module load. ",
"title": "Module 3 Load Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "loadInformation"
},
"model": {
"description": "Model ID string.",
"title": "Model",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Cisco 30 SP+",
"title": "Cisco 30 SP+"
},
{
"value": "Cisco 12 SP+",
"title": "Cisco 12 SP+"
},
{
"value": "Cisco 12 SP",
"title": "Cisco 12 SP"
},
{
"value": "Cisco 12 S",
"title": "Cisco 12 S"
},
{
"value": "Cisco 30 VIP",
"title": "Cisco 30 VIP"
},
{
"value": "Cisco 7910",
"title": "Cisco 7910"
},
{
"value": "Cisco 7960",
"title": "Cisco 7960"
},
{
"value": "Cisco 7940",
"title": "Cisco 7940"
},
{
"value": "Cisco 7935",
"title": "Cisco 7935"
},
{
"value": "Cisco VGC Phone",
"title": "Cisco VGC Phone"
},
{
"value": "Cisco VGC Virtual Phone",
"title": "Cisco VGC Virtual Phone"
},
{
"value": "Cisco ATA 186",
"title": "Cisco ATA 186"
},
{
"value": "EMCC Base Phone",
"title": "EMCC Base Phone"
},
{
"value": "SCCP Phone",
"title": "SCCP Phone"
},
{
"value": "Analog Access",
"title": "Analog Access"
},
{
"value": "Digital Access",
"title": "Digital Access"
},
{
"value": "Digital Access+",
"title": "Digital Access+"
},
{
"value": "Digital Access WS-X6608",
"title": "Digital Access WS-X6608"
},
{
"value": "Analog Access WS-X6624",
"title": "Analog Access WS-X6624"
},
{
"value": "VGC Gateway",
"title": "VGC Gateway"
},
{
"value": "Conference Bridge",
"title": "Conference Bridge"
},
{
"value": "Conference Bridge WS-X6608",
"title": "Conference Bridge WS-X6608"
},
{
"value": "Cisco IOS Conference Bridge (HDV2)",
"title": "Cisco IOS Conference Bridge (HDV2)"
},
{
"value": "Cisco Conference Bridge (WS-SVC-CMM)",
"title": "Cisco Conference Bridge (WS-SVC-CMM)"
},
{
"value": "H.323 Phone",
"title": "H.323 Phone"
},
{
"value": "H.323 Gateway",
"title": "H.323 Gateway"
},
{
"value": "Music On Hold",
"title": "Music On Hold"
},
{
"value": "Device Pilot",
"title": "Device Pilot"
},
{
"value": "CTI Port",
"title": "CTI Port"
},
{
"value": "CTI Route Point",
"title": "CTI Route Point"
},
{
"value": "Voice Mail Port",
"title": "Voice Mail Port"
},
{
"value": "Cisco IOS Software Media Termination Point (HDV2)",
"title": "Cisco IOS Software Media Termination Point (HDV2)"
},
{
"value": "Cisco Media Server (WS-SVC-CMM-MS)",
"title": "Cisco Media Server (WS-SVC-CMM-MS)"
},
{
"value": "Cisco Video Conference Bridge (IPVC-35xx)",
"title": "Cisco Video Conference Bridge (IPVC-35xx)"
},
{
"value": "Cisco IOS Heterogeneous Video Conference Bridge",
"title": "Cisco IOS Heterogeneous Video Conference Bridge"
},
{
"value": "Cisco IOS Guaranteed Audio Video Conference Bridge",
"title": "Cisco IOS Guaranteed Audio Video Conference Bridge"
},
{
"value": "Cisco IOS Homogeneous Video Conference Bridge",
"title": "Cisco IOS Homogeneous Video Conference Bridge"
},
{
"value": "Route List",
"title": "Route List"
},
{
"value": "Load Simulator",
"title": "Load Simulator"
},
{
"value": "Media Termination Point",
"title": "Media Termination Point"
},
{
"value": "Media Termination Point Hardware",
"title": "Media Termination Point Hardware"
},
{
"value": "Cisco IOS Media Termination Point (HDV2)",
"title": "Cisco IOS Media Termination Point (HDV2)"
},
{
"value": "Cisco Media Termination Point (WS-SVC-CMM)",
"title": "Cisco Media Termination Point (WS-SVC-CMM)"
},
{
"value": "Cisco 7941",
"title": "Cisco 7941"
},
{
"value": "Cisco 7971",
"title": "Cisco 7971"
},
{
"value": "MGCP Station",
"title": "MGCP Station"
},
{
"value": "MGCP Trunk",
"title": "MGCP Trunk"
},
{
"value": "GateKeeper",
"title": "GateKeeper"
},
{
"value": "7914 14-Button Line Expansion Module",
"title": "7914 14-Button Line Expansion Module"
},
{
"value": "Trunk",
"title": "Trunk"
},
{
"value": "Tone Announcement Player",
"title": "Tone Announcement Player"
},
{
"value": "SIP Trunk",
"title": "SIP Trunk"
},
{
"value": "SIP Gateway",
"title": "SIP Gateway"
},
{
"value": "WSM Trunk",
"title": "WSM Trunk"
},
{
"value": "Remote Destination Profile",
"title": "Remote Destination Profile"
},
{
"value": "7915 12-Button Line Expansion Module",
"title": "7915 12-Button Line Expansion Module"
},
{
"value": "7915 24-Button Line Expansion Module",
"title": "7915 24-Button Line Expansion Module"
},
{
"value": "7916 12-Button Line Expansion Module",
"title": "7916 12-Button Line Expansion Module"
},
{
"value": "7916 24-Button Line Expansion Module",
"title": "7916 24-Button Line Expansion Module"
},
{
"value": "CKEM 36-Button Line Expansion Module",
"title": "CKEM 36-Button Line Expansion Module"
},
{
"value": "SPA8800",
"title": "SPA8800"
},
{
"value": "Unknown MGCP Gateway",
"title": "Unknown MGCP Gateway"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "Cisco 7985",
"title": "Cisco 7985"
},
{
"value": "Cisco 7911",
"title": "Cisco 7911"
},
{
"value": "Cisco 7961G-GE",
"title": "Cisco 7961G-GE"
},
{
"value": "Cisco 7941G-GE",
"title": "Cisco 7941G-GE"
},
{
"value": "Motorola CN622",
"title": "Motorola CN622"
},
{
"value": "Third-party SIP Device (Basic)",
"title": "Third-party SIP Device (Basic)"
},
{
"value": "Cisco 7931",
"title": "Cisco 7931"
},
{
"value": "Cisco Unified Personal Communicator",
"title": "Cisco Unified Personal Communicator"
},
{
"value": "Cisco 7921",
"title": "Cisco 7921"
},
{
"value": "Cisco 7906",
"title": "Cisco 7906"
},
{
"value": "Third-party SIP Device (Advanced)",
"title": "Third-party SIP Device (Advanced)"
},
{
"value": "Cisco TelePresence",
"title": "Cisco TelePresence"
},
{
"value": "Nokia S60",
"title": "Nokia S60"
},
{
"value": "Cisco 7962",
"title": "Cisco 7962"
},
{
"value": "Cisco 3951",
"title": "Cisco 3951"
},
{
"value": "Cisco 7937",
"title": "Cisco 7937"
},
{
"value": "Cisco 7942",
"title": "Cisco 7942"
},
{
"value": "Cisco 7945",
"title": "Cisco 7945"
},
{
"value": "Cisco 7965",
"title": "Cisco 7965"
},
{
"value": "Cisco 7975",
"title": "Cisco 7975"
},
{
"value": "Cisco 3911",
"title": "Cisco 3911"
},
{
"value": "Cisco Unified Mobile Communicator",
"title": "Cisco Unified Mobile Communicator"
},
{
"value": "Cisco TelePresence 1000",
"title": "Cisco TelePresence 1000"
},
{
"value": "Cisco TelePresence 3000",
"title": "Cisco TelePresence 3000"
},
{
"value": "Cisco TelePresence 3200",
"title": "Cisco TelePresence 3200"
},
{
"value": "Cisco TelePresence 500-37",
"title": "Cisco TelePresence 500-37"
},
{
"value": "Cisco 7925",
"title": "Cisco 7925"
},
{
"value": "Cisco 9971",
"title": "Cisco 9971"
},
{
"value": "Cisco 6921",
"title": "Cisco 6921"
},
{
"value": "Cisco 6941",
"title": "Cisco 6941"
},
{
"value": "Cisco 6961",
"title": "Cisco 6961"
},
{
"value": "Cisco Unified Client Services Framework",
"title": "Cisco Unified Client Services Framework"
},
{
"value": "Cisco TelePresence 1300-65",
"title": "Cisco TelePresence 1300-65"
},
{
"value": "Cisco TelePresence 1100",
"title": "Cisco TelePresence 1100"
},
{
"value": "Transnova S3",
"title": "Transnova S3"
},
{
"value": "BlackBerry MVS VoWifi",
"title": "BlackBerry MVS VoWifi"
},
{
"value": "Cisco 9951",
"title": "Cisco 9951"
},
{
"value": "Cisco 8961",
"title": "Cisco 8961"
},
{
"value": "Cisco 6901",
"title": "Cisco 6901"
},
{
"value": "Cisco 6911",
"title": "Cisco 6911"
},
{
"value": "Cisco ATA 187",
"title": "Cisco ATA 187"
},
{
"value": "Cisco TelePresence 200",
"title": "Cisco TelePresence 200"
},
{
"value": "Cisco TelePresence 400",
"title": "Cisco TelePresence 400"
},
{
"value": "Cisco Dual Mode for iPhone",
"title": "Cisco Dual Mode for iPhone"
},
{
"value": "Cisco 6945",
"title": "Cisco 6945"
},
{
"value": "Cisco Dual Mode for Android",
"title": "Cisco Dual Mode for Android"
},
{
"value": "Cisco 7926",
"title": "Cisco 7926"
},
{
"value": "Cisco E20",
"title": "Cisco E20"
},
{
"value": "Generic Single Screen Room System",
"title": "Generic Single Screen Room System"
},
{
"value": "Generic Multiple Screen Room System",
"title": "Generic Multiple Screen Room System"
},
{
"value": "Cisco TelePresence EX90",
"title": "Cisco TelePresence EX90"
},
{
"value": "Cisco 8945",
"title": "Cisco 8945"
},
{
"value": "Cisco 8941",
"title": "Cisco 8941"
},
{
"value": "Generic Desktop Video Endpoint",
"title": "Generic Desktop Video Endpoint"
},
{
"value": "Cisco TelePresence 500-32",
"title": "Cisco TelePresence 500-32"
},
{
"value": "Cisco TelePresence 1300-47",
"title": "Cisco TelePresence 1300-47"
},
{
"value": "Cisco 3905",
"title": "Cisco 3905"
},
{
"value": "Cisco Cius",
"title": "Cisco Cius"
},
{
"value": "VKEM 36-Button Line Expansion Module",
"title": "VKEM 36-Button Line Expansion Module"
},
{
"value": "Cisco TelePresence TX1310-65",
"title": "Cisco TelePresence TX1310-65"
},
{
"value": "Cisco TelePresence MCU",
"title": "Cisco TelePresence MCU"
},
{
"value": "Ascom IP-DECT Device",
"title": "Ascom IP-DECT Device"
},
{
"value": "Cisco TelePresence Exchange System",
"title": "Cisco TelePresence Exchange System"
},
{
"value": "Cisco TelePresence EX60",
"title": "Cisco TelePresence EX60"
},
{
"value": "Cisco TelePresence Codec C90",
"title": "Cisco TelePresence Codec C90"
},
{
"value": "Cisco TelePresence Codec C60",
"title": "Cisco TelePresence Codec C60"
},
{
"value": "Cisco TelePresence Codec C40",
"title": "Cisco TelePresence Codec C40"
},
{
"value": "Cisco TelePresence Quick Set C20",
"title": "Cisco TelePresence Quick Set C20"
},
{
"value": "Cisco TelePresence Profile 42 (C20)",
"title": "Cisco TelePresence Profile 42 (C20)"
},
{
"value": "Cisco TelePresence Profile 42 (C60)",
"title": "Cisco TelePresence Profile 42 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 (C40)",
"title": "Cisco TelePresence Profile 52 (C40)"
},
{
"value": "Cisco TelePresence Profile 52 (C60)",
"title": "Cisco TelePresence Profile 52 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 Dual (C60)",
"title": "Cisco TelePresence Profile 52 Dual (C60)"
},
{
"value": "Cisco TelePresence Profile 65 (C60)",
"title": "Cisco TelePresence Profile 65 (C60)"
},
{
"value": "Cisco TelePresence Profile 65 Dual (C90)",
"title": "Cisco TelePresence Profile 65 Dual (C90)"
},
{
"value": "Cisco TelePresence MX200",
"title": "Cisco TelePresence MX200"
},
{
"value": "Cisco TelePresence TX9000",
"title": "Cisco TelePresence TX9000"
},
{
"value": "Cisco TelePresence TX9200",
"title": "Cisco TelePresence TX9200"
},
{
"value": "Cisco 7821",
"title": "Cisco 7821"
},
{
"value": "Cisco 7841",
"title": "Cisco 7841"
},
{
"value": "Cisco 7861",
"title": "Cisco 7861"
},
{
"value": "Cisco TelePresence SX20",
"title": "Cisco TelePresence SX20"
},
{
"value": "Cisco TelePresence MX300",
"title": "Cisco TelePresence MX300"
},
{
"value": "IMS-integrated Mobile (Basic)",
"title": "IMS-integrated Mobile (Basic)"
},
{
"value": "Third-party AS-SIP Endpoint",
"title": "Third-party AS-SIP Endpoint"
},
{
"value": "Cisco Cius SP",
"title": "Cisco Cius SP"
},
{
"value": "Cisco TelePresence Profile 42 (C40)",
"title": "Cisco TelePresence Profile 42 (C40)"
},
{
"value": "Cisco VXC 6215",
"title": "Cisco VXC 6215"
},
{
"value": "CTI Remote Device",
"title": "CTI Remote Device"
},
{
"value": "Usage Profile",
"title": "Usage Profile"
},
{
"value": "Carrier-integrated Mobile",
"title": "Carrier-integrated Mobile"
},
{
"value": "Universal Device Template",
"title": "Universal Device Template"
},
{
"value": "Cisco DX650",
"title": "Cisco DX650"
},
{
"value": "Cisco Unified Communications for RTX",
"title": "Cisco Unified Communications for RTX"
},
{
"value": "Cisco Jabber for Tablet",
"title": "Cisco Jabber for Tablet"
},
{
"value": "Cisco 8831",
"title": "Cisco 8831"
},
{
"value": "Cisco ATA 190",
"title": "Cisco ATA 190"
},
{
"value": "Cisco TelePresence SX10",
"title": "Cisco TelePresence SX10"
},
{
"value": "Cisco 8841",
"title": "Cisco 8841"
},
{
"value": "Cisco 8851",
"title": "Cisco 8851"
},
{
"value": "Cisco 8861",
"title": "Cisco 8861"
},
{
"value": "Cisco TelePresence SX80",
"title": "Cisco TelePresence SX80"
},
{
"value": "Cisco TelePresence MX200 G2",
"title": "Cisco TelePresence MX200 G2"
},
{
"value": "Cisco TelePresence MX300 G2",
"title": "Cisco TelePresence MX300 G2"
},
{
"value": "Cisco 7905",
"title": "Cisco 7905"
},
{
"value": "Cisco 7920",
"title": "Cisco 7920"
},
{
"value": "Cisco 7970",
"title": "Cisco 7970"
},
{
"value": "Cisco 7912",
"title": "Cisco 7912"
},
{
"value": "Cisco 7902",
"title": "Cisco 7902"
},
{
"value": "Cisco IP Communicator",
"title": "Cisco IP Communicator"
},
{
"value": "Cisco 7961",
"title": "Cisco 7961"
},
{
"value": "Cisco 7936",
"title": "Cisco 7936"
},
{
"value": "Analog Phone",
"title": "Analog Phone"
},
{
"value": "ISDN BRI Phone",
"title": "ISDN BRI Phone"
},
{
"value": "SCCP gateway virtual phone",
"title": "SCCP gateway virtual phone"
},
{
"value": "IP-STE",
"title": "IP-STE"
},
{
"value": "Cisco TelePresence Conductor",
"title": "Cisco TelePresence Conductor"
},
{
"value": "Cisco DX80",
"title": "Cisco DX80"
},
{
"value": "Cisco DX70",
"title": "Cisco DX70"
},
{
"value": "BEKEM 36-Button Line Expansion Module",
"title": "BEKEM 36-Button Line Expansion Module"
},
{
"value": "Cisco TelePresence MX700",
"title": "Cisco TelePresence MX700"
},
{
"value": "Cisco TelePresence MX800",
"title": "Cisco TelePresence MX800"
},
{
"value": "Cisco TelePresence IX5000",
"title": "Cisco TelePresence IX5000"
},
{
"value": "Cisco 7811",
"title": "Cisco 7811"
},
{
"value": "Cisco 8821",
"title": "Cisco 8821"
},
{
"value": "Cisco 8811",
"title": "Cisco 8811"
},
{
"value": "Interactive Voice Response",
"title": "Interactive Voice Response"
},
{
"value": "Cisco 8845",
"title": "Cisco 8845"
},
{
"value": "Cisco 8865",
"title": "Cisco 8865"
},
{
"value": "Cisco TelePresence MX800 Dual",
"title": "Cisco TelePresence MX800 Dual"
},
{
"value": "Cisco 8851NR",
"title": "Cisco 8851NR"
},
{
"value": "Cisco Spark Remote Device",
"title": "Cisco Spark Remote Device"
},
{
"value": "Cisco Webex DX80",
"title": "Cisco Webex DX80"
},
{
"value": "Cisco TelePresence DX70",
"title": "Cisco TelePresence DX70"
},
{
"value": "Cisco 7832",
"title": "Cisco 7832"
},
{
"value": "Cisco 8865NR",
"title": "Cisco 8865NR"
},
{
"value": "Cisco Meeting Server",
"title": "Cisco Meeting Server"
},
{
"value": "Cisco Webex Room Kit",
"title": "Cisco Webex Room Kit"
},
{
"value": "Cisco Webex Room 55",
"title": "Cisco Webex Room 55"
},
{
"value": "Cisco Webex Room Kit Plus",
"title": "Cisco Webex Room Kit Plus"
},
{
"value": "CP-8800-Video 28-Button Key Expansion Module",
"title": "CP-8800-Video 28-Button Key Expansion Module"
},
{
"value": "CP-8800-Audio 28-Button Key Expansion Module",
"title": "CP-8800-Audio 28-Button Key Expansion Module"
},
{
"value": "Cisco 8832",
"title": "Cisco 8832"
},
{
"value": "Cisco Webex Room 70 Single",
"title": "Cisco Webex Room 70 Single"
},
{
"value": "Cisco 8832NR",
"title": "Cisco 8832NR"
},
{
"value": "Cisco ATA 191",
"title": "Cisco ATA 191"
},
{
"value": "Cisco Collaboration Mobile Convergence",
"title": "Cisco Collaboration Mobile Convergence"
},
{
"value": "Cisco Webex Room 70 Dual",
"title": "Cisco Webex Room 70 Dual"
},
{
"value": "Cisco Webex Room Kit Pro",
"title": "Cisco Webex Room Kit Pro"
},
{
"value": "Cisco Webex Room 55 Dual",
"title": "Cisco Webex Room 55 Dual"
},
{
"value": "Cisco Webex Room 70 Single G2",
"title": "Cisco Webex Room 70 Single G2"
},
{
"value": "Cisco Webex Room 70 Dual G2",
"title": "Cisco Webex Room 70 Dual G2"
},
{
"value": "SIP Station",
"title": "SIP Station"
},
{
"value": "Cisco Webex Room Kit Mini",
"title": "Cisco Webex Room Kit Mini"
},
{
"value": "Cisco Webex VDI Svc Framework",
"title": "Cisco Webex VDI Svc Framework"
},
{
"value": "Cisco Webex Board 55",
"title": "Cisco Webex Board 55"
},
{
"value": "Cisco Webex Board 70",
"title": "Cisco Webex Board 70"
},
{
"value": "Cisco Webex Board 85",
"title": "Cisco Webex Board 85"
},
{
"value": "Cisco Webex Desk Pro",
"title": "Cisco Webex Desk Pro"
},
{
"value": "Cisco Webex Room Panorama",
"title": "Cisco Webex Room Panorama"
},
{
"value": "Cisco Webex Room 70 Panorama",
"title": "Cisco Webex Room 70 Panorama"
},
{
"value": "Cisco Webex Room Phone",
"title": "Cisco Webex Room Phone"
},
{
"value": "Cisco 860",
"title": "Cisco 860"
},
{
"value": "Cisco Webex Desk LE",
"title": "Cisco Webex Desk LE"
}
],
"default": "7914 14-Button Line Expansion Module",
"maxItems": 1,
"type": "string",
"name": "model"
},
"index": {
"description": " Choose the appropriate expansion module or none. ",
"title": "Module 3",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer",
"name": "index"
}
}
},
"required": false,
"maxItems": 3,
"type": "array"
}
}
},
"authenticationString": {
"description": " If you chose the By Authentication String option in the Authentication Mode drop-down list box, this field applies. Manually enter a string or generate a string by clicking the Generate String button. Ensure that the string contains 4 to 10 digits. To install, upgrade, delete, or troubleshoot a locally significant certificate, the phone user or administrator must enter the authentication string on the phone. ",
"title": "Authentication String",
"minItems": 0,
"pattern": "^[0-9]{4,10}$",
"required": false,
"maxItems": 1,
"maxLength": 10,
"type": "string",
"minLength": 4
},
"requireOffPremiseLocation": {
"description": "Check this check box if the device inserted requires off-premise location update upon registration. Off-premise location update is required when the device location cannot be detected automatically by Cisco Emergency Responder. Check this check box only for remote or mobile devices that change locations frequently. ",
"title": "Require off-premise location",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"phoneActivationCode": {
"type": [
"string"
],
"description": "The provisioning code which must be entered on the phone",
"title": "Phone Activation Code"
},
"isProtected": {
"description": " Check this check box to designate a phone as protected, which enables the phone to play a 2-second tone to notify the user when a call is encrypted and both phones are configured as protected devices. The tone plays for both parties when the call is answered. The tone does not play unless both phones are protected and the call occurs over encrypted media. Checking this check box represents only one of several configuration requirements for the secure indication tone to play. For a detailed description of the secure indication tone feature and the configuration requirements, see the \n Cisco Unified Communications Manager Security Guide . If you check this check box and the system determines that the call is not encrypted, the phone plays nonsecure indication tone to alert the user that the call is not protected. ",
"title": "Protected Device",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"subscribeCallingSearchSpaceName": {
"description": " Supported with the Presence feature, the SUBSCRIBE calling search space determines how Cisco Unified CM routes presence requests that come from the phone. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the phone. From the drop-down list box, choose the SUBSCRIBE calling search space to use for presence requests for the phone. All calling search spaces that you configure in \n Cisco Unified Communications Manager Administration display in the SUBSCRIBE Calling Search Space drop-down list box. If you do not select a different calling search space for the end user from the drop-down list, the SUBSCRIBE calling search space defaults to None. To configure a SUBSCRIBE calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces. ",
"title": "SUBSCRIBE Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Css",
"choices": []
},
"allowCtiControlFlag": {
"description": " Check this check box to allow CTI to control and monitor this device. If the associated directory number specifies a shared line, the check box should be enabled as long as at least one associated device specifies a combination of device type and protocol that CTI supports. ",
"title": "Allow Control of Device from CTI",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"rfc2833Disabled": {
"description": " For phones that are running SCCP, check this check box to disable RFC2833 support. ",
"title": "RFC2833 Disabled",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"hlogStatus": {
"title": "Hlog Status",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"maxItems": 1,
"type": "string"
},
"upgradeFinishTime": {
"title": "Operation Completes By",
"minItems": 0,
"pattern": "^[0-9]{4}:[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}$|::::00",
"required": false,
"maxItems": 1,
"type": "string",
"description": "The completion deadline for the operation (CCYY:MM:DD:HH:MM)"
},
"isActive": {
"description": " The Device Is Active message in the Phone Configuration window in \n Cisco Unified Communications Manager Administration displays when a phone consumes device license units and when a phone can register with Cisco Unified CM. For a phone that uses a real MAC address, not the dummy MAC address that is created via BAT, the Device Is Active message displays, which indicates that the phone uses device license units and can register with \n Cisco Unified Communications Manager. For a phone that uses the dummy MAC address that is created via BAT, the Device Is Active message does not display. If you manually convert the dummy MAC address to a real MAC address in the Phone Configuration window, the Device Is Active message displays after you save the configuration; this ensures that the phone can register with \n Cisco Unified Communications Manager and that licensing consumes device license units for the phone. ",
"title": "Is Active",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"allowiXApplicableMedia": {
"description": "This field is applicable only for Third-party AS-SIP Endpoint.",
"title": "Allow iX Applicable Media",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"hotlineDevice": {
"description": "This tag is applicable for PLAR-supporting SIP/SCCP phones only",
"title": "Hot line Device",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"securityProfileName": {
"description": " Choose the security profile to apply to the device. You must apply a security profile to all phones that are configured in \n Cisco Unified Communications Manager Administration. \n Installing Cisco Unified Communications Manager provides a set of predefined, nonsecure security profiles for auto-registration. To enable security features for a phone, you must configure a new security profile for the device type and protocol and apply it to the phone. If the phone does not support security, choose a nonsecure profile. To identify the settings that the profile contains, choose System > Security Profile > Phone Security Profile. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The CAPF settings that are configured in the profile relate to the Certificate Authority Proxy Function settings that display in the Phone Configuration window. You must configure CAPF settings for certificate operations that involve manufacturer-installed certificates (MICs) or locally significant certificates (LSC). See the \n Cisco Unified Communications Manager Security Guide for more information about how CAPF settings that you update in the phone configuration window affect security profile CAPF settings. \n \n \n ",
"title": "Device Security Profile",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/PhoneSecurityProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/PhoneSecurityProfile",
"choices": []
},
"dndRingSetting": {
"description": " 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: \n \n \n None\u2014This option specifies that the DND Incoming Call Alert setting from the Common Phone Profile window gets used for this device. \n \n Disable\u2014This 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. \n \n Beep Only\u2014For an incoming call, this option causes the phone to play a beep tone only. \n \n Flash Only\u2014For an incoming call, this option causes the phone to display a flash alert. \n ",
"title": "DND Incoming Call Alert",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"protocolSide": {
"description": "Side information is read-only except when creating a device",
"title": "Protocol Side",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Network",
"title": "Network"
},
{
"value": "User",
"title": "User"
}
],
"default": "User",
"maxItems": 1,
"type": "string"
},
"mlppDomainId": {
"description": " Choose an MLPP domain from the drop-down list box for the MLPP domain that is associated with this device. If you leave the None value, this device inherits its MLPP domain from the value that was set in the common device configuration. If the common device configuration does not have an MLPP domain setting, this device inherits its MLPP domain from the value that was set for the MLPP Domain Identifier enterprise parameter. ",
"title": "MLPP Domain ID",
"minItems": 0,
"pattern": "^[0-9a-fA-F]{6}|-1$",
"format": "uri",
"required": false,
"target_attr": "domainId",
"target": "/api/device/cucm/MlppDomain/choices/?field=domainId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxItems": 1,
"maxLength": 6,
"type": [
"string",
"null"
],
"minLength": 2,
"target_model_type": "device/cucm/MlppDomain",
"choices": []
},
"aarNeighborhoodName": {
"description": " Choose the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. If no AAR group is specified, Cisco Unified CM uses the AAR group that is associated with Device Pool or Line. ",
"title": "AAR Group",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/AarGroup",
"choices": []
},
"locationName": {
"description": " Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC enables you to regulate audio quality and video availability by limiting the amount of bandwidth that is available 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. From the drop-down list box, choose the appropriate location for this \n Cisco Unified IP Phone. A location setting of Hub_None means that the locations feature does not keep track of the bandwidth that this \n Cisco Unified IP Phone consumes. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP. To configure a new location, use the System > Location menu option. ",
"title": "Location",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": "string",
"target_model_type": "device/cucm/Location",
"choices": []
},
"mediaResourceListName": {
"description": " Choose the appropriate Media Resource Group List. A Media Resource Group List comprises a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List. If you choose <None>, Cisco Unified CM uses the Media Resource Group List that is defined in the device pool. ",
"title": "Media Resource Group List",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/MediaResourceList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/MediaResourceList",
"choices": []
},
"devicePoolName": {
"description": " Choose the device pool to which you want this phone assigned. The device pool defines sets of common characteristics for devices, such as region, date/time group, and softkey template. ",
"title": "Device Pool",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/DevicePool/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": "string",
"target_model_type": "device/cucm/DevicePool",
"choices": []
},
"isDualMode": {
"description": "Read-only tag.",
"title": "Is Dual Mode",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"vendorConfig": {
"title": "Vendor Config",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "any",
"name": "value",
"title": "Value"
},
"key": {
"type": "string",
"name": "key",
"title": "Key"
}
}
},
"required": false,
"type": "array"
},
"authenticationUrl": {
"description": " Enter the URL that the phone uses to validate requests that are made to the phone web server. If you do not provide an authentication URL, the advanced features on the \n Cisco Unified IP Phone that require authentication will not function. By default, this URL accesses a Cisco Unified Communications Self Care Portal window that was configured during installation. Leave this field blank to accept the default setting. ",
"title": "Authentication Server",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"certificateOperation": {
"description": " From the drop-down list box, choose one of the following options: \n \n \n No Pending Operation\u2014Displays when no certificate operation is occurring (default setting). \n \n Install/Upgrade\u2014Installs a new or upgrades an existing locally significant certificate in the phone. \n \n Delete\u2014Deletes the locally significant certificate that exists in the phone. \n \n Troubleshoot\u2014Retrieves the locally significant certificate (LSC) or the manufacture installed certificate (MIC), so you can view the certificate credentials in the CAPF trace file. If both certificate types exist in the phone, Cisco Unified CM creates two trace files, one for each certificate type. By choosing the Troubleshooting option, you can verify that an LSC or MIC exists in the phone. \n For more information on CAPF operations, see the \n Cisco Unified Communications Manager Security Guide . ",
"title": "Certificate Operation",
"minItems": 1,
"required": true,
"choices": [
{
"value": "No Pending Operation",
"title": "No Pending Operation"
},
{
"value": "Install/Upgrade",
"title": "Install/Upgrade"
},
{
"value": "Delete",
"title": "Delete"
},
{
"value": "Troubleshoot",
"title": "Troubleshoot"
}
],
"default": "No Pending Operation",
"maxItems": 1,
"type": "string"
},
"userHoldMohAudioSourceId": {
"description": " To specify the audio source that plays when a user initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, Cisco Unified CM 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. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source. \n \n \n ",
"title": "User Hold MOH Audio Source",
"minItems": 0,
"format": "uri",
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null",
"integer"
],
"target_model_type": "device/cucm/MohAudioSource"
},
"defaultProfileName": {
"description": "The name of the default profile for this device.Not Nullable.",
"title": "EM Profile",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/DeviceProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/DeviceProfile",
"choices": []
},
"enableCallRoutingToRdWhenNoneIsActive": {
"description": " Determines whether calls should be routed to all remote destinations when the active remote destination is not set. Check this check box to receive calls during network connection outage or to use a third-party voicemail system. \n \n \n \n Note\u00a0\u00a0\u00a0 \n This field appears only on a CTI remote device type. \n \n \n ",
"title": "Enable Call Routing To Rd When None Is Active",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"sipProfileName": {
"description": " Choose the default SIP profile or a specific profile that was previously created. SIP profiles provide specific SIP information for the phone such as registration and keepalive timers, media ports, and do not disturb control. ",
"title": "SIP Profile",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/SipProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/SipProfile",
"choices": []
},
"preemption": {
"description": " Be aware that this setting is not available on all devices. If available, 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 from the following options: \n \n \n Default\u2014This device inherits its MLPP preemption setting from the common device configuration. \n \n Disabled\u2014This device does not allow preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. \n \n Forceful\u2014This device allows preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Do not configure a device 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. \n \n \n ",
"title": "MLPP Preemption",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Forceful",
"title": "Forceful"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"singleButtonBarge": {
"description": " From the drop-down list box, enable or disable the Single Button Barge/cBarge feature for this device or choose Default to use the service parameter setting. \n \n \n Off\u2014This setting disables the Single Button Barge/cBarge feature; however, the regular Barge or cBarge features will still work. \n \n Barge\u2014This setting enables the Single Button Barge feature. \n \n CBarge\u2014This setting enables the Single Button cBarge feature. \n \n Default\u2014Uses the Single Button Barge/cBarge setting that is in the service parameter. \n ",
"title": "Single Button Barge",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "Barge",
"title": "Barge"
},
{
"value": "CBarge",
"title": "CBarge"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"messagesUrl": {
"description": " Leave this field blank (not used by \n Cisco Unified Communications Manager). ",
"title": "Messages",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"enableExtensionMobility": {
"description": " Check this check box if this phone supports extension mobility. ",
"title": "Enable Extension Mobility",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"commonDeviceConfigName": {
"description": " Choose the common device configuration to which you want this phone assigned. The common device configuration includes the attributes (services or features) that are associated with a particular user. Configure the common device in the Common Device Configuration window. To see the common device configuration settings, click the View Details link. ",
"title": "Common Device Configuration",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/CommonDeviceConfig/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/CommonDeviceConfig",
"choices": []
},
"earlyOfferSupportForVoiceCall": {
"description": "This field is applicable only for Third-party AS-SIP Endpoint.",
"title": "Early Offer support for voice and video calls (insert MTP if needed)",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"informationUrl": {
"description": " This field displays the name of the active firmware load if the \n Cisco Unified IP Phone has registered with \n Cisco Unified Communications Manager. In some cases, the Active Load ID field displays \"Unknown.\" For example, \n Cisco Unified Communications Manager Administration might display \"Unknown\" in the Active Load ID field for any of the following circumstances: \n \n \n For SCCP phones, when the phone is a \n Cisco Unified IP Phone 7940 (SCCP), 7960 (SCCP), or 7985 (SCCP), because these phone models do not support the necessary version of SCCP. \n \n For SCCP and SIP phones, when the phone is any third-party phone. \n \n When \n Cisco Unified Communications Manager cannot determine the status of the phone. \n ",
"title": "Information",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"secureAuthenticationUrl": {
"description": " Enter the secure URL that the phone uses to validate requests that are made to the phone web server. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you do not provide a Secure Authentication URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. \n \n \n By default, this URL accesses a Cisco Unified Communications Self Care Portal window that was configured during installation. Leave this field blank to accept the default setting. Maximum length: 255 ",
"title": "Secure Authentication URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"blockIncomingCallsWhenRoaming": {
"title": "Block Incoming Calls while Roaming",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"secureIdleUrl": {
"description": " Enter the secure URL for the information that displays on the \n Cisco Unified IP Phone display when the phone is idle, as specified in Idle Timer field. For example, you can display a logo on the LCD when the phone has not been used for 5 minutes. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you do not provide a Secure Idle URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. \n \n \n To accept the default setting, leave this field blank. Maximum length: 255 ",
"title": "Secure Idle URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"useDevicePoolCgpnTransformCss": {
"title": "Use Device Pool Calling Party Transformation CSS (Device Mobility Related Information)",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"homeNetworkId": {
"description": "This tag is only valid when value of blockIncomingCallsWhenRoaming is true",
"title": "Home Network ID",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"traceFlag": {
"title": "Trace Flag",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"phoneSuite": {
"description": " The Phone Personalization setting allows you to enable a \n Cisco Unified IP Phone, so it works with Phone Designer, a Cisco Unified Communications widget that allows a phone user to customize the wallpaper and ring tones on the phone. From the Phone Personalization drop-down list box, choose one of the following options: \n \n \n Disabled-The user cannot customize the \n Cisco Unified IP Phone by using Phone Designer. \n \n Enabled-The user can use Phone Designer to customize the phone. \n \n Default-The phone uses the configuration from the Phone Personalization enterprise parameter if you choose Default in both the Phone Configuration and Common Phone Profile Configuration windows. If you choose Default in the Common Phone Profile Configuration window but not in the Phone Configuration window, the phone uses the configuration that you specify in the Phone Configuration window. \n You must install and configure Phone Designer, so the phone user can customize the phone. Before you install and configure Phone Designer, identify which \n Cisco Unified IP Phone models work with Phone Designer, as described in the Phone Designer documentation. For more information on Phone Designer, see the Phone Designer documentation. ",
"title": "Phone Personalization",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "HTTPS Only",
"title": "HTTPS Only"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"geoLocationName": {
"description": " From the drop-down list box, choose a geolocation. You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation. You can also choose a geolocation that has been configured with the System > Geolocation Configuration menu option. ",
"title": "Geolocation",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/GeoLocation/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/GeoLocation",
"choices": []
},
"digestUser": {
"description": "This field is applicable only to SIP phones.",
"title": "Digest User",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "userid",
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/User",
"choices": []
},
"joinAcrossLines": {
"description": " From the drop-down list box, enable or disable the Join Across Lines feature for this device or choose Default to use the service parameter setting. \n \n \n Off\u2014This setting disables the Join Across Lines feature. \n \n On\u2014This setting enables the Join Across Lines feature. \n \n Default\u2014This setting uses the Join Across Lines setting that is in the service parameter. \n ",
"title": "Join Across Lines",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"speeddials": {
"title": "Speeddials",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"speeddial": {
"name": "speeddial",
"title": "Speeddial",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
},
"dirn": {
"name": "dirn",
"title": "Dirn",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 255,
"type": "string"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"dndStatus": {
"description": " Check this check box to enable Do Not Disturb on the phone. ",
"title": "Do Not Disturb",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"wirelessLanProfileGroup": {
"description": " Select a wireless LAN profile group from the drop-down list box. You may also click View Details to display the settings for this wireless LAN profile group. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You can specify the Wireless LAN Profile Group at the Device Pool level or the individual phone level. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n This field does not apply to all phone models. \n \n \n ",
"title": "Wireless Lan Profile Group",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/WlanProfileGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/WlanProfileGroup",
"choices": []
},
"networkHoldMohAudioSourceId": {
"description": " To specify the audio source that is played when the network initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, Cisco Unified CM 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. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source. \n \n \n ",
"title": "Network Hold MOH Audio Source",
"minItems": 0,
"format": "uri",
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null",
"integer"
],
"target_model_type": "device/cucm/MohAudioSource"
},
"networkLocation": {
"description": "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.",
"title": "Network Location",
"minItems": 0,
"required": false,
"choices": [
{
"value": "OnNet",
"title": "OnNet"
},
{
"value": "OffNet",
"title": "OffNet"
},
{
"value": "Use System Default",
"title": "Use System Default"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": "string"
},
"unattendedPort": {
"description": " Check this check box to indicate an unattended port on this device. ",
"title": "Unattended Port",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"cgpnTransformationCssName": {
"description": " From the drop-down list box, choose the calling search space (CSS) that contains the calling party transformation pattern that you want to apply on the calling number when this phone initiates a call. Cisco Unified CM transforms the calling party using the digit transformations configured on the matching calling party transformation pattern when this phone initiates a call. This setting allows you to transform the calling party number before Cisco Unified CM routes the call. For example, a transformation pattern can change a phone extension to an E.164 number. This setting is generally configured when a user dials using a URI instead of digits. Cisco Unified CM allows calling party transformations on various patterns when dialing using digits, this setting provides similar transformation provision even when dialing using a URI. ",
"title": "Calling Party Transformation CSS",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Css",
"choices": []
},
"mobilityUserIdName": {
"description": " From the drop-down list box, choose the user ID of the person to whom this dual-mode phone is assigned. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The Mobility User ID configuration gets used for the Cisco Unified Mobility and Mobile Voice Access features for dual-mode phones. The Owner User ID and Mobility User ID can differ. \n \n \n ",
"title": "Mobility User ID",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/User/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/User",
"choices": []
},
"ecKeySize": {
"description": "ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.",
"title": "Ec Key Size",
"minItems": 0,
"required": false,
"choices": [
{
"value": "256",
"title": "256"
},
{
"value": "384",
"title": "384"
},
{
"value": "521",
"title": "521"
}
],
"maxItems": 1,
"type": "string"
},
"versionStamp": {
"description": "UUID changed each time device is updated",
"title": "Version Stamp",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": [
"string",
"null"
]
},
"deviceTrustMode": {
"description": " Select whether the device is trusted or not trusted. You can configure this setting for analog phones using SCCP, and for some third-party endpoints. ",
"title": "Device Trust Mode",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Not Trusted",
"title": "Not Trusted"
},
{
"value": "Trusted",
"title": "Trusted"
}
],
"default": "Not Trusted",
"maxItems": 1,
"type": "string"
},
"lines": {
"title": "Lines",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"null",
"object"
],
"properties": {
"line": {
"description": "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.",
"title": "Line",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"displayAscii": {
"name": "displayAscii",
"title": "Display Ascii",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"associatedEndusers": {
"name": "associatedEndusers",
"title": "Associated Endusers",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"enduser": {
"name": "enduser",
"title": "Enduser",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"userId": {
"name": "userId",
"title": "User Id",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "userid",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/User",
"choices": []
}
}
},
"required": false,
"array_element_id_field": "userId",
"type": "array"
}
}
},
"ringSetting": {
"name": "ringSetting",
"title": "Ring Setting",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Ring",
"maxItems": 1,
"type": "string"
},
"consecutiveRingSetting": {
"description": "Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.",
"title": "Consecutive Ring Setting",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "consecutiveRingSetting"
},
"recordingProfileName": {
"name": "recordingProfileName",
"title": "Recording Profile Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RecordingProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RecordingProfile",
"choices": []
},
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
},
"ringSettingActivePickupAlert": {
"description": "Applicable only for IP Phones",
"title": "Ring Setting Active Pickup Alert",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "ringSettingActivePickupAlert"
},
"line_link": {
"format": "link",
"required": false,
"type": "string",
"description": "Link to the line resource",
"title": "Link To Line"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"recordingMediaSource": {
"name": "recordingMediaSource",
"title": "Recording Media Source",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Gateway Preferred",
"title": "Gateway Preferred"
},
{
"value": "Phone Preferred",
"title": "Phone Preferred"
}
],
"default": "Gateway Preferred",
"maxItems": 1,
"type": "string"
},
"maxNumCalls": {
"name": "maxNumCalls",
"title": "Max Num Calls",
"minItems": 0,
"required": false,
"default": 2,
"maxItems": 1,
"type": "integer"
},
"partitionUsage": {
"description": "This tag cannot be modified. It can only be specified in the add request.",
"title": "Partition Usage",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Intercom",
"title": "Intercom"
},
{
"value": "Call Control Discovery Learned Pattern",
"title": "Call Control Discovery Learned Pattern"
},
{
"value": "General",
"title": "General"
},
{
"value": "Directory URI",
"title": "Directory URI"
}
],
"default": "General",
"maxItems": 1,
"type": "string",
"name": "partitionUsage"
},
"recordingFlag": {
"name": "recordingFlag",
"title": "Recording Flag",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Call Recording Disabled",
"title": "Call Recording Disabled"
},
{
"value": "Automatic Call Recording Enabled",
"title": "Automatic Call Recording Enabled"
},
{
"value": "Selective Call Recording Enabled",
"title": "Selective Call Recording Enabled"
}
],
"default": "Call Recording Disabled",
"maxItems": 1,
"type": "string"
},
"speedDial": {
"name": "speedDial",
"title": "Speed Dial",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"monitoringCssName": {
"name": "monitoringCssName",
"title": "Monitoring Css Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"e164Mask": {
"name": "e164Mask",
"title": "E164Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"missedCallLogging": {
"name": "missedCallLogging",
"title": "Missed Call Logging",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"callInfoDisplay": {
"name": "callInfoDisplay",
"title": "Call Info Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"dialedNumber": {
"name": "dialedNumber",
"title": "Dialed Number",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"redirectedNumber": {
"name": "redirectedNumber",
"title": "Redirected Number",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callerNumber": {
"name": "callerNumber",
"title": "Caller Number",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callerName": {
"name": "callerName",
"title": "Caller Name",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
}
}
},
"dirn": {
"description": "Only uuid attribute is returned in response",
"title": "Dirn",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"line_filter": {
"name": "line_filter",
"title": "Inventory Filter",
"default": "default",
"required": false,
"choices": [
{
"value": "default",
"title": "Default"
},
{
"value": "lines_unused_only_local",
"title": "Show Unused Numbers (Site Only)"
},
{
"value": "lines_unused_only",
"title": "Show Unused Numbers"
},
{
"value": "lines_e164_unused_local",
"title": "Show Unused Numbers with Associated E164's (Site Only)"
},
{
"value": "lines_e164_unused",
"title": "Show Unused Numbers with Associated E164's"
},
{
"value": "lines_used_only_local",
"title": "Show Used Numbers (Site Only)"
},
{
"value": "lines_used_only",
"title": "Show Used Numbers"
},
{
"value": "lines_userid_used",
"title": "Show Numbers belonging to this Subscriber"
}
],
"type": "string"
},
"pattern": {
"name": "pattern",
"title": "Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
}
},
"name": "dirn"
},
"mwlPolicy": {
"name": "mwlPolicy",
"title": "Mwl Policy",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Policy",
"title": "Use System Policy"
},
{
"value": "Light and Prompt",
"title": "Light and Prompt"
},
{
"value": "Prompt Only",
"title": "Prompt Only"
},
{
"value": "Light Only",
"title": "Light Only"
},
{
"value": "None",
"title": "None"
}
],
"default": "Use System Policy",
"maxItems": 1,
"type": "string"
},
"ringSettingIdlePickupAlert": {
"description": "Applicable only for IP Phones",
"title": "Ring Setting Idle Pickup Alert",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "ringSettingIdlePickupAlert"
},
"busyTrigger": {
"name": "busyTrigger",
"title": "Busy Trigger",
"minItems": 0,
"required": false,
"default": 1,
"maxItems": 1,
"type": "integer"
},
"audibleMwi": {
"description": "Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway",
"title": "Audible Mwi",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string",
"name": "audibleMwi"
},
"display": {
"name": "display",
"title": "Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
}
}
},
"required": false,
"array_element_id_field": "dirn",
"type": "array",
"name": "line"
}
}
},
"requireThirdPartyRegistration": {
"title": "Third-party Registration Required",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"alwaysUsePrimeLine": {
"description": " From the drop-down list box, choose one of the following options: \n \n \n Off\u2014When 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. \n \n On\u2014When 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. \n \n Default\u2014\n Cisco Unified Communications Manager uses the configuration from the Always Use Prime Line service parameter, which supports the Cisco CallManager service. \n ",
"title": "Always Use Prime Line",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"mtpPreferedCodec": {
"description": " From the drop-down list box, choose the codec to use if a media termination point is required for SIP calls. ",
"title": "MTP Preferred Originating Codec",
"minItems": 0,
"required": false,
"choices": [
{
"value": "711ulaw",
"title": "711ulaw"
},
{
"value": "711alaw",
"title": "711alaw"
},
{
"value": "G729/G729a",
"title": "G729/G729a"
},
{
"value": "G729b/G729ab",
"title": "G729b/G729ab"
}
],
"default": "711ulaw",
"maxItems": 1,
"type": "string"
},
"blfDirectedCallParks": {
"title": "Blf Directed Call Parks",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"blfDirectedCallPark": {
"name": "blfDirectedCallPark",
"title": "Blf Directed Call Park",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
},
"directedCallParkDnAndPartition": {
"name": "directedCallParkDnAndPartition",
"title": "Directed Call Park Dn And Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"dnPattern": {
"name": "dnPattern",
"title": "Dn Pattern",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "pattern",
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/DirectedCallPark/choices/?field=pattern&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/DirectedCallPark",
"choices": []
}
}
},
"directedCallParkId": {
"description": "Only the uuid attribute is read",
"title": "Directed Call Park Id",
"minItems": 0,
"pattern": "\\{........-....-....-....-............\\}",
"required": false,
"maxItems": 1,
"type": "string",
"name": "directedCallParkId"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"sshPwd": {
"description": "This tag is applicable only to thosedevices that support ssh feature.",
"title": "Secure Shell Password ",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": "string"
},
"ringSettingIdleBlfAudibleAlert": {
"description": " This setting determines the busy lamp field (BLF) audible alert setting when no current call exists on the BLF DN: \n \n \n On\u2014An audible alert sounds. \n \n Off\u2014No audible alert sounds. \n \n Default\u2014The configuration in the Service Parameters Configuration window determines the alert option. \n ",
"title": "BLF Audible Alert Setting (Phone Idle)",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"builtInBridgeStatus": {
"description": " Enable or disable the built-in conference bridge for the barge feature by using the Built In Bridge drop-down list box (choose On, Off, or Default). \n \n \n \n Note\u00a0\u00a0\u00a0 \n \n Cisco Unified IP Phones 7940 and 7960 cannot support two media stream encryptions or SRTP streams simultaneously. To prevent instability due to this condition, the system automatically disables the built-in bridge for 7940 and 7960 phones when the device security mode is set to encrypted. \n \n \n ",
"title": "Built In Bridge",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"packetCaptureDuration": {
"description": " This setting exists for troubleshooting encryption only; packet capturing may cause high CPU usage or call-processing interruptions. This field specifies the maximum number of minutes that is allotted for one session of packet capturing. The default setting equals 0, although the range exists from 0 to 300 minutes. To initiate packet capturing, enter a value other than 0 in the field. After packet capturing completes, the value, 0, displays. For more information on packet capturing, see the \n Cisco Unified Communications Manager \n Troubleshooting Guide . ",
"title": "Packet Capture Duration",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"wifiHotspotProfile": {
"title": "Wifi Hotspot Profile",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/WifiHotspot/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/WifiHotspot",
"choices": []
},
"useDevicePoolCgpnIngressDN": {
"title": "Use Device Pool Calling Party Transformation CSS (Caller ID For Calls From This Phone)",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"AllowPresentationSharingUsingBfcp": {
"description": "This field is applicable only for Third-party AS-SIP Endpoint.",
"title": "Allow Presentation Sharing using BFCP",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"servicesUrl": {
"description": " From the drop-down list box, choose how the phone will support the services: \n \n \n Internal\u2014The phone uses the phone configuration file to support the service. Choose this option or Both for Cisco-provided default services where the Service URL has not been updated; that is, the service URL indicates Application:Cisco/<name of service>; for example, Application:Cisco/CorporateDirectory. Choose Internal or Both for Cisco-signed Java MIDlets because Cisco-signed Java MIDlets are provisioned in the configuration file. \n \n External URL\u2014Choosing External URL indicates that the phone ignores the services in the phone configuration file and retrieves the services from a Service URL. If you configured a custom Service URL for a service, including a Cisco-provided default service, you must choose either External URL or Both; if you choose Internal in this case, the services that are associated with the custom URLs do not work on the phone. \n \n Both\u2014Choosing Both indicates that the phone support both the services that are defined in the configuration file and external applications that are retrieved from service URLs. \n ",
"title": "Services",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"featureControlPolicy": {
"description": " From the drop-down list box, you can choose a feature control policy that has already been configured in the Feature Control Policy configuration window (Device > Device Settings > Feature Control Policy). ",
"title": "Feature Control Policy",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/FeatureControlPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/FeatureControlPolicy",
"choices": []
},
"mlppIndicationStatus": {
"description": " If available, 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 from the following options: \n \n \n Default\u2014This device inherits its MLPP indication setting from the common device configuration. \n \n Off\u2014This device does not handle nor process indication of an MLPP precedence call. \n \n On\u2014This device does handle and process indication of an MLPP precedence call. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Do not configure a device 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. Turning on MLPP Indication (at the enterprise parameter or device level) disables normal Ring Setting behavior for the lines on a device, unless MLPP Indication is turned off (overridden) for the device. \n \n \n ",
"title": "MLPP Indication",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Off",
"maxItems": 1,
"type": "string"
},
"busyLampFields": {
"title": "Busy Lamp Fields",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"busyLampField": {
"name": "busyLampField",
"title": "Busy Lamp Field",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
},
"blfDest": {
"description": "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.",
"title": "Blf Dest",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "string",
"name": "blfDest"
},
"callPickup": {
"required": false,
"type": "boolean",
"title": "Call Pickup"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"routePartition": {
"name": "routePartition",
"title": "Route Partition",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"blfDirn": {
"description": "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.",
"title": "Blf Dirn",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": "string",
"name": "blfDirn"
}
}
},
"required": false,
"type": "array"
}
}
},
"enableActivationID": {
"description": "This boolean setting, when set to true, indicates that the phone should use activation code based registration",
"title": "Enable Activation ID",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"packetCaptureMode": {
"description": " This setting exists for troubleshooting encryption only; packet capturing may cause high CPU usage or call-processing interruptions. Choose one of the following options from the drop-down list box: \n \n \n None\u2014This option, which serves as the default setting, indicates that no packet capturing is occurring. After you complete packet capturing, configure this setting. \n \n Batch Processing Mode\u2014Cisco Unified CM writes the decrypted or nonencrypted messages to a file, and the system encrypts each file. On a daily basis, the system creates a new file with a new encryption key. Cisco Unified CM, which stores the file for seven days, also stores the keys that encrypt the file in a secure location. Cisco Unified CM stores the file in the PktCap virtual directory. A single file contains the time stamp, source IP address, source IP port, destination IP address, packet protocol, message length, and the message. The TAC debugging tool uses HTTPS, administrator username and password, and the specified day to request a single encrypted file that contains the captured packets. Likewise, the tool requests the key information to decrypt the encrypted file. \n For more information on packet capturing, see the \n Troubleshooting Guide for \n Cisco Unified Communications Manager . ",
"title": "Packet Capture Mode",
"minItems": 1,
"required": true,
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "Batch Processing Mode",
"title": "Batch Processing Mode"
}
],
"default": "None",
"maxItems": 1,
"type": "string"
},
"status": {
"type": "string",
"description": "Registration status of the phone",
"title": "Registration Status"
},
"loadInformation": {
"description": " Enter the custom software for the \n Cisco Unified IP Phone. The value that you enter overrides the default value for the current model. For more information about \n Cisco Unified IP Phone software and configuration, see the \n Cisco Unified IP Phone Administration Guide for \n Cisco Unified Communications Manager, which is specific to the phone model and Unified CM release. ",
"title": "Phone Load Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"product": {
"description": "Product ID string. read-only except when creating a device.",
"title": "Product",
"minItems": 1,
"required": true,
"choices": [
{
"value": "7914 14-Button Line Expansion Module",
"title": "7914 14-Button Line Expansion Module"
},
{
"value": "7915 12-Button Line Expansion Module",
"title": "7915 12-Button Line Expansion Module"
},
{
"value": "7915 24-Button Line Expansion Module",
"title": "7915 24-Button Line Expansion Module"
},
{
"value": "7916 12-Button Line Expansion Module",
"title": "7916 12-Button Line Expansion Module"
},
{
"value": "7916 24-Button Line Expansion Module",
"title": "7916 24-Button Line Expansion Module"
},
{
"value": "AIM-VOICE-30",
"title": "AIM-VOICE-30"
},
{
"value": "Analog Phone",
"title": "Analog Phone"
},
{
"value": "Annunciator",
"title": "Annunciator"
},
{
"value": "BEKEM 36-Button Line Expansion Module",
"title": "BEKEM 36-Button Line Expansion Module"
},
{
"value": "C881V",
"title": "C881V"
},
{
"value": "C887VA-V",
"title": "C887VA-V"
},
{
"value": "CKEM 36-Button Line Expansion Module",
"title": "CKEM 36-Button Line Expansion Module"
},
{
"value": "CP-8800-Audio 28-Button Key Expansion Module",
"title": "CP-8800-Audio 28-Button Key Expansion Module"
},
{
"value": "CP-8800-Video 28-Button Key Expansion Module",
"title": "CP-8800-Video 28-Button Key Expansion Module"
},
{
"value": "CTI Port",
"title": "CTI Port"
},
{
"value": "CTI Remote Device",
"title": "CTI Remote Device"
},
{
"value": "CTI Route Point",
"title": "CTI Route Point"
},
{
"value": "Carrier-integrated Mobile",
"title": "Carrier-integrated Mobile"
},
{
"value": "Cisco IAD2400",
"title": "Cisco IAD2400"
},
{
"value": "Cisco 12 S",
"title": "Cisco 12 S"
},
{
"value": "Cisco 12 SP",
"title": "Cisco 12 SP"
},
{
"value": "Cisco 12 SP+",
"title": "Cisco 12 SP+"
},
{
"value": "Cisco 1751",
"title": "Cisco 1751"
},
{
"value": "Cisco 1760",
"title": "Cisco 1760"
},
{
"value": "Cisco 1861",
"title": "Cisco 1861"
},
{
"value": "Cisco 269X",
"title": "Cisco 269X"
},
{
"value": "Cisco 26XX",
"title": "Cisco 26XX"
},
{
"value": "Cisco 2801",
"title": "Cisco 2801"
},
{
"value": "Cisco 2811",
"title": "Cisco 2811"
},
{
"value": "Cisco 2821",
"title": "Cisco 2821"
},
{
"value": "Cisco 2851",
"title": "Cisco 2851"
},
{
"value": "Cisco 2901",
"title": "Cisco 2901"
},
{
"value": "Cisco 2911",
"title": "Cisco 2911"
},
{
"value": "Cisco 2921",
"title": "Cisco 2921"
},
{
"value": "Cisco 2951",
"title": "Cisco 2951"
},
{
"value": "Cisco 30 SP+",
"title": "Cisco 30 SP+"
},
{
"value": "Cisco 30 VIP",
"title": "Cisco 30 VIP"
},
{
"value": "Cisco 362X",
"title": "Cisco 362X"
},
{
"value": "Cisco 364X",
"title": "Cisco 364X"
},
{
"value": "Cisco 366X",
"title": "Cisco 366X"
},
{
"value": "Cisco 3725",
"title": "Cisco 3725"
},
{
"value": "Cisco 3745",
"title": "Cisco 3745"
},
{
"value": "Cisco 3825",
"title": "Cisco 3825"
},
{
"value": "Cisco 3845",
"title": "Cisco 3845"
},
{
"value": "Cisco 3905",
"title": "Cisco 3905"
},
{
"value": "Cisco 3911",
"title": "Cisco 3911"
},
{
"value": "Cisco 3925",
"title": "Cisco 3925"
},
{
"value": "Cisco 3925E",
"title": "Cisco 3925E"
},
{
"value": "Cisco 3945",
"title": "Cisco 3945"
},
{
"value": "Cisco 3945E",
"title": "Cisco 3945E"
},
{
"value": "Cisco 3951",
"title": "Cisco 3951"
},
{
"value": "Cisco 6901",
"title": "Cisco 6901"
},
{
"value": "Cisco 6911",
"title": "Cisco 6911"
},
{
"value": "Cisco 6921",
"title": "Cisco 6921"
},
{
"value": "Cisco 6941",
"title": "Cisco 6941"
},
{
"value": "Cisco 6945",
"title": "Cisco 6945"
},
{
"value": "Cisco 6961",
"title": "Cisco 6961"
},
{
"value": "Cisco 7811",
"title": "Cisco 7811"
},
{
"value": "Cisco 7821",
"title": "Cisco 7821"
},
{
"value": "Cisco 7832",
"title": "Cisco 7832"
},
{
"value": "Cisco 7841",
"title": "Cisco 7841"
},
{
"value": "Cisco 7861",
"title": "Cisco 7861"
},
{
"value": "Cisco 7902",
"title": "Cisco 7902"
},
{
"value": "Cisco 7905",
"title": "Cisco 7905"
},
{
"value": "Cisco 7906",
"title": "Cisco 7906"
},
{
"value": "Cisco 7910",
"title": "Cisco 7910"
},
{
"value": "Cisco 7911",
"title": "Cisco 7911"
},
{
"value": "Cisco 7912",
"title": "Cisco 7912"
},
{
"value": "Cisco 7920",
"title": "Cisco 7920"
},
{
"value": "Cisco 7921",
"title": "Cisco 7921"
},
{
"value": "Cisco 7925",
"title": "Cisco 7925"
},
{
"value": "Cisco 7926",
"title": "Cisco 7926"
},
{
"value": "Cisco 7931",
"title": "Cisco 7931"
},
{
"value": "Cisco 7935",
"title": "Cisco 7935"
},
{
"value": "Cisco 7936",
"title": "Cisco 7936"
},
{
"value": "Cisco 7937",
"title": "Cisco 7937"
},
{
"value": "Cisco 7940",
"title": "Cisco 7940"
},
{
"value": "Cisco 7941",
"title": "Cisco 7941"
},
{
"value": "Cisco 7941G-GE",
"title": "Cisco 7941G-GE"
},
{
"value": "Cisco 7942",
"title": "Cisco 7942"
},
{
"value": "Cisco 7945",
"title": "Cisco 7945"
},
{
"value": "Cisco 7960",
"title": "Cisco 7960"
},
{
"value": "Cisco 7961",
"title": "Cisco 7961"
},
{
"value": "Cisco 7961G-GE",
"title": "Cisco 7961G-GE"
},
{
"value": "Cisco 7962",
"title": "Cisco 7962"
},
{
"value": "Cisco 7965",
"title": "Cisco 7965"
},
{
"value": "Cisco 7970",
"title": "Cisco 7970"
},
{
"value": "Cisco 7971",
"title": "Cisco 7971"
},
{
"value": "Cisco 7975",
"title": "Cisco 7975"
},
{
"value": "Cisco 7985",
"title": "Cisco 7985"
},
{
"value": "Cisco 860",
"title": "Cisco 860"
},
{
"value": "Cisco 881",
"title": "Cisco 881"
},
{
"value": "Cisco 8811",
"title": "Cisco 8811"
},
{
"value": "Cisco 8821",
"title": "Cisco 8821"
},
{
"value": "Cisco 8831",
"title": "Cisco 8831"
},
{
"value": "Cisco 8832",
"title": "Cisco 8832"
},
{
"value": "Cisco 8832NR",
"title": "Cisco 8832NR"
},
{
"value": "Cisco 8841",
"title": "Cisco 8841"
},
{
"value": "Cisco 8845",
"title": "Cisco 8845"
},
{
"value": "Cisco 8851",
"title": "Cisco 8851"
},
{
"value": "Cisco 8851NR",
"title": "Cisco 8851NR"
},
{
"value": "Cisco 8861",
"title": "Cisco 8861"
},
{
"value": "Cisco 8865",
"title": "Cisco 8865"
},
{
"value": "Cisco 8865NR",
"title": "Cisco 8865NR"
},
{
"value": "Cisco 888/887/886",
"title": "Cisco 888/887/886"
},
{
"value": "Cisco 8941",
"title": "Cisco 8941"
},
{
"value": "Cisco 8945",
"title": "Cisco 8945"
},
{
"value": "Cisco 8961",
"title": "Cisco 8961"
},
{
"value": "Cisco 9951",
"title": "Cisco 9951"
},
{
"value": "Cisco 9971",
"title": "Cisco 9971"
},
{
"value": "Cisco ATA 186",
"title": "Cisco ATA 186"
},
{
"value": "Cisco ATA 187",
"title": "Cisco ATA 187"
},
{
"value": "Cisco ATA 190",
"title": "Cisco ATA 190"
},
{
"value": "Cisco ATA 191",
"title": "Cisco ATA 191"
},
{
"value": "Cisco C8200/L-1N-4T",
"title": "Cisco C8200/L-1N-4T"
},
{
"value": "Cisco C8300-1N1S-4T2X",
"title": "Cisco C8300-1N1S-4T2X"
},
{
"value": "Cisco C8300-1N1S-6T",
"title": "Cisco C8300-1N1S-6T"
},
{
"value": "Cisco C8300-2N2S-4T2X/6T",
"title": "Cisco C8300-2N2S-4T2X/6T"
},
{
"value": "Cisco Catalyst 4000 Access Gateway Module",
"title": "Cisco Catalyst 4000 Access Gateway Module"
},
{
"value": "Cisco Catalyst 4224 Voice Gateway Switch",
"title": "Cisco Catalyst 4224 Voice Gateway Switch"
},
{
"value": "Cisco Catalyst 6000 12 port FXO Gateway",
"title": "Cisco Catalyst 6000 12 port FXO Gateway"
},
{
"value": "Cisco Catalyst 6000 24 port FXS Gateway",
"title": "Cisco Catalyst 6000 24 port FXS Gateway"
},
{
"value": "Cisco Catalyst 6000 E1 VoIP Gateway",
"title": "Cisco Catalyst 6000 E1 VoIP Gateway"
},
{
"value": "Cisco Catalyst 6000 T1 VoIP Gateway",
"title": "Cisco Catalyst 6000 T1 VoIP Gateway"
},
{
"value": "Cisco Cius",
"title": "Cisco Cius"
},
{
"value": "Cisco Cius SP",
"title": "Cisco Cius SP"
},
{
"value": "Cisco Collaboration Mobile Convergence",
"title": "Cisco Collaboration Mobile Convergence"
},
{
"value": "Cisco Conference Bridge (WS-SVC-CMM)",
"title": "Cisco Conference Bridge (WS-SVC-CMM)"
},
{
"value": "Cisco Conference Bridge Hardware",
"title": "Cisco Conference Bridge Hardware"
},
{
"value": "Cisco Conference Bridge Software",
"title": "Cisco Conference Bridge Software"
},
{
"value": "Cisco DX650",
"title": "Cisco DX650"
},
{
"value": "Cisco DX70",
"title": "Cisco DX70"
},
{
"value": "Cisco DX80",
"title": "Cisco DX80"
},
{
"value": "Cisco Dual Mode for Android",
"title": "Cisco Dual Mode for Android"
},
{
"value": "Cisco Dual Mode for iPhone",
"title": "Cisco Dual Mode for iPhone"
},
{
"value": "Cisco E20",
"title": "Cisco E20"
},
{
"value": "Cisco ENCS 5400 ISRV",
"title": "Cisco ENCS 5400 ISRV"
},
{
"value": "Cisco IOS Conference Bridge",
"title": "Cisco IOS Conference Bridge"
},
{
"value": "Cisco IOS Enhanced Conference Bridge",
"title": "Cisco IOS Enhanced Conference Bridge"
},
{
"value": "Cisco IOS Enhanced Media Termination Point",
"title": "Cisco IOS Enhanced Media Termination Point"
},
{
"value": "Cisco IOS Enhanced Software Media Termination Point",
"title": "Cisco IOS Enhanced Software Media Termination Point"
},
{
"value": "Cisco IOS Guaranteed Audio Video Conference Bridge",
"title": "Cisco IOS Guaranteed Audio Video Conference Bridge"
},
{
"value": "Cisco IOS Heterogeneous Video Conference Bridge",
"title": "Cisco IOS Heterogeneous Video Conference Bridge"
},
{
"value": "Cisco IOS Homogeneous Video Conference Bridge",
"title": "Cisco IOS Homogeneous Video Conference Bridge"
},
{
"value": "Cisco IOS Media Termination Point",
"title": "Cisco IOS Media Termination Point"
},
{
"value": "Cisco IP Communicator",
"title": "Cisco IP Communicator"
},
{
"value": "Cisco ISR 4321",
"title": "Cisco ISR 4321"
},
{
"value": "Cisco ISR 4331",
"title": "Cisco ISR 4331"
},
{
"value": "Cisco ISR 4351",
"title": "Cisco ISR 4351"
},
{
"value": "Cisco ISR 4431",
"title": "Cisco ISR 4431"
},
{
"value": "Cisco ISR 4451",
"title": "Cisco ISR 4451"
},
{
"value": "Cisco ISR 4461",
"title": "Cisco ISR 4461"
},
{
"value": "Cisco Jabber for Tablet",
"title": "Cisco Jabber for Tablet"
},
{
"value": "Cisco MGCP BRI Port",
"title": "Cisco MGCP BRI Port"
},
{
"value": "Cisco MGCP E1 Port",
"title": "Cisco MGCP E1 Port"
},
{
"value": "Cisco MGCP FXO Port",
"title": "Cisco MGCP FXO Port"
},
{
"value": "Cisco MGCP FXS Port",
"title": "Cisco MGCP FXS Port"
},
{
"value": "Cisco MGCP T1 Port",
"title": "Cisco MGCP T1 Port"
},
{
"value": "Cisco Media Server (WS-SVC-CMM-MS)",
"title": "Cisco Media Server (WS-SVC-CMM-MS)"
},
{
"value": "Cisco Media Termination Point (WS-SVC-CMM)",
"title": "Cisco Media Termination Point (WS-SVC-CMM)"
},
{
"value": "Cisco Media Termination Point Hardware",
"title": "Cisco Media Termination Point Hardware"
},
{
"value": "Cisco Media Termination Point Software",
"title": "Cisco Media Termination Point Software"
},
{
"value": "Cisco Meeting Server",
"title": "Cisco Meeting Server"
},
{
"value": "Cisco SIP FXS Port",
"title": "Cisco SIP FXS Port"
},
{
"value": "Cisco Spark Remote Device",
"title": "Cisco Spark Remote Device"
},
{
"value": "Cisco TelePresence",
"title": "Cisco TelePresence"
},
{
"value": "Cisco TelePresence 1000",
"title": "Cisco TelePresence 1000"
},
{
"value": "Cisco TelePresence 1100",
"title": "Cisco TelePresence 1100"
},
{
"value": "Cisco TelePresence 1300-47",
"title": "Cisco TelePresence 1300-47"
},
{
"value": "Cisco TelePresence 1300-65",
"title": "Cisco TelePresence 1300-65"
},
{
"value": "Cisco TelePresence 200",
"title": "Cisco TelePresence 200"
},
{
"value": "Cisco TelePresence 3000",
"title": "Cisco TelePresence 3000"
},
{
"value": "Cisco TelePresence 3200",
"title": "Cisco TelePresence 3200"
},
{
"value": "Cisco TelePresence 400",
"title": "Cisco TelePresence 400"
},
{
"value": "Cisco TelePresence 500-32",
"title": "Cisco TelePresence 500-32"
},
{
"value": "Cisco TelePresence 500-37",
"title": "Cisco TelePresence 500-37"
},
{
"value": "Cisco TelePresence Codec C40",
"title": "Cisco TelePresence Codec C40"
},
{
"value": "Cisco TelePresence Codec C60",
"title": "Cisco TelePresence Codec C60"
},
{
"value": "Cisco TelePresence Codec C90",
"title": "Cisco TelePresence Codec C90"
},
{
"value": "Cisco TelePresence Conductor",
"title": "Cisco TelePresence Conductor"
},
{
"value": "Cisco TelePresence DX70",
"title": "Cisco TelePresence DX70"
},
{
"value": "Cisco TelePresence EX60",
"title": "Cisco TelePresence EX60"
},
{
"value": "Cisco TelePresence EX90",
"title": "Cisco TelePresence EX90"
},
{
"value": "Cisco TelePresence Exchange System",
"title": "Cisco TelePresence Exchange System"
},
{
"value": "Cisco TelePresence IX5000",
"title": "Cisco TelePresence IX5000"
},
{
"value": "Cisco TelePresence MCU",
"title": "Cisco TelePresence MCU"
},
{
"value": "Cisco TelePresence MX200",
"title": "Cisco TelePresence MX200"
},
{
"value": "Cisco TelePresence MX200 G2",
"title": "Cisco TelePresence MX200 G2"
},
{
"value": "Cisco TelePresence MX300",
"title": "Cisco TelePresence MX300"
},
{
"value": "Cisco TelePresence MX300 G2",
"title": "Cisco TelePresence MX300 G2"
},
{
"value": "Cisco TelePresence MX700",
"title": "Cisco TelePresence MX700"
},
{
"value": "Cisco TelePresence MX800",
"title": "Cisco TelePresence MX800"
},
{
"value": "Cisco TelePresence MX800 Dual",
"title": "Cisco TelePresence MX800 Dual"
},
{
"value": "Cisco TelePresence Profile 42 (C20)",
"title": "Cisco TelePresence Profile 42 (C20)"
},
{
"value": "Cisco TelePresence Profile 42 (C40)",
"title": "Cisco TelePresence Profile 42 (C40)"
},
{
"value": "Cisco TelePresence Profile 42 (C60)",
"title": "Cisco TelePresence Profile 42 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 (C40)",
"title": "Cisco TelePresence Profile 52 (C40)"
},
{
"value": "Cisco TelePresence Profile 52 (C60)",
"title": "Cisco TelePresence Profile 52 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 Dual (C60)",
"title": "Cisco TelePresence Profile 52 Dual (C60)"
},
{
"value": "Cisco TelePresence Profile 65 (C60)",
"title": "Cisco TelePresence Profile 65 (C60)"
},
{
"value": "Cisco TelePresence Profile 65 Dual (C90)",
"title": "Cisco TelePresence Profile 65 Dual (C90)"
},
{
"value": "Cisco TelePresence Quick Set C20",
"title": "Cisco TelePresence Quick Set C20"
},
{
"value": "Cisco TelePresence SX10",
"title": "Cisco TelePresence SX10"
},
{
"value": "Cisco TelePresence SX20",
"title": "Cisco TelePresence SX20"
},
{
"value": "Cisco TelePresence SX80",
"title": "Cisco TelePresence SX80"
},
{
"value": "Cisco TelePresence TX1310-65",
"title": "Cisco TelePresence TX1310-65"
},
{
"value": "Cisco TelePresence TX9000",
"title": "Cisco TelePresence TX9000"
},
{
"value": "Cisco TelePresence TX9200",
"title": "Cisco TelePresence TX9200"
},
{
"value": "Cisco Unified Client Services Framework",
"title": "Cisco Unified Client Services Framework"
},
{
"value": "Cisco Unified Communications for RTX",
"title": "Cisco Unified Communications for RTX"
},
{
"value": "Cisco Unified Mobile Communicator",
"title": "Cisco Unified Mobile Communicator"
},
{
"value": "Cisco Unified Personal Communicator",
"title": "Cisco Unified Personal Communicator"
},
{
"value": "Cisco VG200",
"title": "Cisco VG200"
},
{
"value": "Cisco VG248 Gateway",
"title": "Cisco VG248 Gateway"
},
{
"value": "Cisco VGC Phone",
"title": "Cisco VGC Phone"
},
{
"value": "Cisco VGC Virtual Phone",
"title": "Cisco VGC Virtual Phone"
},
{
"value": "Cisco VGD-1T3",
"title": "Cisco VGD-1T3"
},
{
"value": "Cisco VXC 6215",
"title": "Cisco VXC 6215"
},
{
"value": "Cisco Video Conference Bridge(IPVC-35xx)",
"title": "Cisco Video Conference Bridge(IPVC-35xx)"
},
{
"value": "Cisco Voice Mail Port",
"title": "Cisco Voice Mail Port"
},
{
"value": "Cisco Webex Board 55",
"title": "Cisco Webex Board 55"
},
{
"value": "Cisco Webex Board 70",
"title": "Cisco Webex Board 70"
},
{
"value": "Cisco Webex Board 85",
"title": "Cisco Webex Board 85"
},
{
"value": "Cisco Webex DX80",
"title": "Cisco Webex DX80"
},
{
"value": "Cisco Webex Desk LE",
"title": "Cisco Webex Desk LE"
},
{
"value": "Cisco Webex Desk Pro",
"title": "Cisco Webex Desk Pro"
},
{
"value": "Cisco Webex Room 55",
"title": "Cisco Webex Room 55"
},
{
"value": "Cisco Webex Room 55 Dual",
"title": "Cisco Webex Room 55 Dual"
},
{
"value": "Cisco Webex Room 70 Dual",
"title": "Cisco Webex Room 70 Dual"
},
{
"value": "Cisco Webex Room 70 Dual G2",
"title": "Cisco Webex Room 70 Dual G2"
},
{
"value": "Cisco Webex Room 70 Panorama",
"title": "Cisco Webex Room 70 Panorama"
},
{
"value": "Cisco Webex Room 70 Single",
"title": "Cisco Webex Room 70 Single"
},
{
"value": "Cisco Webex Room 70 Single G2",
"title": "Cisco Webex Room 70 Single G2"
},
{
"value": "Cisco Webex Room Kit",
"title": "Cisco Webex Room Kit"
},
{
"value": "Cisco Webex Room Kit Mini",
"title": "Cisco Webex Room Kit Mini"
},
{
"value": "Cisco Webex Room Kit Plus",
"title": "Cisco Webex Room Kit Plus"
},
{
"value": "Cisco Webex Room Kit Pro",
"title": "Cisco Webex Room Kit Pro"
},
{
"value": "Cisco Webex Room Panorama",
"title": "Cisco Webex Room Panorama"
},
{
"value": "Cisco Webex Room Phone",
"title": "Cisco Webex Room Phone"
},
{
"value": "Cisco Webex VDI Svc Framework",
"title": "Cisco Webex VDI Svc Framework"
},
{
"value": "Communication Media Module",
"title": "Communication Media Module"
},
{
"value": "EMCC Base Phone",
"title": "EMCC Base Phone"
},
{
"value": "FLEX_SLOT",
"title": "FLEX_SLOT"
},
{
"value": "Gatekeeper",
"title": "Gatekeeper"
},
{
"value": "Generic Desktop Video Endpoint",
"title": "Generic Desktop Video Endpoint"
},
{
"value": "Generic Multiple Screen Room System",
"title": "Generic Multiple Screen Room System"
},
{
"value": "Generic Single Screen Room System",
"title": "Generic Single Screen Room System"
},
{
"value": "H.225 Trunk (Gatekeeper Controlled)",
"title": "H.225 Trunk (Gatekeeper Controlled)"
},
{
"value": "H.323 Client",
"title": "H.323 Client"
},
{
"value": "H.323 Gateway",
"title": "H.323 Gateway"
},
{
"value": "Hunt List",
"title": "Hunt List"
},
{
"value": "IAD2400_ANALOG",
"title": "IAD2400_ANALOG"
},
{
"value": "IAD2400_DIGITAL",
"title": "IAD2400_DIGITAL"
},
{
"value": "IMS-integrated Mobile (Basic)",
"title": "IMS-integrated Mobile (Basic)"
},
{
"value": "IP-STE",
"title": "IP-STE"
},
{
"value": "ISDN BRI Phone",
"title": "ISDN BRI Phone"
},
{
"value": "Inter-Cluster Trunk (Gatekeeper Controlled)",
"title": "Inter-Cluster Trunk (Gatekeeper Controlled)"
},
{
"value": "Inter-Cluster Trunk (Non-Gatekeeper Controlled)",
"title": "Inter-Cluster Trunk (Non-Gatekeeper Controlled)"
},
{
"value": "Interactive Voice Response",
"title": "Interactive Voice Response"
},
{
"value": "Load Simulator",
"title": "Load Simulator"
},
{
"value": "Motorola CN622",
"title": "Motorola CN622"
},
{
"value": "Music On Hold",
"title": "Music On Hold"
},
{
"value": "NM-1V",
"title": "NM-1V"
},
{
"value": "NM-2V",
"title": "NM-2V"
},
{
"value": "NM-4VWIC-MBRD",
"title": "NM-4VWIC-MBRD"
},
{
"value": "NM-HD-1V",
"title": "NM-HD-1V"
},
{
"value": "NM-HD-2V",
"title": "NM-HD-2V"
},
{
"value": "NM-HD-2VE",
"title": "NM-HD-2VE"
},
{
"value": "NM-HDA",
"title": "NM-HDA"
},
{
"value": "NM-HDV",
"title": "NM-HDV"
},
{
"value": "NM-HDV2-0PORT",
"title": "NM-HDV2-0PORT"
},
{
"value": "NM-HDV2-1PORT",
"title": "NM-HDV2-1PORT"
},
{
"value": "NM-HDV2-2PORT",
"title": "NM-HDV2-2PORT"
},
{
"value": "Nokia S60",
"title": "Nokia S60"
},
{
"value": "PA-MCX",
"title": "PA-MCX"
},
{
"value": "PA-VXA",
"title": "PA-VXA"
},
{
"value": "PA-VXB",
"title": "PA-VXB"
},
{
"value": "PA-VXC",
"title": "PA-VXC"
},
{
"value": "Pilot",
"title": "Pilot"
},
{
"value": "Remote Destination Profile",
"title": "Remote Destination Profile"
},
{
"value": "Route List",
"title": "Route List"
},
{
"value": "SCCP Device",
"title": "SCCP Device"
},
{
"value": "SCCP gateway virtual phone",
"title": "SCCP gateway virtual phone"
},
{
"value": "SIP Trunk",
"title": "SIP Trunk"
},
{
"value": "SIP WSM Connection",
"title": "SIP WSM Connection"
},
{
"value": "SPA8800",
"title": "SPA8800"
},
{
"value": "Third-party AS-SIP Endpoint",
"title": "Third-party AS-SIP Endpoint"
},
{
"value": "Third-party SIP Device (Advanced)",
"title": "Third-party SIP Device (Advanced)"
},
{
"value": "Third-party SIP Device (Basic)",
"title": "Third-party SIP Device (Basic)"
},
{
"value": "Transnova S3",
"title": "Transnova S3"
},
{
"value": "Universal Device Template",
"title": "Universal Device Template"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "VG202",
"title": "VG202"
},
{
"value": "VG204",
"title": "VG204"
},
{
"value": "VG224",
"title": "VG224"
},
{
"value": "VG310",
"title": "VG310"
},
{
"value": "VG320",
"title": "VG320"
},
{
"value": "VG350",
"title": "VG350"
},
{
"value": "VG400",
"title": "VG400"
},
{
"value": "VG420",
"title": "VG420"
},
{
"value": "VG450",
"title": "VG450"
},
{
"value": "VGC Port",
"title": "VGC Port"
},
{
"value": "VIC_SLOT",
"title": "VIC_SLOT"
},
{
"value": "VKEM 36-Button Line Expansion Module",
"title": "VKEM 36-Button Line Expansion Module"
},
{
"value": "VNM-HDA",
"title": "VNM-HDA"
},
{
"value": "VWIC_SLOT",
"title": "VWIC_SLOT"
},
{
"value": "WS-SVC-CMM-MS",
"title": "WS-SVC-CMM-MS"
},
{
"value": "WS-X6600",
"title": "WS-X6600"
}
],
"maxItems": 1,
"type": "string"
},
"description": {
"description": " Identify the purpose of the device. You can enter the user name (such as John Smith) or the phone location (such as Lobby) in this field. For Cisco VG248 gateways, begin the description with VGC<mac address>. The description can include up to 128 characters in any language, but it cannot include double-quotes (\"), percentage sign (%), ampersand (&), back-slash (\\), or angle brackets (<>). ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": [
"string",
"null"
]
},
"allowMraMode": {
"title": "Allow MRA Mode",
"minItems": 0,
"required": false,
"default": false,
"readonly": false,
"maxItems": 1,
"type": "boolean"
},
"sendGeoLocation": {
"title": "Send Geo Location",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"ownerUserName": {
"description": " From the drop-down list box, choose the user ID of the assigned phone user. The user ID gets recorded in the call detail record (CDR) for all calls made from this device. Assigning a user ID to the device also moves the device from \"Unassigned Devices\" to \"Users\" in the License Usage Report. ",
"title": "Owner User ID",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "userid",
"maxItems": 1,
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/User",
"choices": []
},
"ignorePresentationIndicators": {
"description": " Check this check box to configure call display restrictions on a call-by-call basis. When this check box is checked, Cisco Unified CM ignores any presentation restriction that is received for internal calls. 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. See the translation configuration settings for more information about the calling line ID presentation and the connected line ID presentation parameters. ",
"title": "Ignore Presentation Indicators (internal calls only)",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"phoneActivationCodeExpiry": {
"type": [
"string"
],
"description": "The provisioning code expiry datetime",
"title": "Phone Activation Code Expiry"
},
"secureServicesUrl": {
"description": " Enter the secure URL for \n Cisco Unified IP Phone services. The is the location that the secure \n Cisco Unified IP Phone contacts when the user presses the Services button. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you do not provide a Secure Services URL, the device uses the nonsecure URL. If you provide both a secure URL and a nonsecure URL, the device chooses the appropriate URL, based on its capabilities. \n \n \n To accept the default setting, leave this field blank. Maximum length: 255 ",
"title": "Secure Services URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"services": {
"title": "Services",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"service": {
"name": "service",
"title": "Service",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"name": "name",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 100,
"type": "string"
},
"url": {
"name": "url",
"title": "Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"serviceNameAscii": {
"name": "serviceNameAscii",
"title": "Service Name Ascii",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"urlButtonIndex": {
"name": "urlButtonIndex",
"title": "Url Button Index",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"telecasterServiceName": {
"name": "telecasterServiceName",
"title": "Telecaster Service Name",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "serviceName",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/IpPhoneServices/choices/?field=serviceName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/IpPhoneServices",
"choices": []
},
"urlLabel": {
"name": "urlLabel",
"title": "Url Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"sshUserId": {
"description": " Enter a user ID for the secure shell user. You can enter any alphanumeric or special characters up to 50 characters. Invalid characters include\u201d,\u00a0%, &, <, >, and \\. This field displays when the phone device that you are configuring supports SSH access. Cisco Technical Assistance Center (TAC) uses secure shell for troubleshooting and debugging. Contact TAC for further assistance. See the \n Cisco Unified Communications Manager Security Guide for this release for information about how to configure encrypted phone configuration files to ensure that Cisco Unified CM does not send SSH credentials to the phone in the clear. ",
"title": "Secure Shell User",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"certificateStatus": {
"title": "Certificate Status",
"minItems": 0,
"required": false,
"readonly": true,
"maxItems": 1,
"type": "string"
},
"class": {
"description": "Class ID string. Class information is read-only except when creating a device.",
"title": "Class",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Phone",
"title": "Phone"
},
{
"value": "Gateway",
"title": "Gateway"
},
{
"value": "Conference Bridge",
"title": "Conference Bridge"
},
{
"value": "Media Termination Point",
"title": "Media Termination Point"
},
{
"value": "Route List",
"title": "Route List"
},
{
"value": "Voice Mail",
"title": "Voice Mail"
},
{
"value": "CTI Route Point",
"title": "CTI Route Point"
},
{
"value": "Music On Hold",
"title": "Music On Hold"
},
{
"value": "Simulation",
"title": "Simulation"
},
{
"value": "Pilot",
"title": "Pilot"
},
{
"value": "GateKeeper",
"title": "GateKeeper"
},
{
"value": "Add-on modules",
"title": "Add-on modules"
},
{
"value": "Hidden Phone",
"title": "Hidden Phone"
},
{
"value": "Trunk",
"title": "Trunk"
},
{
"value": "Tone Announcement Player",
"title": "Tone Announcement Player"
},
{
"value": "Remote Destination Profile",
"title": "Remote Destination Profile"
},
{
"value": "EMCC Base Phone Template",
"title": "EMCC Base Phone Template"
},
{
"value": "EMCC Base Phone",
"title": "EMCC Base Phone"
},
{
"value": "Remote Destination Profile Template",
"title": "Remote Destination Profile Template"
},
{
"value": "Gateway Template",
"title": "Gateway Template"
},
{
"value": "UDP Template",
"title": "UDP Template"
},
{
"value": "Phone Template",
"title": "Phone Template"
},
{
"value": "Device Profile",
"title": "Device Profile"
},
{
"value": "Invalid",
"title": "Invalid"
},
{
"value": "Interactive Voice Response",
"title": "Interactive Voice Response"
}
],
"default": "Phone",
"maxItems": 1,
"type": "string"
},
"dndOption": {
"description": " When you enable DND on the phone, this parameter allows you to specify how the DND features handle incoming calls: \n \n \n Call Reject\u2014This 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. \n \n Ringer Off\u2014This option turns off the ringer, but incoming call information gets presented to the device, so the user can accept the call. \n \n Use Common Phone Profile Setting\u2014This option specifies that the DND Option setting from the Common Phone Profile window will get used for this device. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n 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. \n \n \n ",
"title": "DND Option",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Ringer Off",
"title": "Ringer Off"
},
{
"value": "Call Reject",
"title": "Call Reject"
},
{
"value": "Use Common Phone Profile Setting",
"title": "Use Common Phone Profile Setting"
}
],
"default": "Ringer Off",
"maxItems": 1,
"type": "string"
},
"presenceGroupName": {
"title": "BLF Presence Group",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/PresenceGroup",
"choices": []
},
"rerouteCallingSearchSpaceName": {
"description": " From the drop-down list box, choose a calling search space to use for rerouting. The rerouting calling search space of the referrer gets used to find the route to the refer-to target. When the Refer fails due to the rerouting calling search space, the Refer Primitive rejects the request with the \"405 Method Not Allowed\" message. The redirection (3xx) primitive and transfer feature also uses the rerouting calling search space to find the redirect-to or transfer-to target. ",
"title": "Rerouting Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Css",
"choices": []
},
"commonPhoneConfigName": {
"description": " From the drop-down list box, choose a common phone profile from the list of available common phone profiles. ",
"title": "Common Phone Profile",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/CommonPhoneConfig/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": "string",
"target_model_type": "device/cucm/CommonPhoneConfig",
"choices": []
},
"idleTimeout": {
"description": " Enter the time (in seconds) that you want to elapse before the URL that is specified in the Idle field displays. To accept the value of the Idle URL Timer enterprise parameter, leave this field blank. ",
"title": "Idle Timer (seconds)",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"idleUrl": {
"description": " This setting determines the busy lamp field (BLF) audible alert setting when no current call exists on the BLF DN: \n \n \n On\u2014An audible alert sounds. \n \n Off\u2014No audible alert sounds. \n \n Default\u2014The configuration in the Service Parameters Configuration window determines the alert option. \n ",
"title": "Idle",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"softkeyTemplateName": {
"description": " Choose the appropriate softkey template. The softkey template determines the configuration of the softkeys on \n Cisco Unified IP Phones. Leave this field blank if the common device configuration contains the assigned softkey template. ",
"title": "Softkey Template",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/SoftKeyTemplate/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/SoftKeyTemplate",
"choices": []
},
"remoteDevice": {
"description": " If you are experiencing delayed connect times over SCCP pipes to remote sites, check the Remote Device check box in the Phone Configuration window. Checking this check box tells Cisco Unified CM to allocate a buffer for the phone device when it registers and to bundle SCCP messages to the phone. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n Because this feature consumes resources, be sure to check this check box only when you are experiencing signaling delays for phones that are running SCCP. Most users do not require this option. \n \n \n Cisco Unified CM sends the bundled messages to the phone when the station buffer is full, as soon as it receives a media-related message, or when the Bundle Outbound SCCP Messages timer expires. To specify a setting other than the default setting (100 msec) for the Bundle Outbound SCCP Messages timer, configure a new value in the Service Parameters Configuration window for the Cisco CallManager service. Although 100 msec specifies the recommended setting, you may enter 15 msec to 500 msec. The phone must support SCCP version 9 to use this option. The following phones do not support SCCP message optimization: \n Cisco Unified IP Phone 7935/7936. This feature may require a phone reset after update. ",
"title": "Remote Device",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"automatedAlternateRoutingCssName": {
"description": " Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR). The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth. ",
"title": "AAR Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Css",
"choices": []
},
"dialRulesName": {
"description": " If required, choose the appropriate SIP dial rule. SIP dial rules provide local dial plans for \n Cisco Unified IP Phones 7905, 7912, 7940, and 7960, so users do not have to press a key or wait for a timer before the call gets processed. Leave the SIP Dial Rules field set to <None> if you do not want dial rules to apply to the IP phone that is running SIP. This means that the user must use the Dial softkey or wait for the timer to expire before the call gets processed. ",
"title": "SIP Dial Rules",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
}
},
"schema_version": "14.0"
}