[Index]

Model: relation/SubscriberPhone

Phones

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This procedure configures phones.

Preparation for Adding Phones (CUCM)

Before adding phones in VOSS Automate, you will need to add and configure the following items on Cisco Unified Communications Manager (Unified CM), and then import these items into VOSS Automate:

View and Update Sites Defaults for Phones

When setting up VOSS Automate, default values are created when adding Providers, Customers, and Sites. For example, the Site IDs. If the site dial plan specifies Device Pool, CSS, and Partition names, these can also be selected. To identify the site-related values, see the naming conventions used in Modify Site Defaults.

The Site Defaults also populates certain default values for phones.

To view and update site defaults for phones:

  1. In the VOSS Automate Admin Portal, go to (default menus) Site Management > Defaults.

  2. Click the relevant site defaults doc in the list.

  3. View or update phone parameter defaults for the site on the following tabs:

    Note

    • CSS Filtering only applies to HCS dial plans.
    • If Enable CSS filtering is selected in the customer dial plan, the available calling search spaces includes only those marked as Class of Service at the site (via, default menus, Dial Plan Management > Site > Class of Service). You can add a custom CSS in a CSS field if you know the exact syntax.
    • If Enable CSS filtering checkbox is cleared, the available calling search spaces includes all CSSs configured on Unified CM.

Add a Phone

This procedure adds a phone.

Note

It is recommended that you use Smart Add phone to add standalone phones and use Quick Add Subscriber to add phones to subscribers. See Smart Add Phone Overview and Quick Add Subscriber.

  1. Log in to the Admin Portal as a Provider, Customer, or Site admin.

    Note

    Only a subset of fields are available to Site admins.

  2. Choose the hierarchy.

  3. Go to (default menus) Subscriber Management > Phones.

  4. View the list of phones on the Phones list.

    Note

    An administrator with the required access profile can click Fetch real-time phone status on the toolbar to fetch the Unified CM phone IP address and status directly from the Unified CM. Data is fetched in real-time and displays read-only values in the following columns:

    • Registration Status column (for example, "None", "UnRegistered with CUCM-11-5-IP2", "Registered with CUCM-11-5-IP2")
    • IP Address column

    Fetched data is not cached or stored in the database, and cannot be exported or filtered. Real-time data displays the latest data for the current list of phones on the Admin Portal. Prior to fetching real-time status updates, existing column values display cached values from the RIS data collector (if enabled).

    The Activate Phone Status Service setting is enabled by default and can be managed by system level administrators. See the Advanced Configuration Guide for details.

  5. Click Add, then configure the phone and its associated settings on the following tabs.

    Tab Description
    Phone

    Default values are applied for some fields (such as Device Protocol, BAT Phone Template, and Device Security Profile), based on the selected product type.

    The Vendor Config settings are related to the selected phone type.

    Fields that display are based on the selected Product (device type) and the Device Protocol (such as SIP or SCCP).

    The supported features available for each phone type are retrieved from the related Unified CM.

    To override the default Phone Button Template, either choose another template, or enter a custom value. The new value is applied on the Unified CM if it allows that phone type.

    If you don't see a template that you are looking for in the drop-down list (for example, for Phone Button Template, Device Security Profile or SIP Profile), edit the template on Unified CM, and then sync the template into VOSS Automate to have it appear in the drop-down list.

    If the Product type list does not contain the phone or endpoint you want, take the following steps. In Unified CM, install a COP file for the endpoint you want. Install the COP file only once for the Unified CM instance where the endpoint is added. Then in VOSS Automate, import the phone button template from Unified CM.

    Follow these steps while creating a CTI Remote Device to enable Extend and Connect in VOSS Automate:

    1. Enter the Device Name. For example, CTIRD<USERID>.
    2. Choose the Product as CTI Remote Device.
    3. Choose the Owner User ID from the drop-down list.
    4. Choose the SUBSCRIBE Calling Search Space name from the drop-down list.
    5. Choose the Rerouting Calling Search Space name from the drop-down list.
    Lines

    This tab serves two purposes.

    1. To show all the lines that are associated with the device
    2. To associate lines with the device.

    The Lines sections reflect the Lines object in Unified CM. You can add lines to this group and associate lines with the device. You can add custom lines by entering a line in the drop-down list. If Number Inventory is enabled, you can select a number from the list of available numbers.

    Speed Dials Allows you to configure speed dials for the device. Available speed dials depend on the device's Phone Button Template. The order in which Speed Dial entries are added matches the slots that are available in Unified CM.
    Services Used to set IP Phone services. Once you choose the IP phone service, the system retrieves the URL and a custom parameter (if any, for example, ext1 and ext2) from device/cucm/IpPhoneService, and populates the URL field.
    Busy Lamp Fields Allows you to configure busy lamps for the device. Available busy lamp fields depend on the device's Phone Button Template.
    Blf Directed Call Parks Allows you to configure Busy Lamp Field directed call parks for the device. Available BLF-directed call parks depend on the device's Phone Button Template. Create BLF-directed call parks in Call Routing > Directed Call Parks on Unified CM before configuring them from this tab. The available BLF-directed call parks match those created for each specific Route Partition Name.

    System Message: ERROR/3 (<string>, line 206)

    Malformed table.

    +---------------------------------+------------------------------------------------------------------------------------+
    | Tab                             | Description                                                                        |
    +=================================+====================================================================================+
    |                                 | Only applies to a Dual Mode Phone, Spark Remote                                    |
    |                                 | Device, or CTI Remote Device, and allows you to                                    |
    |                                 | enter the relevant Mobile Identity and Remote                                      |
    | Dual Mode Settings              | Destination (or CTI Remote Destination)                                            |
    |                                 | parameters for the device. These parameters                                        |
    |                                 | include Name, Destination Number, Owner User ID,                                   |
    |                                 | Dual Mode Device Name (or CTI Remote Device), and                                  |
    |                                 | Answer Too Soon and Too Late Timers.                                               |
    +---------------------------------+------------------------------------------------------------------------------------+
    |                                 | Only applies to a Dual Mode Phone, Spark Remote                                    |
    |                                 | Device, or CTI Remote Device, and allows you to                                    |
    |                                 | enter the relevant Mobile Identity and Remote                                      |
    | Certificate Authority Functions | Destination (or CTI Remote Destination)                                            |
    |                                 | parameters for the device. These parameters                                        |
    |                                 | include Name, Destination Number, Owner User ID,                                   |
    |                                 | Dual Mode Device Name (or CTI Remote Device), and                                  |
    |                                 | Answer Too Soon and Too Late Timers. See                                           |
    |                                 | Certificate Authority Functions Fields                                      |
    |                                 |                                                                                    |
    |                                 | The date-time value must be added manually as: ``CCYY:MM:DD:HH:MM``                |
    +---------------------------------+------------------------------------------------------------------------------------+
    
  1. Save your changes to add the phone.

