Configure Cisco Wireless Phone 9821 on Control Hub

Phone feature configuration on Control Hub

You can set up phones to have a variety of features, based on the needs of your users. You can apply features to all phones, a group of phones, or to individual phones. When you set up features on Control Hub, note that the configuration follows a hierarchical structure; therefore, if you configure a setting for an individual device, it takes precedence over the same setting configured at the location or organization level. In summary, the precedence order is:

Individual phones (highest precedence)
Location
Organization (lowest precedence)

Configure phones at organization level

Configure settings for all phones deployed within your organization to improve efficiency and reduce administrative overhead.

The configuration follows a hierarchical structure; therefore, if you configure a setting for an individual device or at the location level, it takes precedence over the same setting configured at the organization level.

1	From the customer view in Control Hub, go to Devices and select Settings.
2	Go to the Configuration Defaults tab and select Open org-wide defaults.
3	Search for an existing configuration or add a new one. To change an existing configuration, enter the parameter name in the search bar and open the configuration. To add a configuration, select Add configurations. Search for the configuration by product name or by parameter name and open it. See the supported phone parameters in Parameters for Cisco Wireless Phone 9821 settings on Control Hub.
4	Change the settings.
5	Click Next after you finish the configurations.
6	Review your change and click Apply changes.

Configure phones at location level

You can configure your phones based on a physical location, allowing for flexible adjustments that won’t affect settings in other areas of the organization.

The configuration follows a hierarchical structure; therefore, if you configure a setting for an individual device, it takes precedence over the same setting configured at the location level.

1	From the customer view in Control Hub, go to Devices and select Settings.
2	Go to the Configuration Defaults tab.
3	If the desired location is available in the location list, select the Edit icon on it to open the configuration. Otherwise, select Set defaults on location and search for the location.
4	Search for the configuration by product name or by parameter name and open it. See the supported phone parameters in Parameters for Cisco Wireless Phone 9821 settings on Control Hub.
5	Change the settings.
6	Select Next after you finish the configurations.
7	Review your change and select Apply changes.

Configure settings for multiple phones

You can configure settings for multiple phones at once to save time.

1	From the customer view in Control Hub, go to Devices, and then select the phones that you want to configure.
2	Click Edit in the top right of the device list.
3	Click All configurations. All the configurations that are applicable to the selected devices are displayed.
4	Modify the configurations that you want to apply to the selected devices. Expand a configuration to view its supported devices. Certain configurations allow you to customize values by device type.
5	Click Next.
6	Review your changes and click Apply. The results show the successfully applied settings and unsupported configuration items.
7	Click Close to close the page.

Configure settings for an individual phone

The configuration follows a hierarchical structure; therefore, if you configure a setting for an individual device, it takes precedence over the same setting configured at the location or organization level.

1	From the customer view in Control Hub, go to Devices, and then select your phone.
2	Select All configurations.
3	Set the desired parameters in the respective sections. For more information about these parameters, see Parameters for Cisco Wireless Phone 9821 settings on Control Hub.
4	Select Next.
5	Review your changes and select Apply.
6	Select Close to close the page.

Configure phones with a configuration template

A configuration template is a collection of custom settings for devices or a location. Administrators can create and use configuration templates to apply collections of settings to groups of devices. These templates help to simplify the management of devices in your organization.

Create a configuration template for phones

You can add configurations for either a specific device type or multiple device types. When the template is applied, the system only implements compatible settings and skips those that don't apply.

1	From the customer view in Control Hub, go to Devices > Templates.
2	Click Create template.
3	Enter the unique template name and optionally provide a description for the template.
4	Select the configurations to add to your template. By default, the configuration list displays all available settings for all device types. You can search for specific configurations. To search for applicable configurations for your device, select your device model in the Filter by device type drop-down list. To search for a specific configuration, enter the parameter name in the search bar. See the supported phone parameters in Parameters for Cisco Wireless Phone 9821 settings on Control Hub.
5	Change the configuration values. Expand a configuration to view its supported devices. Certain settings allow you to customize values by device type.
6	Continue adding more configurations to the template. To go back to the configuration list, use the breadcrumb on the page.
7	When finished, click Next and review your configurations. You can edit or remove configurations as needed.
8	Click Create to complete the template.

