In this article
dropdown icon
Customize the Action button
    Emergency calls parameter settings
    Custom services parameter settings
    A single trigger for multiple events parameter settings
    Configure multiple triggers
HTTP Post request for the Action button
Macro variables supported in XML URLs
Configure the Action button (Control Hub)
list-menuIn this article
list-menuFeedback?

This Help article is for Cisco Wireless Phone 9821 registered to Webex Calling.

The Action button is the red button located at the right side of Cisco Wireless Phone 9821. 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.

Customize the Action button

1

From the customer view in Control Hub, go to Devices, and then select your phone.

2

Select All configurations.

3

Navigate to the Phone section and select Action Button.

4

Customize the Action button parameters based on your use cases.

5

Select Next.

6

Review your changes and select Apply.

7

Select Close to close the page.

Emergency calls parameter settings

The Action button for emergency calls ensures quick and easy access to critical assistance in workspaces. Configure the following parameters for emergency calls.

Table 1. Emergency calls parameter settings

Parameter

Settings

Action Button Function

Select Emergency Call.

Action Button Service Destination

Enter the phone number or the URI of the emergency service.

Action Button Service Name

(Optional) Specify a name for the service associated with the trigger. This name will be displayed in the on-screen message when the user presses the button, indicating which service will be triggered. When no name is specified, Emergency call or Silent emergency call will be used as the display name.

Dial Out Delay

Set the timeout period, in seconds, for the phone to initiate an event after detecting the trigger. The default value is 5 seconds. When set to 0, the event is initiated immediately upon trigger detection.

The delay screen displays a countdown timer, allowing the user to cancel the action triggered by the Action button. During emergency call 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

Select a trigger from the list: Single Press, Long Press, or Press 3 Times.

Silent Emergency Call

(Optional) By default, the emergency call functions as a two-way call, similar to other outgoing calls. When silent emergency call is enabled, the audio is silent on the caller side to avoid drawing attention during the onging call. Only the call recipient can end the silent emergency call.

During a silent emergency call, the Cisco Wireless Phone 9821 screen will be turned off. All other functions are inaccessible. The phone restores normal operation after the recipient ends the call.

Allow Silent Emergency Call Retrieval

(Optional) Enable this feature if you allow users to press any key to restore normal phone operation while maintaining the emergency call. The call audio remains silent unless the user increases the speaker volume using the Volume key.

Custom services parameter settings

When you associate the Action button with a custom 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.

Configure the following parameters for custom services.

Table 2. Custom services parameter settings

Parameter

Settings

Action Button Function

Select Custom.

Action Button Service Destination

Enter the URL of the custom service. The URL must start with http:// or https://, for example, https://10.11.20.159/path/service.xml.

Action Button Service Name

(Optional) Specify a name for the service associated with the trigger. This name will be displayed in the on-screen message when the user presses the button, indicating which service will be triggered. When no name is specified, Custom service will be used as the display name.

Custom Content Field

(Optional) If you want to enable the phone to send an HTTP Post request when the Action button is pressed, enter the HTTP data such as method, header, and post content, with a maximum length of 1024 characters.

For POST script examples and the syntax, see HTTP Post request for the Action button.

Dial Out Delay

Set the timeout period, in seconds, for the phone to initiate an event after detecting the trigger. The default value is 5 seconds. When set to 0, the event is initiated immediately upon trigger detection.

The delay screen displays a countdown timer, allowing the user to cancel the action triggered by the Action button. During custom services scenarios, Cisco Wireless Phone 9821 vibrates continuously while the delay screen is displayed.

Service Trigger

Select a trigger from the list: Single Press, Long Press, or Press 3 Times.

A single trigger for multiple events parameter settings

A single trigger for multiple events allows one action on the action button to initiate several related processes simultaneously. This feature enhances responsiveness, reduces complexity, and ensures seamless workflow execution across applications.

Configure the following parameters to assign multiple events to a trigger.

Table 3. A single trigger for multiple events parameter settings

Parameter

Settings

Action Button Function

Select Custom.

Action Button Service Destination

Enter the phone number to call and the XML service URL in this format:

tel:<phonenumber or SIP URI> + <serviceURL>

The URL must start with http:// or https://.

Example: tel:1234 + https://10.11.20.159/path/service.xml

Action Button Service Name

(Optional) Specify a name for the service associated with the trigger. This name will be displayed in the on-screen message when the user presses the button, indicating which service will be triggered. When no name is specified, Custom service will be used as the display name.

Custom Content Field

(Optional) If you want to enable the phone to send an HTTP Post request when the Action button is pressed, enter the HTTP data such as method, header, and post content, with a maximum length of 1024 characters.

For POST script examples and the syntax, see HTTP Post request for the Action button.

