- Home
- /
- Article
Configure phone features on the phone administration page
This Help article is for Cisco Desk Phone 9800 Series registered to Cisco BroadWorks or Webex Calling. On the phone administration web page, you can configure Action button, power-saving feature (Office Hours: Display-Off and Deep Sleep Mode ), feature key sync, etc.
Action button
The Action button is the red button located at the top-right of the phone. It allows users to quickly access designated services, such as emergency or custom services. You can associate the button with up to three services, each with its own trigger.
Associate the Action button with a single service
When you associate the Action button with a service, the phone users can access the service by the designated trigger, such as a single press, long press, or triple presses on the button.
1 |
Access the phone administration web page. | |||||||||||||||||||||||||||
2 |
Select . | |||||||||||||||||||||||||||
3 |
Navigate to the Action Button section and configure the following parameters to associate the Action button with a service.
You can also configure these parameters in the phone configuration XML file (cfg.xml) by entering the following strings:
| |||||||||||||||||||||||||||
4 |
When done, click Submit All Changes. |
Associate the Action button with multiple services
You can configure the Action button to connect to multiple services and assign each service with its own trigger. For example, a long press on the Action button places a call to the designated emergency agent; a single short press on the button post a notification to the phones within the corporation.
1 |
Access the phone administration web page. | ||||||||||||||||||||||||
2 |
Select . | ||||||||||||||||||||||||
3 |
In the Action Button section, set Service Trigger to Multiple Triggers. You can configure this parameter in the phone configuration XML file (cfg.xml) by entering a string in this format: <Service_Trigger ua="na">Multiple Triggers</Service_Trigger>
When the Multiple Triggers option is selected, only the settings in the Multi Triggers - Single Press/Press Three Times/Long Press sections will be applied, while the settings in the Action button section will be ignored. Make sure to configure at least one trigger when the Multiple Triggers option is selected. | ||||||||||||||||||||||||
4 |
In the Multi Triggers - Single Press/Press Three Times/Long Press sections, configure the following parameters to associate the Action button with services.
You can also configure these parameters in the phone configuration XML file (cfg.xml) by entering the following strings:
| ||||||||||||||||||||||||
5 |
When done, click Submit All Changes. |
HTTP Post request for the Action button
The Action button on Cisco Desk Phone 9800 Series can be configured to trigger XML applications through HTTP Post requests.
In Custom Content Field, enter the request script. You can specify
either XML or JSON content type and include macros in the request. For example,
$SS
can be added to the script to retrieve the authentication secret,
token, or password provided in the Service Secret field.
The following examples are in XML and JSON:
Sample #1: XML
--method POST
--header 'Content-Type: application/xml'
--header 'Authorization: Bearer username:$SS'
--body '<MetaData><Trigger>True</Trigger><Description>This is for HTTP POST XML</Description></MetaData>'
Sample #2: JSON
--method POST
--header 'Content-Type: application/json'
--header 'Authorization: $SS'
--body '{"events":[{"evtid":"12345", "parameters": {"trigger":true}, "Description":"This is for HTTP POST JSON"}]}'
The following example is for an HTTP Post request.
--method POST
--header 'Content-Type: application/xml'
--body '<MetaData><Trigger>True</Trigger><Description>This is for HTTP POST XML</Description></MetaData>'
Macro name | Macro expansion |
---|---|
#DEVICENAME# | The device name displayed in the calling system; for example, SEP845A3EC21288 |
$MA | MAC address using lowercase hex digits (000e08aabbcc). |
$MCASTADDR | Address of multicast paging application. |
$PN $PSN | Product Name; for example, DP-9851, DP-9871. |
$SN | Serial Number string; for example, FVH28022D0T. |
$SS | Service secret required to access an XML application. |
Configure your phone for power saving (Office Hours)
Three power-saving options are available on the phone to reduce power consumption during periods of inactivity.
Display-Off ModeIn Display-Off Mode, the phone turns off the screen to save power outside of the designated working hours. When the Office Hours feature is enabled, the phone goes into Display-Off Mode after working hours. You can light up the display by pressing any key on the phone. The display remains on until the phone has been in idle for a designated length of time, then it turns off automatically.
Deep Sleep ModeIn Deep Sleep Mode, the phone automatically powers down during the designated periods. You can choose to enable Deep Sleep Mode exclusively for non-workdays, or for both non-workdays and non-working hours on workdays. To wake up the phone, press the Select button on the Navigation Cluster.
By default, the Office Hours feature is enabled on your phone. The default office hours are set to 7:00 to 19:00 from Monday to Friday. The phone turns off the screen outside of the designated hours. You can customize working hours, workdays, and the power-saving mode outside of office hours.
1 |
Access the phone administration web page. | ||||||||||||||||||||||||||||||
2 |
Select . | ||||||||||||||||||||||||||||||
3 |
Customize working hours and workdays to reflect the business hours of your users.
| ||||||||||||||||||||||||||||||
4 |
To customize the settings for non-working hours, configure the following parameters in the Outside Office Hours Deep Sleep section. You can set up the idle timeout for Display-Off Mode and customize the Deep Sleep Mode settings as needed.
| ||||||||||||||||||||||||||||||
5 |
When done, click Submit All Changes. |
Enable hoteling on a phone
When you enable the hoteling feature of BroadSoft on the phone, the user can sign in to the phone as a guest. After the guest sign out of the phone, the user will switch back to the host user.
You can also enable hoteling service from the server. For more information, see Cisco BroadWorks Partner Configuration Guide.
When you enable hoteling:
-
A phone with multiple lines displays Hoteling softkey on the phone home screen for each line that has hoteling enabled.
A phone with multiple lines displays Guest in softkey on the phone home screen for each line that has hoteling enabled. You see this line when you press More (…) next to the line.
- A phone with single line displays Guest in softkey on the phone home screen.
Before you begin
On the server:
- Enable hoteling service for the host user and the guest user. For more information, see Cisco BroadWorks Partner Configuration Guide.
- Set the Guest in password.
1 |
Access the phone administration web page. |
2 |
Select (where [n] is the extension number). |
3 |
In the Call Feature Settings section, set Enable Broadsoft Hoteling parameter to Yes. You can configure this parameter in the phone configuration XML file (cfg.xml) by entering a string in this format:
Options: Yes and No Default: No |
4 |
Set the amount of time (in seconds) in Hoteling Subscription Expires paramter that specifies how often the phone sends the SUBSCRIBE message. You can configure this parameter in the phone configuration XML file (cfg.xml) by entering a string in this format:
Valid values: An integer from 10 through 86400 Default: 3600 When the parameter is set to 0, the default 3600 is used. |
5 |
Click Submit All Changes. |
Phone settings sync
DND and call forward status sync
You can configure the settings on the phone administration web page to enable status synchronization of Do Not Disturb (DND) and call forward between the phone and the server.
There are two ways to synchronize the feature status:
-
Feature Key Synchronization (FKS)
-
XSI Synchronization
FKS uses SIP messages to communicate the feature status. XSI Synchronization uses HTTP messages. If both FKS and XSI synchronization are enabled, FKS takes precedent over XSI synchronization. See the table below for how FKS interacts with XSI synchronization.
Feature Key Sync |
XSI DND Enabled |
XSI CFWD Enabled |
DND Sync |
CFWD Sync |
---|---|---|---|---|
Yes |
Yes |
Yes |
Yes (SIP) |
Yes (SIP) |
Yes |
No |
No |
Yes (SIP) |
Yes (SIP) |
Yes |
No |
Yes |
Yes (SIP) |
Yes (SIP) |
No |
Yes |
Yes |
Yes (HTTP) |
Yes (HTTP) |
No |
No |
Yes |
No |
Yes (HTTP) |
No |
Yes |
No |
Yes (HTTP) |
No |
No |
No |
No |
No |
No |
Enable DND and Call Forward status sync with Feature Key Sync (FKS)
When you enable the Feature Key Synchronization (FKS), the settings of call forward and do not disturb (DND) on the server are synchronized to the phone. The changes in DND and call forward settings made on the phone will also be synchronized to the server.
When FKS is enabled on a line, the line get the DND and Call Forward settings from the server and doesn't sync with the settings on
tab.1 |
Access the phone administration web page. |
2 |
Select (where [n] is the extension number). |
3 |
In the Call Feature Settings section, set the Feature Key Sync field to Yes. |
4 |
Click Submit All Changes. |
Enable call forward status sync via XSI service
When call forward sync is enabled, the settings related to call forward on the server are synchronized to the phone. The changes in call forward settings made on the phone will also be synchronized to the server.
Before you begin
-
Configure the XSI host server and the corresponding credentials on the
tab.-
When using Login Credentials for XSI server authentication, enter XSI Host Server, Login User ID, and Login Password in the XSI Line Service section.
-
When using SIP Credentials for XSI server authentication, enter XSI Host Server and Login User ID in the XSI Line Service section, and Auth ID and Password in the Subscriber Information section.
-
-
Disable Feature Key Sync (FKS) in Call Feature Settings section from .
1 |
Access the phone administration web page. |
2 |
Select (where [n] is the extension number). |
3 |
In the XSI Line Service section, set the CFWD Enable parameter to Yes. You can configure this parameter in the phone configuration XML file (cfg.xml) by entering a string in this format:
Options: Yes and No Default: No |
4 |
Click Submit All Changes. |
Enable DND status sync via XSI service
When do not disturb (DND) sync is enabled, the DND setting on the server is synchronized to the phone. The changes in DND setting made on the phone will also be synchronized to the server.
Before you begin
-
Configure the XSI host server and the corresponding credentials on the
tab.-
When using Login Credentials for XSI server authentication, enter XSI Host Server, Login User ID, and Login Password in the XSI Line Service section.
-
When using SIP Credentials for XSI server authentication, enter XSI Host Server and Login User ID in the XSI Line Service section, and Auth ID and Password in the Subscriber Information section.
-
-
Disable Feature Key Synchronization (FKS) in Call Feature Settings section from .
1 |
Select (where [n] is the extension number). |
2 |
In the XSI Line Service section, set the DND Enable parameter to Yes. You can configure this parameter in the phone configuration XML file (cfg.xml) by entering a string in this format:
Options: Yes and No Default: No |
3 |
Click Submit All Changes. |
Configure conference settings for phones
The following sections provide information on how to configure the conference service for your phones.
Enable conference service
Enable the conference service for your phones so that users can initiate or join multiple-way calls using their phone lines.
1 |
Access the phone administration web page. |
2 |
To enable conference service for the phone do the following: |
3 |
Specify the conference bridge URL for your desired line: |
4 |
Click Submit All Changes. |
Enable Webex calendar service
If you want to enable the phone to have the ability to join Webex calendar meetings, do the following:
Before you begin
Your phone has been registered to Webex Calling.
1 |
Access the phone administration web page. |
2 |
Select . |
3 |
In the Webex section, set the field Calendar Enable. Set Yes or No to enable or disable the Webex calendar service on the phone. Options: Yes|No; Default: Yes You can also configure the parameters in the configuration file (cfg.xml) by entering the strings in this format:
|
4 |
Click Submit All Changes. |
Enable call recording with SIP REC
You can enable call recording on a phone so that your user can record an active call. The
recording mode configured on the server controls the display of the recording softkeys for
each phone. In the Programmable Softkeys section, by default, the
following strings are added in the Connected Key List and
Conferencing Key List fields.
crdstart;crdstop;crdpause;crdresume
Recording Mode in Server | Recording Softkeys Available on the Phone |
---|---|
Always |
No softkeys available. Your user can't control recording from the phone. Recording starts automatically when a call is connected. |
Always with Pause/Resume |
PauseRec ResRec When call is connected, user can pause the recording and resume the recording. |
On Demand |
Record PauseRec ResRec When a call is connected, recording starts automatically but the recording is not saved until the user presses the Record softkey. Your user sees a message when recording state changes. |
On Demand with User Initiated Start |
Record PauseRec StopRec ResRec The recording only starts when your user presses the Record softkey. Your user sees a message when recording state changes. |
Never |
No recording softkeys are available, hence user will not be able to record calls. |
1 |
Access the phone administration web page. |
2 |
Select Voice > Phone. |
3 |
In the Supplementary Services section, click Yes or click No to enable or disable the Call Recording Serv parameter. You can configure this parameter in the phone configuration XML file (cfg.xml) by entering a string in this format: <Call_Recording_Serv
ua="na">Yes</Call_Recording_Serv>
Options: Yes and No Default: No |
4 |
Click Submit All Changes. |
Configure multicast paging
You can set up multicast paging to allow users to send paging messages to other phones. The page can go to all phones or a group of phones in the same network. Any phone in the group can initiate a multicast paging session. The page is received only by the phones that are set to listen for the paging group.
A phone can be added to up to10 paging groups. Each paging group has a unique multicast port and number. The phones within a paging group must subscribe to the same multicast IP address, port, and multicast number.
You configure the priority for the incoming page from a specific group. When a phone is active and an important page must be played, the user hears the page on the active audio path.
When multiple paging sessions occur, they are answered in chronological order. After the active page ends, the next page is automatically answered. When do not disturb (DND) applies to all lines on a phone instead of a specific line, the phone ignores any incoming paging.
You can specify a codec for the paging to use. The supported codecs are G711a, G711u, G722, and G729. If you don't specify the codec, paging uses G711u by default.
You can also enable phones to receive pages from a server to optionally display an image or other UI elements. With this feature, an XML service can be invoked during a multicast paging. To enable this feature, configure the parameter XML Application Service URL
and add "xmlapp=yes
" in the paging group scripts from . For more information about the parameters, see XML applications configuration for phones on BroadWorks and Parameters for multiple paging group.
You can also configure the parameters in the phone configuration file with XML(cfg.xml) code. To configure each parameter, see the syntax of the string in Parameters for multiple paging group.
Before you begin
- Make sure that your network supports multicast so that all devices in the same paging group are able to receive paging.
- For Wi-Fi networks, enable and properly configure the access point for multicast.
- Make sure that all the phones in a paging group are in the same network.
1 |
Access the phone administration web page. |
2 |
Select . |
3 |
Go to the Multiple Paging Group Parameters section. |
4 |
Enter multicast paging scripts as defined in the following table of Parameters for multiple paging group. |
5 |
Click Submit All Changes. |
Parameters for multiple paging group
The following table defines the function and usage of the multiple paging group parameters in the phone administration page.
It also defines the syntax of the string that is added in the phone configuration file (cfg.xml) to configure a parameter.
Parameter | Description |
---|---|
Group 1 Paging Script – Group 10 Paging Script |
Enter a string to configure the phone to listen for and initiate multicast paging. You can add a phone to up to 10 paging groups. Enter the script in this format:
In the phone configuration file with XML(cfg.xml), enter a string in this format:
Default: Empty |
Configure a phone to answer pages automatically
The paging feature enables a user to directly contact another user by phone. If the phone of the person being paged has been configured to answer pages automatically, the phone does not ring. Instead, a direct connection between the two phones is automatically established when paging is initiated.
You can also configure the parameters in the phone configuration file with XML(cfg.xml) code.
Before you begin
1 |
Access the phone administration web page. |
2 |
Select . |
3 |
In the Supplementary Services section, choose Yes for the Auto Answer Page parameter. You can configure this parameter in the phone configuration XML file (cfg.xml) by entering a string in this format:
Options: Yes and No Default: Yes |
4 |
Click Submit All Changes. |
Prepare your wallpaper and logo images
To get the best experience, keep the following tips in mind when choosing or designing your images:
- Avoid using clustered images that can make it hard for you to identify phone lines on the home screen. Simplicity is key when selecting wallpapers.
- Ensure that your chosen wallpapers match your phone's color scheme. Opt for wallpapers that complement either the dark or light color palettes. Dark images are best suited for dark mode, while light images work well for light mode.
- Avoid using high contrast images as wallpapers. The extreme contrast can make it challenging to see the logo and other screen elements against the background.
- Avoid using dynamic images as wallpapers.
- The logo displays on the phone screen only, and it doesn't display on the KEM screen. When multiple lines are configured on Cisco Desk Phone 9841, 9851, and 9861, the logo and the logo setting in the Settings menu are unavailable.
- To use custom wallpaper on phones with Key Expansion Modules (KEM) attached, prepare both phone wallpaper and KEM wallpaper.
Image | Supported format (Unified CM) | Supported format (Webex Calling or BroadWorks) | Recommended dimensions (pixels) | Description |
---|---|---|---|---|
Logo | PNG |
BMP, GIF, JPG, JPEG, PNG, PBM, PGM, PPM, TIFF, XBM, XPM, CUR, ICO, SVG, TIF, WEBP |
Cisco Desk Phone 9851: 190x125 Cisco Desk Phone 9861: 380x250 Cisco Desk Phone 9871: 494x325 / 418x275 Cisco Video Phone 8875: 380x250 | Images that don't match the recommended dimensions will be scaled proportionally. You don't need to create a separate thumbnail image for the logo. The system automatically scales the logo image to fit the dimensions of the thumbnail. |
Wallpaper |
Cisco Desk Phone 9851: 480x240 Cisco Desk Phone 9861: 800x480 Cisco Desk Phone 9871: 1280x720 Cisco Desk Phone 9800 Key Expansion Module: 480x800 Cisco Video Phone 8875: 1024x600 | Images that don't match the recommended dimensions may be scaled to fit the phone screen, which may cause the image to become distorted. | ||
Wallpaper thumbnail |
Cisco Desk Phone 9851: 100x56 Cisco Desk Phone 9861: 150x90 Cisco Desk Phone 9871: 228x128 Cisco Video Phone 8875: 180x100 | Images that don't match the recommended dimensions may cause certain issues on the phone. |
Phone Model | Maximum size per image | Maximum number of images | Limit size |
---|---|---|---|
Cisco Desk Phone 9851 | 250KB | 10 | 250KB x 10 |
Cisco Desk Phone 9861 | 1MB | 20 | 1MB x 20 |
Cisco Desk Phone 9871 | 1MB | 20 | 1MB x 20 |
Cisco Video Phone 8875 | 1MB | 20 | 1MB x 20 |
1 |
Choose your desired logo and wallpaper images. |
2 |
Format the images to meet the required specifications as described in the table above. |
3 |
Rename the wallpaper image files in this format: Do one of the following actions according to the call control system where the phone is deployed:
On Unified CM:
On Webex Calling or BroadWorks: No restrictions for the filenames. Therefore, you can rename the wallpaper image files in any format for your convenience. Thumbnail images for logo and KEM wallpapers are not required. |
Customize wallpaper and logo on phone web page
You can choose a predefined system wallpaper, and customize wallpaper and logo on the phone administration web page.
1 |
Access the phone administration web page. | |||||||||||||||
2 |
Select . | |||||||||||||||
3 |
Navigate to the Screen section and configure the following parameters to customize the phone screen.
| |||||||||||||||
4 |
Click Submit All Changes. | |||||||||||||||
5 |
(Optional) To check the download status of the images, select Screen Status section. , and then navigate to the |