Apply a configuration template to devices

You can apply a template to either a group of devices or an individual device.

Before you begin

You have a configuration template that is created for your devices.

1	From the customer view in Control Hub, go to Devices.
2	Select one or more devices by ticking the check box on each device entry.
3	Click Edit in the upper right of the list.
4	Click Configuration templates in the Configurations section.
5	Select the template in the drop-down list. The configurations included in the template display.
6	Click Next and review the configurations. Only the supported configurations will be applied to the selected devices.
7	Click Apply. The results show the successfully applied settings and unsupported configuration items.

Apply a configuration template to an individual device

Before you begin

You have a configuration template that is created for your device.

1	From the customer view in Control Hub, go to Devices.
2	Search for your device and open the device details.
3	Click Configuration templates in the Configurations section.
4	Select the template in the drop-down list. The configurations included in the template display.
5	Click Next and review the configurations. Only the supported configurations will be applied to the selected device.
6	Click Apply. The results show the successfully applied settings and unsupported configuration items.

Parameters for Cisco Wireless Phone 9821 settings on Control Hub

The following table includes a diversity of parameters available under All Configurations on Control Hub, catering to a wide range of needs and functionalities.

Parameter	Default and options	Description
Certificate > SCEP Configuration If you configure SCEP on the phone web page before the phone's onboarding process, the configuration will be kept and synchronized to Control Hub after the onboarding.
Root CA Fingerprint	Default: Empty	Specifies an SHA256 or SHA1 fingerprint of the Root CA for validation during the SCEP process.
Server	Default: Empty	Specifies the an SCEP server address (URL or IP address), which is used to install CDC on the phone. Note that the HTTPS scheme isn't supported.
Lines
Line[n] Call Feature Settings Missed Call Notification	Default: Yes Options: Yes, No	Enables or disables visual notifications for missed calls on the line.
Phone > Action Button Customize the Action button to initiate events that suit your specific use cases. See Configure the Action button (Control Hub) for detailed configuration tasks.
Action Button Function	Default: Off Options: Off, Emergency Call, Custom	You can configure the button with a specific service. Off: When set to Off, the Action button for single service on the phone will not function. Emergency Call: Users can use the Action button to place an emergency call, if configured. Custom: Users can use the Action button to access the custom service, if configured. When you set the field to Emergency Call or Custom, make sure that you enter the service destination in the Action Button Service Destination field. Or, the phone will display a configuration error.
Action Button Service Destination	Default: Empty	Provide the service destination in one of the following formats based on the service assigned to the Action button: For emergency call services, enter a telephone number or the URI of emergency service. When configure the button for a custom service, enter the service URL. The URL must start with `http://` or `https://`. For example, `https://10.11.20.159/path/service.xml`. To configure the button to initiate multiple events with a single trigger, enter `tel:<phonenumber or SIP URL> + <Service RUL>`. Example: `tel:1234 + https://10.11.20.159/path/service.xml`. Calling SIP URIs is also supported. Enter the URI in the format of `tel: sip 4567@co.webex.com` For more information about a single trigger for multiple events, see A single trigger for multiple events parameter settings. If you enable the Action button without setting a valid service destination, the user on the phone will see a message prompting for configuration. After the user closes this notification, the warning icon will persist in the header of the phone screen until the button is properly configured or disabled. Phone numbers cannot be used as destinations for custom services. If you configure the Action Button as Custom and enter a phone number as the service destination, an alert message will display on the phone indicating that the button is unconfigured. Instead, you can add a phone number in this format `tel:<phone number>`, for example, `tel:1234`.
Action Button Service Name	Default: Empty	Optionally specify a name for the service associated with the Action button. This name will be displayed in the on-screen message when the user presses the button, indicating which service will be triggered. If you don't specify a name, the default name will be Emergency call, Silent emergency call, or Custom action based on your selection in the Action Button Function field.
Allow Silent Emergency Call Retrieval	Default: No Options: Yes, No	Controls whether users can retrieve phone functionality during a silent emergency call. By default, once a silent emergency call is initiated, the phone locks all functions until the call recipient ends the call. When this parameter is set to Yes, users can press any key to restore normal phone operation while maintaining the emergency call. The call audio remains silent unless the user increases the volume using the Volume key.
Custom Content Field	Default: Empty	This setting works only when the Action Button Function is set to Custom. Enter the HTTP data such as method, header, and post content, with a maximum length of 1024 characters. When configured, the phone sends an HTTP Post request when the Action is pressed. You can use macros in the HTTP data, such as `$MA`, `$SN`. For POST script examples and the syntax, see HTTP Post request for the Action button.
Dial Out Delay	Default: 5 Options: 0 - 30	Set the timeout period, in seconds, for the phone to initiate an emergency call or a custom action after the Action button is pressed. Set it to 0 if you prefer the phone to place the call or initiate an event immediately upon detecting the trigger, as specified by a single press, long press, or triple presses on the button. The delay screen displays a countdown timer, allowing the user to cancel the action triggered by the Action button. During emergency call and custom services scenarios, Cisco Wireless Phone 9821 vibrates continuously while the delay screen is displayed. However, for silent emergency calls or signals, Cisco Wireless Phone 9821 does not vibrate.
Service Trigger	Default: Single Press Options: Single Press, Long Press, Press 3 times, MultiTrigger	Choose how users can place an emergency call or initiate a custom service using the phone's Action button. Single Press: Press the Action button to trigger the associated call or service. Long Press: Press the Action button down for at least 2 seconds to trigger the associated call or service. Press 3 times: Press the Action button three times with intervals of one second between each press to trigger the associated call or service. MultiTrigger: Select this option to associate multiple triggers and events to the Action button. Go to the Service Trigger MultiTrigger section to select a trigger and configure the specific settings. For detailed information about multiple triggers, see Configure multiple triggers.
Service Trigger MultiTrigger	Options: Single Press, Long Press, Press 3 times	This setting works only when Service Trigger is set to MultiTrigger. Choose a trigger from the available options to open and configure the settings. For detailed information about multiple triggers, see Configure multiple triggers. For details about the MultiTrigger parameters, see Parameters for MultiTrigger.
Silent Emergency Call	Default: Disabled Options: Enabled, Disabled	Silent emergency call is designed for discreet assistance in dangerous situations. It enables users to seek help without making any noise. When enabled, users are able to place one-way calls with the Action button. After the silent emergency call is placed, only the other party can end the call. To avoid drawing attention during the ongoing call, the Cisco Wireless Phone 9821 screen will be turned off. The phone locks all functions during a silent emergency call, by default. To allow users to restore normal phone operation while maintaining the silent emergency call, enable the Allow Silent Emergency Call Retrieval feature. When disabled, the emergency call functions as a two-way call, similar to other outgoing calls.
Phone > Call History
Call History	Default: Webex Options: Phone, Webex	Sets call history to either use the local history or the Webex unified call history from all of the end user's devices. This setting currently only applies to user devices and doesn't apply to workspace devices.
Phone > Dialing Mode
Dialing Mode	Default: On-hook Dialing Options: On-hook Dialing, Off-hook Dialing	Controls the behavior of the Answer/Send key when it is pressed. If On-hook Dialing is selected, then the phone will remain on-hook. If Off-hook Dialing is selected, then phone sends an off-hook message.
Phone > Directory Service
Enable Directory Search For Offhook Dial	Default: No Options: Yes, No	Enables or disables contact searching in directories during an off-hook call.
Phone > Divert Alerting Call
Divert Alerting Call	Default: Enabled Options: Enabled, Disabled	Controls whether or not to show the Decline softkey for Incoming Call Alert.
Phone > Home Screen
Home Screen	Default: Application View Options: Application View, Line View	Sets the phone's default home screen to Application View or Line View.
Phone > Line Key Label
Line Key Label	Default: User Name (First Name Last Name) Options: User Extension / First Name User Name (First Name Last Name) User Name (Last Name First Name)	Sets a predefined number or name format to display as the line label for configured lines.
Phone > Line Key Settings
Call Appearances Per Line	Default: 6 Options: 1 - 10	Sets the maximum number of calls allowed on a line.
Revert To All Calls	Default: No Options: Yes, No	Enables or disables the Revert to All Calls feature. The phone automatically reverts to the primary line after the final call on a line ends, provided the following conditions are met: Revert to All Calls is set to Yes. Show All Calls On Primary Line is set to Yes. The current line has no remaining active calls.
Show All Calls On Primary Line	Default: No Options: Yes, No	Enables or disables the Show All Calls On Primary Line feature. When enabled, the phone displays a list of all active calls on the primary line, which is useful if a user wants to see all calls on a single screen, especially when a user has multiple lines or share lines with other users. The Show All Calls On Primary Line feature operates only when both the Show All Calls On Primary Line and Revert To All Calls options are set to Yes.
Phone > Locked Screen Emergency Numbers
Locked Screen Emergency Numbers	Default: Empty	Sets the emergency numbers that can be dialed without unlocking the phone keypad. Example: 911,411
Phone > Menu Customization Opens the menu item list, where you can customize the Settings menu by hiding items that you don't want users to access. By default, all menu items are visible to phone users. See Customize the Settings menu for details.
Phone > Programmable Softkeys on Wireless Phone
Programmable Softkeys		See Configure the Programmable Softkeys (Control Hub) for details.
Phone > Shortcut Soft Key
Shortcut Soft Key	Default: None Options: None, Voicemail	Determines whether a shortcut to Voicemail is available or not. The Shortcut softkey is located on the left side below the phone screen. This position remains fixed, even when the display is set to a right-to-left (RTL) language.
Phone > Voicemail Access
Voicemail Access	Default: Enabled Options: Enabled, Disabled	Enables or disables access to Voicemail.
Phone > Webex
Directory Enable	Default: No Options: Yes, No	Enables or disables Webex directory service for the phone. When enabled, users on the phone can access and search for the contacts stored in the directory.
Directory Name	Default: Empty	Sets the display name for the directory.
Phone > XML Service
XML Application Service Name	Default: Empty	Defines the internal name for the XML application. While this name is hidden from the phone interface, users can launch the application directly from the Apps app.
XML Application Service URL	Default: Empty	Enters the URL where the XML application is located. For the supported XML objects and URIs, see Supported XML objects and URIs. Macro variables are supported in XML URLs. For the valid macro variables, see Macro variables supported in XML URLs.
Regional > Control Timer Values
Interdigit Long Timer	Default: 10 Options: 0 - 65535	Defines the amount of time that the phone will wait when no digit patterns match before the phone dials the number. A smaller time value causes unmatched dialed digits to be dialed quickly.
Interdigit Short Timer	Default: 3 Options: 0 - 65535	Defines the amount of time that the phone waits for the user to enter a digit. A smaller timer value requires digits to be dialed quickly.
Regional > Phone Language
Phone Language	Default: English-US	Sets the display language for the phone. This value will override the default value derived from its provisioned Location.
SIP
ICE	Default: No Options: Yes, No	Controls whether to allow SIP Media streams to go directly between phones on the same local network.
User Preferred Offhook Timer	Default: Empty Options: 0 - 30	This timer starts when the phone goes off hook. If no digits are dialed within the specified number of seconds, the timer expires and the null entry is evaluated. Unless you have a special dial plan string to allow a null entry, the call is rejected.
Software
Upgrade Channel	Default: Stable Options: Stable, Stable_Delay, Preview	Sets the channel for the phone to get firmware updates.
System > Bluetooth Enabled
Bluetooth Enabled	Default: No Options: Yes, No	Enables or disables the Bluetooth^® function on the phone. When enabled, phone users can connect their Bluetooth headsets to the phone.
System > IEEE802.1X If you configure the 802.1X authentication on the phone UI or phone web page before the phone's onboarding process, the configuration will be kept and synchronized to Control Hub after the onboarding.
IEEE802.1X	Default: No Options: Yes, No	Enables or disables Port Based Network Access Control for devices. Setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
IEEE802.1X Certificate Select	Default: Manufacturing installed Options: Manufacturing installed, Custom installed	Sets which certificate (MIC or Custom) is used for the 802.1X authentication.
IEEE802.1X User ID	Default: Empty	Customizes the User ID for the 802.1X authentication in the wired network. This parameter also supports macro variables, see Macro variables supported in XML URLs for details. Ensure that IEEE802.1X Certificate Select is set to Custom Installed. Otherwise, the Common Name in MIC/SUDI will always be used as the identity for 802.1X. For wired 802.1X, this parameter takes precedence over the Common Name (in Certificate > SCEP Configuration). If both are configured, User ID will be the identity for wired 802.1X.
System > Optional Network Configuration
Debug Level	Default: Notice Options: Notice, Debug	Sets the logging level for troubleshooting. The debugging level may affect the performance of the phone and it’s advisable to use it during troubleshooting.
Use Config TOS	Default: No Options: Yes, No	Controls whether the phone uses the Time of Service (TOS) configurations.
System > Web Access
Web Access	Default: Yes Options: Yes, No	Enables or disables access to the phone’s web page and remote management using xAPI. When set to Yes, users and administrators can access the phone's web interface using the its IP address. Authorized administrators can also use xAPIs to remotely manage the phone. Contact Cisco Technical Assistance Center (TAC) to request or create xAPI administrator credentials. To check the xAPI admin account status, go to Info > Status > Phone Status in the phone's web interface. For information about the supported xAPIs and the related documentation, see https://phoneos.cisco.com.
User > Audio Volume
Bluetooth Volume	Default: 9 Options: 0 - 15	Sets the Bluetooth headset volume. The users on the phone can change the settings with the Volume key on the phone or the Volume button on the headset.
Handset Volume	Default: 10 Options: 0 - 15	Sets the handset volume. The users on the phone can change the settings with the Volume key on the phone.
Headset Volume	Default: 10 Options: 0 - 15	Sets the headset volume. The users on the phone can change the settings with the Volume key on the phone or on their headset.
Ringer Volume	Default: 9 Options: 0 - 15	Sets the ringer volume. The users on the phone can change the settings with the Volume key on the phone.
Speaker Volume	Default: 11 Options: 0 - 15	Sets the speaker volume. The users on the phone can change the settings with the Volume key on the phone.
User > Battery
Battery Lifetime Alert	Default: No Options: Yes, No	Enables or disables Battery Lifetime alert. When enabled, the phone reminds users to verify the battery's manufacture date and replace the battery if necessary.
Battery Lifetime Alert Interval	Default: 24 Months Options: 6 Months,12 Months, 24 Months	Specifies the interval time over which the Battery Lifetime Alert is generated.
Battery SN Reminder	Default: No Options: Yes, No	Enables or disables Battery SN Reminder. When enabled, the phone displays a reminder after each boot-up, advising users to verify the battery's manufacture date and replace the battery if necessary.
User > Compliant Standard
Compliant Standard	Default: TIA Options: TIA, ETSI, HAC	Selects an option for IP phone to comply with different telecom Audio Compliance Standards, including TIA(Telecommunications Industry Association), ETSI (European Telecommunications Standards Institute) and HAC (Hearing Aid Compatibility).
User > Microphone Audio Mobile
Microphone Audio On Wireless Phone	Default: Noise removal Options: Original, Noise removal, Optimize for my voice	Selects an option for how your microphone audio is processed and heard during calls. Original—Preserves all audios, including music and noise, without processing. Noise removal—Removes all noise. Optimize for my voice—Removes all noise and background voices. Audio optimization consumes additional power and can reduce battery life on Cisco Wireless Phone 9821.
User > Power Off In Multicharger
Power Off In Multicharger	Default: Disabled Options: Enabled, Disabled	Controls whether to automatically power off a Cisco Wireless Phone 9821 when a user puts it in the multicharger.
User > Screen
Appearance	Default: Violet Dark Options: Cyan Dark, Purple Dark, Blue Dark, Violet Dark, Blue Light, Violet Light, CustWallpaper <n>	Sets the wallpaper for the phone's home screen and the color theme for its user interface. For more details, see Custom wallpaper for Cisco Wireless Phone 9821 (Control Hub).
Custom Wallpaper	Default: Empty	Specifies the download URL of the custom wallpaper. For more details, see Custom wallpaper for Cisco Wireless Phone 9821 (Control Hub).
Display Brightness	Default: 12 Options: 1 - 15	Sets the display brightness.
User > Supplementary Services
DND Setting	Default: Yes Options: Yes, No	Enables or disables Do Not Disturb (DND) capability on the phone. When enabled, the users on the phone can turn DND on or off.
Date Format	Default: month/day Options: month/day, day/month	Defines the date format.
Time Format	Default: 12hr Options: 12hr, 24hr	Sets the display format for time.
User > WLAN Alert
Out Of Range Tone	Default: Disabled Options: Disabled, Beep once, Beep every 10 seconds, Beep every 30 seconds, Beep every 60 seconds	Controls the frequency of audible tones when the phone is out of range of an AP. The phone does not play audible alerts when the parameter value is "disabled." The phone can beep one time or regularly at 10, 30, or 60 second intervals. When the phone is within range of an AP, the alert stops.

