[Index]

Model: relation/MvsSubscriber

MS Teams Subscriber relation model

Model Details: relation/MvsSubscriber

Title Description Details
Confirm MLPP Password Confirm the MLPP password. Note    To confirm that you entered the MLPP Password correctly, re-enter the password in this field.
  • Field Name: mlppPassword
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
  • MaxLength: 20
  • Pattern: ^[0-9]{4,20}$
Associated Pc This required field applies for Cisco IP Softphone users.
  • Field Name: associatedPc
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Convert LDAP Synchronized User to Local User This check box appears for LDAP synchronized end users. Check this check box then save changes to convert an LDAP synchronized user to a local user.
  • Field Name: convertUserAccount
  • Type: String
  • Cardinality: [0..1]
Customer Name This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
  • Field Name: customerName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Confirm PIN Enter the PIN again.
  • Field Name: pin
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Enable User for Unified CM IM and Presence (Configure IM and Presence in the associated UC Service Profile) Check this check box to enable the end user (on the home cluster) for IM and Presence. Configure IM and Presence in the associated service profile. Note    IM and Presence does not function properly if an end user is assigned to more than one home cluster. Note    You must install a Unified Communications Manager IM and Presence node along with this Unified Communications Manager cluster. Use the User Management > User Settings > UC Services menu to configure the IM and Presence service.
  • Field Name: imAndPresenceEnable
  • Type: Boolean
  • Cardinality: [0..1]
Calendar Presence
  • Field Name: calendarPresence
  • Type: Boolean
  • Cardinality: [0..1]
User Profile
  • Field Name: userProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/UserProfileProvision
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Associated Devices Also known as controlled devices.
  • Field Name: associatedDevices
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Device Name of device.
  • Field Name: device.[n]
  • Type: Array
Manager Enter the user ID of the end user manager ID. Tip    The manager user ID that you enter does not have to exist in the same cluster as the end user; therefore, Unified CM does not require that you enter a user ID that already exists in the database.
  • Field Name: manager
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
IPCC Extension From the drop-down list box, choose an IPCC extension for this end user. Note    This field appears only if the IPCC Express Installed enterprise parameter is set to True.
  • Field Name: ipccExtension
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Home Cluster Check this check box if the end user is homed to this cluster. The end user should only be homed to one cluster within the enterprise. Note    After an upgrade to Unified Communications Manager Release 10.0(1), when new users are synced from LDAP, the home cluster is not enabled. You must modify your existing LDAP synchronization agreement and add a Feature Group Template which has the home cluster enabled. Default: True
  • Field Name: homeCluster
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Maximum Wait Time for Desk Pickup Enter the maximum time in milliseconds that is permitted to pass before the user must pick up a call that is transferred from the mobile phone to desktop phone. Default: 10000
  • Field Name: maxDeskPickupWaitTime
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 10000
Primary Extension Only DNs associated with the associatedDevices of the User can be used as primary extension.
  • Field Name: primaryExtension
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pattern * DN or Pattern
  • Field Name: primaryExtension.pattern
  • Type: String
  • Target: device/cucm/Line
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Route Partition Name * Route Partition to which the DN is associated.
  • Field Name: primaryExtension.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • MaxLength: 50
  • Format: uri
Directory Uri Enter the directory URI that you want to associate to this end user. A directory URI looks like an email address and follows the user@host format. For information about valid formats for directory URIs, see Directory URI formats in the "Intercluster Directory URI" chapter of the Cisco Unified Communications Manager Administrative Guide. Note    If you enter a directory URI and also enter a directory number in the Primary Extension field, this directory URI automatically becomes the primary directory URI that is associated to that directory number.
  • Field Name: directoryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 254
  • Pattern: ^[^@]{1,47}@[^@]+$
Title
  • Field Name: title
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Middle Name Enter the end user middle name.
  • Field Name: middleName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
MLPP Precedence Authorization Level Set the MLPP Precedence Authorization Level. The following precedence levels indicate the priority level that is associated with a call: 0: Flash Override (highest) 1: Flash 2: Immediate 3: Priority 4: Routine (lowest) You can set the Precedence Authorization Level to any standard precedence level from Routine to Executive Override. Calls of equal or lower precedence are authorized to be originated by the user. Default: Default
  • Field Name: patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Associated Headsets Contains headset that are associated to user.
  • Field Name: associatedHeadsets
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Headset Name of headset.
  • Field Name: headset.[n]
  • Type: Array
  • Cardinality: [0..15]
Attendees Access Code Set the Attendees Access Code for a secure conference call. The access code can be modified in the Self Care Portal. For more information on how to modify the access code, see the Cisco Unified Communications Self Care Portal User Guide.
  • Field Name: attendeesAccessCode
  • Type: String
  • Cardinality: [0..1]
Home Number Enter the end user home number. You may use the following special characters: (,), and -.
  • Field Name: homeNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ipcc Route Partition Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs with ipccExtension tag only.
  • Field Name: ipccRoutePartition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Zero Hop If zeroHop value is false pin will be synchronized with UCxN, if synchronization is enabled for Unity Connection server and if zeroHop is true pin will not be synchronized with UCxN. This tage is supported only for updateUser api
  • Field Name: zeroHop
  • Type: Boolean
  • Cardinality: [0..1]
Department Enter the end user department information (for example, the department number or name).
  • Field Name: department
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Confirm Digest Credentials To confirm that you entered the digest credentials correctly, re-enter the credentials in this field.
  • Field Name: digestCredentials
  • Type: ["String", "Null"]
  • Is Password: True
  • Cardinality: [0..1]
Enable User To Host Conference Now Check this check box to allow End User to host Conference Now.
  • Field Name: enableUserToHostConferenceNow
  • Type: Boolean
  • Cardinality: [0..1]
Associated Groups
  • Field Name: associatedGroups
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
User Group
  • Field Name: userGroup.[n]
  • Type: Array
Groups * Name of User Group
  • Field Name: associatedGroups.userGroup.[n].name
  • Type: String
  • Target: device/cucm/UserGroup
  • Target attr: name
  • Cardinality: [1..1]
  • MaxLength: 100
  • Format: uri
User Roles
  • Field Name: userRoles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Roles READ ONLY: Name of the User Role associated with the user group will be taken.
  • Field Name: userRole.[n]
  • Type: Array
Self Service The Meeting Number is generated automatically when the Self-Service User ID field is configured.
  • Field Name: selfService
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#]{0,27}$
Enable Mobility Check this check box to activate Cisco Unified Mobility, which allows the user to manage calls by using a single phone number and to pick up in-progress calls on the desktop phone and cellular phone. Checking this check box triggers licensing to consume device license units for Cisco Unified Mobility.
  • Field Name: enableMobility
  • Type: Boolean
  • Cardinality: [0..1]
Enable Extension Mobility Cross Cluster Check this box to enable this end user to use the Cisco Extension Mobility Cross Cluster feature. For more information about the Cisco Extension Mobility Cross Cluster feature, see the Feature Configuration Guide for Cisco Unified Communications Manager.
  • Field Name: enableEmcc
  • Type: Boolean
  • Cardinality: [0..1]
Password Credentials Not Applicable for Add. Credential configuration for password.
  • Field Name: passwordCredentials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pwd Cred User Must Change
  • Field Name: passwordCredentials.pwdCredUserMustChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred User Cant Change
  • Field Name: passwordCredentials.pwdCredUserCantChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Time Changed
  • Field Name: passwordCredentials.pwdCredTimeChanged
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Time Admin Lockout
  • Field Name: passwordCredentials.pwdCredTimeAdminLockout
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pwd Cred Policy Name
  • Field Name: passwordCredentials.pwdCredPolicyName
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Locked By Administrator
  • Field Name: passwordCredentials.pwdCredLockedByAdministrator
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Reset Hack Count The tag will be ignored in add, while update you can reset the hack count.
  • Field Name: passwordCredentials.pwdResetHackCount
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Does Not Expire
  • Field Name: passwordCredentials.pwdCredDoesNotExpire
  • Type: Boolean
  • Cardinality: [0..1]
MLPP User ID This pane displays the Instance ID from the CAPF Profile that you configured for this user. To view or update the profile, double-click the Instance ID or click the Instance ID to highlight it; then, click View Details. The End User CAPF Profile Configuration window displays with the current settings. Note    The MLPP User Identification number must comprise 6 - 20 numeric characters. For information on how to configure the End User CAPF Profile, see the Cisco Unified Communications Manager Security Guide.
  • Field Name: numericUserId
  • Type: String
  • Cardinality: [0..1]
  • Pattern: ^[0-9]{6,20}$
SUBSCRIBE Calling Search Space Supported with the BLF Presence feature, the SUBSCRIBE calling search space determines how Unified Communications Manager routes presence requests that come from the end user. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the end user. From the drop-down list box, choose the SUBSCRIBE calling search space to use for presence requests for the end user. All calling search spaces that you configure in Cisco Unified CM Administration appear 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 box, 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.
  • Field Name: subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
User Locale From the drop-down list box, choose the locale that is associated with the end user. The user locale identifies a set of detailed information to support end users, including language and font. Unified Communications Manager uses this locale for extension mobility and the Cisco Unified Communications Self Care Portal. For Cisco Extension Mobility login, the locale that is specified takes precedence over the device and device profile settings. For Cisco Extension Mobility logout, Unified Communications Manager uses the end user locale that the default device profile specifies. Note    If you do not choose an end user locale, the locale that is specified in the Cisco CallManager service parameters as Default User Locale applies.
  • Field Name: userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Allow Control of Device from CTI If this check box is checked, when the user logs in to a device, the AllowCTIControlFlag device property becomes active, which allows control of the device from CTI applications. Until the user logs in to a device, this setting has no effect. Note    The Allow Control of Device from CTI setting in the end user configuration overrides the AllowCTIControlFlag device property of the device to which the user logs in. Default: True
  • Field Name: enableCti
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Mailid Enter the end user e-mail address.
  • Field Name: mailid
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Phone Profiles
  • Field Name: phoneProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Profile Name
  • Field Name: profileName.[n]
  • Type: Array
  • Cardinality: [1..n]
Pager Number Enter the end user pager number. You may use the following special characters: (,), and -.
  • Field Name: pagerNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Name Dialing
  • Field Name: nameDialing
  • Type: String
  • Cardinality: [0..1]
Enable Mobile Voice Access Check this check box to allow the user to access the Mobile Voice Access integrated voice response (IVR) system to initiate Cisco Unified Mobility calls and activate or deactivate Cisco Unified Mobility capabilities.
  • Field Name: enableMobileVoiceAccess
  • Type: Boolean
  • Cardinality: [0..1]
Confirm Password This field does not display for LDAP Synchronized users if LDAP Authentication is enabled. Enter the end user password again.
  • Field Name: password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Default Profile From the drop-down list box, choose a default extension mobility profile for this end user.
  • Field Name: defaultProfile
  • Type: String
  • Cardinality: [0..1]
Telephone Number Enter the end user work number. You may use the following special characters: (, ), and -.
  • Field Name: telephoneNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Mobile Number Enter the end user mobile number. You may use the following special characters: (,), and -.
  • Field Name: mobileNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Display Name This field appears for local end users as well as LDAP synchronized end users. You can specify a display name for the local end users. For LDAP synchronized end users, this field appears if Microsoft Active Directory is used as the corporate directory. It displays the display name of the end user as specified in Microsoft Active Directory. Note    This field is supported on Administrative XML (AXL) and Bulk Administration Tool (BAT).
  • Field Name: displayName
  • Type: String
  • Cardinality: [0..1]
First Name Enter the end user first name.
  • Field Name: firstName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Last Name * Enter the end user last name.
  • Field Name: lastName
  • Type: String
  • Cardinality: [1..1]
UC Service Profile To revert to the System Default Service Profile value, select any value from the drop-down, blank it (i.e. delete ALL text) and submit.
  • Field Name: serviceProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/ServiceProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Garbage Collection Status Garbage Collection Status
  • Field Name: status
  • Type: Integer
  • Cardinality: [0..1]
Userid * Enter the unique end user identification name. You can enter any character, including alphanumeric and special characters. No character restrictions exist for this field. You can modify the user ID only for local users. For LDAP synchronized users, you can view the user ID, but you cannot modify it. Note    We recommend that you do not use a slash (/) in the User ID field. Cisco User Data Services will not function properly for the user when the User ID contains a slash.
  • Field Name: userid
  • Type: String
  • Cardinality: [1..1]
Em Max Login Time
  • Field Name: emMaxLoginTime
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Cti Controlled Device Profiles
  • Field Name: ctiControlledDeviceProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Controlled Profiles This drop-down list box displays the CTI-controlled profiles that are available for association with an end user who is configured for CTI.
  • Field Name: profileName.[n]
  • Type: Array
  • Cardinality: [1..n]
Extensions Info These tags are for Quick User/Phone Add page
  • Field Name: extensionsInfo
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Extension These tags are for Quick User/Phone Add page
  • Field Name: extension.[n]
  • Type: Array
Pattern *
  • Field Name: extensionsInfo.extension.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Partition
  • Field Name: extensionsInfo.extension.[n].partition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Line Primary Uri
  • Field Name: extensionsInfo.extension.[n].linePrimaryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Sort Order
  • Field Name: extensionsInfo.extension.[n].sortOrder
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Route Partition
  • Field Name: extensionsInfo.extension.[n].routePartition
  • Type: String
  • Cardinality: [0..1]
User Identity Value should be of of the format user@domain
  • Field Name: userIdentity
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ldap Directory Name
  • Field Name: ldapDirectoryName
  • Type: ["String", "Null"]
  • Target: device/cucm/LdapDirectory
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Remote Destination Limit Enter the maximum number of phones to which the user is permitted to transfer calls from the desktop phone. Default: 4
  • Field Name: remoteDestinationLimit
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 4
Custom User Fields
  • Field Name: customUserFields
  • Type: Object
  • Cardinality: [0..1]
Custom User Field This Tag is valid only for GetUser
  • Field Name: customUserField.[n]
  • Type: Array
  • Cardinality: [0..5]
Name
  • Field Name: customUserFields.customUserField.[n].name
  • Type: String
  • Cardinality: [0..1]
Value
  • Field Name: customUserFields.customUserField.[n].value
  • Type: String
  • Cardinality: [0..1]
Pin Credentials Not Applicable for add. These groups get automatically added once an user is added.
  • Field Name: pinCredentials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pin Reset Hack Count The tag will be ignored in add, while update you can reset the hack count.
  • Field Name: pinCredentials.pinResetHackCount
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Locked By Administrator
  • Field Name: pinCredentials.pinCredLockedByAdministrator
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Time Admin Lockout
  • Field Name: pinCredentials.pinCredTimeAdminLockout
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pin Cred Does Not Expire
  • Field Name: pinCredentials.pinCredDoesNotExpire
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Policy Name
  • Field Name: pinCredentials.pinCredPolicyName
  • Type: String
  • Cardinality: [0..1]
Pin Cred User Cant Change
  • Field Name: pinCredentials.pinCredUserCantChange
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Time Changed
  • Field Name: pinCredentials.pinCredTimeChanged
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred User Must Change
  • Field Name: pinCredentials.pinCredUserMustChange
  • Type: Boolean
  • Cardinality: [0..1]
Line Appearance Association For Presences Applicable for Controlled Devices
  • Field Name: lineAppearanceAssociationForPresences
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Appearance Association For Presence
  • Field Name: lineAppearanceAssociationForPresence.[n]
  • Type: Array
Laap Product Type
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapProductType
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Associate
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapAssociate
  • Type: String
  • Cardinality: [0..1]
Laap Device Name
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDeviceName
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Partition
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapPartition
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Directory
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDirectory
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Description
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDescription
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
BLF Presence Group * Use this field to configure the BLF Presence feature. From the drop-down list box, choose a BLF presence group for the end user. The selected group specifies the destinations that the end user can monitor. The default value for BLF Presence Group specifies Standard Presence group, configured with installation. BLF Presence Groups that are configured in Cisco Unified Administration also appear in the drop-down list box. BLF Presence Group authorization works with BLF Presence Groups to allow or block presence requests between groups.
  • Field Name: presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Associated Remote Destination Profiles Read-Only.These groups automatically get added once the user is associated with a Remote Destination Profile.
  • Field Name: associatedRemoteDestinationProfiles
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Remote Destination Profiles This field lists the remote destination profiles that were created for this user. To view the details of a particular remote destination profile, choose a remote destination profile in the list and click the View Details link.
  • Field Name: remoteDestinationProfile.[n]
  • Type: Array
Subscriber Quick Add Group
  • Field Name: SubscriberQuickAddGroup
  • Type: Object
User ID of the CUCM User
  • Field Name: SubscriberQuickAddGroup.userid
  • Type: String
Subscriber Quick Add Group
  • Field Name: SubscriberQuickAddGroup.quick_add_group_name
  • Type: String
  • Target: data/QuickAddGroups
  • Target attr: group_name
  • Format: uri
Web Ex User
  • Field Name: WebExUser.[n]
  • Type: Array
  • Cardinality: [0..1]
Time Zone With DST
  • Field Name: WebExUser.[n].timeZoneWithDST
  • Type: String
  • Cardinality: [0..1]
Remote Support
  • Field Name: remoteSupport
  • Type: Object
  • Cardinality: [0..1]
Recording
  • Field Name: recording
  • Type: Object
  • Cardinality: [0..1]
Type
  • Field Name: WebExUser.[n].remoteSupport.recording.type
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["NBR", "LOCAL"]
Enforce *
  • Field Name: WebExUser.[n].remoteSupport.recording.enforce
  • Type: Boolean
  • Cardinality: [1..1]
Location
  • Field Name: WebExUser.[n].remoteSupport.recording.location
  • Type: String
  • Cardinality: [0..1]
Auto Request
  • Field Name: autoRequest
  • Type: Object
  • Cardinality: [0..1]
Enable *
  • Field Name: WebExUser.[n].remoteSupport.autoRequest.enable
  • Type: Boolean
  • Cardinality: [1..1]
Request
  • Field Name: WebExUser.[n].remoteSupport.autoRequest.request
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["DESK_VIEW", "DESK_CTRL", "APP_VIEW", "APP_CTRL"]
Sharing View
  • Field Name: WebExUser.[n].remoteSupport.sharingView
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["FS_SCALE", "FS", "WIN_SCALE", "WIN"]
Sharing Color
  • Field Name: WebExUser.[n].remoteSupport.sharingColor
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["256", "16BIT"]
Default Client
  • Field Name: defaultClient
  • Type: Object
  • Cardinality: [0..1]
Type *
  • Field Name: WebExUser.[n].remoteSupport.defaultClient.type
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["MULTI_SESS", "SINGLE_SESS"]
Single Sess Client
  • Field Name: WebExUser.[n].remoteSupport.defaultClient.singleSessClient
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["NEW_CONSL", "OLD_CONSL"]
Language ID
  • Field Name: WebExUser.[n].languageID
  • Type: Integer
  • Cardinality: [0..1]
Locale
  • Field Name: WebExUser.[n].locale
  • Type: String
  • Cardinality: [0..1]
Phones
  • Field Name: phones
  • Type: Object
  • Cardinality: [0..1]
Phone2
  • Field Name: WebExUser.[n].phones.phone2
  • Type: String
  • Cardinality: [0..1]
Mobile Phone2
  • Field Name: WebExUser.[n].phones.mobilePhone2
  • Type: String
  • Cardinality: [0..1]
Pager
  • Field Name: WebExUser.[n].phones.pager
  • Type: String
  • Cardinality: [0..1]
PIN
  • Field Name: WebExUser.[n].phones.PIN
  • Type: String
  • Cardinality: [0..1]
User Id Default: -1
  • Field Name: WebExUser.[n].userId
  • Type: Integer
  • Cardinality: [0..1]
  • Default: -1
Web Ex Id *
  • Field Name: WebExUser.[n].webExId
  • Type: String
  • Cardinality: [1..1]
Personal Teleconf
  • Field Name: personalTeleconf
  • Type: Object
  • Cardinality: [0..1]
Join Before Host
  • Field Name: WebExUser.[n].personalTeleconf.joinBeforeHost
  • Type: Boolean
  • Cardinality: [0..1]
Account
  • Field Name: account.[n]
  • Type: Array
  • Cardinality: [0..3]
Subscriber Access Code
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].subscriberAccessCode
  • Type: String
  • Cardinality: [0..1]
Account Index *
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].accountIndex
  • Type: Integer
  • Cardinality: [1..1]
Auto Generate
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].autoGenerate
  • Type: Boolean
  • Cardinality: [0..1]
Participant Limited Access Code
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].participantLimitedAccessCode
  • Type: String
  • Cardinality: [0..1]
Participant Full Access Code
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].participantFullAccessCode
  • Type: String
  • Cardinality: [0..1]
Join Before Host
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].joinBeforeHost
  • Type: Boolean
  • Cardinality: [0..1]
Default Flag
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].defaultFlag
  • Type: Boolean
  • Cardinality: [0..1]
Delete
  • Field Name: WebExUser.[n].personalTeleconf.account.[n].delete
  • Type: Boolean
  • Cardinality: [0..1]
Expiration Date
  • Field Name: WebExUser.[n].expirationDate
  • Type: String
  • Cardinality: [0..1]
Email2
  • Field Name: WebExUser.[n].email2
  • Type: String
  • Cardinality: [0..1]
Personal Url
  • Field Name: WebExUser.[n].personalUrl
  • Type: String
  • Cardinality: [0..1]
Comm Options
  • Field Name: commOptions
  • Type: Object
  • Cardinality: [0..1]
Electronic Info
  • Field Name: WebExUser.[n].commOptions.electronicInfo
  • Type: Boolean
  • Cardinality: [0..1]
Fax
  • Field Name: WebExUser.[n].commOptions.fax
  • Type: Boolean
  • Cardinality: [0..1]
Phone
  • Field Name: WebExUser.[n].commOptions.phone
  • Type: Boolean
  • Cardinality: [0..1]
Promos
  • Field Name: WebExUser.[n].commOptions.promos
  • Type: Boolean
  • Cardinality: [0..1]
Training Info
  • Field Name: WebExUser.[n].commOptions.trainingInfo
  • Type: Boolean
  • Cardinality: [0..1]
Press
  • Field Name: WebExUser.[n].commOptions.press
  • Type: Boolean
  • Cardinality: [0..1]
Mail
  • Field Name: WebExUser.[n].commOptions.mail
  • Type: Boolean
  • Cardinality: [0..1]
Prod Announce
  • Field Name: WebExUser.[n].commOptions.prodAnnounce
  • Type: Boolean
  • Cardinality: [0..1]
Email
  • Field Name: WebExUser.[n].commOptions.email
  • Type: Boolean
  • Cardinality: [0..1]
Meeting Types
  • Field Name: meetingTypes
  • Type: Object
  • Cardinality: [0..1]
Meeting Type
  • Field Name: meetingType.[n]
  • Type: Array
Title
  • Field Name: WebExUser.[n].title
  • Type: String
  • Cardinality: [0..1]
Session Options
  • Field Name: sessionOptions
  • Type: Object
  • Cardinality: [0..1]
Auto Delete After Meeting End
  • Field Name: WebExUser.[n].sessionOptions.autoDeleteAfterMeetingEnd
  • Type: Boolean
  • Cardinality: [0..1]
Display Quick Start Host
  • Field Name: WebExUser.[n].sessionOptions.displayQuickStartHost
  • Type: Boolean
  • Cardinality: [0..1]
Display Quick Start Attendees
  • Field Name: WebExUser.[n].sessionOptions.displayQuickStartAttendees
  • Type: Boolean
  • Cardinality: [0..1]
Default Service Type
  • Field Name: WebExUser.[n].sessionOptions.defaultServiceType
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["MeetingCenter", "EventCenter", "TrainingCenter", "SupportCenter", "SalesCenter"]
Default Session Type
  • Field Name: WebExUser.[n].sessionOptions.defaultSessionType
  • Type: Integer
  • Cardinality: [0..1]
Supported Services
  • Field Name: supportedServices
  • Type: Object
  • Cardinality: [0..1]
Event Center
  • Field Name: WebExUser.[n].supportedServices.eventCenter
  • Type: Boolean
  • Cardinality: [0..1]
Sales Center
  • Field Name: WebExUser.[n].supportedServices.salesCenter
  • Type: Boolean
  • Cardinality: [0..1]
Support Center
  • Field Name: WebExUser.[n].supportedServices.supportCenter
  • Type: Boolean
  • Cardinality: [0..1]
Meeting Center
  • Field Name: WebExUser.[n].supportedServices.meetingCenter
  • Type: Boolean
  • Cardinality: [0..1]
Training Center
  • Field Name: WebExUser.[n].supportedServices.trainingCenter
  • Type: Boolean
  • Cardinality: [0..1]
Privilege
  • Field Name: privilege
  • Type: Object
  • Cardinality: [0..1]
Is Enable PMR
  • Field Name: WebExUser.[n].privilege.isEnablePMR
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call In
  • Field Name: WebExUser.[n].privilege.teleConfCallIn
  • Type: Boolean
  • Cardinality: [0..1]
Attendee Only
  • Field Name: WebExUser.[n].privilege.attendeeOnly
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call Out
  • Field Name: WebExUser.[n].privilege.teleConfCallOut
  • Type: Boolean
  • Cardinality: [0..1]
Ro Site Admin
  • Field Name: WebExUser.[n].privilege.roSiteAdmin
  • Type: Boolean
  • Cardinality: [0..1]
Voice Over Ip
  • Field Name: WebExUser.[n].privilege.voiceOverIp
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Toll Free Call In
  • Field Name: WebExUser.[n].privilege.teleConfTollFreeCallIn
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call Out International
  • Field Name: WebExUser.[n].privilege.teleConfCallOutInternational
  • Type: Boolean
  • Cardinality: [0..1]
Meeting Assist
  • Field Name: WebExUser.[n].privilege.meetingAssist
  • Type: Boolean
  • Cardinality: [0..1]
Allow Ext Attendees
  • Field Name: WebExUser.[n].privilege.allowExtAttendees
  • Type: Boolean
  • Cardinality: [0..1]
Host
  • Field Name: WebExUser.[n].privilege.host
  • Type: Boolean
  • Cardinality: [0..1]
H Dvideo
  • Field Name: WebExUser.[n].privilege.HDvideo
  • Type: Boolean
  • Cardinality: [0..1]
Recording Editor
  • Field Name: WebExUser.[n].privilege.recordingEditor
  • Type: Boolean
  • Cardinality: [0..1]
Site Admin
  • Field Name: WebExUser.[n].privilege.siteAdmin
  • Type: Boolean
  • Cardinality: [0..1]
Is Enable CET
  • Field Name: WebExUser.[n].privilege.isEnableCET
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call In International
  • Field Name: WebExUser.[n].privilege.teleConfCallInInternational
  • Type: Boolean
  • Cardinality: [0..1]
Other Telephony Default: True
  • Field Name: WebExUser.[n].privilege.otherTelephony
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Lab Admin
  • Field Name: WebExUser.[n].privilege.labAdmin
  • Type: Boolean
  • Cardinality: [0..1]
H Qvideo
  • Field Name: WebExUser.[n].privilege.HQvideo
  • Type: Boolean
  • Cardinality: [0..1]
Email *
  • Field Name: WebExUser.[n].email
  • Type: String
  • Cardinality: [0..1]
Web ACD Prefs
  • Field Name: webACDPrefs
  • Type: Object
  • Cardinality: [0..1]
Manager Monitor All RS Queues
  • Field Name: WebExUser.[n].webACDPrefs.managerMonitorAllRSQueues
  • Type: Boolean
  • Cardinality: [0..1]
Monitor All RS Agents
  • Field Name: WebExUser.[n].webACDPrefs.monitorAllRSAgents
  • Type: Boolean
  • Cardinality: [0..1]
Agent Monitor All RS Queues
  • Field Name: WebExUser.[n].webACDPrefs.agentMonitorAllRSQueues
  • Type: Boolean
  • Cardinality: [0..1]
Num Agent Sessions
  • Field Name: WebExUser.[n].webACDPrefs.numAgentSessions
  • Type: Integer
  • Cardinality: [0..1]
Is Agent
  • Field Name: WebExUser.[n].webACDPrefs.isAgent
  • Type: Boolean
  • Cardinality: [0..1]
Is Mgr
  • Field Name: WebExUser.[n].webACDPrefs.isMgr
  • Type: Boolean
  • Cardinality: [0..1]
Time Zone ID Default: -1
  • Field Name: WebExUser.[n].timeZoneID
  • Type: Integer
  • Cardinality: [0..1]
  • Default: -1
Description
  • Field Name: WebExUser.[n].description
  • Type: String
  • Cardinality: [0..1]
Personal Meeting Room
  • Field Name: personalMeetingRoom
  • Type: Object
  • Cardinality: [0..1]
Photo URL
  • Field Name: WebExUser.[n].personalMeetingRoom.photoURL
  • Type: String
  • Cardinality: [0..1]
Sip URL
  • Field Name: WebExUser.[n].personalMeetingRoom.sipURL
  • Type: String
  • Cardinality: [0..1]
Welcome Message
  • Field Name: WebExUser.[n].personalMeetingRoom.welcomeMessage
  • Type: String
  • Cardinality: [0..1]
Pilot Number
  • Field Name: WebExUser.[n].personalMeetingRoom.pilotNumber
  • Type: String
  • Cardinality: [0..1]
Personal Meeting Room URL
  • Field Name: WebExUser.[n].personalMeetingRoom.personalMeetingRoomURL
  • Type: String
  • Cardinality: [0..1]
Host PIN
  • Field Name: WebExUser.[n].personalMeetingRoom.hostPIN
  • Type: String
  • Cardinality: [0..1]
Header Image Branding
  • Field Name: WebExUser.[n].personalMeetingRoom.headerImageBranding
  • Type: Boolean
  • Cardinality: [0..1]
Apply PMR For Instant Meeting
  • Field Name: WebExUser.[n].personalMeetingRoom.applyPMRForInstantMeeting
  • Type: Boolean
  • Cardinality: [0..1]
Access Code
  • Field Name: WebExUser.[n].personalMeetingRoom.accessCode
  • Type: String
  • Cardinality: [0..1]
Header Image URL
  • Field Name: WebExUser.[n].personalMeetingRoom.headerImageURL
  • Type: String
  • Cardinality: [0..1]
Company
  • Field Name: WebExUser.[n].company
  • Type: String
  • Cardinality: [0..1]
Office Greeting
  • Field Name: WebExUser.[n].officeGreeting
  • Type: String
  • Cardinality: [0..1]
Tsp Account
  • Field Name: tspAccount
  • Type: Object
  • Cardinality: [0..1]
Tsp Account
  • Field Name: tspAccount.[n]
  • Type: Array
  • Cardinality: [0..3]
Participant Access Code
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].participantAccessCode
  • Type: String
  • Cardinality: [0..1]
Nbr Dial Out
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].nbrDialOut
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["TOLL_FREE", "TOLL"]
Create On Bridge
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].createOnBridge
  • Type: Boolean
  • Cardinality: [0..1]
Toll Free Call In Number
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].tollFreeCallInNumber
  • Type: String
  • Cardinality: [0..1]
Toll Call In Data
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].tollCallInData
  • Type: String
  • Cardinality: [0..1]
Custom1
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].custom1
  • Type: String
  • Cardinality: [0..1]
Custom2
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].custom2
  • Type: String
  • Cardinality: [0..1]
Custom3
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].custom3
  • Type: String
  • Cardinality: [0..1]
Toll Call In Number
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].tollCallInNumber
  • Type: String
  • Cardinality: [0..1]
Default Flag
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].defaultFlag
  • Type: Boolean
  • Cardinality: [0..1]
Account Index
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].accountIndex
  • Type: Integer
  • Cardinality: [0..1]
Delete
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].delete
  • Type: Boolean
  • Cardinality: [0..1]
Toll Free Call In Data
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].tollFreeCallInData
  • Type: String
  • Cardinality: [0..1]
Subscriber Access Code
  • Field Name: WebExUser.[n].tspAccount.tspAccount.[n].subscriberAccessCode
  • Type: String
  • Cardinality: [0..1]
Language
  • Field Name: WebExUser.[n].language
  • Type: String
  • Cardinality: [0..1]
Visit Count
  • Field Name: WebExUser.[n].visitCount
  • Type: Integer
  • Cardinality: [0..1]
Address
  • Field Name: address
  • Type: Object
  • Cardinality: [0..1]
City
  • Field Name: WebExUser.[n].address.city
  • Type: String
  • Cardinality: [0..1]
Address Type Default: PERSONAL
  • Field Name: WebExUser.[n].address.addressType
  • Type: String
  • Cardinality: [0..1]
  • Default: PERSONAL
  • Choices: ["PERSONAL", "GLOBAL"]
Address1
  • Field Name: WebExUser.[n].address.address1
  • Type: String
  • Cardinality: [0..1]
Address2
  • Field Name: WebExUser.[n].address.address2
  • Type: String
  • Cardinality: [0..1]
Zip Code
  • Field Name: WebExUser.[n].address.zipCode
  • Type: String
  • Cardinality: [0..1]
State
  • Field Name: WebExUser.[n].address.state
  • Type: String
  • Cardinality: [0..1]
Country
  • Field Name: WebExUser.[n].address.country
  • Type: String
  • Cardinality: [0..1]
Active *
  • Field Name: WebExUser.[n].active
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["ACTIVATED", "REQUEST_TO_ACTIVATE", "DEACTIVATED"]
Password *
  • Field Name: WebExUser.[n].password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
  • MaxLength: 60
Remote Access
  • Field Name: remoteAccess
  • Type: Object
  • Cardinality: [0..1]
Recording
  • Field Name: recording
  • Type: Object
  • Cardinality: [0..1]