Dial Out Delay

Set the timeout period, in seconds, for the phone to initiate an event after detecting the trigger. The default value is 5 seconds. When set to 0, the event is initiated immediately upon trigger detection.

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

Select a trigger from the list: Single Press, Long Press, or Press 3 Times.

Silent Emergency Call

(Optional) By default, the emergency call functions as a two-way call, similar to other outgoing calls. When silent emergency call is enabled, the audio is silent on the caller side to avoid drawing attention during the onging call. Only the call recipient can end the silent emergency call.

During a silent emergency call, the Cisco Wireless Phone 9821 screen will be turned off. All other functions are inaccessible. The phone restores normal operation after the recipient ends the call.

Allow Silent Emergency Call Retrieval

(Optional) Enable this feature if you allow users to press any key to restore normal phone operation while maintaining the emergency call. The call audio remains silent unless the user increases the speaker volume using the Volume key.

Configure multiple triggers

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

Set Service Trigger to MultiTrigger.

  • When the MultiTrigger option is selected, only the settings in the Service Trigger MultiTrigger section will be applied, while the settings related to Action button outside that section will be ignored.

  • Make sure to configure at least one trigger when the MultiTrigger option is selected.

2

Go to Service Trigger MultiTrigger and select your desired trigger from the available options - Single Press, Long Press, and Press 3 times.

3

Configure the following parameters for your selected trigger:

Table 4. Multiple triggers parameter settings

Parameter

Settings

Action Button Function

Select the service that phone users can access via the trigger.

Action Button Service Destination

Enter phone number or the URI of the service.

Action Button Service Name

(Optional) Specify a name for the service associated with the trigger. This name will be displayed in the on-screen message when the user presses the button, indicating which service will be triggered. When no name is specified, Custom service will be used as the display name.

Custom Content Field

(Optional) If you want to enable the phone to send an HTTP Post request when the Action button is pressed, enter the HTTP data such as method, header, and post content, with a maximum length of 1024 characters.

For POST script examples and the syntax, see HTTP Post request for the Action button.

Dial Out Delay

Set the timeout period, in seconds, for the phone to initiate an event after detecting the trigger. The default value is 5 seconds. When set to 0, the event is initiated immediately upon trigger detection.

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

(Optional) By default, the emergency call functions as a two-way call, similar to other outgoing calls. When silent emergency call is enabled, the audio is silent on the caller side to avoid drawing attention during the onging call. Only the call recipient can end the silent emergency call.

During a silent emergency call, the Cisco Wireless Phone 9821 screen will be turned off. All other functions are inaccessible. The phone restores normal operation after the recipient ends the call.

Allow Silent Emergency Call Retrieval

(Optional) Enable this feature if you allow users to press any key to restore normal phone operation while maintaining the emergency call. The call audio remains silent unless the user increases the speaker volume using the Volume key.

4

Continue to follow Step 2 and 3 to configure more triggers.

HTTP Post request for the Action button

The Action button on Cisco Wireless Phone 9821 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.

The following examples are in XML and JSON:

Sample #1: XML
--method POST
--header 'Content-Type: application/xml'
--body '<MetaData><Trigger>True</Trigger><Description>This is for HTTP POST XML</Description></MetaData>' 

Sample #2: JSON
--method POST
--header 'Content-Type: application/json'
--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>'
Table 5. Supported macros
Macro nameMacro expansion
#DEVICENAME#The device name displayed in the calling system; for example, SEPE8BCE4956A29.
$MAMAC address using lowercase hex digits (000e08aabbcc).
$MCASTADDRAddress of multicast paging application.

$PN

$PSN

Product Name; for example, WP-9821.
$SNSerial Number string; for example, FVH29513116.

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 6. Supported macros
Macro nameMacro expansion
$The form $$ expands to a single $ character.
A through PReplaced by general-purpose parameters GPP_A through GPP_P.
SA through SDReplaced 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.

MAMAC address using lowercase hex digits (000e08aabbcc).
MAUMAC address using uppercase hex digits (000E08AABBCC).
MACMAC address using lowercase hex digits with a colon to separate hex digit pairs (00:0e:08:aa:bb:cc).
PNProduct Name; for example, Cisco Wireless Phone 9821.
PSNProduct Series Number; for example, 9821.
SNSerial Number string; for example, FVH29513116.
CCERTSSL Client Certificate status, installed or not installed.
IPIP address of the phone within its local subnet; for example, 192.168.1.100.
EXTIPExternal 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.

INCOMINGNAMEName 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.

DISPLAYNAMEnThe contents of the Line N Display Name configuration parameter.
AUTHIDnThe contents of the Line N auth ID configuration parameter.
Was this article helpful?
Was this article helpful?