The following table lists the parameters for MultiTrigger under Action button settings.

Table 1. Parameters for MultiTrigger
Parameter	Default and options	Description
Action Button Function	Default: Off Options: Off, Emergency Call, Custom	Select the service that phone users can access via the service trigger. Off: When set to Off, the action trigger will not function. Emergency Call: Users can place a call to the designated emergency number via the action trigger. Custom: Users can access the designated service via the action trigger. When you set the field to Emergency Call or Custom, make sure that you enter the proper service destination in the Action Button Service Destination field. Or, the phone will display a configuration error.
Action Button Service Destination	Default: Empty	Provide the phone number, the URI for emergency call, or the URL for the custom service. If you enter a service URL, the URL must start with `http://` or `https://`. Example: `https://10.11.20.159/path/service.xml`. Phone numbers cannot be used as destinations for custom services. If you configure the Action Button as Custom and enter a phone number as the service destination, an alert message will display on the phone indicating that the button is unconfigured. Instead, you can add a phone number in this format `tel:<phone number>`, for example, `tel:1234`.
Action Button Service Name	Default: Empty	Optionally specify a name for the service associated with the action trigger. This name will be displayed in the on-screen message when the user presses the button, indicating which service will be triggered. If you don't specify a name, the default name will be Emergency call, Silent emergency call, or Custom action based on your selection in the Action Button Function field.
Custom Content Field	Default: Empty	This setting works only when the Action Button Function is set to Custom. Enter the HTTP data such as method, header, and post content, with a maximum length of 1024 characters. When configured, the phone sends an HTTP Post request when the Action is pressed. You can use macros in the HTTP data, such as `$MA`, `$SN`. For POST script examples and the syntax, see HTTP Post request for the Action button.
Dial Out Delay	Default: 5 Options: 0 - 30	Set the timeout period, in seconds, for the phone to initiate an emergency call or a custom action after the Action button is pressed. Set it to 0 if you prefer the phone to place the call or initiate an event immediately upon detecting the trigger, as specified by a single press, long press, or triple presses on the button. The delay screen displays a countdown timer, allowing the user to cancel the action triggered by the Action button. During emergency call and custom services scenarios, Cisco Wireless Phone 9821 vibrates continuously while the delay screen is displayed. However, for silent emergency calls or signals, Cisco Wireless Phone 9821 does not vibrate.
Silent Emergency Call	Default: Disabled Options: Enabled, Disabled	Silent emergency call is designed for discreet assistance in dangerous situations. It enables users to seek help without making any noise. When enabled, users are able to place one-way calls with the Action button. After the silent emergency call is placed, only the other party can end the call. To avoid drawing attention during the ongoing call, the Cisco Wireless Phone 9821screen will be turned off. The phone locks all functions during a silent emergency call, by default. To allow users to restore normal phone operation while maintaining the silent emergency call, enable the Allow Silent Emergency Call Retrieval feature. When disabled, the emergency call functions as a two-way call, similar to other outgoing calls.