Type
  • Field Name: WebExUser.[n].remoteAccess.recording.type
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["NBR", "LOCAL"]
Enforce *
  • Field Name: WebExUser.[n].remoteAccess.recording.enforce
  • Type: Boolean
  • Cardinality: [1..1]
Location
  • Field Name: WebExUser.[n].remoteAccess.recording.location
  • Type: String
  • Cardinality: [0..1]
Sharing View
  • Field Name: WebExUser.[n].remoteAccess.sharingView
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["FS_SCALE", "FS", "WIN_SCALE", "WIN"]
Sharing Color
  • Field Name: WebExUser.[n].remoteAccess.sharingColor
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["256", "16BIT"]
Officeurl
  • Field Name: WebExUser.[n].officeurl
  • Type: String
  • Cardinality: [0..1]
Tracking
  • Field Name: tracking
  • Type: Object
  • Cardinality: [0..1]
Tracking Code5
  • Field Name: WebExUser.[n].tracking.trackingCode5
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code4
  • Field Name: WebExUser.[n].tracking.trackingCode4
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code7
  • Field Name: WebExUser.[n].tracking.trackingCode7
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code6
  • Field Name: WebExUser.[n].tracking.trackingCode6
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code1
  • Field Name: WebExUser.[n].tracking.trackingCode1
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code10
  • Field Name: WebExUser.[n].tracking.trackingCode10
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code3
  • Field Name: WebExUser.[n].tracking.trackingCode3
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code2
  • Field Name: WebExUser.[n].tracking.trackingCode2
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code9
  • Field Name: WebExUser.[n].tracking.trackingCode9
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code8
  • Field Name: WebExUser.[n].tracking.trackingCode8
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
My Web Ex
  • Field Name: myWebEx
  • Type: Object
  • Cardinality: [0..1]
Is My Web Ex Pro
  • Field Name: WebExUser.[n].myWebEx.isMyWebExPro
  • Type: Boolean
  • Cardinality: [0..1]
Total Storage Size
  • Field Name: WebExUser.[n].myWebEx.totalStorageSize
  • Type: Integer
  • Cardinality: [0..1]
My Profile
  • Field Name: WebExUser.[n].myWebEx.myProfile
  • Type: Boolean
  • Cardinality: [0..1]
My Meetings
  • Field Name: WebExUser.[n].myWebEx.myMeetings
  • Type: Boolean
  • Cardinality: [0..1]
My Computer
  • Field Name: WebExUser.[n].myWebEx.myComputer
  • Type: Integer
  • Cardinality: [0..1]
My Folders
  • Field Name: WebExUser.[n].myWebEx.myFolders
  • Type: Boolean
  • Cardinality: [0..1]
Personal Meeting Room
  • Field Name: WebExUser.[n].myWebEx.personalMeetingRoom
  • Type: Boolean
  • Cardinality: [0..1]
My Contact
  • Field Name: WebExUser.[n].myWebEx.myContact
  • Type: Boolean
  • Cardinality: [0..1]
My Workspaces
  • Field Name: WebExUser.[n].myWebEx.myWorkspaces
  • Type: Boolean
  • Cardinality: [0..1]
Additional Recording Storage
  • Field Name: WebExUser.[n].myWebEx.additionalRecordingStorage
  • Type: Integer
  • Cardinality: [0..1]
My Partner Links
  • Field Name: WebExUser.[n].myWebEx.myPartnerLinks
  • Type: Boolean
  • Cardinality: [0..1]
Recorded Events
  • Field Name: WebExUser.[n].myWebEx.recordedEvents
  • Type: Boolean
  • Cardinality: [0..1]
My Reports
  • Field Name: WebExUser.[n].myWebEx.myReports
  • Type: Boolean
  • Cardinality: [0..1]
Training Recordings
  • Field Name: WebExUser.[n].myWebEx.trainingRecordings
  • Type: Boolean
  • Cardinality: [0..1]
Service
  • Field Name: WebExUser.[n].service
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["FREE_OFFICE", "STANDARD_OFFICE", "PRO_OFFICE"]
First Name *
  • Field Name: WebExUser.[n].firstName
  • Type: String
  • Cardinality: [0..1]
Scheduling Permission
  • Field Name: WebExUser.[n].schedulingPermission
  • Type: String
  • Cardinality: [0..1]
Password Hint Answer
  • Field Name: WebExUser.[n].passwordHintAnswer
  • Type: String
  • Cardinality: [0..1]
Last Name *
  • Field Name: WebExUser.[n].lastName
  • Type: String
  • Cardinality: [0..1]
Category Id
  • Field Name: WebExUser.[n].categoryId
  • Type: Integer
  • Cardinality: [0..1]
Support Center
  • Field Name: supportCenter
  • Type: Object
  • Cardinality: [0..1]
Service Desk
  • Field Name: serviceDesk
  • Type: Object
  • Cardinality: [0..1]
Enable
  • Field Name: WebExUser.[n].supportCenter.serviceDesk.enable
  • Type: Boolean
  • Cardinality: [0..1]
Order Tabs
  • Field Name: orderTabs
  • Type: Object
  • Cardinality: [0..1]
Tab
  • Field Name: tab.[n]
  • Type: Array
  • Cardinality: [4..4]
Third Party Teleconf
  • Field Name: thirdPartyTeleconf
  • Type: Object
  • Cardinality: [0..1]
Account
  • Field Name: account.[n]
  • Type: Array
  • Cardinality: [0..3]
Conf Bridge Num
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].confBridgeNum
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Pause
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].pause
  • Type: Integer
  • Cardinality: [0..1]
Name
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].name
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Moderator Code
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].moderatorCode
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Phone Name1
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].phoneName1
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Access Code
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].accessCode
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Account Index *
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].accountIndex
  • Type: Integer
  • Cardinality: [1..1]
Phone Name2
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].phoneName2
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Toll Free Num
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].tollFreeNum
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Default Flag
  • Field Name: WebExUser.[n].thirdPartyTeleconf.account.[n].defaultFlag
  • Type: Boolean
  • Cardinality: [0..1]
Mp Profile Number
  • Field Name: WebExUser.[n].mpProfileNumber
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 64
Password Hint
  • Field Name: WebExUser.[n].passwordHint
  • Type: String
  • Cardinality: [0..1]
Time Zone
  • Field Name: WebExUser.[n].timeZone
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["GMT-12:00, Dateline (Eniwetok)", "GMT-11:00, Samoa (Samoa)", "GMT-10:00, Hawaii (Honolulu)", "GMT-09:00, Alaska (Ancorage)", "GMT-08:00, Pacific (San Jose)", "GMT-07:00, Mountain (Arizona)", "GMT-07:00, Mountain (Denver)", "GMT-06:00, Central (Chicago)", "GMT-06:00, Mexico (Mexico City,Tegucigalpa)", "GMT-06:00, Central (Regina)", "GMT-05:00, S. America Pacific (Bogota)", "GMT-05:00, Eastern (New York)", "GMT-05:00, Eastern (Indiana)", "GMT-04:00, Atlantic (Halifax)", "GMT-04:00, S. America Western (Caracas)", "GMT-03:30, Newfoundland (Newfoundland)", "GMT-03:00, S. America Eastern (Brasilia)", "GMT-03:00, S. America Eastern (Buenos Aires)", "GMT-02:00, Mid-Atlantic (Mid-Atlantic)", "GMT-01:00, Azores (Azores)", "GMT+00:00, Greenwich (Casablanca)", "GMT+00:00, GMT (London)", "GMT+01:00, Europe (Amsterdam)", "GMT+01:00, Europe (Paris)", "GMT+01:00, Europe (Prague)", "GMT+01:00, Europe (Berlin)", "GMT+02:00, Greece (Athens)", "GMT+02:00, Eastern Europe (Bucharest)", "GMT+02:00, Egypt (Cairo)", "GMT+02:00, South Africa (Pretoria)", "GMT+02:00, Northern Europe (Helsinki)", "GMT+02:00, Israel (Tel Aviv)", "GMT+03:00, Saudi Arabia (Baghdad)", "GMT+03:00, Russian (Moscow)", "GMT+03:00, Nairobi (Nairobi)", "GMT+03:00, Iran (Tehran)", "GMT+04:00, Arabian (Abu Dhabi, Muscat)", "GMT+04:00, Baku (Baku)", "GMT+04:00, Afghanistan (Kabul)", "GMT+05:00, West Asia (Ekaterinburg)", "GMT+05:00, West Asia (Islamabad)", "GMT+05:30, India (Bombay)", "GMT+06:00, Columbo (Columbo)", "GMT+06:00, Central Asia (Almaty)", "GMT+07:00, Bangkok (Bangkok)", "GMT+08:00, China (Beijing)", "GMT+08:00, Australia Western (Perth)", "GMT+08:00, Singapore (Singapore)", "GMT+08:00, Taipei (Hong Kong)", "GMT+09:00, Tokyo (Tokyo)", "GMT+09:00, Korea (Seoul)", "GMT+09:30, Yakutsk (Yakutsk)", "GMT+09:30, Australia Central (Adelaide)", "GMT+09:30, Australia Central (Darwin)", "GMT+10:00, Australia Eastern (Brisbane)", "GMT+10:00, Australia Eastern (Sydney)", "GMT+10:00, West Pacific (Guam)", "GMT+10:00, Tasmania (Hobart)", "GMT+10:00, Vladivostok (Vladivostok)", "GMT+11:00, Central Pacific (Solomon Is)", "GMT+12:00, New Zealand (Wellington)", "GMT+12:00, Fiji (Fiji)", "GMT-09:00, Alaska (Anchorage)"]
Security
  • Field Name: security
  • Type: Object
  • Cardinality: [0..1]
Force Change Password
  • Field Name: WebExUser.[n].security.forceChangePassword
  • Type: Boolean
  • Cardinality: [0..1]
Lock Account
  • Field Name: WebExUser.[n].security.lockAccount
  • Type: Boolean
  • Cardinality: [0..1]
Reset Password
  • Field Name: WebExUser.[n].security.resetPassword
  • Type: Boolean
  • Cardinality: [0..1]
Registration Date
  • Field Name: WebExUser.[n].registrationDate
  • Type: String
  • Cardinality: [0..1]
Options
  • Field Name: options
  • Type: Object
  • Cardinality: [0..1]
Notify On New Message
  • Field Name: WebExUser.[n].options.notifyOnNewMessage
  • Type: Boolean
  • Cardinality: [0..1]
Folder Read
  • Field Name: WebExUser.[n].options.folderRead
  • Type: Boolean
  • Cardinality: [0..1]
Subscription Office
  • Field Name: WebExUser.[n].options.subscriptionOffice
  • Type: Boolean
  • Cardinality: [0..1]
Hold On Link Request
  • Field Name: WebExUser.[n].options.holdOnLinkRequest
  • Type: Boolean
  • Cardinality: [0..1]
Notify On Link Request
  • Field Name: WebExUser.[n].options.notifyOnLinkRequest
  • Type: Boolean
  • Cardinality: [0..1]
Title Visible
  • Field Name: WebExUser.[n].options.titleVisible
  • Type: Boolean
  • Cardinality: [0..1]
Cell Phone Visible
  • Field Name: WebExUser.[n].options.cellPhoneVisible
  • Type: Boolean
  • Cardinality: [0..1]
Office Url Visible
  • Field Name: WebExUser.[n].options.officeUrlVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support Meeting Record
  • Field Name: WebExUser.[n].options.supportMeetingRecord
  • Type: Boolean
  • Cardinality: [0..1]
Message Visible
  • Field Name: WebExUser.[n].options.messageVisible
  • Type: Boolean
  • Cardinality: [0..1]
Folder Write
  • Field Name: WebExUser.[n].options.folderWrite
  • Type: Boolean
  • Cardinality: [0..1]
Support Desktop Share Remote
  • Field Name: WebExUser.[n].options.supportDesktopShareRemote
  • Type: Boolean
  • Cardinality: [0..1]
Notify On Meeting
  • Field Name: WebExUser.[n].options.notifyOnMeeting
  • Type: Boolean
  • Cardinality: [0..1]
Email Visible
  • Field Name: WebExUser.[n].options.emailVisible
  • Type: Boolean
  • Cardinality: [0..1]
Is Enable CET
  • Field Name: WebExUser.[n].options.isEnableCET
  • Type: Boolean
  • Cardinality: [0..1]
Fax Visible
  • Field Name: WebExUser.[n].options.faxVisible
  • Type: Boolean
  • Cardinality: [0..1]
Icon Select2
  • Field Name: WebExUser.[n].options.iconSelect2
  • Type: Boolean
  • Cardinality: [0..1]
Icon Select1
  • Field Name: WebExUser.[n].options.iconSelect1
  • Type: Boolean
  • Cardinality: [0..1]
List In Category
  • Field Name: WebExUser.[n].options.listInCategory
  • Type: Boolean
  • Cardinality: [0..1]
Support App
  • Field Name: WebExUser.[n].options.supportApp
  • Type: Boolean
  • Cardinality: [0..1]
Pager Visible
  • Field Name: WebExUser.[n].options.pagerVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support Desktop Share
  • Field Name: WebExUser.[n].options.supportDesktopShare
  • Type: Boolean
  • Cardinality: [0..1]
Support Appshare Remote
  • Field Name: WebExUser.[n].options.supportAppshareRemote
  • Type: Boolean
  • Cardinality: [0..1]
Accept Link Request
  • Field Name: WebExUser.[n].options.acceptLinkRequest
  • Type: Boolean
  • Cardinality: [0..1]
First Name Visible
  • Field Name: WebExUser.[n].options.firstNameVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support File Share
  • Field Name: WebExUser.[n].options.supportFileShare
  • Type: Boolean
  • Cardinality: [0..1]
Support Web Tour Remote
  • Field Name: WebExUser.[n].options.supportWebTourRemote
  • Type: Boolean
  • Cardinality: [0..1]
Follow Me Enable
  • Field Name: WebExUser.[n].options.followMeEnable
  • Type: Boolean
  • Cardinality: [0..1]
Address Visible
  • Field Name: WebExUser.[n].options.addressVisible
  • Type: Boolean
  • Cardinality: [0..1]
Last Name Visible
  • Field Name: WebExUser.[n].options.lastNameVisible
  • Type: Boolean
  • Cardinality: [0..1]
Picture Visible
  • Field Name: WebExUser.[n].options.pictureVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support Video
  • Field Name: WebExUser.[n].options.supportVideo
  • Type: Boolean
  • Cardinality: [0..1]
Work Phone Visible
  • Field Name: WebExUser.[n].options.workPhoneVisible
  • Type: Boolean
  • Cardinality: [0..1]
Cuc User
  • Field Name: CUCUser.[n]
  • Type: Array
  • Cardinality: [0..1]
Exit Target Handler The unique identifier of the specific object to send along to the target conversation.
  • Field Name: CUCUser.[n].ExitTargetHandlerObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Title The position or function of a user within an organization, such as 'Vice President.'
  • Field Name: CUCUser.[n].Title
  • Type: String
Address Mode The default method the subscriber will use to address messages to other subscribers.
  • Field Name: CUCUser.[n].AddressMode
  • Type: Integer
Dtmf Name First Last The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the first name followed by the last name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: CUCUser.[n].DtmfNameFirstLast
  • Type: String
Command Digit Timeout The amount of time (in milliseconds) between digits on a multiple digit menu command entry (i.e. different than the inter digit timeout that is used for strings of digits such as extensions and transfer strings).
  • Field Name: CUCUser.[n].CommandDigitTimeout
  • Type: Integer
Voice Name The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.
  • Field Name: CUCUser.[n].VoiceName
  • Type: String
Say Timestamp After A flag indicating whether Cisco Unity Connection announces the timestamp after it plays back each message for the subscriber.
  • Field Name: CUCUser.[n].SayTimestampAfter
  • Type: Boolean
Department The name or number for the department or subdivision of an organization to which a person belongs.
  • Field Name: CUCUser.[n].Department
  • Type: String
Greet By Name A flag indicating whether the subscriber hears his/her name when they log into their mailbox over the phone.
  • Field Name: CUCUser.[n].GreetByName
  • Type: Boolean
Retain Urgent Message Flag A flag that indicates whether the urgent message flag on a message is retained for both reply and forward message actions. The default value is 0; the urgent message flag is NOT retained for both reply and forward message actions.
  • Field Name: CUCUser.[n].RetainUrgentMessageFlag
  • Type: Boolean
Cuc Pin
  • Field Name: CUCPin
  • Type: Object
Credential Policy URI
  • Field Name: CUCUser.[n].CUCPin.CredentialPolicyURI
  • Type: String
  • Format: uri
Locked A flag indicating whether access to the user account associated with this set of credentials is locked.
  • Field Name: CUCUser.[n].CUCPin.Locked
  • Type: Boolean
Time Hacked The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy.
  • Field Name: CUCUser.[n].CUCPin.TimeHacked
  • Type: String
Time Changed The date and time when the credentials were last changed. The date and time is recorded in this column whenever a user credential is created or changed.
  • Field Name: CUCUser.[n].CUCPin.TimeChanged
  • Type: String
URI
  • Field Name: CUCUser.[n].CUCPin.URI
  • Type: String
  • Format: uri
User URI
  • Field Name: CUCUser.[n].CUCPin.UserURI
  • Type: String
  • Format: uri
Credential Type The type of credential such as password, PIN, Windows or Domino credential.
  • Field Name: CUCUser.[n].CUCPin.CredentialType
  • Type: Integer
  • Choices: ["Password", "PIN"]
Alias The unique text name for either a user, distribution list, or personal group.
  • Field Name: CUCUser.[n].CUCPin.Alias
  • Type: String
Hacked A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.
  • Field Name: CUCUser.[n].CUCPin.Hacked
  • Type: Boolean
Hack Count The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication provider determined that the credentials supplied as part of a user logon attempt were invalid.
  • Field Name: CUCUser.[n].CUCPin.HackCount
  • Type: Integer
User Object Id * The unique identifier of the User object to which this credential belongs. - template parameter [1]
  • Field Name: CUCUser.[n].CUCPin.UserObjectId
  • Type: ["String"]
  • Target: device/cuc/User
  • Target attr: ObjectId
  • Format: uri
Time Last Hack The date and time of the last logon attempt with an invalid user credential.
  • Field Name: CUCUser.[n].CUCPin.TimeLastHack
  • Type: String
Time Lockout The date and time that the credential was locked by an administrator.
  • Field Name: CUCUser.[n].CUCPin.TimeLockout
  • Type: String
Doesnt Expire A flag indicating whether this user credential will expire, and therefore the user must change the credential periodically. However, if the credential does not expire (value = "1"), the user still may change the credential (if allowed by CantChange).
  • Field Name: CUCUser.[n].CUCPin.DoesntExpire
  • Type: Boolean
Object Id Surrogate key to support IMS
  • Field Name: CUCUser.[n].CUCPin.ObjectId
  • Type: String
Cant Change A flag indicating whether the user can set this credential.
  • Field Name: CUCUser.[n].CUCPin.CantChange
  • Type: Boolean
Credential Policy Object Id The unique identifier of the CredentialPolicy object that is associated with this credential.
  • Field Name: CUCUser.[n].CUCPin.CredentialPolicyObjectId
  • Type: String
PIN The PIN or password, for a user. The credentials are stored in an encrypted format.
  • Field Name: CUCUser.[n].CUCPin.Credentials
  • Type: String
  • Is Password: True
Is Primary A flag indicating whether this credential is mapped to the user NT/AD domain account and as such is designated as the 'primary' credential for the user. This column is not currently used, but is retained from Unity 4.x in case it is needed in the future.
  • Field Name: CUCUser.[n].CUCPin.IsPrimary
  • Type: Boolean
Cred Must Change A flag indicating whether the user must change their credentials (PIN or password) at the next login.
  • Field Name: CUCUser.[n].CUCPin.CredMustChange
  • Type: Boolean
Dtmf Name Last First The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the last name followed by the first name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: CUCUser.[n].DtmfNameLastFirst
  • Type: String
Speech Sensitivity A variable level of sound sensitivity that enables the speech engine to filter out background noise and not mistake it for speech. A higher value means higher sensitivity.
  • Field Name: CUCUser.[n].SpeechSensitivity
  • Type: Integer
Conversation Tui The name of the conversation the subscriber uses to set up, send, and retrieve messages.
  • Field Name: CUCUser.[n].ConversationTui
  • Type: String
Ccm Id Id of associated EndUser, ApplicationUser, or DirectoryNumber in Call Manager
  • Field Name: CUCUser.[n].CcmId
  • Type: String
Location The name of the LocationVMS object to which this user belongs.
  • Field Name: CUCUser.[n].LocationObjectId
  • Type: String
  • Target: device/cuc/Location
  • Target attr: ObjectId
  • Format: uri
External Service Accounts URI
  • Field Name: CUCUser.[n].ExternalServiceAccountsURI
  • Type: String
  • Format: uri
Save Message On Hangup A flag indicating when hanging up while listening to a new message, whether the message is marked new again or is marked read.
  • Field Name: CUCUser.[n].SaveMessageOnHangup
  • Type: Boolean
Enable Visual Message Locator A flag indicating whether the visual message locator feature is enabled for the subscriber. The visual message locator feature presents a list of messages on the subscriber's IP phone display for the subscriber to select from visually.
  • Field Name: CUCUser.[n].EnableVisualMessageLocator
  • Type: Boolean
Repeat Menu The number of times to repeat a menu in TUI.
  • Field Name: CUCUser.[n].RepeatMenu
  • Type: Integer
Building The name of the building where the user is based (e.g., SJ-21).
  • Field Name: CUCUser.[n].Building
  • Type: String
User Mailbox URI The URI to change the mailbox settings.
  • Field Name: CUCUser.[n].UserMailboxURI
  • Type: String
Conversation Vui The VUI conversation assigned to the subscriber.
  • Field Name: CUCUser.[n].ConversationVui
  • Type: String
Employee Id The numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.
  • Field Name: CUCUser.[n].EmployeeId
  • Type: String
Object Id The primary key for this table. A globally unique, system-generated identifier for a User object. - template parameter [1]
  • Field Name: CUCUser.[n].ObjectId
  • Type: String
Creation Time The date and time the user account was created.
  • Field Name: CUCUser.[n].CreationTime
  • Type: String
Jump To Messages On Login A flag indicating whether the subscriber conversation jumps directly to the first message in the message stack after subscriber sign-in.
  • Field Name: CUCUser.[n].JumpToMessagesOnLogin
  • Type: Boolean
Say Sender A flag indicating whether Cisco Unity Connection announces the sender of a message during message playback for the subscriber.
  • Field Name: CUCUser.[n].SaySender
  • Type: Boolean
URI
  • Field Name: CUCUser.[n].URI
  • Type: String
  • Format: uri
Prompt Speed The audio speed Cisco Unity Connection uses to play back prompts to the subscriber.
  • Field Name: CUCUser.[n].PromptSpeed
  • Type: Integer
Mailbox Dn The distinguished name of the mailbox.
  • Field Name: CUCUser.[n].MailboxDn
  • Type: String
Phone Number A phone number.
  • Field Name: CUCUser.[n].PhoneNumber
  • Type: String
Ccm Id Type Type of CCM user/object this id refers to (end user, application user, or directory number)
  • Field Name: CUCUser.[n].CcmIdType
  • Type: Integer
Synch Schedule URI
  • Field Name: CUCUser.[n].SynchScheduleURI
  • Type: String
  • Format: uri
Client Matter Code The client matter code to transmit to Call Manger when a phone number is dialed on an outbound call. The CMC is entered after a phone number is dialed so that the customer can assigning account or billing codes to the call. Whether or not the CMC will be transmitted is dictated by a setting on outbound call. The subscriber's CMC is used only if the outbound call doesn't have its own CMC.
  • Field Name: CUCUser.[n].ClientMatterCode
  • Type: String
Confirm Delete Deleted Message A flag indicating whether Cisco Unity Connection will request confirmation from a subscriber before proceeding with a deletion of a single deleted message.
  • Field Name: CUCUser.[n].ConfirmDeleteDeletedMessage
  • Type: Boolean
Enable Save Draft A flag indicating whether the save draft message feature is enabled for the subscriber.
  • Field Name: CUCUser.[n].EnableSaveDraft
  • Type: Boolean
Alternate Names URI The URI to get the alternate names of the user.
  • Field Name: CUCUser.[n].AlternateNamesURI
  • Type: String
Voice File URI
  • Field Name: CUCUser.[n].VoiceFileURI
  • Type: String
  • Format: uri
Initials The initial letters of some or all of the names of this user.
  • Field Name: CUCUser.[n].Initials
  • Type: String
Alt First Name The alternate spelling of a user first name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.
  • Field Name: CUCUser.[n].AltFirstName
  • Type: String
Exit Call Action The unique identifier of the CallAction object that is taken when a caller exits the subscriber conversation by pressing the * key or timing out.
  • Field Name: CUCUser.[n].ExitCallActionObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Say Msg Number A flag indicating whether Cisco Unity Connection announces the position of each message in the stack (i.e., 'Message 1', 'Message 2' ,etc.) during message playback for the subscriber.
  • Field Name: CUCUser.[n].SayMsgNumber
  • Type: Boolean
En Alt Greet Prevent Skip A flag indicating whether callers can skip the greeting while it is playing when the alternate greeting is turned on.
  • Field Name: CUCUser.[n].EnAltGreetPreventSkip
  • Type: Boolean
Say Total Saved A flag indicating whether Cisco Unity Connection announces the total number of saved messages in the subscriber mailbox.
  • Field Name: CUCUser.[n].SayTotalSaved
  • Type: Boolean
Read Only If set to 1 (true) user is read-only and cannot be modified.
  • Field Name: CUCUser.[n].ReadOnly
  • Type: Boolean
Say Sender Extension A flag indicating whether Cisco Unity Connection during message playback, plays the primary extension information of the subscriber who sent the message after playing the sender's voice name.
  • Field Name: CUCUser.[n].SaySenderExtension
  • Type: Boolean
Saved Message Stack Order The order in which Cisco Unity Connection plays the following types of "saved" messages: * Urgent voice messages * Non-urgent voice messages * Urgent fax messages * Non-urgent fax messages * Urgent e-mail messages * Non-urgent e-mail messages * Receipts and notices
  • Field Name: CUCUser.[n].SavedMessageStackOrder
  • Type: String
Say Sender Extension After This flag works exactly the same as the SaySenderExtension flag on a user, except the conversation plays the sender's extension in the message footer.
  • Field Name: CUCUser.[n].SaySenderExtensionAfter
  • Type: Boolean
Display Name The preferred text name of a person to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.
  • Field Name: CUCUser.[n].DisplayName
  • Type: String
Inbox Auto Refresh The rate (in minutes) at which Unity Inbox performs a refresh.
  • Field Name: CUCUser.[n].InboxAutoRefresh
  • Type: Integer
Use Default Time Zone Indicates if the default timezone is being used.
  • Field Name: CUCUser.[n].UseDefaultTimeZone
  • Type: Boolean
Phone System URI
  • Field Name: CUCUser.[n].PhoneSystemURI
  • Type: String
  • Format: uri
State The full name of the state or province where this user is located, or with which a user is associated.
  • Field Name: CUCUser.[n].State
  • Type: String
Alt Last Name The alternate spelling of a user last name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.
  • Field Name: CUCUser.[n].AltLastName
  • Type: String
Announce Upcoming Meetings The amount ahead of time, in minutes, that Connection will warn the subscriber of upcoming meetings when the subscriber calls into the system.
  • Field Name: CUCUser.[n].AnnounceUpcomingMeetings
  • Type: Integer
Mailbox Store Name The Mailbox store name of user.
  • Field Name: CUCUser.[n].MailboxStoreName
  • Type: String
Say Ani A flag indicating whether Cisco Unity Connection plays the Automatic Number Identification (ANI) information during message playback for voice messages from unidentified callers.
  • Field Name: CUCUser.[n].SayAni
  • Type: Boolean
New Message Sort Order The order in which Cisco Unity Connection will sort new messages.
  • Field Name: CUCUser.[n].NewMessageSortOrder
  • Type: Integer
  • Choices: ["Newest first", "Oldest first"]
Localization Key Localization Key.
  • Field Name: CUCUser.[n].LocalizationKey
  • Type: String
Dtmf Name Last The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the last name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: CUCUser.[n].DtmfNameLast
  • Type: String
Fax Server The unique identifier of the FaxServer object for the subscriber.
  • Field Name: CUCUser.[n].FaxServerObjectId
  • Type: String
  • Target: device/cuc/FaxServer
  • Target attr: ObjectId
  • Format: uri
Ldap Type The LDAP configuration information for the user.
  • Field Name: CUCUser.[n].LdapType
  • Type: Integer
  • Choices: ["Do not Integrate with LDAP directory", "Integrate with LDAP directory", "Authenticate", "Integrate and Authenticate with LDAP directory", "Inactive"]
Dtmf Name First The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the first name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: CUCUser.[n].DtmfNameFirst
  • Type: String
Message Locator Sort Order The order in which Cisco Unity Connection will sort messages when the "Message Locator" feature is enabled.
  • Field Name: CUCUser.[n].MessageLocatorSortOrder
  • Type: Integer
Say Total New Voice A flag indicating whether Cisco Unity Connection announces the total number of new voice messages in the subscriber mailbox.
  • Field Name: CUCUser.[n].SayTotalNewVoice
  • Type: Boolean
Continuous Add Mode A flag indicating whether when addressing, after entering one recipient name, whether the subscriber is asked to enter another name or assume the subscriber is finished adding names and is ready to move on to recording the message or applying message options.
  • Field Name: CUCUser.[n].ContinuousAddMode
  • Type: Boolean
Enhanced Security Alias The unique text name used to idenitify and authenticate the user with an RSA SecurID security system.
  • Field Name: CUCUser.[n].EnhancedSecurityAlias
  • Type: String
Partition Name The unique identifier of the Partition to which the DtmfAccessId is assigned.
  • Field Name: CUCUser.[n].PartitionObjectId
  • Type: String
  • Target: device/cuc/Partition
  • Target attr: ObjectId
  • Format: uri
Confirm Delete Multiple Messages A flag indicating whether Cisco Unity Connection allows the subscriber to choose which message they want to delete or whether Cisco Unity Connection permanently deletes the specified type of messages. Changes what Cisco Unity Connection does when subscribers press 3 > 2 > 2 from the Main menu to permanently delete multiple deleted messages at once.
  • Field Name: CUCUser.[n].ConfirmDeleteMultipleMessages
  • Type: Boolean
Inbox Messages Per Page The number of messages Unity Inbox displays in a page.
  • Field Name: CUCUser.[n].InboxMessagesPerPage
  • Type: Integer
Enable Message Bookmark A flag indicating whether Message Bookmark is enabled for the subscriber
  • Field Name: CUCUser.[n].EnableMessageBookmark
  • Type: Boolean
Conversation Name The name of the conversation the subscriber uses to set up, send, and retrieve messages.
  • Field Name: CUCUser.[n].ConversationName
  • Type: String
Cuc Password
  • Field Name: CUCPassword
  • Type: Object
Credential Policy URI
  • Field Name: CUCUser.[n].CUCPassword.CredentialPolicyURI
  • Type: String
  • Format: uri
Locked A flag indicating whether access to the user account associated with this set of credentials is locked.
  • Field Name: CUCUser.[n].CUCPassword.Locked
  • Type: Boolean
Time Hacked The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy.
  • Field Name: CUCUser.[n].CUCPassword.TimeHacked
  • Type: String
Time Changed The date and time when the credentials were last changed. The date and time is recorded in this column whenever a user credential is created or changed.
  • Field Name: CUCUser.[n].CUCPassword.TimeChanged
  • Type: String
URI
  • Field Name: CUCUser.[n].CUCPassword.URI
  • Type: String
  • Format: uri
User URI
  • Field Name: CUCUser.[n].CUCPassword.UserURI
  • Type: String
  • Format: uri
Credential Type The type of credential such as password, PIN, Windows or Domino credential.
  • Field Name: CUCUser.[n].CUCPassword.CredentialType
  • Type: Integer
  • Choices: ["Password", "PIN"]
Alias The unique text name for either a user, distribution list, or personal group.
  • Field Name: CUCUser.[n].CUCPassword.Alias
  • Type: String
Hacked A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.
  • Field Name: CUCUser.[n].CUCPassword.Hacked
  • Type: Boolean
Hack Count The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication provider determined that the credentials supplied as part of a user logon attempt were invalid.
  • Field Name: CUCUser.[n].CUCPassword.HackCount
  • Type: Integer
User Object Id * The unique identifier of the User object to which this credential belongs. - template parameter [1]
  • Field Name: CUCUser.[n].CUCPassword.UserObjectId
  • Type: ["String"]
  • Target: device/cuc/User
  • Target attr: ObjectId
  • Format: uri
Time Last Hack The date and time of the last logon attempt with an invalid user credential.
  • Field Name: CUCUser.[n].CUCPassword.TimeLastHack
  • Type: String
Time Lockout The date and time that the credential was locked by an administrator.
  • Field Name: CUCUser.[n].CUCPassword.TimeLockout
  • Type: String
Doesnt Expire A flag indicating whether this user credential will expire, and therefore the user must change the credential periodically. However, if the credential does not expire (value = "1"), the user still may change the credential (if allowed by CantChange).
  • Field Name: CUCUser.[n].CUCPassword.DoesntExpire
  • Type: Boolean
Object Id Surrogate key to support IMS
  • Field Name: CUCUser.[n].CUCPassword.ObjectId
  • Type: String
Cant Change A flag indicating whether the user can set this credential.
  • Field Name: CUCUser.[n].CUCPassword.CantChange
  • Type: Boolean
Credential Policy Object Id The unique identifier of the CredentialPolicy object that is associated with this credential.
  • Field Name: CUCUser.[n].CUCPassword.CredentialPolicyObjectId
  • Type: String