Update a Phone

Note the following for updating a phone:

Note

If the required Unified CM setting "Customer Support upload URL" is configured at the Enterprise, Profile, or Device level, then the Action menu option Generate Prt Phone can be used to send a Problem Report Tool (PRT) file to the upload URL.

View and Update Phone Vendor Config Settings

The Vendor Config settings will display if the Field Display Policy (FDP) allows it.

You can access the vendor configuration settings for a phone as follows:

  1. In the Admin Portal, go to (default menus) Subscriber Management > Phones.

  2. On the Phones list view, click on a phone to open its settings.

  3. On the Phones tab, scroll down to the bottom of the page to locate the Vendor Config setting.

  4. Click Vendor Config to open the configuration screen:

    Settings can be enabled or disabled. Ensure you're setting values correctly for Bulk Loaders, the API, or in custom Configuration Templates, where values must be defined as key-value pairs:

Phone Type Management

After you make changes to any phone model specific data in Unified CM, for example by loading a new BAT file, editing phone button templates, security profiles, and so on, then in order to utilize that data in VOSS Automate, you need to do a sync of the Unified CM.

Include the following models in the data sync - depending on what you changed:

If you do a full sync or full import this will make the changes available in VOSS Automate. However, between full syncs, it is best practice to create a sync setup with a model type list that includes the above model types. This allows you to run an ad-hoc sync with a very limited scope as needed - if changes are made in the Unified CM that require a sync.