References

Supported XML objects and URIs

XML Services Interface (XSI) is a protocol that allows communication between applications and the phone system. You can add your own XSI services to your phone using the supported XML objects and URIs. After subscribing the phone to the services, users can access all the configured services on the phone by accessing the Apps 9821 Apps app icon app.

See the following lists for the XML objects and URIs that Cisco Wireless Phone 9821 supports.

For more information about how to use the XML objects and URIs, see Cisco Unified IP Phone Services Application Development Notes.

Supported XML objects

CiscoIPPhoneMenu
CiscoIPPhoneText
CiscoIPPhoneInput
CiscoIPPhoneDirectory
CiscoIPPhoneImage
CiscoIPPhoneImageFile
CiscoIPPhoneIconMenu
CiscoIPPhoneIconFileMenu
CiscoIPPhoneExecute
CiscoIPPhoneStatus
CiscoIPPhoneStatusFile

Supported URIs

Device
Dial
EditDail
Init
Key
Play (ringtones only)
Softkey

Macro variables supported in XML URLs

You can use macro variables in XML URLs. The following macro variables are supported:

User ID—UID1, UID2 to UIDn
Display name—DISPLAYNAME1, DISPLAYNAME2 to DISPLAYNAMEn
Auth ID—AUTHID1, AUTHID2 to AUTHIDn
Proxy—PROXY1, PROXY2 to PROXYn
MAC Address using lowercase hex digits—MA
Product Name—PN
Product Series Number—PSN
Serial Number—SERIAL_NUMBER