Password The PIN or password, for a user. The credentials are stored in an encrypted format.
  • Field Name: CUCUser.[n].CUCPassword.Credentials
  • Type: String
  • Is Password: True
Is Primary A flag indicating whether this credential is mapped to the user NT/AD domain account and as such is designated as the 'primary' credential for the user. This column is not currently used, but is retained from Unity 4.x in case it is needed in the future.
  • Field Name: CUCUser.[n].CUCPassword.IsPrimary
  • Type: Boolean
Cred Must Change A flag indicating whether the user must change their credentials (PIN or password) at the next login.
  • Field Name: CUCUser.[n].CUCPassword.CredMustChange
  • Type: Boolean
Pab Last Imported The date and time when the personal address book was last imported from a groupware package into the personal groups for a user.
  • Field Name: CUCUser.[n].PabLastImported
  • Type: String
Pca Home Page The Home Page is the first page that is displayed after logging in to the PCA.
  • Field Name: CUCUser.[n].PcaHomePage
  • Type: String
Update Broadcast Msg A flag indicating whether the subscriber has the ability to update broadcast messages that are active or will be active in the future.
  • Field Name: CUCUser.[n].UpdateBroadcastMsg
  • Type: Boolean
Search By Name Search Space The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by name (character string).
  • Field Name: CUCUser.[n].SearchByNameSearchSpaceObjectId
  • Type: String
  • Target: device/cuc/SearchSpace
  • Target attr: ObjectId
  • Format: uri
Say Copied Names A flag indicating whether Cisco Unity Connection announces the "copied" names during message playback for a subscriber.
  • Field Name: CUCUser.[n].SayCopiedNames
  • Type: Boolean
Speech Complete Timeout Specifies the required length of silence (in milliseconds) following user speech before the recognizer finalizes a result (either accepting it or throwing a nomatch event). The SpeechCompleteTimeout property is used when the speech prior to the silence matches an active grammar. A long SpeechCompleteTimeout value delays the result completion and therefore makes the system's response slow. A short SpeechCompleteTimeout value may lead to the inappropriate break up of an utterance. Reasonable SpeechCompleteTimeout values are typically in the range of 0.3 seconds to 1.0 second. See Appendix D?Timing properties of the VoiceXML Specification for details.
  • Field Name: CUCUser.[n].SpeechCompleteTimeout
  • Type: Integer
Mwis URI
  • Field Name: CUCUser.[n].MwisURI
  • Type: String
  • Format: uri
Forced Authorization Code A valid authorization code that is entered prior to extending calls to classes of dialed numbers, for example, external, toll and international calls.
  • Field Name: CUCUser.[n].ForcedAuthorizationCode
  • Type: String
Video Service Accounts URI
  • Field Name: CUCUser.[n].VideoServiceAccountsURI
  • Type: String
  • Format: uri
Skip Forward Time Indicates the amount of time (in milliseconds) to jump forward when skipping ahead in a voice or TTS message using either DTMF or voice commands while reviewing messages.
  • Field Name: CUCUser.[n].SkipForwardTime
  • Type: Integer
Say Message Length After This flag works exactly the same as the SayMessageLength flag on a user, except the conversation plays the message length in the message footer.
  • Field Name: CUCUser.[n].SayMessageLengthAfter
  • Type: Boolean
Use Vui A flag indicating whether the speech recognition conversation is the default conversation for the subscriber.
  • Field Name: CUCUser.[n].UseVui
  • Type: Boolean
Speech Confidence Threshold When the engine matches a spoken phrase, it associates a confidence level with that conclusion. This parameter determines what confidence level should be considered a successful match. A higher value means the engine is will report fewer successful matches, but it will be more confident in the matches that it reports.
  • Field Name: CUCUser.[n].SpeechConfidenceThreshold
  • Type: Integer
First Digit Timeout The amount of time to wait (in milliseconds) for first digit when collecting touch tones.
  • Field Name: CUCUser.[n].FirstDigitTimeout
  • Type: Integer
Address After Record A flag indicating whether the subscriber will be prompted to address message before or after it is recorded.
  • Field Name: CUCUser.[n].AddressAfterRecord
  • Type: Boolean
Phone System The unique identifier of the MediaSwitch object Cisco Unity Connection uses for subscriber Telephone Record and Playback (TRAP) sessions and to dial MWI on or off requests when the Cisco Unity Connection system has a dual switch integration.
  • Field Name: CUCUser.[n].MediaSwitchObjectId
  • Type: String
  • Target: device/cuc/PhoneSystem
  • Target attr: ObjectId
  • Format: uri
Exit Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: CUCUser.[n].ExitTargetConversation
  • Type: String
Saved Message Sort Order The order in which Cisco Unity Connection will sort saved messages.
  • Field Name: CUCUser.[n].SavedMessageSortOrder
  • Type: Integer
Partition URI
  • Field Name: CUCUser.[n].PartitionURI
  • Type: String
  • Format: uri
First Name The first name (i.e., givenName) of this user. Not their surname nor middle name.
  • Field Name: CUCUser.[n].FirstName
  • Type: String
Use Brief Prompts A flag indicating whether the subscriber hears brief or full phone menus when accessing Cisco Unity Connection over the phone.
  • Field Name: CUCUser.[n].UseBriefPrompts
  • Type: Boolean
Skip Password For Known Device A flag indicating whether the subscriber will be asked for his/her PIN when attempting to sign-in from a known device.
  • Field Name: CUCUser.[n].SkipPasswordForKnownDevice
  • Type: Boolean
Last Name The last name (i.e., surname or family name) of this user, by which a user is commonly known.
  • Field Name: CUCUser.[n].LastName
  • Type: String
Message Type Menu A flag indicating whether Cisco Unity Connection plays the message type menu when the subscriber logs on to Cisco Unity Connection over the phone.
  • Field Name: CUCUser.[n].MessageTypeMenu
  • Type: Boolean
Skip Reverse Time Indicates the amount of time (in milliseconds) to jump backward when skipping in reverse in a voice or TTS message using either DTMF or voice commands while reviewing messages.
  • Field Name: CUCUser.[n].SkipReverseTime
  • Type: Integer
Country The two-letter ISO 3166-1 country code where the user is located, or with which a user is associated.
  • Field Name: CUCUser.[n].Country
  • Type: String
Route NDR To Sender A flag indicating, for an undeliverable message, whether NDR messages will appear in the subscriber's mailbox or are deleted by the system.
  • Field Name: CUCUser.[n].RouteNDRToSender
  • Type: Boolean
Template Alias Query parameter
  • Field Name: CUCUser.[n].templateAlias
  • Type: ["String"]
  • Target: device/cuc/UserTemplate
  • Target attr: Alias
  • Format: uri
Say Timestamp Before A flag indicating whether Cisco Unity Connection announces the timestamp before it plays back each for the subscriber.
  • Field Name: CUCUser.[n].SayTimestampBefore
  • Type: Boolean
Private Lists URI
  • Field Name: CUCUser.[n].PrivateListsURI
  • Type: String
  • Format: uri
Say Msg Number After This flag works exactly the same as the SayMsgNumber flag on a user, except the conversation plays the message number in the message footer.
  • Field Name: CUCUser.[n].SayMsgNumberAfter
  • Type: Boolean
Inbox Auto Resolve Message Recipients A flag indicating whether Cisco Unity Connection automatically resolves a recipient address entered in the To, Cc or Bcc fields to a subscriber or distribution list. Known as the "AutoResolve" feature.
  • Field Name: CUCUser.[n].InboxAutoResolveMessageRecipients
  • Type: Boolean
User Web Password URI The URI to change the web application password.
  • Field Name: CUCUser.[n].UserWebPasswordURI
  • Type: String
En Alt Greet Prevent Msg A flag indicating whether callers can leave a message after the greeting when the subscriber alternate greeting is turned on.
  • Field Name: CUCUser.[n].EnAltGreetPreventMsg
  • Type: Boolean
Auto Advance Msgs A flag indicating that the conversation will, during playback, advance to the next message in the playback stack automatically after it is done playing the after message menu.
  • Field Name: CUCUser.[n].AutoAdvanceMsgs
  • Type: Boolean
En Alt Greet Dont Ring Phone A flag indicating whether a caller is prevented from being transferred to the subscriber phone when the subscriber alternate greeting is turned on.
  • Field Name: CUCUser.[n].EnAltGreetDontRingPhone
  • Type: Boolean
Voice Name URI
  • Field Name: CUCUser.[n].VoiceNameURI
  • Type: String
  • Format: uri
Enable Message Locator A flag indicating whether the message locator feature is enabled for the subscriber.
  • Field Name: CUCUser.[n].EnableMessageLocator
  • Type: Boolean
Create Smtp Proxy From Corp Flag indicating whether an SMTP proxy address matching the corporate e-mail address (column EmailAddress) should be created for this User.
  • Field Name: CUCUser.[n].CreateSmtpProxyFromCorp
  • Type: Boolean
Is Set For Vm Enrollment Temporary placeholder until IsVmEnrolled can be phased out. At that point, delete this column and rename tbl_UserSubscriber.IsVmEnrolled to IsSetForVmEnrollment. A flag indicating whether Cisco Unity Connection plays the enrollment conversation (record a voice name, indicate if they are listed in the directory, etc.) for the subscriber when they login.
  • Field Name: CUCUser.[n].IsSetForVmEnrollment
  • Type: Boolean
User Voice Pin URI The URI to change the voice mail pin of the user.
  • Field Name: CUCUser.[n].UserVoicePinURI
  • Type: String
User Role URI The URI to change the role of the user.
  • Field Name: CUCUser.[n].UserRoleURI
  • Type: String
Clock Mode The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.
  • Field Name: CUCUser.[n].ClockMode
  • Type: Integer
Is Template A flag indicating whether this instance of a User object is a "template" for creating new users.
  • Field Name: CUCUser.[n].IsTemplate
  • Type: Boolean
Ldap Ccm User Id The userid of associated end user in the sleeping SeaDragon database.
  • Field Name: CUCUser.[n].LdapCcmUserId
  • Type: String
Say Ani After This flag works exactly the same as the SayAni flag on a user, except the conversation plays the ani in the message footer.
  • Field Name: CUCUser.[n].SayAniAfter
  • Type: Boolean
Ring Primary Phone First A flag indicating whether a subscriber's primary phone should be rung before trying other destinations in a personal group.
  • Field Name: CUCUser.[n].RingPrimaryPhoneFirst
  • Type: Boolean
Postal Code For users in the United States, the zip code where the user is located. For users in Canada, Mexico, and other countries, the postal code where the user is located.
  • Field Name: CUCUser.[n].PostalCode
  • Type: String
Xfer String The cross-server transfer extension. If NULL, the user's primary extension is used.
  • Field Name: CUCUser.[n].XferString
  • Type: String
Confirmation Confidence Threshold Voice Recognition Confirmation Confidence Threshold
  • Field Name: CUCUser.[n].ConfirmationConfidenceThreshold
  • Type: Integer
Undeletable A flag indicating whether this subscriber can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.
  • Field Name: CUCUser.[n].Undeletable
  • Type: Boolean
Delay After Greeting The amount of time (in milliseconds) Cisco Unity Connection will delay after playing greeting.
  • Field Name: CUCUser.[n].DelayAfterGreeting
  • Type: Integer
Encrypt Private Messages A flag indicating whether Cisco Unity Connection encrypts messages from the subscriber that are marked private.
  • Field Name: CUCUser.[n].EncryptPrivateMessages
  • Type: Boolean
Say Total Receipts A flag indicating whether Cisco Unity Connection announces the total number of new receipts in the subscriber mailbox.
  • Field Name: CUCUser.[n].SayTotalReceipts
  • Type: Boolean
New Message Stack Order The order in which Cisco Unity Connection plays the following types of "new" messages: * Urgent voice messages * Non-urgent voice messages * Urgent fax messages * Non-urgent fax messages * Urgent e-mail messages * Non-urgent e-mail messages * Receipts and notices
  • Field Name: CUCUser.[n].NewMessageStackOrder
  • Type: String
Notification Devices URI
  • Field Name: CUCUser.[n].NotificationDevicesURI
  • Type: String
  • Format: uri
Mailbox Store Mailbox Store for the tenant.
  • Field Name: CUCUser.[n].MailboxStoreObjectId
  • Type: String
  • Target: device/cuc/MailboxStore
  • Target attr: ObjectId
  • Format: uri
Is Vm Enrolled A flag indicating whether Cisco Unity Connection plays the enrollment conversation (record a voice name, indicate if they are listed in the directory, etc.) for the subscriber when they login.
  • Field Name: CUCUser.[n].IsVmEnrolled
  • Type: Boolean
Inactive A flag indicating whether this subscriber is inactive or not.
  • Field Name: CUCUser.[n].Inactive
  • Type: Boolean
Email Address The corporate email address of the user.
  • Field Name: CUCUser.[n].EmailAddress
  • Type: String
Enable Tts A flag indicating whether TTS is enabled for the subscriber. Only relevant if TTS enabled in User's COS also.
  • Field Name: CUCUser.[n].EnableTts
  • Type: Boolean
Search By Extension Search Space The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by extension (dial string).
  • Field Name: CUCUser.[n].SearchByExtensionSearchSpaceObjectId
  • Type: String
  • Target: device/cuc/SearchSpace
  • Target attr: ObjectId
  • Format: uri
Pca Address Book Rows Per Page Controls the number of matching entries the Address Book displays per page, when a search is performed. The Address Book is used across multiple PCA applications and so this setting applies globally.
  • Field Name: CUCUser.[n].PcaAddressBookRowsPerPage
  • Type: Integer
Location URI
  • Field Name: CUCUser.[n].LocationURI
  • Type: String
  • Format: uri
Say Distribution List A flag indicating whether Cisco Unity Connection announces the distribution list that sends a message, if applicable.
  • Field Name: CUCUser.[n].SayDistributionList
  • Type: Boolean
City The name of a locality, such as a city, county or other geographic region where the user is located, or with which a user is associated.
  • Field Name: CUCUser.[n].City
  • Type: String
Send Broadcast Msg A flag indicating whether the subscriber may send broadcast messages.
  • Field Name: CUCUser.[n].SendBroadcastMsg
  • Type: Boolean
Exit Action The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: CUCUser.[n].ExitAction
  • Type: Integer
Voice Name Required A flag indicating whether a recorded voice name is required for this subscriber.
  • Field Name: CUCUser.[n].VoiceNameRequired
  • Type: Boolean
Search By Extension Search Space URI
  • Field Name: CUCUser.[n].SearchByExtensionSearchSpaceURI
  • Type: String
  • Format: uri
Smtp Proxy Addresses URI The URI to get the smtp proxy addresses of the user.
  • Field Name: CUCUser.[n].SmtpProxyAddressesURI
  • Type: String
Message Handlers URI
  • Field Name: CUCUser.[n].MessageHandlersURI
  • Type: String
  • Format: uri
Say Total New Fax A flag indicating whether Cisco Unity Connection announces the total number of new fax messages in the subscriber mailbox.
  • Field Name: CUCUser.[n].SayTotalNewFax
  • Type: Boolean
Assistant Rows Per Page This controls the number of entries to display per page for all tables in the Unity Assistant, e.g. the Private List Members table.
  • Field Name: CUCUser.[n].AssistantRowsPerPage
  • Type: Integer
Call Handler The unique identifier of the primary CallHandler object for the subscriber.
  • Field Name: CUCUser.[n].CallHandlerObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Time Zone The time zone to which this user account is associated.
  • Field Name: CUCUser.[n].TimeZone
  • Type: Integer
Say Sender After This flag works exactly the same as the SaySender flag on a user, except the conversation plays the sender in the message footer.
  • Field Name: CUCUser.[n].SaySenderAfter
  • Type: Boolean
Name Confirmation Indicates whether the voice name of the subscriber or distribution list added to an address list when a subscriber addresses a message to other subscribers is played. The default value for this is off (no voice name played) since the voice name was just played as part of the list of matches . To most users this sounds redundant when on, but some users prefer it.
  • Field Name: CUCUser.[n].NameConfirmation
  • Type: Boolean
Search By Name Search Space URI
  • Field Name: CUCUser.[n].SearchByNameSearchSpaceURI
  • Type: String
  • Format: uri
Enable Personal Rules A flag indicating whether a subscriber's personal rules are enabled. Subscribers can use this setting to disable all personal rules at once.
  • Field Name: CUCUser.[n].EnablePersonalRules
  • Type: Boolean
Confirm Delete Message A flag indicating whether Cisco Unity Connection will request confirmation from a subscriber before proceeding with a deletion of a single new or saved message.
  • Field Name: CUCUser.[n].ConfirmDeleteMessage
  • Type: Boolean
Synch Schedule The unique identifier of the Schedule object to use for synchronization Calendar information from groupware (such as Exchange).
  • Field Name: CUCUser.[n].SynchScheduleObjectId
  • Type: String
  • Target: device/cuc/Schedule
  • Target attr: ObjectId
  • Format: uri
Language The preferred language of this user. For a user with a voice mailbox, it is the language in which the subscriber hears instructions played to them. If the subscriber has TTS enabled by their COS, it is the language used for TTS.
  • Field Name: CUCUser.[n].Language
  • Type: Integer
Record Unknown Caller Name A flag indicating whether a caller should be promoted to record his/her name if Unity does not receive caller id.
  • Field Name: CUCUser.[n].RecordUnknownCallerName
  • Type: Boolean
Fax Server URI
  • Field Name: CUCUser.[n].FaxServerURI
  • Type: String
  • Format: uri
Call Answer Timeout The number of rings to wait for a subscriber destination to answer before the call is forwarded to the subscriber's primary phone.
  • Field Name: CUCUser.[n].CallAnswerTimeout
  • Type: Integer
Volume The audio volume expressed as a percentage that Cisco Unity Connection uses to play back message.
  • Field Name: CUCUser.[n].Volume
  • Type: Integer
Address The physical address such as a house number and street name where the user is located, or with which a user is associated.
  • Field Name: CUCUser.[n].Address
  • Type: String
Interdigit Delay The amount of time to wait (in milliseconds) for input between touch tones when collecting digits in TUI.
  • Field Name: CUCUser.[n].InterdigitDelay
  • Type: Integer
Speed The audio speed Cisco Unity Connection uses to play back messages to the subscriber.
  • Field Name: CUCUser.[n].Speed
  • Type: Integer
Cos URI
  • Field Name: CUCUser.[n].CosURI
  • Type: String
  • Format: uri
Smtp Address SMTP address The full SMTP address for this object.
  • Field Name: CUCUser.[n].SmtpAddress
  • Type: String
Time Last Call The date and time when the subscriber last accessed their mailbox by phone (last time they were offered messages).
  • Field Name: CUCUser.[n].TimeLastCall
  • Type: String
Class of Service The name of the Class of Service object with which this user account is associated.
  • Field Name: CUCUser.[n].CosObjectId
  • Type: String
  • Target: device/cuc/Cos
  • Target attr: ObjectId
  • Format: uri
Say Message Length A flag indicating whether Cisco Unity Connection announces the length of each message during message playback.
  • Field Name: CUCUser.[n].SayMessageLength
  • Type: Boolean
Callhandler URI
  • Field Name: CUCUser.[n].CallhandlerURI
  • Type: String
  • Format: uri
Say Alt Greet Warning A flag indicating whether Cisco Unity Connection notifies the subscriber when they login via the phone (plays conversation) or CPCA (displays a warning banner) if their alternate greeting is turned on.
  • Field Name: CUCUser.[n].SayAltGreetWarning
  • Type: Boolean
Alias * The unique text name for either a user, distribution list, or personal group.
  • Field Name: CUCUser.[n].Alias
  • Type: String
Prompt Volume The volume level for playback of system prompts.
  • Field Name: CUCUser.[n].PromptVolume
  • Type: Integer
Tenant The name of the tenant to which the user belongs.
  • Field Name: CUCUser.[n].TenantObjectId
  • Type: String
  • Target: device/cuc/Tenant
  • Target attr: ObjectId
  • Format: uri
Say Total Draft Msg A flag indicating whether Cisco Unity Connection announces the total number of draft messages in the subscriber mailbox
  • Field Name: CUCUser.[n].SayTotalDraftMsg
  • Type: Boolean
Say Total New A flag indicating whether Cisco Unity Connection announces the total number of new messages in the subscriber mailbox.
  • Field Name: CUCUser.[n].SayTotalNew
  • Type: Boolean
Say Total New Email A flag indicating whether Cisco Unity Connection announces the total number of new e-mail messages in the subscriber mailbox.
  • Field Name: CUCUser.[n].SayTotalNewEmail
  • Type: Boolean
Use Dynamic Name Search Weight Use dynamic name search weight. When this user addresses objects, the name search weight for those objects will automatically be incremented.
  • Field Name: CUCUser.[n].UseDynamicNameSearchWeight
  • Type: Boolean
Ldap Ccm Pkid The pkid of associated end user in the sleeping SeaDragon database.
  • Field Name: CUCUser.[n].LdapCcmPkid
  • Type: String
Speech Incomplete Timeout Specifies the required length of silence (in milliseconds) from when the speech prior to the silence matches an active grammar, but where it is possible to speak further and still match the grammar. By contrast, the SpeechCompleteTimeout property is used when the speech prior to the silence matches an active grammar and no further words can be spoken. A long SpeechIncompleteTimeout value delays the result completion and therefore makes the system's response slow. A short SpeechIncompleteTimeout value may lead to the inappropriate break up of an utterance. The SpeechIncompleteTimeout value is usually longer than the completetimeout value to allow users to pause mid-utterance (for example, to breathe). Note that values set for the completetimeout property are only supported if they are less than the incompletetimeout property. See Appendix D?Timing properties of the VoiceXML Specification for details.
  • Field Name: CUCUser.[n].SpeechIncompleteTimeout
  • Type: Integer
Alternate Extensions URI
  • Field Name: CUCUser.[n].AlternateExtensionsURI
  • Type: String
  • Format: uri
Dialable Phone Number A dialable version of the PhoneNumber column.
  • Field Name: CUCUser.[n].DialablePhoneNumber
  • Type: String
Is Clock Mode24Hour The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.
  • Field Name: CUCUser.[n].IsClockMode24Hour
  • Type: Boolean
Use Short Poll For Cache A flag indicating whether the user's polling cycle for retrieving calendar information will be the shorter "power user" polling cycle.
  • Field Name: CUCUser.[n].UseShortPollForCache
  • Type: Boolean
Dtmf Access Id * The DTMF access id (i.e., extension) of the subscriber. The dialable number.
  • Field Name: CUCUser.[n].DtmfAccessId
  • Type: String
Manager The name of the person who is the manager or supervisor of the user.
  • Field Name: CUCUser.[n].Manager
  • Type: ["String", "Null"]
Billing Id Accounting information or project code associated with this user.
  • Field Name: CUCUser.[n].BillingId
  • Type: String
List In Directory A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers.
  • Field Name: CUCUser.[n].ListInDirectory
  • Type: Boolean
Deleted Message Sort Order The order in which Cisco Unity Connection presents deleted messages to the subscriber.
  • Field Name: CUCUser.[n].DeletedMessageSortOrder
  • Type: Integer
Speech Speed Vs Accuracy Tunes the engine towards Performance or Accuracy. A higher value for this setting means faster matches that may be less accurate. A lower value for this setting means more accurate matches along with more processing and higher CPU utilization.
  • Field Name: CUCUser.[n].SpeechSpeedVsAccuracy
  • Type: Integer
Use Default Language Set to true (1) if call handler is using default language from the location it belongs to.
  • Field Name: CUCUser.[n].UseDefaultLanguage
  • Type: Boolean
Send Message On Hangup An enum indicating when hanging up while addressing a message that has a recording and at least one recipient, whether the message is discarded, sent or saved as a draft message if the subscriber explicitly issues the command to send the message either via DTMF or voice input.
  • Field Name: CUCUser.[n].SendMessageOnHangup
  • Type: Integer
Phone
  • Field Name: Phone.[n]
  • Type: Array
Directory Enter the server from which the phone obtains directory information. Leave this field blank to accept the default setting. Note    If you set a Secured Directory URL enterprise parameter in the Enterprise Parameters Configuration window, that value overwrites the value of this field.
  • Field Name: Phone.[n].directoryUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Device Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: Phone.[n].protocol
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["SCCP", "Digital Access PRI", "H.225", "Analog Access", "Digital Access T1", "Route Point", "Unicast Bridge", "Multicast Point", "Inter-Cluster Trunk", "RAS", "Digital Access BRI", "SIP", "MGCP", "Static SIP Mobile Subscriber", "SIP Connector", "Remote Destination", "Mobile Smart Client", "Digital Access E1 R2", "CTI Remote Device", "Protocol Not Specified"]
Secure Information URL Enter the secure URL for the server location where the 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. Note    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. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: Phone.[n].secureInformationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Authentication Mode 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: By Authentication String—Installs/upgrades, deletes, or troubleshoots a locally significant certificate only when the user enters the CAPF authentication string on the phone. By Null String— 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. By Existing Certificate (Precedence to LSC)—Installs/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. By Existing Certificate (Precedence to MIC)—Installs, 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. Note    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. Default: By Null String
  • Field Name: Phone.[n].authenticationMode
  • Type: String
  • Cardinality: [0..1]
  • Default: By Null String
  • Choices: ["By Authentication String", "By Null String", "By Existing Certificate (precedence to LSC)", "By Existing Certificate (precedence to MIC)"]
Require DTMF Reception For phones that are running SIP and SCCP, check this check box to require DTMF reception for this phone. Note    In configuring 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.
  • Field Name: Phone.[n].requireDtmfReception
  • Type: Boolean
  • Cardinality: [0..1]
BAT Phone Template * 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.
  • Field Name: Phone.[n].phoneTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/PhoneButtonTemplate
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Search Space 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. Note    When set to <none>, Unified CM uses the device mobility calling search space, which is configured on the device pool.
  • Field Name: Phone.[n].callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
MRA Service Domain
  • Field Name: Phone.[n].mraServiceDomain
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Calling Party Transformation CSS 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.
  • Field Name: Phone.[n].cgpnIngressDN
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Use Trusted Relay Point * 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: Default—If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates. Off—Choose 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. On—Choose 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. 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. Default: Default
  • Field Name: Phone.[n].useTrustedRelayPoint
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Network Locale 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. Note    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 Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: Phone.[n].networkLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/Country
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["Argentina", "Australia", "Austria", "Belgium", "Brazil", "Canada", "China", "Colombia", "Cyprus", "Czech Republic", "Denmark", "Egypt", "Finland", "France", "Germany", "Ghana", "Greece", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Japan", "Jordan", "Kenya", "Korea Republic", "Lebanon", "Luxembourg", "Malaysia", "Mexico", "Nepal", "Netherlands", "New Zealand", "Nigeria", "Norway", "Pakistan", "Panama", "Peru", "Philippines", "Poland", "Portugal", "Russian Federation", "Saudi Arabia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sweden", "Switzerland", "Taiwan", "Thailand", "Turkey", "United Kingdom", "United States", "Venezuela", "Zimbabwe", "Itu", "Chile", "Bulgaria", "Croatia", "Romania", "Serbia and Montenegro", "United Arab Emirates", "Oman", "Kuwait", "Algeria", "Bahrain", "Iraq", "Mauritania", "Republic of Montenegro", "Morocco", "Qatar", "Republic of Serbia", "Sudan", "Tunisia", "Vietnam", "Yemen", "Lithuania", "Latvia", "Estonia", "Ukraine"]
BLF Audible Alert Setting (Phone Busy) 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: On—An audible alert sounds. Off—No audible alert sounds. Default—The configuration in the Service Parameters Configuration window determines the alert option. Default: Default
  • Field Name: Phone.[n].ringSettingBusyBlfAudibleAlert
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Msisdn Mobile Subscriber ISDN
  • Field Name: Phone.[n].msisdn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
User Locale From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information to support users, including language and font. Cisco Unified CM makes this field available only for phone models that support localization. Note    If no user locale is specified, Cisco Unified Communications Manager uses the user locale that is associated with the 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 Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: Phone.[n].userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Device Mobility Mode * 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: Cisco Unified Communications Manager Group Roaming Device Pool Location Region Network Locale AAR Group AAR Calling Search Space Device Calling Search Space Media Resource Group List SRST Default: Default
  • Field Name: Phone.[n].deviceMobilityMode
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Elin Group
  • Field Name: Phone.[n].elinGroup
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Outbound Call Rollover Use this setting for the Cisco Unified IP Phone 7931. No Rollover—Conference 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. Rollover Within Same DN—Conferences 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. Rollover to any line—Conferences 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. Default: No Rollover
  • Field Name: Phone.[n].outboundCallRollover
  • Type: String
  • Cardinality: [0..1]
  • Default: No Rollover
  • Choices: ["No Rollover", "Rollover Within Same DN", "Rollover to any line"]
IP Address IP address of the phone
  • Field Name: Phone.[n].ip_address
  • Type: String
Primary Phone * 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).
  • Field Name: Phone.[n].primaryPhoneName
  • Type: ["String", "Null"]
  • Target: device/cucm/Phone
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Device Name * 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. Tip    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 Cisco Unified Personal Communicator, make sure that the name starts with UPC. Note    Ensure that the device name of a Cisco Unified Mobile Communicator does not exceed 15 characters. If the device name of a Cisco Unified Mobile Communicator exceeds 15 characters, migration of this device will fail upon upgrade to a different release of Cisco Unified Communications Manager. If an existing Cisco Unified Mobile Communicator device name specifies a longer name, shorten the device name to 15 or fewer characters. Cisco Unified Mobile Communicator supports dual mode phones. The preceding limit of 15 characters also applies to 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.
  • Field Name: Phone.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Retry Video Call as Audio 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. Default: True
  • Field Name: Phone.[n].retryVideoCallAsAudio
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Privacy For each phone that wants Privacy, choose On in the Privacy drop-down list box. Default: Default
  • Field Name: Phone.[n].callInfoPrivacyStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Geo Location Filter Name
  • Field Name: Phone.[n].geoLocationFilterName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocationFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Services Provisioning From the drop-down list box, choose how the phone will support the services: Internal—The 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. External URL—Choosing 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. Both—Choosing 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. Default: Default
  • Field Name: Phone.[n].phoneServiceDisplay
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Internal", "External URL", "Both", "Default"]
Key Order keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot. Default: RSA Only
  • Field Name: Phone.[n].keyOrder
  • Type: String
  • Cardinality: [0..1]
  • Default: RSA Only
  • Choices: ["RSA Only", "EC Only", "EC Preferred, RSA Backup"]
Secure Directory URL Enter the secure URL for the server from which the phone obtains directory information. This parameter specifies the URL that secured Cisco Unified IP Phones use when you press the Directory button. Note    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. Leave this field blank to accept the default setting. Maximum length: 255
  • Field Name: Phone.[n].secureDirectoryUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Always Use Prime Line for Voice Message From the drop-down list box, choose one of the following options: On—If the phone is idle, the primary line on the phone becomes the active line for retrieving voice messages when the phone user presses the Messages button on the phone. Off—If the phone is idle, pressing the Messages button on the phone automatically dials the voice-messaging system from the line that has a voice message. Cisco Unified 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. Default—Cisco Unified CM uses the configuration from the Always Use Prime Line for Voice Message service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: Phone.[n].alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Mtp Required This field is applicable only to SIP phones.
  • Field Name: Phone.[n].mtpRequired
  • Type: Boolean
  • Cardinality: [0..1]
Secure Messages URL Enter the secure URL for the messages server. The Cisco Unified IP Phone contacts this URL when the user presses the Messages button. Note    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. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: Phone.[n].secureMessageUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Key Size (Bits) 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. Note    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. Default: 2048
  • Field Name: Phone.[n].keySize
  • Type: String
  • Cardinality: [0..1]
  • Default: 2048
  • Choices: ["512", "1024", "2048", "3072", "4096"]
Proxy Server 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. The rule contains two parts for when to use the proxy server parameter: The hostname contains a "." The hostname specifies an IP address in any form. 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.
  • Field Name: Phone.[n].proxyServerUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Add On Modules Additional modules attached to the Phone.There can be 0,1, 2 or 3.
  • Field Name: addOnModules
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Add On Module
  • Field Name: addOnModule.[n]
  • Type: Array
  • Cardinality: [0..3]
