- Home
- /
- Article
Configure the Action button for 9800 (Unified CM)
In this articleThe 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 custom the button to initiate events that suit your specific use cases. The information on this page applies to Cisco Desk Phone 9800 Series registered to Cisco Unified Communications Manager (Unified CM).
Customize the Action button
The custom options for the Action button on Cisco Desk Phone 9800 Series require specific PhoneOS firmware support. See the following table for details:
| Feature | Required firmware version |
|---|---|
| Emergency call | PhoneOS 3.0.1 and later |
| Custom service | PhoneOS 3.2.1 and later |
| Multiple triggers | PhoneOS 3.3.1 and later |
| HTTP Post | PhoneOS 3.3.1 and later |
| Multiple events on a single trigger | PhoneOS 3.4.1 and later |
| 1 |
Log in to Cisco Unified Communications Manager Administration. |
| 2 |
Do one of the following actions as needed:
The configuration follows a hierarchical structure:
|
| 3 |
Customize the Action button settings with the following parameters based on your use cases. There are three groups of parameters for the Action button, each corresponding to a service with a unique trigger. If a service trigger is specified in multiple groups, the settings in Group 1 take priority over those in Group 2 and 3, while Group 2 takes priority over Group 3.
For more information about these parameters, see Parameters for the Action button. |
| 4 |
Select Save. |
| 5 |
Select Apply Config. |
References
Parameters for the Action button
The parameters are available in Enterprise Phone Configuration, Common Phone Profile, and individual phone configuration.
| Parameter | Default and options | Description |
|---|---|---|
| Action Button Function 1~3 |
Default: Off Options: Off, Emergency Call, Custom |
You can configure the button with a specific service.
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 Name 1~3 |
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. |
| Action Button Service Destination 1~3 |
Default: Empty |
Provide the service destination in one of the following formats based on the service assigned to the Action button:
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 If you are not allowed to input a URL including ampersand (&), use %26 as a replacement. For example, enter http://1.2.3.4/phone?a=1%26b=2%26c=3 instead of http://1.2.3.4/phone?a=1&b=2&c=3. |
| Custom Content Field 1~3 |
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. If the service requires
authentication to access, make sure to enter the authentication secret in the
Service Secret field. In the HTTP data, use the macro
For examples and the syntax, see HTTP Post request for the Action button. |
| Service Secret 1~3 |
Default: Empty |
A service secret can be an authentication secret, token or password. The
entered secret is displayed as a masked string and can be referenced using the
macro |
| Service Trigger 1~3 |
Default: Single Press Options: Single Press, Long Press, Press 3 times |
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 less than 2 seconds between each press to trigger the associated call or service. Don't repeat a trigger across multiple services, as the parameters with lower priority will not function. The priority order, from highest to lowest, is as follows: Group 1, Group 2, Group 3. |
| Dial Out Delay 1~3 |
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. |
| Silent Emergency Call 1~3 |
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.
|
| 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. |
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 your customized request script. You
can specify either XML or JSON content type and include macros in the request. For example,
$SScan 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"}]}' Cisco Unified Communications Manager (UCM) requires percent encoding for the reserved characters in accordance with RFC 3986.
| Character | Percent encoding |
|---|---|
| & | %26 |
| ' | %27 |
| " | %22 |
| < |
%3c |
| > |
%3e |
The following script is an example using percent-encoded strings.
--method POST
--header %27Content-Type: application/xml%27
--body %27%3cMetaData%3e%3cTrigger%3eTrue%3c/Trigger%3e%3cDescription%3eThis is for HTTP POST XML%3c/Description%3e%3c/MetaData%3e%27| Macro name | Macro expansion |
|---|---|
| #DEVICENAME# | The device name displayed in the calling system. For example, SEP845A3EC21288 |
| $SS | Service Secret which presents a masked string in the phone configuration page, such as authentication secret, token, or password. |