Table 2. Supported macros
Macro name	Macro expansion
$	The form $$ expands to a single $ character.
A through P	Replaced by general-purpose parameters GPP_A through GPP_P.
SA through SD	Replaced by special purpose parameters GPP_SA through GPP_SD. These parameters hold keys or passwords used in provisioning. $SA through $SD are recognized as arguments to the optional resync URL qualifier, --key.
MA	MAC address using lowercase hex digits (000e08aabbcc).
MAU	MAC address using uppercase hex digits (000E08AABBCC).
MAC	MAC address using lowercase hex digits with a colon to separate hex digit pairs (00:0e:08:aa:bb:cc).
PN	Product Name; for example, Cisco Wireless Phone 9821.
PSN	Product Series Number; for example, 9821.
SN	Serial Number string; for example, FVH29513116.
CCERT	SSL Client Certificate status, installed or not installed.
IP	IP address of the phone within its local subnet; for example, 192.168.1.100.
EXTIP	External IP of the phone, as seen on the internet; for example, 66.43.16.52.
SWVER	Software version string. For example, PHONEOS-9821.5-0-1-0004-19.
HWVER	Hardware version string. For example, 2.0.1
PRVST	Provisioning State (a numeric string): -1 = explicit resync request 0 = power-up resync 1 = periodic resync 2 = resync failed, retry attempt
UPGST	Upgrade State (a numeric string): 1 = first upgrade attempt 2 = upgrade failed, retry attempt
UPGERR	Result message (ERR) of previous upgrade attempt; for example http_get failed.
PRVTMR	Seconds since last resync attempt.
UPGTMR	Seconds since last upgrade attempt.
REGTMR1	Seconds since Line 1 lost registration with SIP server.
REGTMR2	Seconds since Line 2 lost registration with SIP server.
UPGCOND	Legacy macro name.
SCHEME	File access scheme, one of TFTP, HTTP, or HTTPS, as obtained after parsing resync or upgrade URL.
SERV	Request target server host name, as obtained after parsing resync or upgrade URL.
SERVIP	Request target server IP address, as obtained after parsing resync or upgrade URL, possibly following DNS lookup.
PORT	Request target UDP/TCP port, as obtained after parsing resync or upgrade URL.
PATH	Request target file path, as obtained after parsing resync or upgrade URL.
ERR	Result message of resync or upgrade attempt. Only useful in generating result syslog messages. The value is preserved in the UPGERR variable in the case of upgrade attempts.
UIDn	The contents of the Line n UserID configuration parameter.
ISCUST	If unit is customized, value=1, otherwise 0. Customization status is viewable on Web UI Info page.
INCOMINGNAME	Name associated with first connected, ringing, or inbound call.
REMOTENUMBER	Phone number of first connected, ringing, or inbound call. If there are multiple calls, the data associated with the first call found is provided.
DISPLAYNAMEn	The contents of the Line N Display Name configuration parameter.
AUTHIDn	The contents of the Line N auth ID configuration parameter.

Cisco AI Assistant

Thanks for your feedback.