Module 3 Load Name * 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.
  • Field Name: Phone.[n].addOnModules.addOnModule.[n].loadInformation
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Model * Model ID string. Default: 7914 14-Button Line Expansion Module
  • Field Name: Phone.[n].addOnModules.addOnModule.[n].model
  • Type: String
  • Cardinality: [1..1]
  • Default: 7914 14-Button Line Expansion Module
  • Choices: ["Cisco 30 SP+", "Cisco 12 SP+", "Cisco 12 SP", "Cisco 12 S", "Cisco 30 VIP", "Cisco 7910", "Cisco 7960", "Cisco 7940", "Cisco 7935", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco ATA 186", "EMCC Base Phone", "SCCP Phone", "Analog Access", "Digital Access", "Digital Access+", "Digital Access WS-X6608", "Analog Access WS-X6624", "VGC Gateway", "Conference Bridge", "Conference Bridge WS-X6608", "Cisco IOS Conference Bridge (HDV2)", "Cisco Conference Bridge (WS-SVC-CMM)", "H.323 Phone", "H.323 Gateway", "Music On Hold", "Device Pilot", "CTI Port", "CTI Route Point", "Voice Mail Port", "Cisco IOS Software Media Termination Point (HDV2)", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Video Conference Bridge (IPVC-35xx)", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Route List", "Load Simulator", "Media Termination Point", "Media Termination Point Hardware", "Cisco IOS Media Termination Point (HDV2)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco 7941", "Cisco 7971", "MGCP Station", "MGCP Trunk", "GateKeeper", "7914 14-Button Line Expansion Module", "Trunk", "Tone Announcement Player", "SIP Trunk", "SIP Gateway", "WSM Trunk", "Remote Destination Profile", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "CKEM 36-Button Line Expansion Module", "SPA8800", "Unknown MGCP Gateway", "Unknown", "Cisco 7985", "Cisco 7911", "Cisco 7961G-GE", "Cisco 7941G-GE", "Motorola CN622", "Third-party SIP Device (Basic)", "Cisco 7931", "Cisco Unified Personal Communicator", "Cisco 7921", "Cisco 7906", "Third-party SIP Device (Advanced)", "Cisco TelePresence", "Nokia S60", "Cisco 7962", "Cisco 3951", "Cisco 7937", "Cisco 7942", "Cisco 7945", "Cisco 7965", "Cisco 7975", "Cisco 3911", "Cisco Unified Mobile Communicator", "Cisco TelePresence 1000", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 500-37", "Cisco 7925", "Cisco 9971", "Cisco 6921", "Cisco 6941", "Cisco 6961", "Cisco Unified Client Services Framework", "Cisco TelePresence 1300-65", "Cisco TelePresence 1100", "Transnova S3", "BlackBerry MVS VoWifi", "Cisco 9951", "Cisco 8961", "Cisco 6901", "Cisco 6911", "Cisco ATA 187", "Cisco TelePresence 200", "Cisco TelePresence 400", "Cisco Dual Mode for iPhone", "Cisco 6945", "Cisco Dual Mode for Android", "Cisco 7926", "Cisco E20", "Generic Single Screen Room System", "Generic Multiple Screen Room System", "Cisco TelePresence EX90", "Cisco 8945", "Cisco 8941", "Generic Desktop Video Endpoint", "Cisco TelePresence 500-32", "Cisco TelePresence 1300-47", "Cisco 3905", "Cisco Cius", "VKEM 36-Button Line Expansion Module", "Cisco TelePresence TX1310-65", "Cisco TelePresence MCU", "Ascom IP-DECT Device", "Cisco TelePresence Exchange System", "Cisco TelePresence EX60", "Cisco TelePresence Codec C90", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C40", "Cisco TelePresence Quick Set C20", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence MX200", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco 7821", "Cisco 7841", "Cisco 7861", "Cisco TelePresence SX20", "Cisco TelePresence MX300", "IMS-integrated Mobile (Basic)", "Third-party AS-SIP Endpoint", "Cisco Cius SP", "Cisco TelePresence Profile 42 (C40)", "Cisco VXC 6215", "CTI Remote Device", "Usage Profile", "Carrier-integrated Mobile", "Universal Device Template", "Cisco DX650", "Cisco Unified Communications for RTX", "Cisco Jabber for Tablet", "Cisco 8831", "Cisco ATA 190", "Cisco TelePresence SX10", "Cisco 8841", "Cisco 8851", "Cisco 8861", "Cisco TelePresence SX80", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300 G2", "Cisco 7905", "Cisco 7920", "Cisco 7970", "Cisco 7912", "Cisco 7902", "Cisco IP Communicator", "Cisco 7961", "Cisco 7936", "Analog Phone", "ISDN BRI Phone", "SCCP gateway virtual phone", "IP-STE", "Cisco TelePresence Conductor", "Cisco DX80", "Cisco DX70", "BEKEM 36-Button Line Expansion Module", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence IX5000", "Cisco 7811", "Cisco 8821", "Cisco 8811", "Interactive Voice Response", "Cisco 8845", "Cisco 8865", "Cisco TelePresence MX800 Dual", "Cisco 8851NR", "Cisco Spark Remote Device", "Cisco Webex DX80", "Cisco TelePresence DX70", "Cisco 7832", "Cisco 8865NR", "Cisco Meeting Server", "Cisco Webex Room Kit", "Cisco Webex Room 55", "Cisco Webex Room Kit Plus", "CP-8800-Video 28-Button Key Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "Cisco 8832", "Cisco Webex Room 70 Single", "Cisco 8832NR", "Cisco ATA 191", "Cisco Collaboration Mobile Convergence", "Cisco Webex Room 70 Dual", "Cisco Webex Room Kit Pro", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Single G2", "Cisco Webex Room 70 Dual G2", "SIP Station", "Cisco Webex Room Kit Mini", "Cisco Webex VDI Svc Framework", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex Desk Pro", "Cisco Webex Room Panorama", "Cisco Webex Room 70 Panorama", "Cisco Webex Room Phone", "Cisco 860", "Cisco Webex Desk LE"]
Module 3 Choose the appropriate expansion module or none.
  • Field Name: Phone.[n].addOnModules.addOnModule.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Authentication String 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.
  • Field Name: Phone.[n].authenticationString
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 10
  • Pattern: ^[0-9]{4,10}$
Require off-premise location 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.
  • Field Name: Phone.[n].requireOffPremiseLocation
  • Type: Boolean
  • Cardinality: [0..1]
Phone Activation Code The provisioning code which must be entered on the phone
  • Field Name: Phone.[n].phoneActivationCode
  • Type: ["String"]
Protected Device 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 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.
  • Field Name: Phone.[n].isProtected
  • Type: Boolean
  • Cardinality: [0..1]
SUBSCRIBE Calling Search Space 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 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.
  • Field Name: Phone.[n].subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Allow Control of Device from CTI 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.
  • Field Name: Phone.[n].allowCtiControlFlag
  • Type: Boolean
  • Cardinality: [0..1]
RFC2833 Disabled For phones that are running SCCP, check this check box to disable RFC2833 support.
  • Field Name: Phone.[n].rfc2833Disabled
  • Type: Boolean
  • Cardinality: [0..1]
Hlog Status
  • Field Name: Phone.[n].hlogStatus
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Off", "On", "Default"]
Operation Completes By The completion deadline for the operation (CCYY:MM:DD:HH:MM)
  • Field Name: Phone.[n].upgradeFinishTime
  • Type: String
  • Cardinality: [0..1]
  • Pattern: ^[0-9]{4}:[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}$|::::00
Is Active The Device Is Active message in the Phone Configuration window in 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 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 Cisco Unified Communications Manager and that licensing consumes device license units for the phone. Default: True
  • Field Name: Phone.[n].isActive
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Allow iX Applicable Media This field is applicable only for Third-party AS-SIP Endpoint.
  • Field Name: Phone.[n].allowiXApplicableMedia
  • Type: Boolean
  • Cardinality: [0..1]
Hot line Device This tag is applicable for PLAR-supporting SIP/SCCP phones only
  • Field Name: Phone.[n].hotlineDevice
  • Type: Boolean
  • Cardinality: [0..1]
Device Security Profile Choose the security profile to apply to the device. You must apply a security profile to all phones that are configured in Cisco Unified Communications Manager Administration. 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. Note    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 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.
  • Field Name: Phone.[n].securityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/PhoneSecurityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
DND Incoming Call Alert When you enable the DND Ringer Off or Call Reject option, this parameter specifies how a call displays on a phone. From the drop-down list, choose one of the following options: None—This option specifies that the DND Incoming Call Alert setting from the Common Phone Profile window gets used for this device. Disable—This option disables both beep and flash notification of a call, but, for the DND Ringer Off option, incoming call information still gets displayed. For the DND Call Reject option, no call alerts display, and no information gets sent to the device. Beep Only—For an incoming call, this option causes the phone to play a beep tone only. Flash Only—For an incoming call, this option causes the phone to display a flash alert.
  • Field Name: Phone.[n].dndRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: Phone.[n].protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
MLPP Domain ID 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.
  • Field Name: Phone.[n].mlppDomainId
  • Type: ["String", "Null"]
  • Target: device/cucm/MlppDomain
  • Target attr: domainId
  • Cardinality: [0..1]
  • MaxLength: 6
  • Pattern: ^[0-9a-fA-F]{6}|-1$
  • Format: uri
AAR Group 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.
  • Field Name: Phone.[n].aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Location * 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 Cisco Unified IP Phone. A location setting of Hub_None means that the locations feature does not keep track of the bandwidth that this 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.
  • Field Name: Phone.[n].locationName
  • Type: String
  • Target: device/cucm/Location
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Media Resource Group List 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.
  • Field Name: Phone.[n].mediaResourceListName
  • Type: ["String", "Null"]
  • Target: device/cucm/MediaResourceList
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Pool * 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.
  • Field Name: Phone.[n].devicePoolName
  • Type: String
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Is Dual Mode Read-only tag.
  • Field Name: Phone.[n].isDualMode
  • Type: Boolean
  • Cardinality: [0..1]
Vendor Config
  • Field Name: vendorConfig.[n]
  • Type: Array
Value
  • Field Name: Phone.[n].vendorConfig.[n].value
  • Type: Any
Key
  • Field Name: Phone.[n].vendorConfig.[n].key
  • Type: String
Authentication Server 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 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.
  • Field Name: Phone.[n].authenticationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Certificate Operation * From the drop-down list box, choose one of the following options: No Pending Operation—Displays when no certificate operation is occurring (default setting). Install/Upgrade—Installs a new or upgrades an existing locally significant certificate in the phone. Delete—Deletes the locally significant certificate that exists in the phone. Troubleshoot—Retrieves 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. For more information on CAPF operations, see the Cisco Unified Communications Manager Security Guide . Default: No Pending Operation
  • Field Name: Phone.[n].certificateOperation
  • Type: String
  • Cardinality: [1..1]
  • Default: No Pending Operation
  • Choices: ["No Pending Operation", "Install/Upgrade", "Delete", "Troubleshoot"]
User Hold MOH Audio Source 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. Note    You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: Phone.[n].userHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
EM Profile The name of the default profile for this device.Not Nullable.
  • Field Name: Phone.[n].defaultProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/DeviceProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Enable Call Routing To Rd When None Is Active 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. Note    This field appears only on a CTI remote device type.
  • Field Name: Phone.[n].enableCallRoutingToRdWhenNoneIsActive
  • Type: Boolean
  • Cardinality: [0..1]
SIP Profile 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.
  • Field Name: Phone.[n].sipProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/SipProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
MLPP Preemption 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: Default—This device inherits its MLPP preemption setting from the common device configuration. Disabled—This device does not allow preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Forceful—This device allows preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Note    Do not configure a device with the following combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is set to Forceful. Default: Default
  • Field Name: Phone.[n].preemption
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Disabled", "Forceful", "Default"]
Single Button Barge 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. Off—This setting disables the Single Button Barge/cBarge feature; however, the regular Barge or cBarge features will still work. Barge—This setting enables the Single Button Barge feature. CBarge—This setting enables the Single Button cBarge feature. Default—Uses the Single Button Barge/cBarge setting that is in the service parameter. Default: Default
  • Field Name: Phone.[n].singleButtonBarge
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "Barge", "CBarge", "Default"]
Messages Leave this field blank (not used by Cisco Unified Communications Manager).
  • Field Name: Phone.[n].messagesUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Enable Extension Mobility Check this check box if this phone supports extension mobility.
  • Field Name: Phone.[n].enableExtensionMobility
  • Type: Boolean
  • Cardinality: [0..1]
Common Device Configuration 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.
  • Field Name: Phone.[n].commonDeviceConfigName
  • Type: ["String", "Null"]
  • Target: device/cucm/CommonDeviceConfig
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Early Offer support for voice and video calls (insert MTP if needed) This field is applicable only for Third-party AS-SIP Endpoint.
  • Field Name: Phone.[n].earlyOfferSupportForVoiceCall
  • Type: Boolean
  • Cardinality: [0..1]
Information This field displays the name of the active firmware load if the Cisco Unified IP Phone has registered with Cisco Unified Communications Manager. In some cases, the Active Load ID field displays "Unknown." For example, Cisco Unified Communications Manager Administration might display "Unknown" in the Active Load ID field for any of the following circumstances: For SCCP phones, when the phone is a Cisco Unified IP Phone 7940 (SCCP), 7960 (SCCP), or 7985 (SCCP), because these phone models do not support the necessary version of SCCP. For SCCP and SIP phones, when the phone is any third-party phone. When Cisco Unified Communications Manager cannot determine the status of the phone.
  • Field Name: Phone.[n].informationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Secure Authentication URL Enter the secure URL that the phone uses to validate requests that are made to the phone web server. Note    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. 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
  • Field Name: Phone.[n].secureAuthenticationUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Block Incoming Calls while Roaming
  • Field Name: Phone.[n].blockIncomingCallsWhenRoaming
  • Type: Boolean
  • Cardinality: [0..1]
Secure Idle URL Enter the secure URL for the information that displays on the 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. Note    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. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: Phone.[n].secureIdleUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Use Device Pool Calling Party Transformation CSS (Device Mobility Related Information) Default: True
  • Field Name: Phone.[n].useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Home Network ID This tag is only valid when value of blockIncomingCallsWhenRoaming is true
  • Field Name: Phone.[n].homeNetworkId
  • Type: String
  • Cardinality: [0..1]
Trace Flag
  • Field Name: Phone.[n].traceFlag
  • Type: Boolean
  • Cardinality: [0..1]
Phone Personalization The Phone Personalization setting allows you to enable a 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: Disabled-The user cannot customize the Cisco Unified IP Phone by using Phone Designer. Enabled-The user can use Phone Designer to customize the phone. 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. You must install and configure Phone Designer, so the phone user can customize the phone. Before you install and configure Phone Designer, identify which 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. Default: Default
  • Field Name: Phone.[n].phoneSuite
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Disabled", "Enabled", "HTTPS Only", "Default"]
Geolocation 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.
  • Field Name: Phone.[n].geoLocationName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Digest User This field is applicable only to SIP phones.
  • Field Name: Phone.[n].digestUser
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • MaxLength: 255
  • Format: uri
Join Across Lines 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. Off—This setting disables the Join Across Lines feature. On—This setting enables the Join Across Lines feature. Default—This setting uses the Join Across Lines setting that is in the service parameter. Default: Default
  • Field Name: Phone.[n].joinAcrossLines
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Speeddials
  • Field Name: speeddials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Speeddial
  • Field Name: speeddial.[n]
  • Type: Array
Index
  • Field Name: Phone.[n].speeddials.speeddial.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Dirn *
  • Field Name: Phone.[n].speeddials.speeddial.[n].dirn
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Label
  • Field Name: Phone.[n].speeddials.speeddial.[n].label
  • Type: String
  • Cardinality: [1..1]
Do Not Disturb Check this check box to enable Do Not Disturb on the phone.
  • Field Name: Phone.[n].dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Wireless Lan Profile Group 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. Note    You can specify the Wireless LAN Profile Group at the Device Pool level or the individual phone level. Note    This field does not apply to all phone models.
  • Field Name: Phone.[n].wirelessLanProfileGroup
  • Type: ["String", "Null"]
  • Target: device/cucm/WlanProfileGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Hold MOH Audio Source 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. Note    You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: Phone.[n].networkHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Network Location The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable. Default: Use System Default
  • Field Name: Phone.[n].networkLocation
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["OnNet", "OffNet", "Use System Default"]
Unattended Port Check this check box to indicate an unattended port on this device.
  • Field Name: Phone.[n].unattendedPort
  • Type: Boolean
  • Cardinality: [0..1]
Calling Party Transformation CSS 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.
  • Field Name: Phone.[n].cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Mobility User ID From the drop-down list box, choose the user ID of the person to whom this dual-mode phone is assigned. Note    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.
  • Field Name: Phone.[n].mobilityUserIdName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Ec Key Size ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
  • Field Name: Phone.[n].ecKeySize
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["256", "384", "521"]
Version Stamp UUID changed each time device is updated
  • Field Name: Phone.[n].versionStamp
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Device Trust Mode 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. Default: Not Trusted
  • Field Name: Phone.[n].deviceTrustMode
  • Type: String
  • Cardinality: [0..1]
  • Default: Not Trusted
  • Choices: ["Not Trusted", "Trusted"]
Lines
  • Field Name: lines
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Line An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
  • Field Name: line.[n]
  • Type: Array
Display Ascii
  • Field Name: Phone.[n].lines.line.[n].displayAscii
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Associated Endusers
  • Field Name: associatedEndusers
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Enduser
  • Field Name: enduser.[n]
  • Type: Array
User Id *
  • Field Name: Phone.[n].lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
Ring Setting Default: Ring
  • Field Name: Phone.[n].lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: Phone.[n].lines.line.[n].consecutiveRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Recording Profile Name
  • Field Name: Phone.[n].lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/RecordingProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Index
  • Field Name: Phone.[n].lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: Phone.[n].lines.line.[n].ringSettingActivePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Link To Line Link to the line resource
  • Field Name: Phone.[n].lines.line.[n].line_link
  • Type: String
  • Format: link
Label
  • Field Name: Phone.[n].lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: Phone.[n].lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: Phone.[n].lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Partition Usage This tag cannot be modified. It can only be specified in the add request. Default: General
  • Field Name: Phone.[n].lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Recording Flag Default: Call Recording Disabled
  • Field Name: Phone.[n].lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
  • Default: Call Recording Disabled
  • Choices: ["Call Recording Disabled", "Automatic Call Recording Enabled", "Selective Call Recording Enabled"]
Speed Dial
  • Field Name: Phone.[n].lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: Phone.[n].lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
E164Mask
  • Field Name: Phone.[n].lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: Phone.[n].lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: Phone.[n].lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: Phone.[n].lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: Phone.[n].lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: Phone.[n].lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Inventory Filter Default: default
  • Field Name: Phone.[n].lines.line.[n].dirn.line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers (Site Only)", "Show Unused Numbers", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Pattern *
  • Field Name: Phone.[n].lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: Phone.[n].lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mwl Policy Default: Use System Policy
  • Field Name: Phone.[n].lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Policy
  • Choices: ["Use System Policy", "Light and Prompt", "Prompt Only", "Light Only", "None"]
Ring Setting Idle Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: Phone.[n].lines.line.[n].ringSettingIdlePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: Phone.[n].lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: Phone.[n].lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: Phone.[n].lines.line.[n].display
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Third-party Registration Required
  • Field Name: Phone.[n].requireThirdPartyRegistration
  • Type: Boolean
  • Cardinality: [0..1]
Always Use Prime Line From the drop-down list box, choose one of the following options: Off—When the phone is idle and receives a call on any line, the phone user answers the call from the line on which the call is received. On—When the phone is idle (off hook) and receives a call on any line, the primary line gets chosen for the call. Calls on other lines continue to ring, and the phone user must select those other lines to answer these calls. Default— Cisco Unified Communications Manager uses the configuration from the Always Use Prime Line service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: Phone.[n].alwaysUsePrimeLine
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
MTP Preferred Originating Codec From the drop-down list box, choose the codec to use if a media termination point is required for SIP calls. Default: 711ulaw
  • Field Name: Phone.[n].mtpPreferedCodec
  • Type: String
  • Cardinality: [0..1]
  • Default: 711ulaw
  • Choices: ["711ulaw", "711alaw", "G729/G729a", "G729b/G729ab"]
Blf Directed Call Parks
  • Field Name: blfDirectedCallParks
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Blf Directed Call Park
  • Field Name: blfDirectedCallPark.[n]
  • Type: Array
Index
  • Field Name: Phone.[n].blfDirectedCallParks.blfDirectedCallPark.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Directed Call Park Dn And Partition
  • Field Name: directedCallParkDnAndPartition
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Route Partition Name
  • Field Name: Phone.[n].blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dn Pattern *
  • Field Name: Phone.[n].blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: ["String", "Null"]
  • Target: device/cucm/DirectedCallPark
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Directed Call Park Id Only the uuid attribute is read
  • Field Name: Phone.[n].blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkId
  • Type: String
  • Cardinality: [0..1]
  • Pattern: \{........-....-....-....-............\}
Label
  • Field Name: Phone.[n].blfDirectedCallParks.blfDirectedCallPark.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Secure Shell Password This tag is applicable only to thosedevices that support ssh feature.
  • Field Name: Phone.[n].sshPwd
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
BLF Audible Alert Setting (Phone Idle) This setting determines the busy lamp field (BLF) audible alert setting when no current call exists on the BLF DN: On—An audible alert sounds. Off—No audible alert sounds. Default—The configuration in the Service Parameters Configuration window determines the alert option. Default: Default
  • Field Name: Phone.[n].ringSettingIdleBlfAudibleAlert
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Built In Bridge * 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). Note    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. Default: Default
  • Field Name: Phone.[n].builtInBridgeStatus
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Packet Capture Duration 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 Cisco Unified Communications Manager Troubleshooting Guide .
  • Field Name: Phone.[n].packetCaptureDuration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Wifi Hotspot Profile
  • Field Name: Phone.[n].wifiHotspotProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/WifiHotspot
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Use Device Pool Calling Party Transformation CSS (Caller ID For Calls From This Phone) Default: True
  • Field Name: Phone.[n].useDevicePoolCgpnIngressDN
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Allow Presentation Sharing using BFCP This field is applicable only for Third-party AS-SIP Endpoint.
  • Field Name: Phone.[n].AllowPresentationSharingUsingBfcp
  • Type: Boolean
  • Cardinality: [0..1]
Services From the drop-down list box, choose how the phone will support the services: Internal—The 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. External URL—Choosing 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. Both—Choosing 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.
  • Field Name: Phone.[n].servicesUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Feature Control Policy 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).
  • Field Name: Phone.[n].featureControlPolicy
  • Type: ["String", "Null"]
  • Target: device/cucm/FeatureControlPolicy
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
MLPP Indication 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: Default—This device inherits its MLPP indication setting from the common device configuration. Off—This device does not handle nor process indication of an MLPP precedence call. On—This device does handle and process indication of an MLPP precedence call. Note    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. Default: Off
  • Field Name: Phone.[n].mlppIndicationStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Off
  • Choices: ["Off", "On", "Default"]
Busy Lamp Fields
  • Field Name: busyLampFields
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Busy Lamp Field
  • Field Name: busyLampField.[n]
  • Type: Array
Index
  • Field Name: Phone.[n].busyLampFields.busyLampField.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Blf Dest Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: Phone.[n].busyLampFields.busyLampField.[n].blfDest
  • Type: String
  • Cardinality: [1..1]
Call Pickup
  • Field Name: Phone.[n].busyLampFields.busyLampField.[n].callPickup
  • Type: Boolean
Label
  • Field Name: Phone.[n].busyLampFields.busyLampField.[n].label
  • Type: String
  • Cardinality: [0..1]
Route Partition
  • Field Name: Phone.[n].busyLampFields.busyLampField.[n].routePartition
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Blf Dirn Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: Phone.[n].busyLampFields.busyLampField.[n].blfDirn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Enable Activation ID This boolean setting, when set to true, indicates that the phone should use activation code based registration
  • Field Name: Phone.[n].enableActivationID
  • Type: Boolean
  • Cardinality: [0..1]
Packet Capture Mode * 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: None—This option, which serves as the default setting, indicates that no packet capturing is occurring. After you complete packet capturing, configure this setting. Batch Processing Mode—Cisco 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. For more information on packet capturing, see the Troubleshooting Guide for Cisco Unified Communications Manager . Default: None
  • Field Name: Phone.[n].packetCaptureMode
  • Type: String
  • Cardinality: [1..1]
  • Default: None
  • Choices: ["None", "Batch Processing Mode"]
Registration Status Registration status of the phone
  • Field Name: Phone.[n].status
  • Type: String