If adding new phone types to the system, you may also need to edit your device groups and entitlement profiles (if used) to have them show as options to the correct users.

Enhanced INI Filtering

If the Enhanced INI Filtering feature is enabled, administrators have access to the Inventory Filter dropdown list menu for lines on the following forms:

The filter would typically be used to show a filtered, shorter dropdown list of directory numbers.

Note

If the Internal Number Inventory (INI) feature is not enabled, Enhanced INI Filtering will not be applied and all the list of numbers are obtained from the device.

The following options are available in the Inventory Filter list:

Phone based relation.

Model Details: relation/SubscriberPhone

Title Description Details
Phone Group Assigned by FDP
  • Field Name: Phone
  • Type: Object
Registration Status Registration status of the phone
  • Field Name: Phone.status
  • Type: String
IP Address IP address of the phone
  • Field Name: Phone.ip_address
  • Type: String
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.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Product * Product ID string. read-only except when creating a device.
  • Field Name: Phone.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.description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Device Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: Phone.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"]
Phone Button 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.phoneTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/PhoneButtonTemplate
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
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.securityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/PhoneSecurityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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.softkeyTemplateName
  • Type: ["String", "Null"]
  • Target: device/cucm/SoftKeyTemplate
  • 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.commonPhoneConfigName
  • Type: String
  • Target: device/cucm/CommonPhoneConfig
  • 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.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Pool Name * 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.devicePoolName
  • Type: String
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Cardinality: [1..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.locationName
  • Type: String
  • Target: device/cucm/Location
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
BLF Presence Group
  • Field Name: Phone.presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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.sipProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/SipProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Digest User This field is applicable only to SIP phones.
  • Field Name: Phone.digestUser
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • MaxLength: 255
  • Format: uri
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.deviceMobilityMode
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
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.rerouteCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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.subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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.dndOption
  • Type: String
  • Cardinality: [0..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
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.dndRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Do Not Disturb Check this check box to enable Do Not Disturb on the phone.
  • Field Name: Phone.dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Enable Extension Mobility Check this check box if this phone supports extension mobility.
  • Field Name: Phone.enableExtensionMobility
  • Type: Boolean
  • Cardinality: [0..1]
Is Dual Mode Read-only tag.
  • Field Name: Phone.isDualMode
  • Type: Boolean
  • Cardinality: [0..1]
Allow CTI Control Flag 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.allowCtiControlFlag
  • Type: Boolean
  • Cardinality: [0..1]
Hot line Device This tag is applicable for PLAR-supporting SIP/SCCP phones only
  • Field Name: Phone.hotlineDevice
  • Type: Boolean
  • Cardinality: [0..1]
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.mobilityUserIdName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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.primaryPhoneName
  • Type: ["String", "Null"]
  • Target: device/cucm/Phone
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
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.userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
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.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"]
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.ownerUserName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Vendor Config
  • Field Name: vendorConfig.[n]
  • Type: Array
Key
  • Field Name: Phone.vendorConfig.[n].key
  • Type: String
Value
  • Field Name: Phone.vendorConfig.[n].value
  • Type: Any
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
Link To Line Link to the line resource
  • Field Name: Phone.lines.line.[n].line_link
  • Type: String
  • Format: link
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Pattern *
  • Field Name: Phone.lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: Phone.lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Position
  • Field Name: Phone.lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
E164Mask
  • Field Name: Phone.lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Label
  • Field Name: Phone.lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Display
  • Field Name: Phone.lines.line.[n].display
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Display Ascii
  • Field Name: Phone.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.lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
Speeddials
  • Field Name: speeddials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Speeddial
  • Field Name: speeddial.[n]
  • Type: Array
Dirn *
  • Field Name: Phone.speeddials.speeddial.[n].dirn
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 255
Position
  • Field Name: Phone.speeddials.speeddial.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Label
  • Field Name: Phone.speeddials.speeddial.[n].label
  • Type: String
  • Cardinality: [1..1]
Services
  • Field Name: services
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Service
  • Field Name: service.[n]
  • Type: Array
Service Name Ascii
  • Field Name: Phone.services.service.[n].serviceNameAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Url
  • Field Name: Phone.services.service.[n].url
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Url Button Index
  • Field Name: Phone.services.service.[n].urlButtonIndex
  • Type: Integer
  • Cardinality: [0..1]
Url Label
  • Field Name: Phone.services.service.[n].urlLabel
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Busy Lamp Fields
  • Field Name: busyLampFields
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Busy Lamp Field
  • Field Name: busyLampField.[n]
  • Type: Array
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.busyLampFields.busyLampField.[n].blfDest
  • Type: String
  • Cardinality: [1..1]
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.busyLampFields.busyLampField.[n].blfDirn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Position
  • Field Name: Phone.busyLampFields.busyLampField.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Label
  • Field Name: Phone.busyLampFields.busyLampField.[n].label
  • Type: String
  • Cardinality: [0..1]
Route Partition
  • Field Name: Phone.busyLampFields.busyLampField.[n].routePartition
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Blf Directed Call Parks
  • Field Name: blfDirectedCallParks
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Blf Directed Call Park
  • Field Name: blfDirectedCallPark.[n]
  • Type: Array
Label
  • Field Name: Phone.blfDirectedCallParks.blfDirectedCallPark.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Position
  • Field Name: Phone.blfDirectedCallParks.blfDirectedCallPark.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Directed Call Park Id Only the uuid attribute is read
  • Field Name: Phone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkId
  • Type: String
  • Cardinality: [0..1]
  • Pattern: \{........-....-....-....-............\}
Directed Call Park Dn And Partition
  • Field Name: directedCallParkDnAndPartition
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dn Pattern *
  • Field Name: Phone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.dnPattern
  • Type: ["String", "Null"]
  • Target: device/cucm/DirectedCallPark
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Route Partition Name
  • Field Name: Phone.blfDirectedCallParks.blfDirectedCallPark.[n].directedCallParkDnAndPartition.routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Remote Destinations Group Assigned by FDP
  • Field Name: Remote Destinations
  • Type: Object
Remote Destination
  • Field Name: RemoteDestination.[n]
  • Type: Array
Name Enter a name that identifies the remote destination or mobile identity.
  • Field Name: Remote Destinations.RemoteDestination.[n].name
  • Type: String
  • 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: Remote Destinations.RemoteDestination.[n].destination
  • Type: String
  • Cardinality: [1..1]
Dual Mode Device Name
  • Field Name: Remote Destinations.RemoteDestination.[n].dualModeDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..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: Remote Destinations.RemoteDestination.[n].answerTooSoonTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 1500
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: Remote Destinations.RemoteDestination.[n].answerTooLateTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 19000
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: Remote Destinations.RemoteDestination.[n].delayBeforeRingingCell
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 4000
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: Remote Destinations.RemoteDestination.[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"]
Mobile Smart Client Name This tag is not applicable for dualmode phones
  • Field Name: Remote Destinations.RemoteDestination.[n].mobileSmartClientName
  • Type: ["String", "Null"]
  • 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: Remote Destinations.RemoteDestination.[n].mobilityProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/MobilityProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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: Remote Destinations.RemoteDestination.[n].singleNumberReachVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
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: Remote Destinations.RemoteDestination.[n].dialViaOfficeReverseVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
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: Remote Destinations.RemoteDestination.[n].enableMobileConnect
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
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: Remote Destinations.RemoteDestination.[n].isMobilePhone
  • Type: Boolean
  • Cardinality: [0..1]
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: Remote Destinations.RemoteDestination.[n].lineAssociations.lineAssociation.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name
  • Field Name: Remote Destinations.RemoteDestination.[n].lineAssociations.lineAssociation.[n].routePartitionName
  • Type: String
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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: Remote Destinations.RemoteDestination.[n].enableExtendAndConnect
  • Type: Boolean
  • Cardinality: [0..1]
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: Remote Destinations.RemoteDestination.[n].ctiRemoteDeviceName
  • Type: String
  • Cardinality: [0..1]
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: Remote Destinations.RemoteDestination.[n].ownerUserId
  • Type: String
  • Cardinality: [1..1]
Enable Unified Mobility While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
  • Field Name: Remote Destinations.RemoteDestination.[n].enableUnifiedMobility
  • Type: Boolean
  • Cardinality: [0..1]