Phone Load Name Enter the custom software for the Cisco Unified IP Phone. The value that you enter overrides the default value for the current model. For more information about Cisco Unified IP Phone software and configuration, see the Cisco Unified IP Phone Administration Guide for Cisco Unified Communications Manager, which is specific to the phone model and Unified CM release.
  • Field Name: Phone.[n].loadInformation
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Product * Product ID string. read-only except when creating a device.
  • Field Name: Phone.[n].product
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["7914 14-Button Line Expansion Module", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "AIM-VOICE-30", "Analog Phone", "Annunciator", "BEKEM 36-Button Line Expansion Module", "C881V", "C887VA-V", "CKEM 36-Button Line Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "CP-8800-Video 28-Button Key Expansion Module", "CTI Port", "CTI Remote Device", "CTI Route Point", "Carrier-integrated Mobile", "Cisco IAD2400", "Cisco 12 S", "Cisco 12 SP", "Cisco 12 SP+", "Cisco 1751", "Cisco 1760", "Cisco 1861", "Cisco 269X", "Cisco 26XX", "Cisco 2801", "Cisco 2811", "Cisco 2821", "Cisco 2851", "Cisco 2901", "Cisco 2911", "Cisco 2921", "Cisco 2951", "Cisco 30 SP+", "Cisco 30 VIP", "Cisco 362X", "Cisco 364X", "Cisco 366X", "Cisco 3725", "Cisco 3745", "Cisco 3825", "Cisco 3845", "Cisco 3905", "Cisco 3911", "Cisco 3925", "Cisco 3925E", "Cisco 3945", "Cisco 3945E", "Cisco 3951", "Cisco 6901", "Cisco 6911", "Cisco 6921", "Cisco 6941", "Cisco 6945", "Cisco 6961", "Cisco 7811", "Cisco 7821", "Cisco 7832", "Cisco 7841", "Cisco 7861", "Cisco 7902", "Cisco 7905", "Cisco 7906", "Cisco 7910", "Cisco 7911", "Cisco 7912", "Cisco 7920", "Cisco 7921", "Cisco 7925", "Cisco 7926", "Cisco 7931", "Cisco 7935", "Cisco 7936", "Cisco 7937", "Cisco 7940", "Cisco 7941", "Cisco 7941G-GE", "Cisco 7942", "Cisco 7945", "Cisco 7960", "Cisco 7961", "Cisco 7961G-GE", "Cisco 7962", "Cisco 7965", "Cisco 7970", "Cisco 7971", "Cisco 7975", "Cisco 7985", "Cisco 860", "Cisco 881", "Cisco 8811", "Cisco 8821", "Cisco 8831", "Cisco 8832", "Cisco 8832NR", "Cisco 8841", "Cisco 8845", "Cisco 8851", "Cisco 8851NR", "Cisco 8861", "Cisco 8865", "Cisco 8865NR", "Cisco 888/887/886", "Cisco 8941", "Cisco 8945", "Cisco 8961", "Cisco 9951", "Cisco 9971", "Cisco ATA 186", "Cisco ATA 187", "Cisco ATA 190", "Cisco ATA 191", "Cisco C8200/L-1N-4T", "Cisco C8300-1N1S-4T2X", "Cisco C8300-1N1S-6T", "Cisco C8300-2N2S-4T2X/6T", "Cisco Catalyst 4000 Access Gateway Module", "Cisco Catalyst 4224 Voice Gateway Switch", "Cisco Catalyst 6000 12 port FXO Gateway", "Cisco Catalyst 6000 24 port FXS Gateway", "Cisco Catalyst 6000 E1 VoIP Gateway", "Cisco Catalyst 6000 T1 VoIP Gateway", "Cisco Cius", "Cisco Cius SP", "Cisco Collaboration Mobile Convergence", "Cisco Conference Bridge (WS-SVC-CMM)", "Cisco Conference Bridge Hardware", "Cisco Conference Bridge Software", "Cisco DX650", "Cisco DX70", "Cisco DX80", "Cisco Dual Mode for Android", "Cisco Dual Mode for iPhone", "Cisco E20", "Cisco ENCS 5400 ISRV", "Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge", "Cisco IOS Enhanced Media Termination Point", "Cisco IOS Enhanced Software Media Termination Point", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Cisco IOS Media Termination Point", "Cisco IP Communicator", "Cisco ISR 4321", "Cisco ISR 4331", "Cisco ISR 4351", "Cisco ISR 4431", "Cisco ISR 4451", "Cisco ISR 4461", "Cisco Jabber for Tablet", "Cisco MGCP BRI Port", "Cisco MGCP E1 Port", "Cisco MGCP FXO Port", "Cisco MGCP FXS Port", "Cisco MGCP T1 Port", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco Media Termination Point Hardware", "Cisco Media Termination Point Software", "Cisco Meeting Server", "Cisco SIP FXS Port", "Cisco Spark Remote Device", "Cisco TelePresence", "Cisco TelePresence 1000", "Cisco TelePresence 1100", "Cisco TelePresence 1300-47", "Cisco TelePresence 1300-65", "Cisco TelePresence 200", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 400", "Cisco TelePresence 500-32", "Cisco TelePresence 500-37", "Cisco TelePresence Codec C40", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C90", "Cisco TelePresence Conductor", "Cisco TelePresence DX70", "Cisco TelePresence EX60", "Cisco TelePresence EX90", "Cisco TelePresence Exchange System", "Cisco TelePresence IX5000", "Cisco TelePresence MCU", "Cisco TelePresence MX200", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300", "Cisco TelePresence MX300 G2", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence MX800 Dual", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C40)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence Quick Set C20", "Cisco TelePresence SX10", "Cisco TelePresence SX20", "Cisco TelePresence SX80", "Cisco TelePresence TX1310-65", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco Unified Client Services Framework", "Cisco Unified Communications for RTX", "Cisco Unified Mobile Communicator", "Cisco Unified Personal Communicator", "Cisco VG200", "Cisco VG248 Gateway", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco VGD-1T3", "Cisco VXC 6215", "Cisco Video Conference Bridge(IPVC-35xx)", "Cisco Voice Mail Port", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex DX80", "Cisco Webex Desk LE", "Cisco Webex Desk Pro", "Cisco Webex Room 55", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Dual", "Cisco Webex Room 70 Dual G2", "Cisco Webex Room 70 Panorama", "Cisco Webex Room 70 Single", "Cisco Webex Room 70 Single G2", "Cisco Webex Room Kit", "Cisco Webex Room Kit Mini", "Cisco Webex Room Kit Plus", "Cisco Webex Room Kit Pro", "Cisco Webex Room Panorama", "Cisco Webex Room Phone", "Cisco Webex VDI Svc Framework", "Communication Media Module", "EMCC Base Phone", "FLEX_SLOT", "Gatekeeper", "Generic Desktop Video Endpoint", "Generic Multiple Screen Room System", "Generic Single Screen Room System", "H.225 Trunk (Gatekeeper Controlled)", "H.323 Client", "H.323 Gateway", "Hunt List", "IAD2400_ANALOG", "IAD2400_DIGITAL", "IMS-integrated Mobile (Basic)", "IP-STE", "ISDN BRI Phone", "Inter-Cluster Trunk (Gatekeeper Controlled)", "Inter-Cluster Trunk (Non-Gatekeeper Controlled)", "Interactive Voice Response", "Load Simulator", "Motorola CN622", "Music On Hold", "NM-1V", "NM-2V", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT", "NM-HDV2-2PORT", "Nokia S60", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "Pilot", "Remote Destination Profile", "Route List", "SCCP Device", "SCCP gateway virtual phone", "SIP Trunk", "SIP WSM Connection", "SPA8800", "Third-party AS-SIP Endpoint", "Third-party SIP Device (Advanced)", "Third-party SIP Device (Basic)", "Transnova S3", "Universal Device Template", "Unknown", "VG202", "VG204", "VG224", "VG310", "VG320", "VG350", "VG400", "VG420", "VG450", "VGC Port", "VIC_SLOT", "VKEM 36-Button Line Expansion Module", "VNM-HDA", "VWIC_SLOT", "WS-SVC-CMM-MS", "WS-X6600"]
Description 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 (<>).
  • Field Name: Phone.[n].description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Allow MRA Mode
  • Field Name: Phone.[n].allowMraMode
  • Type: Boolean
  • Cardinality: [0..1]
Send Geo Location
  • Field Name: Phone.[n].sendGeoLocation
  • Type: Boolean
  • Cardinality: [0..1]
Owner User ID 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.
  • Field Name: Phone.[n].ownerUserName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Ignore Presentation Indicators (internal calls only) 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.
  • Field Name: Phone.[n].ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
Phone Activation Code Expiry The provisioning code expiry datetime
  • Field Name: Phone.[n].phoneActivationCodeExpiry
  • Type: ["String"]
Secure Services URL Enter the secure URL for Cisco Unified IP Phone services. The is the location that the secure Cisco Unified IP Phone contacts when the user presses the Services button. Note    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. To accept the default setting, leave this field blank. Maximum length: 255
  • Field Name: Phone.[n].secureServicesUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Services
  • Field Name: services
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Service
  • Field Name: service.[n]
  • Type: Array
Name *
  • Field Name: Phone.[n].services.service.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 100
Url
  • Field Name: Phone.[n].services.service.[n].url
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Service Name Ascii
  • Field Name: Phone.[n].services.service.[n].serviceNameAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Url Button Index
  • Field Name: Phone.[n].services.service.[n].urlButtonIndex
  • Type: Integer
  • Cardinality: [0..1]
Telecaster Service Name *
  • Field Name: Phone.[n].services.service.[n].telecasterServiceName
  • Type: String
  • Target: device/cucm/IpPhoneServices
  • Target attr: serviceName
  • Cardinality: [1..1]
  • Format: uri
Url Label
  • Field Name: Phone.[n].services.service.[n].urlLabel
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Secure Shell User Enter a user ID for the secure shell user. You can enter any alphanumeric or special characters up to 50 characters. Invalid characters include”, %, &, <, >, 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 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.
  • Field Name: Phone.[n].sshUserId
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Certificate Status
  • Field Name: Phone.[n].certificateStatus
  • Type: String
  • Cardinality: [0..1]
Class * Class ID string. Class information is read-only except when creating a device. Default: Phone
  • Field Name: Phone.[n].class
  • Type: String
  • Cardinality: [1..1]
  • Default: Phone
  • Choices: ["Phone", "Gateway", "Conference Bridge", "Media Termination Point", "Route List", "Voice Mail", "CTI Route Point", "Music On Hold", "Simulation", "Pilot", "GateKeeper", "Add-on modules", "Hidden Phone", "Trunk", "Tone Announcement Player", "Remote Destination Profile", "EMCC Base Phone Template", "EMCC Base Phone", "Remote Destination Profile Template", "Gateway Template", "UDP Template", "Phone Template", "Device Profile", "Invalid", "Interactive Voice Response"]
DND Option When you enable DND on the phone, this parameter allows you to specify how the DND features handle incoming calls: Call Reject—This option specifies that no incoming call information gets presented to the user. Depending on how you configure the DND Incoming Call Alert parameter, the phone may play a beep or display a flash notification of the call. Ringer Off—This option turns off the ringer, but incoming call information gets presented to the device, so the user can accept the call. Use Common Phone Profile Setting—This option specifies that the DND Option setting from the Common Phone Profile window will get used for this device. Note    For 7940/7960 phones that are running SCCP, you can only choose the Ringer Off option. For mobile devices and dual-mode phones, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. Default: Ringer Off
  • Field Name: Phone.[n].dndOption
  • Type: String
  • Cardinality: [0..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
BLF Presence Group
  • Field Name: Phone.[n].presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Rerouting Calling Search Space 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.
  • Field Name: Phone.[n].rerouteCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Common Phone Profile * From the drop-down list box, choose a common phone profile from the list of available common phone profiles.
  • Field Name: Phone.[n].commonPhoneConfigName
  • Type: String
  • Target: device/cucm/CommonPhoneConfig
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Idle Timer (seconds) 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.
  • Field Name: Phone.[n].idleTimeout
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Idle This setting determines the busy lamp field (BLF) audible alert setting when no current call exists on the BLF DN: On—An audible alert sounds. Off—No audible alert sounds. Default—The configuration in the Service Parameters Configuration window determines the alert option.
  • Field Name: Phone.[n].idleUrl
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Softkey Template Choose the appropriate softkey template. The softkey template determines the configuration of the softkeys on Cisco Unified IP Phones. Leave this field blank if the common device configuration contains the assigned softkey template.
  • Field Name: Phone.[n].softkeyTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/SoftKeyTemplate
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Remote Device 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. Tip    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. 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: Cisco Unified IP Phone 7935/7936. This feature may require a phone reset after update.
  • Field Name: Phone.[n].remoteDevice
  • Type: Boolean
  • Cardinality: [0..1]
AAR Calling Search Space 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.
  • Field Name: Phone.[n].automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
SIP Dial Rules If required, choose the appropriate SIP dial rule. SIP dial rules provide local dial plans for 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.
  • Field Name: Phone.[n].dialRulesName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Mobile Identity
  • Field Name: MobileIdentity.[n]
  • Type: Array
  • Cardinality: [0..1]
Enable Extend And Connect While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update
  • Field Name: Phone.[n].MobileIdentity.[n].enableExtendAndConnect
  • Type: Boolean
  • Cardinality: [0..1]
Dial Via Office Reverse Voicemail Configures how dual mode device users answer Dial-via-Office Reverse (DVO-R) calls that terminate on the Mobile Identity (MI). This feature provides users with a single enterprise voicemail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Default: Use System Default
  • Field Name: Phone.[n].MobileIdentity.[n].dialViaOfficeReverseVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Mobile Smart Client Name This tag is not applicable for dualmode phones
  • Field Name: Phone.[n].MobileIdentity.[n].mobileSmartClientName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Answer Too Late Timer * Enter the maximum time in milliseconds that Cisco Unified Communications Manager allows for the mobile phone to answer. If this value is reached, Cisco Unified Communications Manager stops ringing the mobile phone and pulls the call back to the enterprise. Range: 0 and 10,000 - 300,000 milliseconds Default: 19,000 milliseconds If the value is set to zero, the timer is not started. Default: 19000
  • Field Name: Phone.[n].MobileIdentity.[n].answerTooLateTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 19000
Line Associations The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
  • Field Name: lineAssociations
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Association
  • Field Name: lineAssociation.[n]
  • Type: Array
Pattern The directory number to be associated. This directory number must be already associated to remote destination profile.
  • Field Name: Phone.[n].MobileIdentity.[n].lineAssociations.lineAssociation.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name
  • Field Name: Phone.[n].MobileIdentity.[n].lineAssociations.lineAssociation.[n].routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Tod Access Name From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
  • Field Name: Phone.[n].MobileIdentity.[n].todAccessName
  • Type: String
  • Cardinality: [0..1]
Dual Mode Device Name
  • Field Name: Phone.[n].MobileIdentity.[n].dualModeDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Destination Number * Enter the PSTN telephone number for the destination. Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9, *, #, and +. Cisco recommends that you configure the caller ID of the remote destination. If the administrator configures the Incoming Calling Party settings in the Cisco Unified Communications Manager gateway, trunk, or device pool to globalize the incoming calling party number, configure the Destination Number of the remote destination in the E.164 format. Example: For a remote destination with US area code 408 and destination number 5552222, configure the Destination Number as +14085552222. Additionally, if globalized destination numbers are in use, set the Matching Caller ID with Remote Destination service parameter to Complete Match. Note    Add the necessary translation pattern or route patterns to route the destination number. You can also enter a directory URI in this field. Keep in mind that if you enter a directory URI in this field, you must also configure a domain-based SIP route pattern. Note    When you place a call from a remote destination, the caller ID of the destination phone displays the directory number that is associated with the calling directory URI rather than the directory URI.
  • Field Name: Phone.[n].MobileIdentity.[n].destination
  • Type: String
  • Cardinality: [1..1]
Enable Mobile Connect Check the check box to allow an incoming call to ring your desk phone and remote destination at the same time. For detailed task information about Cisco Unified Mobility and Extend and Connect, see the Feature Configuration Guide for Cisco Unified Communications Manager. Default: True
  • Field Name: Phone.[n].MobileIdentity.[n].enableMobileConnect
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Client Services Framework or CTI Remote Device ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
  • Field Name: Phone.[n].MobileIdentity.[n].ctiRemoteDeviceName
  • Type: String
  • Cardinality: [0..1]
Mobility Profile From the drop-down list box, choose the mobility profile that you want to use for this remote destination. To configure a mobility profile, use the Call Routing > Mobility > Mobility Profile menu option.
  • Field Name: Phone.[n].MobileIdentity.[n].mobilityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/MobilityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Enable Unified Mobility While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
  • Field Name: Phone.[n].MobileIdentity.[n].enableUnifiedMobility
  • Type: Boolean
  • Cardinality: [0..1]
Remote Destination Profile From the drop-down list box, choose the remote destination profile that you want to use for this remote destination.
  • Field Name: Phone.[n].MobileIdentity.[n].remoteDestinationProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Single Number Reach Voicemail Policy Configures how mobile device users answer calls that terminate on a remote destination (RD). This feature provides users with a single enterprise voice mail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Note    For User Control to work, you must set the Enable Enterprise Feature Access service parameter to TRUE. Default: Use System Default
  • Field Name: Phone.[n].MobileIdentity.[n].singleNumberReachVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Owner User Id From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
  • Field Name: Phone.[n].MobileIdentity.[n].ownerUserId
  • Type: String
  • Cardinality: [1..1]
Answer Too Soon Timer * Enter the minimum time in milliseconds that Cisco Unified Communications Manager requires the mobile phone to ring before answering the call. This setting accounts for situations where the mobile phone is switched off or is not reachable, in which case the network may immediately divert the call to the mobile phone voice mail. If the mobile phone is answered before this timer expires, Cisco Unified Communications Manager pulls the call back to the enterprise. Range: 0 - 10,000 milliseconds Default: 1,500 milliseconds Default: 1500
  • Field Name: Phone.[n].MobileIdentity.[n].answerTooSoonTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 1500
Ring Schedule This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag. Passing a blank ringSchedule tag in updateRemoteDestination request will result in setting the time schedule to All the time.
  • Field Name: ringSchedule
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
  • Cardinality: [0..7]
End Day Default: None
  • Field Name: Phone.[n].MobileIdentity.[n].ringSchedule.member.[n].endDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
Start Day StartDay and EndDay value should be same Default: None
  • Field Name: Phone.[n].MobileIdentity.[n].ringSchedule.member.[n].startDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
End Time Default: No Office Hours
  • Field Name: Phone.[n].MobileIdentity.[n].ringSchedule.member.[n].endTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Start Time Default: No Office Hours
  • Field Name: Phone.[n].MobileIdentity.[n].ringSchedule.member.[n].startTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Mobile Phone Check the check box if you want calls that the desk phone answers to be sent to your mobile phone as the remote destination. Checking this check box ensures that, if Send Call to Mobile Phone is specified (by using the Mobility softkey for remote destination pickup), the call gets extended to this remote destination. Note    This check box does not apply to dual-mode phones that are running SIP nor to dual-mode phones that are running SCCP, such as the Nokia S60.
  • Field Name: Phone.[n].MobileIdentity.[n].isMobilePhone
  • Type: Boolean
  • Cardinality: [0..1]
Blocked Access List Click this radio button to prevent incoming calls from ringing this remote destination if the caller belongs to the access list that is specified in the drop-down list box and according to the Ring Schedule that you specify in the Ring Schedule pane. This setting applies only if the Enable Cisco Unified Mobility check box is checked for this remote destination. From the drop-down list box, choose an access list that applies to this setting. If you want to view the details of an access list, click the View Details link. (To modify an access list, you must use the Call Routing > Class of Control > Access List menu option.) Choosing an access list that contains no members equates to choosing the Always ring this destination radio button.
  • Field Name: Phone.[n].MobileIdentity.[n].accessListName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Delay Before Ringing Timer * Enter the time that elapses before the mobile phone rings when a call is extended to the remote destination. Range: 0 - 30,000 milliseconds Default: 4,000 milliseconds Tip    When a hunt group is in use, the lines ring only for a short period of time. You may need to manipulate the Delay Before Ringing Timer setting and make it zero to allow a remote destination call to be established, ring, and answer, before the hunt list timer expires and pulls the call back. Default: 4000
  • Field Name: Phone.[n].MobileIdentity.[n].delayBeforeRingingCell
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 4000
Name Enter a name that identifies the remote destination or mobile identity.
  • Field Name: Phone.[n].MobileIdentity.[n].name
  • Type: String
  • Cardinality: [0..1]
Time Zone From the drop-down list box, choose a time zone to use for this remote destination or mobile identity. Note    The time-of-day access feature uses the time zone that you choose for this remote destination or mobile identity to allow or to block calls to this remote destination or mobile identity. Default: Etc/GMT
  • Field Name: Phone.[n].MobileIdentity.[n].timeZone
  • Type: String
  • Cardinality: [0..1]
  • Default: Etc/GMT
  • Choices: ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Riyadh87", "Asia/Riyadh88", "Asia/Riyadh89", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "CET", "CST6CDT", "EET", "EST", "EST5EDT", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "HST", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "MET", "MST", "MST7MDT", "Mideast/Riyadh87", "Mideast/Riyadh88", "Mideast/Riyadh89", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "US/Pacific-New", "WET"]
Remote Destination Phone
  • Field Name: RemoteDestinationPhone.[n]
  • Type: Array
Enable Extend And Connect While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].enableExtendAndConnect
  • Type: Boolean
  • Cardinality: [0..1]
Dial Via Office Reverse Voicemail Configures how dual mode device users answer Dial-via-Office Reverse (DVO-R) calls that terminate on the Mobile Identity (MI). This feature provides users with a single enterprise voicemail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Default: Use System Default
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].dialViaOfficeReverseVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Mobile Smart Client Name This tag is not applicable for dualmode phones
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].mobileSmartClientName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Answer Too Late Timer * Enter the maximum time in milliseconds that Cisco Unified Communications Manager allows for the mobile phone to answer. If this value is reached, Cisco Unified Communications Manager stops ringing the mobile phone and pulls the call back to the enterprise. Range: 0 and 10,000 - 300,000 milliseconds Default: 19,000 milliseconds If the value is set to zero, the timer is not started. Default: 19000
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].answerTooLateTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 19000
Line Associations The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
  • Field Name: lineAssociations
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Association
  • Field Name: lineAssociation.[n]
  • Type: Array
Pattern The directory number to be associated. This directory number must be already associated to remote destination profile.
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].lineAssociations.lineAssociation.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].lineAssociations.lineAssociation.[n].routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Tod Access Name From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].todAccessName
  • Type: String
  • Cardinality: [0..1]
Dual Mode Device Name
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].dualModeDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Destination Number * Enter the PSTN telephone number for the destination. Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9, *, #, and +. Cisco recommends that you configure the caller ID of the remote destination. If the administrator configures the Incoming Calling Party settings in the Cisco Unified Communications Manager gateway, trunk, or device pool to globalize the incoming calling party number, configure the Destination Number of the remote destination in the E.164 format. Example: For a remote destination with US area code 408 and destination number 5552222, configure the Destination Number as +14085552222. Additionally, if globalized destination numbers are in use, set the Matching Caller ID with Remote Destination service parameter to Complete Match. Note    Add the necessary translation pattern or route patterns to route the destination number. You can also enter a directory URI in this field. Keep in mind that if you enter a directory URI in this field, you must also configure a domain-based SIP route pattern. Note    When you place a call from a remote destination, the caller ID of the destination phone displays the directory number that is associated with the calling directory URI rather than the directory URI.
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].destination
  • Type: String
  • Cardinality: [1..1]
Enable Mobile Connect Check the check box to allow an incoming call to ring your desk phone and remote destination at the same time. For detailed task information about Cisco Unified Mobility and Extend and Connect, see the Feature Configuration Guide for Cisco Unified Communications Manager. Default: True
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].enableMobileConnect
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Client Services Framework or CTI Remote Device ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].ctiRemoteDeviceName
  • Type: String
  • Cardinality: [0..1]
Mobility Profile From the drop-down list box, choose the mobility profile that you want to use for this remote destination. To configure a mobility profile, use the Call Routing > Mobility > Mobility Profile menu option.
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].mobilityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/MobilityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Enable Unified Mobility While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].enableUnifiedMobility
  • Type: Boolean
  • Cardinality: [0..1]
Remote Destination Profile From the drop-down list box, choose the remote destination profile that you want to use for this remote destination.
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].remoteDestinationProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Single Number Reach Voicemail Policy Configures how mobile device users answer calls that terminate on a remote destination (RD). This feature provides users with a single enterprise voice mail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Note    For User Control to work, you must set the Enable Enterprise Feature Access service parameter to TRUE. Default: Use System Default
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].singleNumberReachVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Owner User Id From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].ownerUserId
  • Type: String
  • Cardinality: [1..1]
Answer Too Soon Timer * Enter the minimum time in milliseconds that Cisco Unified Communications Manager requires the mobile phone to ring before answering the call. This setting accounts for situations where the mobile phone is switched off or is not reachable, in which case the network may immediately divert the call to the mobile phone voice mail. If the mobile phone is answered before this timer expires, Cisco Unified Communications Manager pulls the call back to the enterprise. Range: 0 - 10,000 milliseconds Default: 1,500 milliseconds Default: 1500
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].answerTooSoonTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 1500
Ring Schedule This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag. Passing a blank ringSchedule tag in updateRemoteDestination request will result in setting the time schedule to All the time.
  • Field Name: ringSchedule
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
  • Cardinality: [0..7]
End Day Default: None
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].ringSchedule.member.[n].endDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
Start Day StartDay and EndDay value should be same Default: None
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].ringSchedule.member.[n].startDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
End Time Default: No Office Hours
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].ringSchedule.member.[n].endTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Start Time Default: No Office Hours
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].ringSchedule.member.[n].startTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Mobile Phone Check the check box if you want calls that the desk phone answers to be sent to your mobile phone as the remote destination. Checking this check box ensures that, if Send Call to Mobile Phone is specified (by using the Mobility softkey for remote destination pickup), the call gets extended to this remote destination. Note    This check box does not apply to dual-mode phones that are running SIP nor to dual-mode phones that are running SCCP, such as the Nokia S60.
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].isMobilePhone
  • Type: Boolean
  • Cardinality: [0..1]
Blocked Access List Click this radio button to prevent incoming calls from ringing this remote destination if the caller belongs to the access list that is specified in the drop-down list box and according to the Ring Schedule that you specify in the Ring Schedule pane. This setting applies only if the Enable Cisco Unified Mobility check box is checked for this remote destination. From the drop-down list box, choose an access list that applies to this setting. If you want to view the details of an access list, click the View Details link. (To modify an access list, you must use the Call Routing > Class of Control > Access List menu option.) Choosing an access list that contains no members equates to choosing the Always ring this destination radio button.
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].accessListName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Delay Before Ringing Timer * Enter the time that elapses before the mobile phone rings when a call is extended to the remote destination. Range: 0 - 30,000 milliseconds Default: 4,000 milliseconds Tip    When a hunt group is in use, the lines ring only for a short period of time. You may need to manipulate the Delay Before Ringing Timer setting and make it zero to allow a remote destination call to be established, ring, and answer, before the hunt list timer expires and pulls the call back. Default: 4000
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].delayBeforeRingingCell
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 4000
Name Enter a name that identifies the remote destination or mobile identity.
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].name
  • Type: String
  • Cardinality: [0..1]
Time Zone From the drop-down list box, choose a time zone to use for this remote destination or mobile identity. Note    The time-of-day access feature uses the time zone that you choose for this remote destination or mobile identity to allow or to block calls to this remote destination or mobile identity. Default: Etc/GMT
  • Field Name: Phone.[n].RemoteDestinationPhone.[n].timeZone
  • Type: String
  • Cardinality: [0..1]
  • Default: Etc/GMT
  • Choices: ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Riyadh87", "Asia/Riyadh88", "Asia/Riyadh89", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "CET", "CST6CDT", "EET", "EST", "EST5EDT", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "HST", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "MET", "MST", "MST7MDT", "Mideast/Riyadh87", "Mideast/Riyadh88", "Mideast/Riyadh89", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "US/Pacific-New", "WET"]
Cti Remote Device
  • Field Name: CTIRemoteDevice.[n]
  • Type: Array
Enable Extend And Connect While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update
  • Field Name: Phone.[n].CTIRemoteDevice.[n].enableExtendAndConnect
  • Type: Boolean
  • Cardinality: [0..1]
Dial Via Office Reverse Voicemail Configures how dual mode device users answer Dial-via-Office Reverse (DVO-R) calls that terminate on the Mobile Identity (MI). This feature provides users with a single enterprise voicemail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Default: Use System Default
  • Field Name: Phone.[n].CTIRemoteDevice.[n].dialViaOfficeReverseVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Mobile Smart Client Name This tag is not applicable for dualmode phones
  • Field Name: Phone.[n].CTIRemoteDevice.[n].mobileSmartClientName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Answer Too Late Timer * Enter the maximum time in milliseconds that Cisco Unified Communications Manager allows for the mobile phone to answer. If this value is reached, Cisco Unified Communications Manager stops ringing the mobile phone and pulls the call back to the enterprise. Range: 0 and 10,000 - 300,000 milliseconds Default: 19,000 milliseconds If the value is set to zero, the timer is not started. Default: 19000
  • Field Name: Phone.[n].CTIRemoteDevice.[n].answerTooLateTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 19000
Line Associations The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
  • Field Name: lineAssociations
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Association
  • Field Name: lineAssociation.[n]
  • Type: Array
Pattern The directory number to be associated. This directory number must be already associated to remote destination profile.
  • Field Name: Phone.[n].CTIRemoteDevice.[n].lineAssociations.lineAssociation.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name
  • Field Name: Phone.[n].CTIRemoteDevice.[n].lineAssociations.lineAssociation.[n].routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Tod Access Name From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
  • Field Name: Phone.[n].CTIRemoteDevice.[n].todAccessName
  • Type: String
  • Cardinality: [0..1]
Dual Mode Device Name
  • Field Name: Phone.[n].CTIRemoteDevice.[n].dualModeDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Destination Number * Enter the PSTN telephone number for the destination. Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9, *, #, and +. Cisco recommends that you configure the caller ID of the remote destination. If the administrator configures the Incoming Calling Party settings in the Cisco Unified Communications Manager gateway, trunk, or device pool to globalize the incoming calling party number, configure the Destination Number of the remote destination in the E.164 format. Example: For a remote destination with US area code 408 and destination number 5552222, configure the Destination Number as +14085552222. Additionally, if globalized destination numbers are in use, set the Matching Caller ID with Remote Destination service parameter to Complete Match. Note    Add the necessary translation pattern or route patterns to route the destination number. You can also enter a directory URI in this field. Keep in mind that if you enter a directory URI in this field, you must also configure a domain-based SIP route pattern. Note    When you place a call from a remote destination, the caller ID of the destination phone displays the directory number that is associated with the calling directory URI rather than the directory URI.
  • Field Name: Phone.[n].CTIRemoteDevice.[n].destination
  • Type: String
  • Cardinality: [1..1]
Enable Mobile Connect Check the check box to allow an incoming call to ring your desk phone and remote destination at the same time. For detailed task information about Cisco Unified Mobility and Extend and Connect, see the Feature Configuration Guide for Cisco Unified Communications Manager. Default: True
  • Field Name: Phone.[n].CTIRemoteDevice.[n].enableMobileConnect
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Client Services Framework or CTI Remote Device ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
  • Field Name: Phone.[n].CTIRemoteDevice.[n].ctiRemoteDeviceName
  • Type: String
  • Cardinality: [0..1]
Mobility Profile From the drop-down list box, choose the mobility profile that you want to use for this remote destination. To configure a mobility profile, use the Call Routing > Mobility > Mobility Profile menu option.
  • Field Name: Phone.[n].CTIRemoteDevice.[n].mobilityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/MobilityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Enable Unified Mobility While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
  • Field Name: Phone.[n].CTIRemoteDevice.[n].enableUnifiedMobility
  • Type: Boolean
  • Cardinality: [0..1]
Remote Destination Profile From the drop-down list box, choose the remote destination profile that you want to use for this remote destination.
  • Field Name: Phone.[n].CTIRemoteDevice.[n].remoteDestinationProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Single Number Reach Voicemail Policy Configures how mobile device users answer calls that terminate on a remote destination (RD). This feature provides users with a single enterprise voice mail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Note    For User Control to work, you must set the Enable Enterprise Feature Access service parameter to TRUE. Default: Use System Default
  • Field Name: Phone.[n].CTIRemoteDevice.[n].singleNumberReachVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Owner User Id From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
  • Field Name: Phone.[n].CTIRemoteDevice.[n].ownerUserId
  • Type: String
  • Cardinality: [1..1]
Answer Too Soon Timer * Enter the minimum time in milliseconds that Cisco Unified Communications Manager requires the mobile phone to ring before answering the call. This setting accounts for situations where the mobile phone is switched off or is not reachable, in which case the network may immediately divert the call to the mobile phone voice mail. If the mobile phone is answered before this timer expires, Cisco Unified Communications Manager pulls the call back to the enterprise. Range: 0 - 10,000 milliseconds Default: 1,500 milliseconds Default: 1500
  • Field Name: Phone.[n].CTIRemoteDevice.[n].answerTooSoonTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 1500
Ring Schedule This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag. Passing a blank ringSchedule tag in updateRemoteDestination request will result in setting the time schedule to All the time.
  • Field Name: ringSchedule
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
  • Cardinality: [0..7]
End Day Default: None
  • Field Name: Phone.[n].CTIRemoteDevice.[n].ringSchedule.member.[n].endDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
Start Day StartDay and EndDay value should be same Default: None
  • Field Name: Phone.[n].CTIRemoteDevice.[n].ringSchedule.member.[n].startDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
End Time Default: No Office Hours
  • Field Name: Phone.[n].CTIRemoteDevice.[n].ringSchedule.member.[n].endTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Start Time Default: No Office Hours
  • Field Name: Phone.[n].CTIRemoteDevice.[n].ringSchedule.member.[n].startTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Mobile Phone Check the check box if you want calls that the desk phone answers to be sent to your mobile phone as the remote destination. Checking this check box ensures that, if Send Call to Mobile Phone is specified (by using the Mobility softkey for remote destination pickup), the call gets extended to this remote destination. Note    This check box does not apply to dual-mode phones that are running SIP nor to dual-mode phones that are running SCCP, such as the Nokia S60.
  • Field Name: Phone.[n].CTIRemoteDevice.[n].isMobilePhone
  • Type: Boolean
  • Cardinality: [0..1]
Blocked Access List Click this radio button to prevent incoming calls from ringing this remote destination if the caller belongs to the access list that is specified in the drop-down list box and according to the Ring Schedule that you specify in the Ring Schedule pane. This setting applies only if the Enable Cisco Unified Mobility check box is checked for this remote destination. From the drop-down list box, choose an access list that applies to this setting. If you want to view the details of an access list, click the View Details link. (To modify an access list, you must use the Call Routing > Class of Control > Access List menu option.) Choosing an access list that contains no members equates to choosing the Always ring this destination radio button.
  • Field Name: Phone.[n].CTIRemoteDevice.[n].accessListName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Delay Before Ringing Timer * Enter the time that elapses before the mobile phone rings when a call is extended to the remote destination. Range: 0 - 30,000 milliseconds Default: 4,000 milliseconds Tip    When a hunt group is in use, the lines ring only for a short period of time. You may need to manipulate the Delay Before Ringing Timer setting and make it zero to allow a remote destination call to be established, ring, and answer, before the hunt list timer expires and pulls the call back. Default: 4000
  • Field Name: Phone.[n].CTIRemoteDevice.[n].delayBeforeRingingCell
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 4000
Name Enter a name that identifies the remote destination or mobile identity.
  • Field Name: Phone.[n].CTIRemoteDevice.[n].name
  • Type: String
  • Cardinality: [0..1]
Time Zone From the drop-down list box, choose a time zone to use for this remote destination or mobile identity. Note    The time-of-day access feature uses the time zone that you choose for this remote destination or mobile identity to allow or to block calls to this remote destination or mobile identity. Default: Etc/GMT
  • Field Name: Phone.[n].CTIRemoteDevice.[n].timeZone
  • Type: String
  • Cardinality: [0..1]
  • Default: Etc/GMT
  • Choices: ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Riyadh87", "Asia/Riyadh88", "Asia/Riyadh89", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "CET", "CST6CDT", "EET", "EST", "EST5EDT", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "HST", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "MET", "MST", "MST7MDT", "Mideast/Riyadh87", "Mideast/Riyadh88", "Mideast/Riyadh89", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "US/Pacific-New", "WET"]
Cft Phone
  • Field Name: CFTPhone
  • Type: Object
Phone name to form Relation
  • Field Name: Phone.[n].CFTPhone.Phone
  • Type: String
Phone Config Template
  • Field Name: Phone.[n].CFTPhone.CFTPhone
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • Format: uri
Device Profile
  • Field Name: DeviceProfile.[n]
  • Type: Array
  • Cardinality: [0..1]
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: DeviceProfile.[n].protocol
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["SCCP", "Digital Access PRI", "H.225", "Analog Access", "Digital Access T1", "Route Point", "Unicast Bridge", "Multicast Point", "Inter-Cluster Trunk", "RAS", "Digital Access BRI", "SIP", "MGCP", "Static SIP Mobile Subscriber", "SIP Connector", "Remote Destination", "Mobile Smart Client", "Digital Access E1 R2", "CTI Remote Device", "Protocol Not Specified"]
Always Use Prime Line For Voice Message From the drop-down list box, choose one of the following options: On—If the phone is idle, the primary line on the phone becomes the active line for retrieving voice messages when the phone user presses the Messages button on the phone. Off—If the phone is idle, pressing the Messages button on the phone automatically dials the voice-messaging system from the line that has a voice message. Cisco Unified Communications Manager always selects the first line that has a voice message. If no line has a voice message, the primary line gets used when the phone user presses the Messages button. Default— Cisco Unified Communications Manager uses the configuration from the Always Use Prime Line for Voice Message service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: DeviceProfile.[n].alwaysUsePrimeLineForVoiceMessage
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
MLPP Domain ID If this user device profile will be used for MLPP precedence calls, choose the MLLP Domain from the drop-down list box. Note    You define MLPP domains in the MLPP Domain Configuration window. For access, choose System > MLPP Domain.
  • Field Name: DeviceProfile.[n].mlppDomainId
  • Type: String
  • Target: device/cucm/MlppDomain
  • Target attr: domainId
  • Cardinality: [0..1]
  • MaxLength: 128
  • Pattern: ^[0-9a-fA-F]{6}|-1$
  • Format: uri
Vendor Config
  • Field Name: vendorConfig
  • Type: ["Object", "Any"]
  • Cardinality: [0..1]
Always Use Prime Line From the drop-down list box, choose one of the following options: Off—When the phone is idle and receives a call on any line, the phone user answers the call from the line on which the call is received. On—When the phone is idle (off hook) and receives a call on any line, the primary line gets chosen for the call. Calls on other lines continue to ring, and the phone user must select those other lines to answer these calls. Default— Cisco Unified Communications Manager uses the configuration from the Always Use Prime Line service parameter, which supports the Cisco CallManager service. Default: Default
  • Field Name: DeviceProfile.[n].alwaysUsePrimeLine
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
User Hold MOH Audio Source To specify the audio source that plays when a user initiates a hold action, choose an audio source from the User Hold MOH Audio Source drop-down list box. If you do not choose an audio source, Cisco Unified Communications Manager uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. Note    You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: DeviceProfile.[n].userHoldMohAudioSourceId
  • Type: ["Integer", "String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Phone Button Template * From the Phone Button Template drop-down list, choose a phone button template. Tip    If you want to configure BLF/SpeedDials for the profile for presence monitoring, choose a phone button template that you configured for BLF/SpeedDials. After you save the configuration, the Add a New BLF SD link displays in the Association Information pane. For more information on BLF/SpeedDials, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: DeviceProfile.[n].phoneTemplateName
  • Type: String
  • Target: device/cucm/PhoneButtonTemplate
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Blf Directed Call Parks
  • Field Name: blfDirectedCallParks
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Blf Directed Call Park
  • Field Name: blfDirectedCallPark.[n]
  • Type: Array
Index
  • Field Name: DeviceProfile.[n].blfDirectedCallParks.blfDirectedCallPark.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Directed Call Park Dn And Partition
  • Field Name: directedCallParkDnAndPartition
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Route Partition Name
  • Field Name: DeviceProfile.[n].blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dn Pattern *
  • Field Name: DeviceProfile.[n].blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: ["String", "Null"]
  • Target: device/cucm/DirectedCallPark
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Label
  • Field Name: DeviceProfile.[n].blfDirectedCallParks.blfDirectedCallPark.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
MLPP Preemption If this user device profile will be used for MLPP precedence calls, assign an MLPP Preemption setting to the device profile. This setting specifies whether a device that can preempt calls in progress will use the capability when it places an MLPP precedence call. From the drop-down list box, choose a setting to assign to this device profile from the following options: Default—This device profile inherits its MLPP preemption setting from the device pool of the associated device. Disabled—This device does not allow preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Forceful—This device allows preemption of lower precedence calls to take place when necessary for completion of higher precedence calls. Note    Do not configure a device profile with the following combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is set to Forceful. Default: Default
  • Field Name: DeviceProfile.[n].preemption
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Disabled", "Forceful", "Default"]
Add On Modules Additional modules attached to the Phone.There can be 0,1 or 2.
  • Field Name: addOnModules
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Add On Module
  • Field Name: addOnModule.[n]
  • Type: Array
  • Cardinality: [0..2]
Load Information * Load Information is either the module's specific load information or the default load information.If any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
  • Field Name: DeviceProfile.[n].addOnModules.addOnModule.[n].loadInformation
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Model * Model ID string. Default: 7914 14-Button Line Expansion Module
  • Field Name: DeviceProfile.[n].addOnModules.addOnModule.[n].model
  • Type: String
  • Cardinality: [1..1]
  • Default: 7914 14-Button Line Expansion Module
  • Choices: ["Cisco 30 SP+", "Cisco 12 SP+", "Cisco 12 SP", "Cisco 12 S", "Cisco 30 VIP", "Cisco 7910", "Cisco 7960", "Cisco 7940", "Cisco 7935", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco ATA 186", "EMCC Base Phone", "SCCP Phone", "Analog Access", "Digital Access", "Digital Access+", "Digital Access WS-X6608", "Analog Access WS-X6624", "VGC Gateway", "Conference Bridge", "Conference Bridge WS-X6608", "Cisco IOS Conference Bridge (HDV2)", "Cisco Conference Bridge (WS-SVC-CMM)", "H.323 Phone", "H.323 Gateway", "Music On Hold", "Device Pilot", "CTI Port", "CTI Route Point", "Voice Mail Port", "Cisco IOS Software Media Termination Point (HDV2)", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Video Conference Bridge (IPVC-35xx)", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Route List", "Load Simulator", "Media Termination Point", "Media Termination Point Hardware", "Cisco IOS Media Termination Point (HDV2)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco 7941", "Cisco 7971", "MGCP Station", "MGCP Trunk", "GateKeeper", "7914 14-Button Line Expansion Module", "Trunk", "Tone Announcement Player", "SIP Trunk", "SIP Gateway", "WSM Trunk", "Remote Destination Profile", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "CKEM 36-Button Line Expansion Module", "SPA8800", "Unknown MGCP Gateway", "Unknown", "Cisco 7985", "Cisco 7911", "Cisco 7961G-GE", "Cisco 7941G-GE", "Motorola CN622", "Third-party SIP Device (Basic)", "Cisco 7931", "Cisco Unified Personal Communicator", "Cisco 7921", "Cisco 7906", "Third-party SIP Device (Advanced)", "Cisco TelePresence", "Nokia S60", "Cisco 7962", "Cisco 3951", "Cisco 7937", "Cisco 7942", "Cisco 7945", "Cisco 7965", "Cisco 7975", "Cisco 3911", "Cisco Unified Mobile Communicator", "Cisco TelePresence 1000", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 500-37", "Cisco 7925", "Cisco 9971", "Cisco 6921", "Cisco 6941", "Cisco 6961", "Cisco Unified Client Services Framework", "Cisco TelePresence 1300-65", "Cisco TelePresence 1100", "Transnova S3", "BlackBerry MVS VoWifi", "Cisco 9951", "Cisco 8961", "Cisco 6901", "Cisco 6911", "Cisco ATA 187", "Cisco TelePresence 200", "Cisco TelePresence 400", "Cisco Dual Mode for iPhone", "Cisco 6945", "Cisco Dual Mode for Android", "Cisco 7926", "Cisco E20", "Generic Single Screen Room System", "Generic Multiple Screen Room System", "Cisco TelePresence EX90", "Cisco 8945", "Cisco 8941", "Generic Desktop Video Endpoint", "Cisco TelePresence 500-32", "Cisco TelePresence 1300-47", "Cisco 3905", "Cisco Cius", "VKEM 36-Button Line Expansion Module", "Cisco TelePresence TX1310-65", "Cisco TelePresence MCU", "Ascom IP-DECT Device", "Cisco TelePresence Exchange System", "Cisco TelePresence EX60", "Cisco TelePresence Codec C90", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C40", "Cisco TelePresence Quick Set C20", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence MX200", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco 7821", "Cisco 7841", "Cisco 7861", "Cisco TelePresence SX20", "Cisco TelePresence MX300", "IMS-integrated Mobile (Basic)", "Third-party AS-SIP Endpoint", "Cisco Cius SP", "Cisco TelePresence Profile 42 (C40)", "Cisco VXC 6215", "CTI Remote Device", "Usage Profile", "Carrier-integrated Mobile", "Universal Device Template", "Cisco DX650", "Cisco Unified Communications for RTX", "Cisco Jabber for Tablet", "Cisco 8831", "Cisco ATA 190", "Cisco TelePresence SX10", "Cisco 8841", "Cisco 8851", "Cisco 8861", "Cisco TelePresence SX80", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300 G2", "Cisco 7905", "Cisco 7920", "Cisco 7970", "Cisco 7912", "Cisco 7902", "Cisco IP Communicator", "Cisco 7961", "Cisco 7936", "Analog Phone", "ISDN BRI Phone", "SCCP gateway virtual phone", "IP-STE", "Cisco TelePresence Conductor", "Cisco DX80", "Cisco DX70", "BEKEM 36-Button Line Expansion Module", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence IX5000", "Cisco 7811", "Cisco 8821", "Cisco 8811", "Interactive Voice Response", "Cisco 8845", "Cisco 8865", "Cisco TelePresence MX800 Dual", "Cisco 8851NR", "Cisco Spark Remote Device", "Cisco Webex DX80", "Cisco TelePresence DX70", "Cisco 7832", "Cisco 8865NR", "Cisco Meeting Server", "Cisco Webex Room Kit", "Cisco Webex Room 55", "Cisco Webex Room Kit Plus", "CP-8800-Video 28-Button Key Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "Cisco 8832", "Cisco Webex Room 70 Single", "Cisco 8832NR", "Cisco ATA 191", "Cisco Collaboration Mobile Convergence", "Cisco Webex Room 70 Dual", "Cisco Webex Room Kit Pro", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Single G2", "Cisco Webex Room 70 Dual G2", "SIP Station", "Cisco Webex Room Kit Mini", "Cisco Webex VDI Svc Framework", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex Desk Pro", "Cisco Webex Room Panorama", "Cisco Webex Room 70 Panorama", "Cisco Webex Room Phone", "Cisco 860", "Cisco Webex Desk LE"]
Module1 You can configure one or two expansion modules for this device profile by choosing phone templates from the expansion module drop-down lists in the expansion module fields. Note    You can view a phone button list at any time by choosing the View button list link next to the phone button template fields. A separate dialog box pops up and displays the phone buttons for that particular expansion module. Choose the appropriate expansion module or None.
  • Field Name: DeviceProfile.[n].addOnModules.addOnModule.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Single Button Barge From the drop-down list box, choose from the following options: Off—This device does not allow users to use the Single Button Barge/cBarge feature. Barge—Choosing this option allows users to press the Single Button Barge shared-line button on the phone to barge into a call using Barge. Default—This device inherits the Single Button Barge/cBarge setting from the service parameter and device pool settings. Note    If the server parameter and device pool settings are different, the device will inherit the setting from the service parameter setting. For more information, see the Cisco Unified Communications Manager Features and Services Guide. Default: Default
  • Field Name: DeviceProfile.[n].singleButtonBarge
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "Barge", "CBarge", "Default"]
Feature Control Policy This tag is valid only for RT Phones.
  • Field Name: DeviceProfile.[n].featureControlPolicy
  • Type: ["String", "Null"]
  • Target: device/cucm/FeatureControlPolicy
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
MLPP Indication If this user device profile will be used for MLPP precedence calls, assign an MLPP Indication setting to the device profile. This setting specifies whether a device that can play precedence tones will use the capability when it places an MLPP precedence call. From the drop-down list box, choose a setting to assign to this device profile from the following options: Default—This device profile inherits its MLPP indication setting from the device pool of the associated device. Off—This device does not handle nor process indication of an MLPP precedence call. On—This device profile does handle and process indication of an MLPP precedence call. Note    Do not configure a device profile with the following combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is set to Forceful. Default: Off
  • Field Name: DeviceProfile.[n].mlppIndicationStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Off
  • Choices: ["Off", "On", "Default"]
Busy Lamp Fields
  • Field Name: busyLampFields
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Busy Lamp Field
  • Field Name: busyLampField.[n]
  • Type: Array
Index
  • Field Name: DeviceProfile.[n].busyLampFields.busyLampField.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Blf Dest Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: DeviceProfile.[n].busyLampFields.busyLampField.[n].blfDest
  • Type: String
  • Cardinality: [1..1]
Call Pickup
  • Field Name: DeviceProfile.[n].busyLampFields.busyLampField.[n].callPickup
  • Type: Boolean
Label
  • Field Name: DeviceProfile.[n].busyLampFields.busyLampField.[n].label
  • Type: String
  • Cardinality: [0..1]
Route Partition
  • Field Name: DeviceProfile.[n].busyLampFields.busyLampField.[n].routePartition
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Blf Dirn Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
  • Field Name: DeviceProfile.[n].busyLampFields.busyLampField.[n].blfDirn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Type Device profile Type string. Read Only
  • Field Name: DeviceProfile.[n].type
  • Type: String
  • Cardinality: [0..1]
Product * Product ID string. read-only except when creating a device.
  • Field Name: DeviceProfile.[n].product
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["7914 14-Button Line Expansion Module", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "AIM-VOICE-30", "Analog Phone", "Annunciator", "BEKEM 36-Button Line Expansion Module", "C881V", "C887VA-V", "CKEM 36-Button Line Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "CP-8800-Video 28-Button Key Expansion Module", "CTI Port", "CTI Remote Device", "CTI Route Point", "Carrier-integrated Mobile", "Cisco IAD2400", "Cisco 12 S", "Cisco 12 SP", "Cisco 12 SP+", "Cisco 1751", "Cisco 1760", "Cisco 1861", "Cisco 269X", "Cisco 26XX", "Cisco 2801", "Cisco 2811", "Cisco 2821", "Cisco 2851", "Cisco 2901", "Cisco 2911", "Cisco 2921", "Cisco 2951", "Cisco 30 SP+", "Cisco 30 VIP", "Cisco 362X", "Cisco 364X", "Cisco 366X", "Cisco 3725", "Cisco 3745", "Cisco 3825", "Cisco 3845", "Cisco 3905", "Cisco 3911", "Cisco 3925", "Cisco 3925E", "Cisco 3945", "Cisco 3945E", "Cisco 3951", "Cisco 6901", "Cisco 6911", "Cisco 6921", "Cisco 6941", "Cisco 6945", "Cisco 6961", "Cisco 7811", "Cisco 7821", "Cisco 7832", "Cisco 7841", "Cisco 7861", "Cisco 7902", "Cisco 7905", "Cisco 7906", "Cisco 7910", "Cisco 7911", "Cisco 7912", "Cisco 7920", "Cisco 7921", "Cisco 7925", "Cisco 7926", "Cisco 7931", "Cisco 7935", "Cisco 7936", "Cisco 7937", "Cisco 7940", "Cisco 7941", "Cisco 7941G-GE", "Cisco 7942", "Cisco 7945", "Cisco 7960", "Cisco 7961", "Cisco 7961G-GE", "Cisco 7962", "Cisco 7965", "Cisco 7970", "Cisco 7971", "Cisco 7975", "Cisco 7985", "Cisco 860", "Cisco 881", "Cisco 8811", "Cisco 8821", "Cisco 8831", "Cisco 8832", "Cisco 8832NR", "Cisco 8841", "Cisco 8845", "Cisco 8851", "Cisco 8851NR", "Cisco 8861", "Cisco 8865", "Cisco 8865NR", "Cisco 888/887/886", "Cisco 8941", "Cisco 8945", "Cisco 8961", "Cisco 9951", "Cisco 9971", "Cisco ATA 186", "Cisco ATA 187", "Cisco ATA 190", "Cisco ATA 191", "Cisco C8200/L-1N-4T", "Cisco C8300-1N1S-4T2X", "Cisco C8300-1N1S-6T", "Cisco C8300-2N2S-4T2X/6T", "Cisco Catalyst 4000 Access Gateway Module", "Cisco Catalyst 4224 Voice Gateway Switch", "Cisco Catalyst 6000 12 port FXO Gateway", "Cisco Catalyst 6000 24 port FXS Gateway", "Cisco Catalyst 6000 E1 VoIP Gateway", "Cisco Catalyst 6000 T1 VoIP Gateway", "Cisco Cius", "Cisco Cius SP", "Cisco Collaboration Mobile Convergence", "Cisco Conference Bridge (WS-SVC-CMM)", "Cisco Conference Bridge Hardware", "Cisco Conference Bridge Software", "Cisco DX650", "Cisco DX70", "Cisco DX80", "Cisco Dual Mode for Android", "Cisco Dual Mode for iPhone", "Cisco E20", "Cisco ENCS 5400 ISRV", "Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge", "Cisco IOS Enhanced Media Termination Point", "Cisco IOS Enhanced Software Media Termination Point", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Cisco IOS Media Termination Point", "Cisco IP Communicator", "Cisco ISR 4321", "Cisco ISR 4331", "Cisco ISR 4351", "Cisco ISR 4431", "Cisco ISR 4451", "Cisco ISR 4461", "Cisco Jabber for Tablet", "Cisco MGCP BRI Port", "Cisco MGCP E1 Port", "Cisco MGCP FXO Port", "Cisco MGCP FXS Port", "Cisco MGCP T1 Port", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco Media Termination Point Hardware", "Cisco Media Termination Point Software", "Cisco Meeting Server", "Cisco SIP FXS Port", "Cisco Spark Remote Device", "Cisco TelePresence", "Cisco TelePresence 1000", "Cisco TelePresence 1100", "Cisco TelePresence 1300-47", "Cisco TelePresence 1300-65", "Cisco TelePresence 200", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 400", "Cisco TelePresence 500-32", "Cisco TelePresence 500-37", "Cisco TelePresence Codec C40", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C90", "Cisco TelePresence Conductor", "Cisco TelePresence DX70", "Cisco TelePresence EX60", "Cisco TelePresence EX90", "Cisco TelePresence Exchange System", "Cisco TelePresence IX5000", "Cisco TelePresence MCU", "Cisco TelePresence MX200", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300", "Cisco TelePresence MX300 G2", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence MX800 Dual", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C40)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence Quick Set C20", "Cisco TelePresence SX10", "Cisco TelePresence SX20", "Cisco TelePresence SX80", "Cisco TelePresence TX1310-65", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco Unified Client Services Framework", "Cisco Unified Communications for RTX", "Cisco Unified Mobile Communicator", "Cisco Unified Personal Communicator", "Cisco VG200", "Cisco VG248 Gateway", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco VGD-1T3", "Cisco VXC 6215", "Cisco Video Conference Bridge(IPVC-35xx)", "Cisco Voice Mail Port", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex DX80", "Cisco Webex Desk LE", "Cisco Webex Desk Pro", "Cisco Webex Room 55", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Dual", "Cisco Webex Room 70 Dual G2", "Cisco Webex Room 70 Panorama", "Cisco Webex Room 70 Single", "Cisco Webex Room 70 Single G2", "Cisco Webex Room Kit", "Cisco Webex Room Kit Mini", "Cisco Webex Room Kit Plus", "Cisco Webex Room Kit Pro", "Cisco Webex Room Panorama", "Cisco Webex Room Phone", "Cisco Webex VDI Svc Framework", "Communication Media Module", "EMCC Base Phone", "FLEX_SLOT", "Gatekeeper", "Generic Desktop Video Endpoint", "Generic Multiple Screen Room System", "Generic Single Screen Room System", "H.225 Trunk (Gatekeeper Controlled)", "H.323 Client", "H.323 Gateway", "Hunt List", "IAD2400_ANALOG", "IAD2400_DIGITAL", "IMS-integrated Mobile (Basic)", "IP-STE", "ISDN BRI Phone", "Inter-Cluster Trunk (Gatekeeper Controlled)", "Inter-Cluster Trunk (Non-Gatekeeper Controlled)", "Interactive Voice Response", "Load Simulator", "Motorola CN622", "Music On Hold", "NM-1V", "NM-2V", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT", "NM-HDV2-2PORT", "Nokia S60", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "Pilot", "Remote Destination Profile", "Route List", "SCCP Device", "SCCP gateway virtual phone", "SIP Trunk", "SIP WSM Connection", "SPA8800", "Third-party AS-SIP Endpoint", "Third-party SIP Device (Advanced)", "Third-party SIP Device (Basic)", "Transnova S3", "Universal Device Template", "Unknown", "VG202", "VG204", "VG224", "VG310", "VG320", "VG350", "VG400", "VG420", "VG450", "VGC Port", "VIC_SLOT", "VKEM 36-Button Line Expansion Module", "VNM-HDA", "VWIC_SLOT", "WS-SVC-CMM-MS", "WS-X6600"]
Description Enter a description of the device profile. For text, use anything that describes this particular user device profile.
  • Field Name: DeviceProfile.[n].description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Trace Flag
  • Field Name: DeviceProfile.[n].traceFlag
  • Type: Boolean
  • Cardinality: [0..1]
Ignore Presentation Indicators (internal calls only) To configure call display restrictions and ignore any presentation restriction that is received for internal calls, check the "Ignore Presentation Indicators (internal calls only)" check box. Tip    Use this configuration in combination with the calling line ID presentation and connected line ID presentation configuration at the translation pattern level. Together, these settings allow you to configure call display restrictions to selectively present or block calling and/or connected line display information for each call. For more information about call display restrictions, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: DeviceProfile.[n].ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
User Locale From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information, including language and font, to support users. Cisco Unified Communications Manager makes this field available only for phone models that support localization. Note    If no user locale is specified, Cisco Unified Communications Manager uses the user locale that is associated with the device pool. Note    If the users require information to display (on the phone) in any language other than English, verify that the locale installer is installed before configuring user locale. See the Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: DeviceProfile.[n].userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Join Across Lines From the drop-down list box, choose from the following options: Off—This device does not allow users to use the Join Across Lines feature. On—This device allows users to join calls across multiple lines. Default—This device inherits the Join Across Lines setting from the service parameter and device pool settings. Note    If the server parameter and device pool settings are different, the device will inherit the setting from the service parameter setting. For more information, see the Cisco Unified Communications Manager System Guide. Default: Default
  • Field Name: DeviceProfile.[n].joinAcrossLines
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Speeddials
  • Field Name: speeddials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Speeddial
  • Field Name: speeddial.[n]
  • Type: Array
Index
  • Field Name: DeviceProfile.[n].speeddials.speeddial.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Dirn *
  • Field Name: DeviceProfile.[n].speeddials.speeddial.[n].dirn
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Label
  • Field Name: DeviceProfile.[n].speeddials.speeddial.[n].label
  • Type: String
  • Cardinality: [1..1]
Class * Class ID string. Class information is read-only except when creating a device. Default: Device Profile
  • Field Name: DeviceProfile.[n].class
  • Type: String
  • Cardinality: [1..1]
  • Default: Device Profile
  • Choices: ["Phone", "Gateway", "Conference Bridge", "Media Termination Point", "Route List", "Voice Mail", "CTI Route Point", "Music On Hold", "Simulation", "Pilot", "GateKeeper", "Add-on modules", "Hidden Phone", "Trunk", "Tone Announcement Player", "Remote Destination Profile", "EMCC Base Phone Template", "EMCC Base Phone", "Remote Destination Profile Template", "Gateway Template", "UDP Template", "Phone Template", "Device Profile", "Invalid", "Interactive Voice Response"]
DND Option When you enable DND on the phone, this parameter allows you to specify how the DND feature handles incoming calls: Call Reject—This option specifies that no incoming call information gets presented to the user. Depending on how you configure the DND Incoming Call Alert parameter, the phone may play a beep or display a flash notification of the call. Ringer Off—This option turns off the ringer, but incoming call information gets presented to the device, so that the user can accept the call. Use Common Phone Profile Setting—This option specifies that the DND Option setting from the Common Phone Profile window will get used for this device. Note    For 7940/7960 phones that are running SCCP, you can only choose the Ringer Off option. For mobile devices and dual-mode phones, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. Default: Ringer Off
  • Field Name: DeviceProfile.[n].dndOption
  • Type: String
  • Cardinality: [0..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
Do Not Disturb Check this check box to enable Do Not Disturb.
  • Field Name: DeviceProfile.[n].dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Name * The device name,using only URL-friendly characters
  • Field Name: DeviceProfile.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
DND Incoming Call Alert When you enable the DND Ringer Off or Call Reject option, this parameter specifies how a call displays on a phone. From the drop-down list, choose one of the following options: None—This option specifies that the DND Incoming Call Alert setting from the Common Phone Profile window will get used for this device. Disable—This option disables both beep and flash notification of a call but for the DND Ringer Off option, incoming call information still gets displayed. For the DND Call Reject option, no call alerts display and no information gets sent to the device. Beep Only—For an incoming call, this option causes the phone to play a beep tone only. Flash Only—For an incoming call, this option causes the phone to display a flash alert.
  • Field Name: DeviceProfile.[n].dndRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["Beep Only", "Flash Only", "Disable"]
Softkey Template From the Softkey Template drop-down list box, choose the softkey template from the list that displays.
  • Field Name: DeviceProfile.[n].softkeyTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/SoftKeyTemplate
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: DeviceProfile.[n].protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
Privacy From the Privacy drop-down list box, choose On for each phone on which you want privacy. For more information, see the Cisco Unified Communications Manager Features and Services Guide. Default: Default
  • Field Name: DeviceProfile.[n].callInfoPrivacyStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Lines
  • Field Name: lines
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Line An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
  • Field Name: line.[n]
  • Type: Array
Display Ascii
  • Field Name: DeviceProfile.[n].lines.line.[n].displayAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Associated Endusers
  • Field Name: associatedEndusers
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Enduser
  • Field Name: enduser.[n]
  • Type: Array
User Id *
  • Field Name: DeviceProfile.[n].lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
Ring Setting Default: Ring
  • Field Name: DeviceProfile.[n].lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: DeviceProfile.[n].lines.line.[n].consecutiveRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Recording Profile Name
  • Field Name: DeviceProfile.[n].lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/RecordingProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Index
  • Field Name: DeviceProfile.[n].lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: DeviceProfile.[n].lines.line.[n].ringSettingActivePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Link To Line Link to the line resource
  • Field Name: DeviceProfile.[n].lines.line.[n].line_link
  • Type: String
  • Format: link
Label
  • Field Name: DeviceProfile.[n].lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: DeviceProfile.[n].lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: DeviceProfile.[n].lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Partition Usage This tag cannot be modified. It can only be specified in the add request. Default: General
  • Field Name: DeviceProfile.[n].lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Recording Flag Default: Call Recording Disabled
  • Field Name: DeviceProfile.[n].lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
  • Default: Call Recording Disabled
  • Choices: ["Call Recording Disabled", "Automatic Call Recording Enabled", "Selective Call Recording Enabled"]
Speed Dial
  • Field Name: DeviceProfile.[n].lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: DeviceProfile.[n].lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
E164Mask
  • Field Name: DeviceProfile.[n].lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: DeviceProfile.[n].lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: DeviceProfile.[n].lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: DeviceProfile.[n].lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: DeviceProfile.[n].lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: DeviceProfile.[n].lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Inventory Filter Default: default
  • Field Name: DeviceProfile.[n].lines.line.[n].dirn.line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers (Site Only)", "Show Unused Numbers", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Pattern *
  • Field Name: DeviceProfile.[n].lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: DeviceProfile.[n].lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mwl Policy Default: Use System Policy
  • Field Name: DeviceProfile.[n].lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Policy
  • Choices: ["Use System Policy", "Light and Prompt", "Prompt Only", "Light Only", "None"]
Ring Setting Idle Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: DeviceProfile.[n].lines.line.[n].ringSettingIdlePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: DeviceProfile.[n].lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: DeviceProfile.[n].lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: DeviceProfile.[n].lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Services
  • Field Name: services
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Service
  • Field Name: service.[n]
  • Type: Array
Name *
  • Field Name: DeviceProfile.[n].services.service.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 100
Url
  • Field Name: DeviceProfile.[n].services.service.[n].url
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Service Name Ascii
  • Field Name: DeviceProfile.[n].services.service.[n].serviceNameAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Url Button Index
  • Field Name: DeviceProfile.[n].services.service.[n].urlButtonIndex
  • Type: Integer
  • Cardinality: [0..1]
Telecaster Service Name *
  • Field Name: DeviceProfile.[n].services.service.[n].telecasterServiceName
  • Type: String
  • Cardinality: [1..1]
Url Label
  • Field Name: DeviceProfile.[n].services.service.[n].urlLabel
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Login User Id From the Login User ID drop-down list box, choose a valid login user ID. Note    If the device profile is used as a logout profile, specify the login user ID that will be associated with the phone. After the user logs out from this user device profile, the phone will automatically log in to this login user ID.
  • Field Name: DeviceProfile.[n].loginUserId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Extension Mobility Cross Cluster CSS From the drop-down list box, choose an existing Calling Search Space (CSS) to use for this device profile for the Extension Mobility Cross Cluster feature. (To configure a new CSS or modify an existing CSS, choose Call Routing > Class of Control > Calling Search Space in Cisco Unified Communications Manager Administration.) Default value specifies None. The home administrator specifies this CSS, which gets used as the device CSS that gets assigned to the phone when the user logs in to this remote phone. For more information, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: DeviceProfile.[n].emccCallingSearchSpace
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Remote Destination Profile
  • Field Name: RemoteDestinationProfile.[n]
  • Type: Array
  • Cardinality: [0..1]
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: RemoteDestinationProfile.[n].protocol
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["SCCP", "Digital Access PRI", "H.225", "Analog Access", "Digital Access T1", "Route Point", "Unicast Bridge", "Multicast Point", "Inter-Cluster Trunk", "RAS", "Digital Access BRI", "SIP", "MGCP", "Static SIP Mobile Subscriber", "SIP Connector", "Remote Destination", "Mobile Smart Client", "Digital Access E1 R2", "CTI Remote Device", "Protocol Not Specified"]
Network Hold MOH Audio Source Choose the audio source from the IOS gateway that provides multicasting audio source for Cisco Unified Mobility and Mobile Voice Access calls.
  • Field Name: RemoteDestinationProfile.[n].networkHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
User ID * Choose the user to whom this profile is assigned. The selection must match the ID of a user in the End User Configuration window where Enable Mobility is checked.
  • Field Name: RemoteDestinationProfile.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
User Hold Audio Source Choose the audio option for users on hold for Cisco Unified Mobility and Mobile Voice Access calls.
  • Field Name: RemoteDestinationProfile.[n].userHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Calling Search Space Choose the calling search space to be used for routing Mobile Voice Access or Enterprise Feature Access calls. Note    This calling search space setting applies only when you are routing calls from the remote destination, which specifies the outbound call leg to the dialed number for Mobile Voice Access and Enterprise Feature Access calls.
  • Field Name: RemoteDestinationProfile.[n].callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Mobile Smart Client Profile Name
  • Field Name: RemoteDestinationProfile.[n].mobileSmartClientProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/MobileSmartClientProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Locale
  • Field Name: RemoteDestinationProfile.[n].networkLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/Country
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["Argentina", "Australia", "Austria", "Belgium", "Brazil", "Canada", "China", "Colombia", "Cyprus", "Czech Republic", "Denmark", "Egypt", "Finland", "France", "Germany", "Ghana", "Greece", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Japan", "Jordan", "Kenya", "Korea Republic", "Lebanon", "Luxembourg", "Malaysia", "Mexico", "Nepal", "Netherlands", "New Zealand", "Nigeria", "Norway", "Pakistan", "Panama", "Peru", "Philippines", "Poland", "Portugal", "Russian Federation", "Saudi Arabia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sweden", "Switzerland", "Taiwan", "Thailand", "Turkey", "United Kingdom", "United States", "Venezuela", "Zimbabwe", "Itu", "Chile", "Bulgaria", "Croatia", "Romania", "Serbia and Montenegro", "United Arab Emirates", "Oman", "Kuwait", "Algeria", "Bahrain", "Iraq", "Mauritania", "Republic of Montenegro", "Morocco", "Qatar", "Republic of Serbia", "Sudan", "Tunisia", "Vietnam", "Yemen", "Lithuania", "Latvia", "Estonia", "Ukraine"]
Use Device Pool Calling Party Transformation CSS To use the Calling Party Transformation CSS that is configured in the device pool that is assigned to this device, check this check box. If you do not check this check box, the device uses the Calling Party Transformation CSS that you configured in the Remote Destination Profile Configuration window. Default: True
  • Field Name: RemoteDestinationProfile.[n].useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Product * Product ID string. read-only except when creating a device.
  • Field Name: RemoteDestinationProfile.[n].product
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["7914 14-Button Line Expansion Module", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "AIM-VOICE-30", "Analog Phone", "Annunciator", "BEKEM 36-Button Line Expansion Module", "C881V", "C887VA-V", "CKEM 36-Button Line Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "CP-8800-Video 28-Button Key Expansion Module", "CTI Port", "CTI Remote Device", "CTI Route Point", "Carrier-integrated Mobile", "Cisco IAD2400", "Cisco 12 S", "Cisco 12 SP", "Cisco 12 SP+", "Cisco 1751", "Cisco 1760", "Cisco 1861", "Cisco 269X", "Cisco 26XX", "Cisco 2801", "Cisco 2811", "Cisco 2821", "Cisco 2851", "Cisco 2901", "Cisco 2911", "Cisco 2921", "Cisco 2951", "Cisco 30 SP+", "Cisco 30 VIP", "Cisco 362X", "Cisco 364X", "Cisco 366X", "Cisco 3725", "Cisco 3745", "Cisco 3825", "Cisco 3845", "Cisco 3905", "Cisco 3911", "Cisco 3925", "Cisco 3925E", "Cisco 3945", "Cisco 3945E", "Cisco 3951", "Cisco 6901", "Cisco 6911", "Cisco 6921", "Cisco 6941", "Cisco 6945", "Cisco 6961", "Cisco 7811", "Cisco 7821", "Cisco 7832", "Cisco 7841", "Cisco 7861", "Cisco 7902", "Cisco 7905", "Cisco 7906", "Cisco 7910", "Cisco 7911", "Cisco 7912", "Cisco 7920", "Cisco 7921", "Cisco 7925", "Cisco 7926", "Cisco 7931", "Cisco 7935", "Cisco 7936", "Cisco 7937", "Cisco 7940", "Cisco 7941", "Cisco 7941G-GE", "Cisco 7942", "Cisco 7945", "Cisco 7960", "Cisco 7961", "Cisco 7961G-GE", "Cisco 7962", "Cisco 7965", "Cisco 7970", "Cisco 7971", "Cisco 7975", "Cisco 7985", "Cisco 860", "Cisco 881", "Cisco 8811", "Cisco 8821", "Cisco 8831", "Cisco 8832", "Cisco 8832NR", "Cisco 8841", "Cisco 8845", "Cisco 8851", "Cisco 8851NR", "Cisco 8861", "Cisco 8865", "Cisco 8865NR", "Cisco 888/887/886", "Cisco 8941", "Cisco 8945", "Cisco 8961", "Cisco 9951", "Cisco 9971", "Cisco ATA 186", "Cisco ATA 187", "Cisco ATA 190", "Cisco ATA 191", "Cisco C8200/L-1N-4T", "Cisco C8300-1N1S-4T2X", "Cisco C8300-1N1S-6T", "Cisco C8300-2N2S-4T2X/6T", "Cisco Catalyst 4000 Access Gateway Module", "Cisco Catalyst 4224 Voice Gateway Switch", "Cisco Catalyst 6000 12 port FXO Gateway", "Cisco Catalyst 6000 24 port FXS Gateway", "Cisco Catalyst 6000 E1 VoIP Gateway", "Cisco Catalyst 6000 T1 VoIP Gateway", "Cisco Cius", "Cisco Cius SP", "Cisco Collaboration Mobile Convergence", "Cisco Conference Bridge (WS-SVC-CMM)", "Cisco Conference Bridge Hardware", "Cisco Conference Bridge Software", "Cisco DX650", "Cisco DX70", "Cisco DX80", "Cisco Dual Mode for Android", "Cisco Dual Mode for iPhone", "Cisco E20", "Cisco ENCS 5400 ISRV", "Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge", "Cisco IOS Enhanced Media Termination Point", "Cisco IOS Enhanced Software Media Termination Point", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Cisco IOS Media Termination Point", "Cisco IP Communicator", "Cisco ISR 4321", "Cisco ISR 4331", "Cisco ISR 4351", "Cisco ISR 4431", "Cisco ISR 4451", "Cisco ISR 4461", "Cisco Jabber for Tablet", "Cisco MGCP BRI Port", "Cisco MGCP E1 Port", "Cisco MGCP FXO Port", "Cisco MGCP FXS Port", "Cisco MGCP T1 Port", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco Media Termination Point Hardware", "Cisco Media Termination Point Software", "Cisco Meeting Server", "Cisco SIP FXS Port", "Cisco Spark Remote Device", "Cisco TelePresence", "Cisco TelePresence 1000", "Cisco TelePresence 1100", "Cisco TelePresence 1300-47", "Cisco TelePresence 1300-65", "Cisco TelePresence 200", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 400", "Cisco TelePresence 500-32", "Cisco TelePresence 500-37", "Cisco TelePresence Codec C40", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C90", "Cisco TelePresence Conductor", "Cisco TelePresence DX70", "Cisco TelePresence EX60", "Cisco TelePresence EX90", "Cisco TelePresence Exchange System", "Cisco TelePresence IX5000", "Cisco TelePresence MCU", "Cisco TelePresence MX200", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300", "Cisco TelePresence MX300 G2", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence MX800 Dual", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C40)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence Quick Set C20", "Cisco TelePresence SX10", "Cisco TelePresence SX20", "Cisco TelePresence SX80", "Cisco TelePresence TX1310-65", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco Unified Client Services Framework", "Cisco Unified Communications for RTX", "Cisco Unified Mobile Communicator", "Cisco Unified Personal Communicator", "Cisco VG200", "Cisco VG248 Gateway", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco VGD-1T3", "Cisco VXC 6215", "Cisco Video Conference Bridge(IPVC-35xx)", "Cisco Voice Mail Port", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex DX80", "Cisco Webex Desk LE", "Cisco Webex Desk Pro", "Cisco Webex Room 55", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Dual", "Cisco Webex Room 70 Dual G2", "Cisco Webex Room 70 Panorama", "Cisco Webex Room 70 Single", "Cisco Webex Room 70 Single G2", "Cisco Webex Room Kit", "Cisco Webex Room Kit Mini", "Cisco Webex Room Kit Plus", "Cisco Webex Room Kit Pro", "Cisco Webex Room Panorama", "Cisco Webex Room Phone", "Cisco Webex VDI Svc Framework", "Communication Media Module", "EMCC Base Phone", "FLEX_SLOT", "Gatekeeper", "Generic Desktop Video Endpoint", "Generic Multiple Screen Room System", "Generic Single Screen Room System", "H.225 Trunk (Gatekeeper Controlled)", "H.323 Client", "H.323 Gateway", "Hunt List", "IAD2400_ANALOG", "IAD2400_DIGITAL", "IMS-integrated Mobile (Basic)", "IP-STE", "ISDN BRI Phone", "Inter-Cluster Trunk (Gatekeeper Controlled)", "Inter-Cluster Trunk (Non-Gatekeeper Controlled)", "Interactive Voice Response", "Load Simulator", "Motorola CN622", "Music On Hold", "NM-1V", "NM-2V", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT", "NM-HDV2-2PORT", "Nokia S60", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "Pilot", "Remote Destination Profile", "Route List", "SCCP Device", "SCCP gateway virtual phone", "SIP Trunk", "SIP WSM Connection", "SPA8800", "Third-party AS-SIP Endpoint", "Third-party SIP Device (Advanced)", "Third-party SIP Device (Basic)", "Transnova S3", "Universal Device Template", "Unknown", "VG202", "VG204", "VG224", "VG310", "VG320", "VG350", "VG400", "VG420", "VG450", "VGC Port", "VIC_SLOT", "VKEM 36-Button Line Expansion Module", "VNM-HDA", "VWIC_SLOT", "WS-SVC-CMM-MS", "WS-X6600"]
Description Enter a text description of the remote destination profile. This field can comprise up to 128 characters. You can use all characters except quotes (“), close angle bracket (>), open angle bracket (<), backslash (\), ampersand (&), and percent sign (%).
  • Field Name: RemoteDestinationProfile.[n].description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ignore Presentation Indicators (internal calls only) Check the check box if you want to ignore the connected line ID presentation. Use this configuration for internal calls.
  • Field Name: RemoteDestinationProfile.[n].ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
User Locale From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information, including language and font, to support users. Cisco Unified Communications Manager makes this field available only for phone models that support localization. Note    If the users require information to display (on the phone) in any language other than English, verify that the locale installer is installed before you configure user locale. See the Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: RemoteDestinationProfile.[n].userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Class * Class ID string. Class information is read-only except when creating a device.
  • Field Name: RemoteDestinationProfile.[n].class
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["Phone", "Gateway", "Conference Bridge", "Media Termination Point", "Route List", "Voice Mail", "CTI Route Point", "Music On Hold", "Simulation", "Pilot", "GateKeeper", "Add-on modules", "Hidden Phone", "Trunk", "Tone Announcement Player", "Remote Destination Profile", "EMCC Base Phone Template", "EMCC Base Phone", "Remote Destination Profile Template", "Gateway Template", "UDP Template", "Phone Template", "Device Profile", "Invalid", "Interactive Voice Response"]
Primary Phone Name
  • Field Name: RemoteDestinationProfile.[n].primaryPhoneName
  • Type: ["String", "Null"]
  • Target: device/cucm/Phone
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dnd Option This Call Reject option specifies that no incoming call information gets presented to the user. Note    For mobile devices, dual-mode phones, and phones that are running SCCP, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. Default: Ringer Off
  • Field Name: RemoteDestinationProfile.[n].dndOption
  • Type: String
  • Cardinality: [0..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
Dnd Status Check this check box to enable Do Not Disturb on the phone.
  • Field Name: RemoteDestinationProfile.[n].dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Name * Enter a text name for the remote destination profile. This name can comprise up to 50 characters. Valid characters include letters, numbers, dashes, dots (periods), spaces, and underscores.
  • Field Name: RemoteDestinationProfile.[n].name
  • Type: String
  • Cardinality: [1..1]
Privacy * Choose a privacy option for the remote destination profile. If you choose the Default value for this field, the setting matches the value of the Privacy Setting service parameter. Note    If you change and save the value of the Privacy Setting service parameter, you must return to the Remote Destination Profile Configuration window for a remote destination profile that specifies Default and click Save for the service parameter change to take effect. Note    You cannot transfer a call from a cell phone to a desk phone if the Remote Destination Profile Privacy specifies On, and the "Enforce Privacy Setting on Held Calls" service parameter specifies True. Default: Default
  • Field Name: RemoteDestinationProfile.[n].callInfoPrivacyStatus
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Rerouting Calling Search Space Choose a calling search space to be used to route Cisco Unified Mobility calls. Note    Ensure that the gateway that is configured for routing mobile calls is assigned to the partition that belongs to the Rerouting Calling Search Space. Cisco Unified Communications Manager determines how to route calls based on the remote destination number and the Rerouting Calling Search Space. Note    The Rerouting Calling Search Space setting applies only when you are routing calls to the remote destination or mobility identity, which specifies the outbound call leg toward the remote destination or mobility identity when a call comes in to the user enterprise number. Note    Cisco Unified Mobility calls do not get routed to the dual-mode mobility identity number that corresponds to the dual-mode mobile phone number if the device associates with the enterprise WLAN and registers with Cisco Unified Communications Manager. Cisco Unified Mobility calls get routed to the dual-mode mobility identity number only when the device is outside the enterprise.
  • Field Name: RemoteDestinationProfile.[n].rerouteCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: RemoteDestinationProfile.[n].protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
Lines
  • Field Name: lines
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Line An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
  • Field Name: line.[n]
  • Type: Array
Display Ascii
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].displayAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Associated Endusers
  • Field Name: associatedEndusers
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Enduser
  • Field Name: enduser.[n]
  • Type: Array
User Id *
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
Ring Setting Default: Ring
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].consecutiveRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Recording Profile Name
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Index
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].ringSettingActivePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Label
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Partition Usage This tag cannot be modified. It can only be specified in the add request. Default: General
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Recording Flag Default: Call Recording Disabled
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
  • Default: Call Recording Disabled
  • Choices: ["Call Recording Disabled", "Automatic Call Recording Enabled", "Selective Call Recording Enabled"]
Speed Dial
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
E164Mask
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Inventory Filter Default: default
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].dirn.line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers (Site Only)", "Show Unused Numbers", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Pattern *
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mwl Policy Default: Use System Policy
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Policy
  • Choices: ["Use System Policy", "Light and Prompt", "Prompt Only", "Light Only", "None"]
Ring Setting Idle Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].ringSettingIdlePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: RemoteDestinationProfile.[n].lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Calling Party Transformation CSS Choose the calling search space for transformations. This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device. Note    The partitions in the calling search space should contain only calling party transformations. Note    Ensure the calling search space is not null because no transformations can apply to null partitions. Note    The device takes on the attributes of the Calling Party Transformation Pattern because you assign the pattern to a partition where the Calling Party Transformation CSS exists. For example, when you configure the Calling Party Transformation CSS under Call Routing > Class of Control > Calling Search Space, you assign the CSS to a partition; when you configure the Calling Party Transformation CSS under Call Routing > Transformation Pattern > Calling Party Transformation Pattern, you choose the partition where the Calling Party Transformation CSS is assigned.
  • Field Name: RemoteDestinationProfile.[n].cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Search Space AAR Choose a calling search space to be used to route Cisco Unified Mobility calls. Note    Ensure that the gateway that is configured for routing mobile calls is assigned to the partition that belongs to the Rerouting Calling Search Space. Cisco Unified Communications Manager determines how to route calls based on the remote destination number and the Rerouting Calling Search Space. Note    The Rerouting Calling Search Space setting applies only when you are routing calls to the remote destination or mobility identity, which specifies the outbound call leg toward the remote destination or mobility identity when a call comes in to the user enterprise number. Note    Cisco Unified Mobility calls do not get routed to the dual-mode mobility identity number that corresponds to the dual-mode mobile phone number if the device associates with the enterprise WLAN and registers with Cisco Unified Communications Manager. Cisco Unified Mobility calls get routed to the dual-mode mobility identity number only when the device is outside the enterprise.
  • Field Name: RemoteDestinationProfile.[n].automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Pool * Choose the device pool that applies to this profile. The device pool defines sets of common characteristics for devices, such as region, date/time group, softkey template, and MLPP information.
  • Field Name: RemoteDestinationProfile.[n].devicePoolName
  • Type: ["String", "Null"]
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Remote Destination Rdp
  • Field Name: RemoteDestinationRDP.[n]
  • Type: Array
Enable Extend And Connect While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].enableExtendAndConnect
  • Type: Boolean
  • Cardinality: [0..1]
Dial Via Office Reverse Voicemail Configures how dual mode device users answer Dial-via-Office Reverse (DVO-R) calls that terminate on the Mobile Identity (MI). This feature provides users with a single enterprise voicemail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Default: Use System Default
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].dialViaOfficeReverseVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Mobile Smart Client Name This tag is not applicable for dualmode phones
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].mobileSmartClientName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Answer Too Late Timer * Enter the maximum time in milliseconds that Cisco Unified Communications Manager allows for the mobile phone to answer. If this value is reached, Cisco Unified Communications Manager stops ringing the mobile phone and pulls the call back to the enterprise. Range: 0 and 10,000 - 300,000 milliseconds Default: 19,000 milliseconds If the value is set to zero, the timer is not started. Default: 19000
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].answerTooLateTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 19000
Line Associations The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
  • Field Name: lineAssociations
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Association
  • Field Name: lineAssociation.[n]
  • Type: Array
Pattern The directory number to be associated. This directory number must be already associated to remote destination profile.
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].lineAssociations.lineAssociation.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].lineAssociations.lineAssociation.[n].routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Tod Access Name From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].todAccessName
  • Type: String
  • Cardinality: [0..1]
Dual Mode Device Name
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].dualModeDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Destination Number * Enter the PSTN telephone number for the destination. Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9, *, #, and +. Cisco recommends that you configure the caller ID of the remote destination. If the administrator configures the Incoming Calling Party settings in the Cisco Unified Communications Manager gateway, trunk, or device pool to globalize the incoming calling party number, configure the Destination Number of the remote destination in the E.164 format. Example: For a remote destination with US area code 408 and destination number 5552222, configure the Destination Number as +14085552222. Additionally, if globalized destination numbers are in use, set the Matching Caller ID with Remote Destination service parameter to Complete Match. Note    Add the necessary translation pattern or route patterns to route the destination number. You can also enter a directory URI in this field. Keep in mind that if you enter a directory URI in this field, you must also configure a domain-based SIP route pattern. Note    When you place a call from a remote destination, the caller ID of the destination phone displays the directory number that is associated with the calling directory URI rather than the directory URI.
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].destination
  • Type: String
  • Cardinality: [1..1]
Enable Mobile Connect Check the check box to allow an incoming call to ring your desk phone and remote destination at the same time. For detailed task information about Cisco Unified Mobility and Extend and Connect, see the Feature Configuration Guide for Cisco Unified Communications Manager. Default: True
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].enableMobileConnect
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Client Services Framework or CTI Remote Device ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].ctiRemoteDeviceName
  • Type: String
  • Cardinality: [0..1]
Mobility Profile From the drop-down list box, choose the mobility profile that you want to use for this remote destination. To configure a mobility profile, use the Call Routing > Mobility > Mobility Profile menu option.
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].mobilityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/MobilityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Enable Unified Mobility While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].enableUnifiedMobility
  • Type: Boolean
  • Cardinality: [0..1]
Remote Destination Profile From the drop-down list box, choose the remote destination profile that you want to use for this remote destination.
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].remoteDestinationProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Single Number Reach Voicemail Policy Configures how mobile device users answer calls that terminate on a remote destination (RD). This feature provides users with a single enterprise voice mail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Note    For User Control to work, you must set the Enable Enterprise Feature Access service parameter to TRUE. Default: Use System Default
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].singleNumberReachVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Owner User Id From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].ownerUserId
  • Type: String
  • Cardinality: [1..1]
Answer Too Soon Timer * Enter the minimum time in milliseconds that Cisco Unified Communications Manager requires the mobile phone to ring before answering the call. This setting accounts for situations where the mobile phone is switched off or is not reachable, in which case the network may immediately divert the call to the mobile phone voice mail. If the mobile phone is answered before this timer expires, Cisco Unified Communications Manager pulls the call back to the enterprise. Range: 0 - 10,000 milliseconds Default: 1,500 milliseconds Default: 1500
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].answerTooSoonTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 1500
Ring Schedule This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag. Passing a blank ringSchedule tag in updateRemoteDestination request will result in setting the time schedule to All the time.
  • Field Name: ringSchedule
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
  • Cardinality: [0..7]
End Day Default: None
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].ringSchedule.member.[n].endDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
Start Day StartDay and EndDay value should be same Default: None
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].ringSchedule.member.[n].startDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
End Time Default: No Office Hours
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].ringSchedule.member.[n].endTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Start Time Default: No Office Hours
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].ringSchedule.member.[n].startTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Mobile Phone Check the check box if you want calls that the desk phone answers to be sent to your mobile phone as the remote destination. Checking this check box ensures that, if Send Call to Mobile Phone is specified (by using the Mobility softkey for remote destination pickup), the call gets extended to this remote destination. Note    This check box does not apply to dual-mode phones that are running SIP nor to dual-mode phones that are running SCCP, such as the Nokia S60.
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].isMobilePhone
  • Type: Boolean
  • Cardinality: [0..1]
Blocked Access List Click this radio button to prevent incoming calls from ringing this remote destination if the caller belongs to the access list that is specified in the drop-down list box and according to the Ring Schedule that you specify in the Ring Schedule pane. This setting applies only if the Enable Cisco Unified Mobility check box is checked for this remote destination. From the drop-down list box, choose an access list that applies to this setting. If you want to view the details of an access list, click the View Details link. (To modify an access list, you must use the Call Routing > Class of Control > Access List menu option.) Choosing an access list that contains no members equates to choosing the Always ring this destination radio button.
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].accessListName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Delay Before Ringing Timer * Enter the time that elapses before the mobile phone rings when a call is extended to the remote destination. Range: 0 - 30,000 milliseconds Default: 4,000 milliseconds Tip    When a hunt group is in use, the lines ring only for a short period of time. You may need to manipulate the Delay Before Ringing Timer setting and make it zero to allow a remote destination call to be established, ring, and answer, before the hunt list timer expires and pulls the call back. Default: 4000
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].delayBeforeRingingCell
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 4000
Name Enter a name that identifies the remote destination or mobile identity.
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].name
  • Type: String
  • Cardinality: [0..1]
Time Zone From the drop-down list box, choose a time zone to use for this remote destination or mobile identity. Note    The time-of-day access feature uses the time zone that you choose for this remote destination or mobile identity to allow or to block calls to this remote destination or mobile identity. Default: Etc/GMT
  • Field Name: RemoteDestinationProfile.[n].RemoteDestinationRDP.[n].timeZone
  • Type: String
  • Cardinality: [0..1]
  • Default: Etc/GMT
  • Choices: ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Riyadh87", "Asia/Riyadh88", "Asia/Riyadh89", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "CET", "CST6CDT", "EET", "EST", "EST5EDT", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "HST", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "MET", "MST", "MST7MDT", "Mideast/Riyadh87", "Mideast/Riyadh88", "Mideast/Riyadh89", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "US/Pacific-New", "WET"]
Data User
  • Field Name: data_User.[n]
  • Type: Array
  • Cardinality: [0..1]
User Name * User's Username.
  • Field Name: data_User.[n].username
  • Type: String
Email Address The User email address.
  • Field Name: data_User.[n].email
  • Type: String
First Name The User first name.
  • Field Name: data_User.[n].first_name
  • Type: String
Last Name The User last name.
  • Field Name: data_User.[n].last_name
  • Type: String
Password The User password.
  • Field Name: data_User.[n].password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: data_User.[n].role
  • Type: String
  • Target: data/Role
  • Target attr: name
  • Format: uri
Language The preferred language for this user. Default: en-us
  • Field Name: data_User.[n].language
  • Type: String
  • Target: data/Language
  • Target attr: lcid
  • Default: en-us
  • Format: uri
Set by Default Language Indicate if the user's language is set by language default in the hierarchy.
  • Field Name: data_User.[n].set_language
  • Type: Boolean
Account Information Additional account information for the given user.
  • Field Name: account_information
  • Type: Object
Change Password on Next Login Indicates if the user must be forced to change their password the next time that login.
  • Field Name: data_User.[n].account_information.change_password_on_login
  • Type: Boolean
Locked Indicates if the account has been locked to prevent the user from logging in.
  • Field Name: data_User.[n].account_information.locked
  • Type: Boolean
Disabled Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.
  • Field Name: data_User.[n].account_information.disabled
  • Type: Boolean
Reason for Disabled A description of why the account is disabled.
  • Field Name: data_User.[n].account_information.reason_for_disabled
  • Type: String
Credential Policy Specifies the policy with the rules used to govern this user's credentials.
  • Field Name: data_User.[n].account_information.credential_policy
  • Type: String
  • Target: data/CredentialPolicy
  • Target attr: name
  • Format: uri
Time Locked Due to Failed Login Attempts The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.
  • Field Name: data_User.[n].account_information.failed_login_lock_date
  • Type: String
  • Format: date-time
Time of Last Password Change The time when the password was last changed.
  • Field Name: data_User.[n].account_information.password_last_change_time
  • Type: String
  • Format: date-time
Time of Last Password Change By User The time when the password was last changed by the user.
  • Field Name: data_User.[n].account_information.password_last_change_time_by_user
  • Type: String
  • Format: date-time
Time of Last Successful Login The time the user last logged in successfully.
  • Field Name: data_User.[n].account_information.last_login_time
  • Type: String
  • Format: date-time
Number of Failed Login Attempts Since Last Successful Login The total number of failed login attempts since last successful login. Default: 0
  • Field Name: data_User.[n].account_information.num_of_failed_login_attempts
  • Type: Integer
  • Default: 0
Security Questions
  • Field Name: security_questions.[n]
  • Type: Array
Question *
  • Field Name: data_User.[n].account_information.security_questions.[n].question
  • Type: String
  • MaxLength: 128
Answer *
  • Field Name: data_User.[n].account_information.security_questions.[n].answer
  • Type: String
  • MaxLength: 128
Used Passwords List of passwords that have been used by user.
  • Field Name: used_passwords.[n]
  • Type: Array
Password Used password
  • Field Name: data_User.[n].account_information.used_passwords.[n].password
  • Type: String
Time Created Time when password was created.
  • Field Name: data_User.[n].account_information.used_passwords.[n].time_created
  • Type: String
Entitlement Profile
  • Field Name: data_User.[n].entitlement_profile
  • Type: String
  • Target: data/HcsEntitlementProfileDAT
  • MaxLength: 1024
  • Format: uri
Sync Source Sync source of the user. Identifies where the user was synced from. This value will determine the master of the data. The data in the User model will be derived from the fields of the master application (E.G. CUCM, CUC, MS-LDAP). Default: LOCAL
  • Field Name: data_User.[n].sync_source
  • Type: String
  • Target: data/UserSyncSource
  • Target attr: name
  • Default: LOCAL
  • Format: uri
Sync Type Sync type of the user. Identifies the user type that was synced from device as indicated by Sync Source information, e.g. CUCM-Local, CUCM-LDAP, LOCAL. Default: LOCAL
  • Field Name: data_User.[n].sync_type
  • Type: String
  • Default: LOCAL
Building Name Building name or number.
  • Field Name: data_User.[n].building_name
  • Type: String
Country Country name.
  • Field Name: data_User.[n].country
  • Type: String
Department Department names and numbers.
  • Field Name: data_User.[n].department
  • Type: String
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: data_User.[n].directory_uri
  • Type: String
Display Name Display name of the user
  • Field Name: data_User.[n].display_name
  • Type: String
Employee Number Employee number of the user
  • Field Name: data_User.[n].employee_number
  • Type: String
Employee Type Employee type
  • Field Name: data_User.[n].employee_type
  • Type: String
Facsimile Telephone Number Contains strings that represent the user's facsimile telephone Number(s).
  • Field Name: facsimile_telephone_number.[n]
  • Type: Array
Home Phone Contains strings that represent the user's home phone number(s).
  • Field Name: home_phone.[n]
  • Type: Array
IP Phone Contains strings that represent the user's IP phone number(s).
  • Field Name: ip_phone.[n]
  • Type: Array
Jabber ID Jabber ID
  • Field Name: data_User.[n].jabber_id
  • Type: String
City Contains the name of a person's locality.
  • Field Name: data_User.[n].city
  • Type: String
Manager Manager.
  • Field Name: data_User.[n].manager
  • Type: String
Member Of The user can be a member of a variety of groups.
  • Field Name: member_of.[n]
  • Type: Array
Mobile Contains strings that represent the user's IP mobile number(s).
  • Field Name: mobile.[n]
  • Type: Array
Organization The name of the person's organization.
  • Field Name: data_User.[n].organization
  • Type: String
Object Class
  • Field Name: object_class.[n]
  • Type: Array
Other Mailbox
  • Field Name: other_mailbox.[n]
  • Type: Array
Organizational Unit The name of the person's organization unit.
  • Field Name: ou.[n]
  • Type: Array
Photo URL Photo URL.
  • Field Name: data_User.[n].photo_url
  • Type: String
Physical Delivery Office Name Physical Delivery Office Name.
  • Field Name: data_User.[n].physical_delivery_office_name
  • Type: String
Postal Code Contains code used by a Postal Service to identify postal service zones.
  • Field Name: data_User.[n].postal_code
  • Type: String
Preferred Language Preferred Language.
  • Field Name: data_User.[n].preferred_language
  • Type: String
State Contains full names of state or province.
  • Field Name: data_User.[n].state
  • Type: String
Street Contains site information from a postal address.
  • Field Name: data_User.[n].street
  • Type: String
Telephone Number Telephone Number.
  • Field Name: telephone_number.[n]
  • Type: Array
Timezone Timezone.
  • Field Name: data_User.[n].timezone
  • Type: String
Title Title.
  • Field Name: data_User.[n].title
  • Type: String
Unverified Mail Box Unverified Mail Box.
  • Field Name: data_User.[n].unverified_mailbox
  • Type: String
Custom String 1 Custom String
  • Field Name: data_User.[n].customString1
  • Type: String
Custom String 2 Custom String
  • Field Name: data_User.[n].customString2
  • Type: String
Custom String 3 Custom String
  • Field Name: data_User.[n].customString3
  • Type: String
Custom String 4 Custom String
  • Field Name: data_User.[n].customString4
  • Type: String
Custom String 5 Custom String
  • Field Name: data_User.[n].customString5
  • Type: String
Custom String 6 Custom String
  • Field Name: data_User.[n].customString6
  • Type: String
Custom String 7 Custom String
  • Field Name: data_User.[n].customString7
  • Type: String
Custom String 8 Custom String
  • Field Name: data_User.[n].customString8
  • Type: String
Custom String 9 Custom String
  • Field Name: data_User.[n].customString9
  • Type: String
Custom String 10 Custom String
  • Field Name: data_User.[n].customString10
  • Type: String
Custom List of Strings 1 Custom List of Strings
  • Field Name: customListOfStrings1.[n]
  • Type: Array
Custom List of Strings 2 Custom List of Strings
  • Field Name: customListOfStrings2.[n]
  • Type: Array
Custom List of Strings 3 Custom List of Strings
  • Field Name: customListOfStrings3.[n]
  • Type: Array
Custom List of Strings 4 Custom List of Strings
  • Field Name: customListOfStrings4.[n]
  • Type: Array
Custom List of Strings 5 Custom List of Strings
  • Field Name: customListOfStrings5.[n]
  • Type: Array
Custom List of Strings 6 Custom List of Strings
  • Field Name: customListOfStrings6.[n]
  • Type: Array
Custom List of Strings 7 Custom List of Strings
  • Field Name: customListOfStrings7.[n]
  • Type: Array
Custom List of Strings 8 Custom List of Strings
  • Field Name: customListOfStrings8.[n]
  • Type: Array
Custom List of Strings 9 Custom List of Strings
  • Field Name: customListOfStrings9.[n]
  • Type: Array
Custom List of Strings 10 Custom List of Strings
  • Field Name: customListOfStrings10.[n]
  • Type: Array
Custom Boolean 1 Custom Boolean
  • Field Name: data_User.[n].customBoolean1
  • Type: Boolean
Custom Boolean 2 Custom Boolean
  • Field Name: data_User.[n].customBoolean2
  • Type: Boolean
Custom Boolean 3 Custom Boolean
  • Field Name: data_User.[n].customBoolean3
  • Type: Boolean
Custom Boolean 4 Custom Boolean
  • Field Name: data_User.[n].customBoolean4
  • Type: Boolean
Custom Boolean 5 Custom Boolean
  • Field Name: data_User.[n].customBoolean5
  • Type: Boolean
Custom Boolean 6 Custom Boolean
  • Field Name: data_User.[n].customBoolean6
  • Type: Boolean
Custom Boolean 7 Custom Boolean
  • Field Name: data_User.[n].customBoolean7
  • Type: Boolean
Custom Boolean 8 Custom Boolean
  • Field Name: data_User.[n].customBoolean8
  • Type: Boolean
Custom Boolean 9 Custom Boolean
  • Field Name: data_User.[n].customBoolean9
  • Type: Boolean
Custom Boolean 10 Custom Boolean
  • Field Name: data_User.[n].customBoolean10
  • Type: Boolean
Auth Method The type of authentication that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user. Default: Local
  • Field Name: data_User.[n].auth_method
  • Type: String
  • Default: Local
  • Choices: ["Local", "Automatic", "LDAP", "SSO"]
LDAP Server A reference to the LDAP server which this user must authenticate against.
  • Field Name: data_User.[n].ldap_server
  • Type: String
  • Target: data/Ldap
  • Format: uri
LDAP Username The login attribute of the associated LDAP device model instance
  • Field Name: data_User.[n].ldap_username
  • Type: String
SSO Identity Provider The entity id of the SSO Identity Provider.
  • Field Name: data_User.[n].sso_idp
  • Type: String
  • Target: data/SsoIdentityProvider
  • Target attr: entity_id
  • Format: uri
SSO Username The name identifier that is used for an SSO authenticated user.
  • Field Name: data_User.[n].sso_username
  • Type: String
User Type Indicate the user's login type. Default: Admin
  • Field Name: data_User.[n].user_type
  • Type: String
  • Default: Admin
  • Choices: ["Admin", "End User", "End User + Admin"]
Exclude from Directory Exclude from Directory flag to control the Phone Services directory lookup. If set to true the User's phone number will not appear in the directory lookup.
  • Field Name: data_User.[n].exclude_from_directory
  • Type: Boolean
Hybrid Status
  • Field Name: data_User.[n].mvs_hybrid_status
  • Type: String
Primary Line
  • Field Name: data_User.[n].mvs_primary_line
  • Type: String
Primary Class of Service
  • Field Name: data_User.[n].mvs_primary_line_cos
  • Type: String
Extensions Extensions to select primary details from.
  • Field Name: mvs_extensions.[n]
  • Type: Array
Line
  • Field Name: data_User.[n].mvs_extensions.[n].line
  • Type: String
Line E164
  • Field Name: data_User.[n].mvs_extensions.[n].line_e164
  • Type: String
Class of Service
  • Field Name: data_User.[n].mvs_extensions.[n].line_cos
  • Type: String
Avaya System Manager User Name The username corresponding to the the Username in Avaya System Manager.
  • Field Name: data_User.[n].username_avaya_system_manager
  • Type: String
Broadworks User Name The username corresponding to the the Username in Broadworks.
  • Field Name: data_User.[n].username_broadworks
  • Type: String
Cisco Unity Connection User Name The username corresponding to the the Username in Cisco Unity Connection.
  • Field Name: data_User.[n].username_cuc
  • Type: String
Cisco Unified Communication Manager User Name The username corresponding to the the Username in Cisco Unified Communication Manager.
  • Field Name: data_User.[n].username_cucm
  • Type: String
HCMF User Name The username corresponding to the the Username in Cisco HCMF.
  • Field Name: data_User.[n].username_hcmf
  • Type: String
LDAP Directory User Name The username corresponding to the the Username in the LDAP Directory.
  • Field Name: data_User.[n].username_ldap
  • Type: String
Microsoft User Name The username corresponding to the the Microsoft Username.
  • Field Name: data_User.[n].username_microsoft
  • Type: String
Microsoft Office 365 User Name The username corresponding to the the Username in Microsoft Office 365.
  • Field Name: data_User.[n].username_ms_365
  • Type: String
Microsoft LDAP User Name The username corresponding to the the Username in Microsoft LDAP.
  • Field Name: data_User.[n].username_ms_ldap
  • Type: String
Microsoft Teams User Name The username corresponding to the the Username in Microsoft Teams.
  • Field Name: data_User.[n].username_ms_teams
  • Type: String
Open LDAP User Name The username corresponding to the the Username in Opoen LDAP.
  • Field Name: data_User.[n].username_open_ldap
  • Type: String
Cisco Unified Contact Centre Express User Name The username corresponding to the the Username in Cisco Unified Contact Centre Express.
  • Field Name: data_User.[n].username_uccx
  • Type: String
Webex App User Name The username corresponding to the the Username in Webex App.
  • Field Name: data_User.[n].username_webex_teams
  • Type: String
Zoom User Name The username corresponding to the the Username in Zoom.
  • Field Name: data_User.[n].username_zoom
  • Type: String
Authorized Admin Hierarchy A reference an Authorized Admin Hierarchy instance that defines this user's administrative capabilities. This enables administrative capabilities for end users.
  • Field Name: data_User.[n].authorized_admin_hierarchy
  • Type: String
  • Target: data/AuthorizedAdminHierarchy
  • Target attr: name
  • Format: uri
Subscriber Data
  • Field Name: SubscriberData
  • Type: Object
userid
  • Field Name: SubscriberData.userid
  • Type: String
Entitlement Profile
  • Field Name: SubscriberData.entitlement_profile
  • Type: String
Warning Warning Status Field Default: No Call Manager has been configured.
  • Field Name: SubscriberData.warning
  • Type: String
  • Default: No Call Manager has been configured.
Spark User
  • Field Name: SparkUser.[n]
  • Type: Array
  • Cardinality: [0..1]
Id
  • Field Name: SparkUser.[n].id
  • Type: String
First Name
  • Field Name: SparkUser.[n].firstName
  • Type: String
Last Name
  • Field Name: SparkUser.[n].lastName
  • Type: String
Email Address *
  • Field Name: SparkUser.[n].email
  • Type: String
Webex Calling - Professional
  • Field Name: SparkUser.[n].calling_pro
  • Type: Boolean
Phone Numbers Phone numbers for the person. Only settable for Webex Calling. Needs a Webex Calling license.
  • Field Name: phoneNumbers.[n]
  • Type: Array
Type The type of phone number. Default: work
  • Field Name: SparkUser.[n].phoneNumbers.[n].type
  • Type: String
  • Default: work
  • Choices: ["Work", "Work Extension", "Mobile", "Fax"]
Number The phone number e.g. +1 408 526 7209
  • Field Name: SparkUser.[n].phoneNumbers.[n].value
  • Type: String
Extension Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.
  • Field Name: SparkUser.[n].extension
  • Type: String
SIP Addresses The users sip addresses.
  • Field Name: sipAddresses.[n]
  • Type: Array
Type The type of SIP address.
  • Field Name: SparkUser.[n].sipAddresses.[n].type
  • Type: String
Number The SIP address
  • Field Name: SparkUser.[n].sipAddresses.[n].value
  • Type: String
Primary
  • Field Name: SparkUser.[n].sipAddresses.[n].primary
  • Type: Boolean
Addresses The users addresses.
  • Field Name: addresses.[n]
  • Type: Array
Type The type of address.
  • Field Name: SparkUser.[n].addresses.[n].type
  • Type: String
Country The user's country. Example value: US
  • Field Name: SparkUser.[n].addresses.[n].country
  • Type: String
Locality The user's locality, often city. Example value: Milpitas
  • Field Name: SparkUser.[n].addresses.[n].locality
  • Type: String
Region The user's region, often state. Example value: California
  • Field Name: SparkUser.[n].addresses.[n].region
  • Type: String
Street Address The user's street. Example value: 1099 Bird Ave.
  • Field Name: SparkUser.[n].addresses.[n].streetAddress
  • Type: String
Postal Code The user's postal or zip code. Example value: 99212
  • Field Name: SparkUser.[n].addresses.[n].postalCode
  • Type: String
Display Name
  • Field Name: SparkUser.[n].displayName
  • Type: String
Nickname
  • Field Name: SparkUser.[n].nickName
  • Type: String
Department
  • Field Name: SparkUser.[n].department
  • Type: String
Manager
  • Field Name: SparkUser.[n].manager
  • Type: String
Manager ID
  • Field Name: SparkUser.[n].managerId
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • Format: uri
Title
  • Field Name: SparkUser.[n].title
  • Type: String
Time Zone
  • Field Name: SparkUser.[n].timezone
  • Type: String
Location
  • Field Name: SparkUser.[n].locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Date Created
  • Field Name: SparkUser.[n].created
  • Type: String
  • Format: date-time
Status
  • Field Name: SparkUser.[n].status
  • Type: String
User Type Default: person
  • Field Name: SparkUser.[n].type
  • Type: String
  • Default: person
  • Choices: ["Person", "Bot", "App User (Guest User)"]
Invite Pending
  • Field Name: SparkUser.[n].invitePending
  • Type: Boolean
Login Enabled
  • Field Name: SparkUser.[n].loginEnabled
  • Type: Boolean
Field to pass selected number from QAS workflow
  • Field Name: SparkUser.[n].line
  • Type: String
Roles
  • Field Name: roles
  • Type: Object
No administrator privileges Default: true
  • Field Name: SparkUser.[n].roles.none
  • Type: Boolean
  • Default: true
Full administrator privileges - User Management - Company Policy & Templates - Analytics & Reports - Support Metrics & Notifications - Licenses & Upgrades - Assign Roles
  • Field Name: SparkUser.[n].roles.full
  • Type: Boolean
Read-only administrator privileges Read-only view of the portal. No changes will be accepted.
  • Field Name: SparkUser.[n].roles.readonly
  • Type: Boolean
Support Administrator - Analytics & Reports - Support Metrics & Notifications
  • Field Name: SparkUser.[n].roles.support
  • Type: Boolean
User and Device Administrator - User Management - Device Management - Licenses & Upgrades
  • Field Name: SparkUser.[n].roles.user_device
  • Type: Boolean
Device Administrator - Device Management
  • Field Name: SparkUser.[n].roles.device
  • Type: Boolean
Assigned Licenses
  • Field Name: licenses.[n]
  • Type: Array
License Select the license to assign to this user.
  • Field Name: SparkUser.[n].licenses.[n].license
  • Type: String
  • Target: device/spark/License
  • Target attr: unique_name
  • Format: uri
Settings
  • Field Name: settings
  • Type: Object
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how a user makes calls in Webex App.
  • Field Name: SparkUser.[n].settings.calling.calling_behaviour
  • Type: String
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app", "Third-Party app"]
Use Organization's Domain Enabling this will use the Webex App organization domain for Calling in Webex App (Unified CM)
  • Field Name: SparkUser.[n].settings.calling.use_org_domain
  • Type: Boolean
UC Manager Profile
  • Field Name: SparkUser.[n].settings.calling.calling_behaviour_uc_manager_profile
  • Type: String
  • Target: device/spark/CallingProfile
  • Target attr: name
  • Format: uri
Create iPhone Device Default: true
  • Field Name: SparkUser.[n].settings.calling.SparkiPhoneDevice
  • Type: Boolean
  • Default: true
Create Android Device Default: true
  • Field Name: SparkUser.[n].settings.calling.SparkAndroidDevice
  • Type: Boolean
  • Default: true
Create Tablet Device Default: true
  • Field Name: SparkUser.[n].settings.calling.SparkTabletDevice
  • Type: Boolean
  • Default: true
Create CSF Device Default: true
  • Field Name: SparkUser.[n].settings.calling.SparkCSFDevice
  • Type: Boolean
  • Default: true
Uccx Agent
  • Field Name: UccxAgent.[n]
  • Type: Array
  • Cardinality: [0..1]
ID
  • Field Name: UccxAgent.[n].id
  • Type: String
User ID User ID of this Agent.
  • Field Name: UccxAgent.[n].userID
  • Type: String
First Name First name of this Agent.
  • Field Name: UccxAgent.[n].firstName
  • Type: String
Last Name Last name of this Agent.
  • Field Name: UccxAgent.[n].lastName
  • Type: String
Extension IPCC extension of this Agent.
  • Field Name: UccxAgent.[n].extension
  • Type: String
Type User type i.e. either an Agent or Supervisor.
  • Field Name: UccxAgent.[n].type
  • Type: String
  • Choices: ["Agent", "Supervisor"]
Alias Alias for this Agent.
  • Field Name: UccxAgent.[n].alias
  • Type: String
  • Pattern: |[^`~@#!$%\^&\*\(\)\-_\+=\{\}\[\]\|\\/:;'\?"\.,<>]{1,31}|[^`~@#!$%\^&\*\(\)\-_\+=\{\}\[\]\|\\/:;'\?"\.,<>]{1,1}[^`~@#!$%\^&\*\(\)\+=\{\}\[\]\|\\/:;'\?",<>]{1,29}[^`~@#!$%\^&\*\(\)\-_\+=\{\}\[\]\|\\/:;'\?"\.,<>]{1,1}
Team The team this Agent is assigned to.
  • Field Name: UccxAgent.[n].teamName
  • Type: String
  • Target: device/uccx/Team
  • Target attr: name
  • Format: uri
Resource Group Resource group this Agent belongs to.
  • Field Name: UccxAgent.[n].resourceGroupName
  • Type: String
  • Target: device/uccx/ResourceGroup
  • Target attr: name
  • Format: uri
Automatic Available Is this Agent automatically available.
  • Field Name: UccxAgent.[n].autoAvailable
  • Type: Boolean
Skills Skills that this Agent has.
  • Field Name: skills.[n]
  • Type: Array
Competence Level Agent's competency level for this skill. Default: 5
  • Field Name: UccxAgent.[n].skills.[n].competencelevel
  • Type: Integer
  • Default: 5
  • Choices: ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10"]
Skill Skill name.
  • Field Name: UccxAgent.[n].skills.[n].skillName
  • Type: String
  • Target: device/uccx/Skill
  • Target attr: name
  • Format: uri
Device
  • Field Name: Device.[n]
  • Type: Array
  • Cardinality: [0..1]
Username *
  • Field Name: UccxAgent.[n].Device.[n].username
  • Type: String
Contact Centre App User ID
  • Field Name: UccxAgent.[n].Device.[n].app_user_id
  • Type: String
Device Type Default: Phone
  • Field Name: UccxAgent.[n].Device.[n].device_type
  • Type: String
  • Default: Phone
  • Choices: ["Phone", "Extension Mobility"]
Phone Name
  • Field Name: UccxAgent.[n].Device.[n].phone_name
  • Type: String
Profile Name
  • Field Name: UccxAgent.[n].Device.[n].profile_name
  • Type: String
Spark Services
  • Field Name: SparkServices
  • Type: Object
name
  • Field Name: SparkServices.name
  • Type: String
configuredCallingBehaviour
  • Field Name: SparkServices.configuredCallingBehaviour
  • Type: String
Custom
  • Field Name: Custom
  • Type: Object
custom_string_1 custom_string_1
  • Field Name: Custom.custom_string_1
  • Type: String
custom_string_2 custom_string_2
  • Field Name: Custom.custom_string_2
  • Type: String
custom_string_3 custom_string_3
  • Field Name: Custom.custom_string_3
  • Type: String
custom_string_4 custom_string_4
  • Field Name: Custom.custom_string_4
  • Type: String
custom_string_5 custom_string_5
  • Field Name: Custom.custom_string_5
  • Type: String
custom_string_6 custom_string_6
  • Field Name: Custom.custom_string_6
  • Type: String
custom_string_7 custom_string_7
  • Field Name: Custom.custom_string_7
  • Type: String
custom_string_8 custom_string_8
  • Field Name: Custom.custom_string_8
  • Type: String
custom_string_9 custom_string_9
  • Field Name: Custom.custom_string_9
  • Type: String
custom_string_10 custom_string_10
  • Field Name: Custom.custom_string_10
  • Type: String
custom_boolean_1 custom_boolean_1
  • Field Name: Custom.custom_boolean_1
  • Type: Boolean
custom_boolean_2 custom_boolean_2
  • Field Name: Custom.custom_boolean_2
  • Type: Boolean
custom_boolean_3 custom_boolean_3
  • Field Name: Custom.custom_boolean_3
  • Type: Boolean
custom_boolean_4 custom_boolean_4
  • Field Name: Custom.custom_boolean_4
  • Type: Boolean
custom_boolean_5 custom_boolean_5
  • Field Name: Custom.custom_boolean_5
  • Type: Boolean
custom_boolean_6 custom_boolean_6
  • Field Name: Custom.custom_boolean_6
  • Type: Boolean
custom_boolean_7 custom_boolean_7
  • Field Name: Custom.custom_boolean_7
  • Type: Boolean
custom_boolean_8 custom_boolean_8
  • Field Name: Custom.custom_boolean_8
  • Type: Boolean
custom_boolean_9 custom_boolean_9
  • Field Name: Custom.custom_boolean_9
  • Type: Boolean
custom_boolean_10 custom_boolean_10
  • Field Name: Custom.custom_boolean_10
  • Type: Boolean
ipcc_trigger IPCC Extension visibility trigger
  • Field Name: Custom.ipcc_trigger
  • Type: Boolean
S4B Online User
  • Field Name: S4BOnlineUser.[n]
  • Type: Array
  • Cardinality: [0..1]
TeamsWorkLoadPolicy
  • Field Name: S4BOnlineUser.[n].TeamsWorkLoadPolicy
  • Type: String
Tenant Dial Plan
  • Field Name: TenantDialPlan.[n]
  • Type: Array
  • Cardinality: [0..1]
Simple Name *
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].SimpleName
  • Type: String
Optimize Device Dialing *
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].OptimizeDeviceDialing
  • Type: Boolean
Description
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].Description
  • Type: String
External Access Prefix
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].ExternalAccessPrefix
  • Type: String
Normalization Rules
  • Field Name: NormalizationRules.[n]
  • Type: Array
Pattern *
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].NormalizationRules.[n].Pattern
  • Type: String
Translation *
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].NormalizationRules.[n].Translation
  • Type: String
Description
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].NormalizationRules.[n].Description
  • Type: String
Identity *
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].NormalizationRules.[n].Identity
  • Type: String
Is Internal Extension *
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].NormalizationRules.[n].IsInternalExtension
  • Type: Boolean
Identity *
  • Field Name: S4BOnlineUser.[n].TenantDialPlan.[n].Identity
  • Type: String
Title
  • Field Name: S4BOnlineUser.[n].Title
  • Type: String
PreferredDataLocationOverwritePolicy
  • Field Name: S4BOnlineUser.[n].PreferredDataLocationOverwritePolicy
  • Type: String
MobilityPolicy
  • Field Name: S4BOnlineUser.[n].MobilityPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsMobilityPolicy
  • Target attr: Identity
  • Format: uri
Department
  • Field Name: S4BOnlineUser.[n].Department
  • Type: String
OwnerUrn
  • Field Name: S4BOnlineUser.[n].OwnerUrn
  • Type: String
TeamsMessagingPolicy
  • Field Name: S4BOnlineUser.[n].TeamsMessagingPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsMessagingPolicy
  • Target attr: Identity
  • Format: uri
TeamsUpgradeNotificationsEnabled
  • Field Name: S4BOnlineUser.[n].TeamsUpgradeNotificationsEnabled
  • Type: Boolean
OtherTelephone
  • Field Name: OtherTelephone.[n]
  • Type: Array
TeamsVoiceRoute
  • Field Name: S4BOnlineUser.[n].TeamsVoiceRoute
  • Type: Boolean
Fax
  • Field Name: S4BOnlineUser.[n].Fax
  • Type: String
Company
  • Field Name: S4BOnlineUser.[n].Company
  • Type: String
PinPolicy
  • Field Name: S4BOnlineUser.[n].PinPolicy
  • Type: String
OnlineVoiceRoutingPolicy
  • Field Name: S4BOnlineUser.[n].OnlineVoiceRoutingPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsOnlineVoiceRoutingPolicy
  • Target attr: Identity
  • Format: uri
ThirdPartyVideoSystemPolicy
  • Field Name: S4BOnlineUser.[n].ThirdPartyVideoSystemPolicy
  • Type: String
HostedVoicemailPolicy
  • Field Name: S4BOnlineUser.[n].HostedVoicemailPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsHostedVoicemailPolicy
  • Target attr: Identity
  • Format: uri
LocationPolicy
  • Field Name: S4BOnlineUser.[n].LocationPolicy
  • Type: String
IPPhone
  • Field Name: S4BOnlineUser.[n].IPPhone
  • Type: String
OriginatingServer
  • Field Name: S4BOnlineUser.[n].OriginatingServer
  • Type: String
BaseSimpleUrl
  • Field Name: S4BOnlineUser.[n].BaseSimpleUrl
  • Type: String
ObjectId
  • Field Name: S4BOnlineUser.[n].ObjectId
  • Type: String
WebPage
  • Field Name: S4BOnlineUser.[n].WebPage
  • Type: String
TeamsSyntheticAutomatedCallPolicy
  • Field Name: S4BOnlineUser.[n].TeamsSyntheticAutomatedCallPolicy
  • Type: String
RegistrarPool
  • Field Name: S4BOnlineUser.[n].RegistrarPool
  • Type: String
TeamsChannelsPolicy
  • Field Name: S4BOnlineUser.[n].TeamsChannelsPolicy
  • Type: String
TeamsIPPhonePolicy
  • Field Name: S4BOnlineUser.[n].TeamsIPPhonePolicy
  • Type: String
StreetAddress
  • Field Name: S4BOnlineUser.[n].StreetAddress
  • Type: String
WhenCreated
  • Field Name: S4BOnlineUser.[n].WhenCreated
  • Type: String
  • Format: date-time
OnlineDialOutPolicy
  • Field Name: S4BOnlineUser.[n].OnlineDialOutPolicy
  • Type: String
CloudMeetingOpsPolicy
  • Field Name: S4BOnlineUser.[n].CloudMeetingOpsPolicy
  • Type: String
CallViaWorkPolicy
  • Field Name: S4BOnlineUser.[n].CallViaWorkPolicy
  • Type: String
TeamsComplianceRecordingPolicy
  • Field Name: S4BOnlineUser.[n].TeamsComplianceRecordingPolicy
  • Type: String
TeamsMeetingPolicy
  • Field Name: S4BOnlineUser.[n].TeamsMeetingPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsMeetingPolicy
  • Target attr: Identity
  • Format: uri
OriginalPreferredDataLocation
  • Field Name: S4BOnlineUser.[n].OriginalPreferredDataLocation
  • Type: String
MobilePhone
  • Field Name: S4BOnlineUser.[n].MobilePhone
  • Type: String
OnPremLineURIManuallySet
  • Field Name: S4BOnlineUser.[n].OnPremLineURIManuallySet
  • Type: Boolean
OnPremSipAddress
  • Field Name: S4BOnlineUser.[n].OnPremSipAddress
  • Type: String
UserPrincipalName
  • Field Name: S4BOnlineUser.[n].UserPrincipalName
  • Type: String
ProvisioningCounter
  • Field Name: S4BOnlineUser.[n].ProvisioningCounter
  • Type: Integer
BroadcastMeetingPolicy
  • Field Name: S4BOnlineUser.[n].BroadcastMeetingPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsBroadcastMeetingPolicy
  • Target attr: Identity
  • Format: uri
PresencePolicy
  • Field Name: S4BOnlineUser.[n].PresencePolicy
  • Type: String
TeamsOwnersPolicy
  • Field Name: S4BOnlineUser.[n].TeamsOwnersPolicy
  • Type: String
CallerIdPolicy
  • Field Name: S4BOnlineUser.[n].CallerIdPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsCallerIdPolicy
  • Target attr: Identity
  • Format: uri
XForestMovePolicy
  • Field Name: S4BOnlineUser.[n].XForestMovePolicy
  • Type: String
VoiceRoutingPolicy
  • Field Name: S4BOnlineUser.[n].VoiceRoutingPolicy
  • Type: String
DisplayName
  • Field Name: S4BOnlineUser.[n].DisplayName
  • Type: String
TargetServerIfMoving
  • Field Name: S4BOnlineUser.[n].TargetServerIfMoving
  • Type: String
HostingProvider
  • Field Name: S4BOnlineUser.[n].HostingProvider
  • Type: String
UserServicesPolicy
  • Field Name: S4BOnlineUser.[n].UserServicesPolicy
  • Type: String
MCOValidationError
  • Field Name: S4BOnlineUser.[n].MCOValidationError
  • Type: String
TeamsVideoInteropServicePolicy
  • Field Name: S4BOnlineUser.[n].TeamsVideoInteropServicePolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsVideoInteropServicePolicy
  • Target attr: Identity
  • Format: uri
ExchUserHoldPolicies
  • Field Name: ExchUserHoldPolicies.[n]
  • Type: Array
TeamsCallingPolicy
  • Field Name: S4BOnlineUser.[n].TeamsCallingPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsCallingPolicy
  • Target attr: Identity
  • Format: uri
TeamsEmergencyCallRoutingPolicy
  • Field Name: S4BOnlineUser.[n].TeamsEmergencyCallRoutingPolicy
  • Type: String
PreferredDataLocation
  • Field Name: S4BOnlineUser.[n].PreferredDataLocation
  • Type: String
OnPremLineURI
  • Field Name: S4BOnlineUser.[n].OnPremLineURI
  • Type: String
LineServerURI
  • Field Name: S4BOnlineUser.[n].LineServerURI
  • Type: String
OnPremOptionFlags
  • Field Name: S4BOnlineUser.[n].OnPremOptionFlags
  • Type: Integer
ClientUpdateOverridePolicy
  • Field Name: S4BOnlineUser.[n].ClientUpdateOverridePolicy
  • Type: String
InterpretedUserType
  • Field Name: S4BOnlineUser.[n].InterpretedUserType
  • Type: String
Enterprise Voice Enabled *
  • Field Name: S4BOnlineUser.[n].EnterpriseVoiceEnabled
  • Type: Boolean
PSShowComputerName
  • Field Name: S4BOnlineUser.[n].PSShowComputerName
  • Type: Boolean
TeamsUpgradeOverridePolicy
  • Field Name: S4BOnlineUser.[n].TeamsUpgradeOverridePolicy
  • Type: String
TeamsMeetingBroadcastPolicy
  • Field Name: S4BOnlineUser.[n].TeamsMeetingBroadcastPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsMeetingBroadcastPolicy
  • Target attr: Identity
  • Format: uri
VoicePolicy
  • Field Name: S4BOnlineUser.[n].VoicePolicy
  • Type: String
PrivateLine
  • Field Name: S4BOnlineUser.[n].PrivateLine
  • Type: String
UpgradeRetryCounter
  • Field Name: S4BOnlineUser.[n].UpgradeRetryCounter
  • Type: Integer
IPPhonePolicy
  • Field Name: S4BOnlineUser.[n].IPPhonePolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsIPPhonePolicy
  • Target attr: Identity
  • Format: uri
AdminDescription
  • Field Name: S4BOnlineUser.[n].AdminDescription
  • Type: String
SipAddress
  • Field Name: S4BOnlineUser.[n].SipAddress
  • Type: String
OnPremEnterpriseVoiceEnabled
  • Field Name: S4BOnlineUser.[n].OnPremEnterpriseVoiceEnabled
  • Type: Boolean
ServiceInstance
  • Field Name: S4BOnlineUser.[n].ServiceInstance
  • Type: String
DistinguishedName
  • Field Name: S4BOnlineUser.[n].DistinguishedName
  • Type: String
TeamsAppPermissionPolicy
  • Field Name: S4BOnlineUser.[n].TeamsAppPermissionPolicy
  • Type: String
TeamsCallParkPolicy
  • Field Name: S4BOnlineUser.[n].TeamsCallParkPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsCallParkPolicy
  • Target attr: Identity
  • Format: uri
StsRefreshTokensValidFrom
  • Field Name: S4BOnlineUser.[n].StsRefreshTokensValidFrom
  • Type: String
  • Format: date-time
Guid
  • Field Name: S4BOnlineUser.[n].Guid
  • Type: String
SamAccountName
  • Field Name: S4BOnlineUser.[n].SamAccountName
  • Type: String
ObjectCategory
  • Field Name: S4BOnlineUser.[n].ObjectCategory
  • Type: String
IsValid
  • Field Name: S4BOnlineUser.[n].IsValid
  • Type: Boolean
WhenChanged
  • Field Name: S4BOnlineUser.[n].WhenChanged
  • Type: String
  • Format: date-time
ObjectState
  • Field Name: S4BOnlineUser.[n].ObjectState
  • Type: String
TeamsTargetingPolicy
  • Field Name: S4BOnlineUser.[n].TeamsTargetingPolicy
  • Type: String
StateOrProvince
  • Field Name: S4BOnlineUser.[n].StateOrProvince
  • Type: String
ThumbnailPhoto
  • Field Name: S4BOnlineUser.[n].ThumbnailPhoto
  • Type: String
ExUmEnabled
  • Field Name: S4BOnlineUser.[n].ExUmEnabled
  • Type: Boolean
SmsServicePolicy
  • Field Name: S4BOnlineUser.[n].SmsServicePolicy
  • Type: String
TeamsEducationAssignmentsAppPolicy
  • Field Name: S4BOnlineUser.[n].TeamsEducationAssignmentsAppPolicy
  • Type: String
FirstName
  • Field Name: S4BOnlineUser.[n].FirstName
  • Type: String
TeamsShiftsAppPolicy
  • Field Name: S4BOnlineUser.[n].TeamsShiftsAppPolicy
  • Type: String
LastName
  • Field Name: S4BOnlineUser.[n].LastName
  • Type: String
SyncingCounter
  • Field Name: S4BOnlineUser.[n].SyncingCounter
  • Type: String
TeamsEmergencyCallingPolicy
  • Field Name: S4BOnlineUser.[n].TeamsEmergencyCallingPolicy
  • Type: String
TeamsUpgradePolicyIsReadOnly
  • Field Name: S4BOnlineUser.[n].TeamsUpgradePolicyIsReadOnly
  • Type: String
UserProvisionType
  • Field Name: S4BOnlineUser.[n].UserProvisionType
  • Type: String
CountryAbbreviation
  • Field Name: S4BOnlineUser.[n].CountryAbbreviation
  • Type: String
Puid
  • Field Name: S4BOnlineUser.[n].Puid
  • Type: String
LineURI
  • Field Name: S4BOnlineUser.[n].LineURI
  • Type: String
TeamsCortanaPolicy
  • Field Name: S4BOnlineUser.[n].TeamsCortanaPolicy
  • Type: String
UserRoutingGroupId
  • Field Name: S4BOnlineUser.[n].UserRoutingGroupId
  • Type: String
CloudVideoInteropPolicy
  • Field Name: S4BOnlineUser.[n].CloudVideoInteropPolicy
  • Type: String
OptionFlags
  • Field Name: S4BOnlineUser.[n].OptionFlags
  • Type: Integer
ExternalAccessPolicy
  • Field Name: S4BOnlineUser.[n].ExternalAccessPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsExternalAccessPolicy
  • Target attr: Identity
  • Format: uri
TeamsFeedbackPolicy
  • Field Name: S4BOnlineUser.[n].TeamsFeedbackPolicy
  • Type: String
ClientVersionPolicy
  • Field Name: S4BOnlineUser.[n].ClientVersionPolicy
  • Type: String
PSComputerName
  • Field Name: S4BOnlineUser.[n].PSComputerName
  • Type: String
Id
  • Field Name: S4BOnlineUser.[n].Id
  • Type: String
Phone
  • Field Name: S4BOnlineUser.[n].Phone
  • Type: String
ClientUpdatePolicy
  • Field Name: S4BOnlineUser.[n].ClientUpdatePolicy
  • Type: String
OnlineDialinConferencingPolicy
  • Field Name: S4BOnlineUser.[n].OnlineDialinConferencingPolicy
  • Type: String
Audio/Video Disabled *
  • Field Name: S4BOnlineUser.[n].AudioVideoDisabled
  • Type: Boolean
UsageLocation
  • Field Name: S4BOnlineUser.[n].UsageLocation
  • Type: String
ArchivingPolicy
  • Field Name: S4BOnlineUser.[n].ArchivingPolicy
  • Type: String
UserAccountControl
  • Field Name: S4BOnlineUser.[n].UserAccountControl
  • Type: String
Enabled *
  • Field Name: S4BOnlineUser.[n].Enabled
  • Type: Boolean
ExchangeArchivingPolicy
  • Field Name: S4BOnlineUser.[n].ExchangeArchivingPolicy
  • Type: String
OnlineAudioConferencingRoutingPolicy
  • Field Name: S4BOnlineUser.[n].OnlineAudioConferencingRoutingPolicy
  • Type: String
OriginatorSid
  • Field Name: S4BOnlineUser.[n].OriginatorSid
  • Type: String
DirSyncEnabled
  • Field Name: S4BOnlineUser.[n].DirSyncEnabled
  • Type: Boolean
RemoteCallControlTelephonyEnabled
  • Field Name: S4BOnlineUser.[n].RemoteCallControlTelephonyEnabled
  • Type: Boolean
PostalCode
  • Field Name: S4BOnlineUser.[n].PostalCode
  • Type: String
AddressBookPolicy
  • Field Name: S4BOnlineUser.[n].AddressBookPolicy
  • Type: String
TeamsMobilityPolicy
  • Field Name: S4BOnlineUser.[n].TeamsMobilityPolicy
  • Type: String
MNCReady
  • Field Name: S4BOnlineUser.[n].MNCReady
  • Type: Boolean
ExperiencePolicy
  • Field Name: S4BOnlineUser.[n].ExperiencePolicy
  • Type: String
IsByPassValidation
  • Field Name: S4BOnlineUser.[n].IsByPassValidation
  • Type: Boolean
Office
  • Field Name: S4BOnlineUser.[n].Office
  • Type: String
ClientPolicy
  • Field Name: S4BOnlineUser.[n].ClientPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsClientPolicy
  • Target attr: Identity
  • Format: uri
TeamsVerticalPackagePolicy
  • Field Name: S4BOnlineUser.[n].TeamsVerticalPackagePolicy
  • Type: String
TeamsShiftsPolicy
  • Field Name: S4BOnlineUser.[n].TeamsShiftsPolicy
  • Type: String
TeamsInteropPolicy
  • Field Name: S4BOnlineUser.[n].TeamsInteropPolicy
  • Type: String
ShadowProxyAddresses
  • Field Name: ShadowProxyAddresses.[n]
  • Type: Array
CallingLineIdentity
  • Field Name: S4BOnlineUser.[n].CallingLineIdentity
  • Type: String
DialPlan
  • Field Name: S4BOnlineUser.[n].DialPlan
  • Type: String
  • Target: device/skypeforbusinessonline/CsDialPlan
  • Target attr: Identity
  • Format: uri
City
  • Field Name: S4BOnlineUser.[n].City
  • Type: String
CloudMeetingPolicy
  • Field Name: S4BOnlineUser.[n].CloudMeetingPolicy
  • Type: String
TeamsClientConfiguration
  • Field Name: S4BOnlineUser.[n].TeamsClientConfiguration
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsClientConfiguration
  • Target attr: Identity
  • Format: uri
CountryOrRegionDisplayName
  • Field Name: S4BOnlineUser.[n].CountryOrRegionDisplayName
  • Type: String
TenantId
  • Field Name: S4BOnlineUser.[n].TenantId
  • Type: String
ConferencingPolicy
  • Field Name: S4BOnlineUser.[n].ConferencingPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsConferencingPolicy
  • Target attr: Identity
  • Format: uri
Sid
  • Field Name: S4BOnlineUser.[n].Sid
  • Type: String
TeamsUpdateManagementPolicy
  • Field Name: S4BOnlineUser.[n].TeamsUpdateManagementPolicy
  • Type: String
TeamsUpgradePolicy
  • Field Name: S4BOnlineUser.[n].TeamsUpgradePolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsTeamsUpgradePolicy
  • Target attr: Identity
  • Format: uri
PublishingCounter
  • Field Name: S4BOnlineUser.[n].PublishingCounter
  • Type: Integer
ExternalUserCommunicationPolicy
  • Field Name: S4BOnlineUser.[n].ExternalUserCommunicationPolicy
  • Type: String
OnPremHideFromAddressLists
  • Field Name: S4BOnlineUser.[n].OnPremHideFromAddressLists
  • Type: Boolean
OverridePreferredDataLocation
  • Field Name: S4BOnlineUser.[n].OverridePreferredDataLocation
  • Type: String
Identity
  • Field Name: S4BOnlineUser.[n].Identity
  • Type: String
OnPremHostingProvider
  • Field Name: S4BOnlineUser.[n].OnPremHostingProvider
  • Type: String
HostedVoiceMail *
  • Field Name: S4BOnlineUser.[n].HostedVoiceMail
  • Type: Boolean
Name
  • Field Name: S4BOnlineUser.[n].Name
  • Type: String
ServiceInfo
  • Field Name: S4BOnlineUser.[n].ServiceInfo
  • Type: String
OnPremSIPEnabled
  • Field Name: S4BOnlineUser.[n].OnPremSIPEnabled
  • Type: Boolean
WindowsEmailAddress
  • Field Name: S4BOnlineUser.[n].WindowsEmailAddress
  • Type: String
TeamsAppSetupPolicy
  • Field Name: S4BOnlineUser.[n].TeamsAppSetupPolicy
  • Type: String
HideFromAddressLists
  • Field Name: S4BOnlineUser.[n].HideFromAddressLists
  • Type: Boolean
Alias
  • Field Name: S4BOnlineUser.[n].Alias
  • Type: String
NonPrimaryResource
  • Field Name: S4BOnlineUser.[n].NonPrimaryResource
  • Type: Boolean
ContactOptionFlags
  • Field Name: S4BOnlineUser.[n].ContactOptionFlags
  • Type: String
TargetRegistrarPool
  • Field Name: S4BOnlineUser.[n].TargetRegistrarPool
  • Type: String
OnlineVoicemailPolicy
  • Field Name: S4BOnlineUser.[n].OnlineVoicemailPolicy
  • Type: String
EnabledForRichPresence
  • Field Name: S4BOnlineUser.[n].EnabledForRichPresence
  • Type: Boolean
PreferredLanguage
  • Field Name: S4BOnlineUser.[n].PreferredLanguage
  • Type: String
TeamsUpgradeEffectiveMode
  • Field Name: S4BOnlineUser.[n].TeamsUpgradeEffectiveMode
  • Type: String
TeamsNotificationAndFeedsPolicy
  • Field Name: S4BOnlineUser.[n].TeamsNotificationAndFeedsPolicy
  • Type: String
SipProxyAddress
  • Field Name: S4BOnlineUser.[n].SipProxyAddress
  • Type: String
GraphPolicy
  • Field Name: S4BOnlineUser.[n].GraphPolicy
  • Type: String
  • Target: device/skypeforbusinessonline/CsGraphPolicy
  • Target attr: Identity
  • Format: uri
Manager
  • Field Name: S4BOnlineUser.[n].Manager
  • Type: String
Street
  • Field Name: S4BOnlineUser.[n].Street
  • Type: String
HomePhone
  • Field Name: S4BOnlineUser.[n].HomePhone
  • Type: String
PendingDeletion
  • Field Name: S4BOnlineUser.[n].PendingDeletion
  • Type: Boolean
IPPBXSoftPhoneRoutingEnabled
  • Field Name: S4BOnlineUser.[n].IPPBXSoftPhoneRoutingEnabled
  • Type: Boolean
LegalInterceptPolicy
  • Field Name: S4BOnlineUser.[n].LegalInterceptPolicy
  • Type: String
HomeServer
  • Field Name: S4BOnlineUser.[n].HomeServer
  • Type: String
Msol User
  • Field Name: MsolUser.[n]
  • Type: Array
  • Cardinality: [0..1]
City The city of the user.
  • Field Name: MsolUser.[n].City
  • Type: String
DisplayName * The display name of the user.
  • Field Name: MsolUser.[n].DisplayName
  • Type: String
FirstName The first name of the user.
  • Field Name: MsolUser.[n].FirstName
  • Type: String
Title The title of the user.
  • Field Name: MsolUser.[n].Title
  • Type: String
LastName The last name of the user.
  • Field Name: MsolUser.[n].LastName
  • Type: String
TenantId The unique ID of the tenant to perform the operation on. If this is not provided then the value will default to the tenant of the current user. This parameter is only applicable to partner users.
  • Field Name: MsolUser.[n].TenantId
  • Type: String
State The state where the user is located.
  • Field Name: MsolUser.[n].State
  • Type: String
PasswordNeverExpires Sets whether or not the user's password will expire periodically.
  • Field Name: MsolUser.[n].PasswordNeverExpires
  • Type: Boolean
Department The department of the user.
  • Field Name: MsolUser.[n].Department
  • Type: String
LicenseAssignment List of licenses to assign the user.
  • Field Name: LicenseAssignment.[n]
  • Type: Array
AlternateMobilePhones Alternate mobile phone numbers of the user
  • Field Name: AlternateMobilePhones.[n]
  • Type: Array
AlternateEmailAddresses The alternate email addresses of the user.
  • Field Name: AlternateEmailAddresses.[n]
  • Type: Array
BlockCredential When true, the user will not be able to log on using their user ID.
  • Field Name: MsolUser.[n].BlockCredential
  • Type: Boolean
IsLicensed
  • Field Name: MsolUser.[n].IsLicensed
  • Type: Boolean
Country The country of the user.
  • Field Name: MsolUser.[n].Country
  • Type: String
Password The new password for the user. If the user is set to require a strong password, then all of the following rules must be met: - The password must contain at least one lowercase letter - The password must contain at least one uppercase letter - The password must contain at least one non-alphanumeric character - The password cannot contain any spaces, tabs, or line breaks - The length of the password must be 8-16 characters - The user name cannot be contained in the password If this value is omitted, then a random password will be assigned to the user.
  • Field Name: MsolUser.[n].Password
  • Type: String
UsageLocation The location of the user where services are consumed. Must be a two-letter country code.
  • Field Name: MsolUser.[n].UsageLocation
  • Type: String
ObjectId The unique ID of the user to retrieve.
  • Field Name: MsolUser.[n].ObjectId
  • Type: String
PreferredLanguage The preferred language of the user.
  • Field Name: MsolUser.[n].PreferredLanguage
  • Type: String
ForceChangePassword When true, the user will be required to change their password the next time they sign in.
  • Field Name: MsolUser.[n].ForceChangePassword
  • Type: Boolean
Fax The fax number of the user.
  • Field Name: MsolUser.[n].Fax
  • Type: String
StreetAddress The street address of the user.
  • Field Name: MsolUser.[n].StreetAddress
  • Type: String
PhoneNumber The phone number of the user.
  • Field Name: MsolUser.[n].PhoneNumber
  • Type: String
PostalCode The postal code of the user.
  • Field Name: MsolUser.[n].PostalCode
  • Type: String
MobilePhone The mobile phone number of the user.
  • Field Name: MsolUser.[n].MobilePhone
  • Type: String
Office The office of the user.
  • Field Name: MsolUser.[n].Office
  • Type: String
UserPrincipalName * The user ID for this user. This is required.
  • Field Name: MsolUser.[n].UserPrincipalName
  • Type: String
ImmutableId The immutable ID of the user's federated identity. This should be omitted for users with standard identities.
  • Field Name: MsolUser.[n].ImmutableId
  • Type: String
ProxyAddresses
  • Field Name: ProxyAddresses.[n]
  • Type: Array
LicenseOptions License options for license assignment. Used to selectively disable individual service plans within a SKU.
  • Field Name: MsolUser.[n].LicenseOptions
  • Type: String
SignInName
  • Field Name: MsolUser.[n].SignInName
  • Type: String
Licenses
  • Field Name: Licenses.[n]
  • Type: Array
Name
  • Field Name: MsolUser.[n].Licenses.[n].FriendlyName
  • Type: String
EnabledPlans
  • Field Name: EnabledPlans.[n]
  • Type: Array
Name
  • Field Name: MsolUser.[n].Licenses.[n].EnabledPlans.[n].FriendlyName
  • Type: String
ServiceType
  • Field Name: MsolUser.[n].Licenses.[n].EnabledPlans.[n].ServiceType
  • Type: String
ServiceName
  • Field Name: MsolUser.[n].Licenses.[n].EnabledPlans.[n].ServiceName
  • Type: String
ServicePlanId
  • Field Name: MsolUser.[n].Licenses.[n].EnabledPlans.[n].ServicePlanId
  • Type: String
  • Target: device/msonline/UCServicePlan
  • Target attr: ServicePlanId
  • Format: uri
AccountSkuId
  • Field Name: MsolUser.[n].Licenses.[n].AccountSkuId
  • Type: String
  • Target: device/msonline/MsolAccountSku
  • Target attr: AccountSkuId
  • Format: uri
StrongPasswordRequired Sets whether or not the user requires a strong password.
  • Field Name: MsolUser.[n].StrongPasswordRequired
  • Type: Boolean