Customize phone programmable softkeys

You can customize the softkeys displayed on the phone. Some of the the default softkeys (when the phone is in an idle state) are Call, Recents, Forward, and DND. Other softkeys are available during specific call states (for example, if a call is on hold, the Resume softkey displays).

You can define the parameters under Programmable Softkeys section with keywords and assign a service to the softkey to provide user easy access to the service. The customized softkeys can be found located at the bottom of the phone screen. You can associate the softykeys with a service to provide a quick access for users

1

Access the phone administration web page.

2

Select Voice > Phone.

3

In the Programmable Softkeys section, set the Programmable Softkey Enable to Yes.

4

Edit the softkeys by entering specific keywords depending on the call state that you want the softkey to display.

In the Programmable Softkeys section, each phone state is displayed and the softkeys that are available to display during that state are listed. Each softkey is separated by a semicolon. Softkeys are shown in the format:

softkeyname|[position]

For more information on the PSK parameters (phone state), see Programmable softkeys parameters.

For more inforamtion on the softkeys and the related keywords, see Programmable softkeys.

5

Click Submit All Changes.

Programmable softkeys parameters

For more information on the keywords and related softkeys, see Programmable softkeys.

Parameter

Default and Syntax

Description

Programmable Softkey Enable

Default: No

Options: Yes|No

Enables programmable softkeys.

PSK 1 through PSK16

Default:

Empty

Syntax:

  • Speed Dial (in PSK1): fnc=sd;ext=ext@$PROXY;vid=2;nme=SD

Programmable softkey fields. Enter a string in these fields to configure softkeys that display on the phone screen.

For example, you can create softkeys for speed dials to numbers or extensions, vertical service activation codes (* codes), and PSK with DTMF support.

Speed dial PSK, see Configure Speed Dial on a programmable softkey.

DTMF PSK, see Configure a PSK with DTMF support.

When you add a programmable softkey to a softkey list, such as Idle Key List, and so on, the programmable softkey displays on the phone screen.

Idle Key List

Default Syntax:

calls;calendar;meeting;recents;

settings;dir;cfwd;dnd;

pickup;gpickup;unpark;guestin;guestout;

hoteling;redial;hotdesk|3;hotdesk_signout|3;

psk1 is added in the string as PSK1 if configured with speed-dial

Softkeys that display when the phone is idle.

Connected Meeting Key List

Default Syntax:

9841/9851/9861: audiomute;endcall|2;home|3;

9871: audiomute;endcall|2;

Configurable values:

endcall;meetings;audiomute;home;participants;

Softkeys that display when a calendar meeting is in progress.

Off Hook Key List

Default Syntax:

abc;redial;cancel;cfwd;dnd;unpark;pickup;gpickup
This key list is not applicable for Cisco Desk Phone 9871.

Softkeys that display when the receiver is lifted, or the headphone or speakerphone buttons are pressed.

Dialing Input Key List

Default Syntax:

abc;call;delchar;line;cancel
This key list is not applicable for Cisco Desk Phone 9871.

Softkeys that display when the user must enter dialing data.

Progressing Key List

Default Syntax:

endcall|2;home|3;		Softkeys that display when a call is attempting to connect.
Connected Key List

Default Syntax:

hold;endcall;newcall;conf;

xfer;bxfer;park;phold;home;

crdstart;crdpause;crdresume;crdstop;

Softkeys that display when a call is connected.
Start-Xfer Key List

Default Syntax:

endcall;xfer;home;		Softkeys that display when a call transfer has been initiated.
Start-Conf Key List

Default Syntax:

hold;endcall;conf;home;		Softkeys that display when a conference call has been initiated.
Conferencing Key List

Default Syntax:

hold;endcall;join;phold;home;

crdstart|5;crdpause|5;crdresume|5;crdstop|6;

Softkeys that display when a conference call is in progress.
Releasing Key List

Default Syntax:

endcall|2;home;		Softkeys that display when a call is disconnecting.
Hold Key List

Default Syntax:

resume;endcall;newcall;home;		Softkeys that display when one or more calls are on hold.
Ringing Key List

Default Syntax:

answer|1;ignore|2;ignoresilent|3;ignoreall;home;		Softkeys that display when a call is incoming.
Shared Active Key List:

Default Syntax: newcall;barge;home;

Softkeys that display when a call is active on a shared line.
Shared Held Key List:

Default Syntax:

resume;barge;home;		Softkeys that display when a call is on hold on a shared line.

Programmable softkeys

Table 1. Programmable softkeys and keywords

Keyword

Key Label

Description

Phone state

answer

Answer

Answers an incoming call.

Ringing

audiomute

Mute or UnmuteAllows meeting participants to mute or unmute themselves in a Webex meeting.Connected

barge

Barge

Allows another user to interrupt a shared call

Shared-Active, Shared-Held

bargesilent

BargeSilent or BargeSlnt

Allows another user to interrupt a shared call with the mic disabled.

Shared-Active

bxfer

BlindXfer

Performs a blind call transfer (transfers a call without speaking to the party to whom the call is transferred). Requires that Blind Xfer Serv is enabled.

Connected

callCallAlways displays at the first position when the phone is registered.Dialing Input or On-Hook
cancelCancel

Cancels a call (for example, when conferencing a call and the second party is not answering.

Off-Hook
cfwdForward / ClrfwdForwards all calls to a specified number.

Idle, Off-Hook, Shared-Active,Hold, Shared-Held

crdpausePauseRecPauses recording.Connected, Conferencing
crdresumeResRecResumes recording.Connected, Conferencing
crdstartRecordStarts a recordingConnected, Conferencing
crdstopStopRecStops a recordingConnected, Conferencing
confConference

Initiates a conference call. Requires that Conf Server is enabled and there are two or more calls that are active or on hold.

Connected
delchar

delChar - backspace Icon

Deletes a character when entering text.Dialing Input
dndDND

Sets Do Not Disturb to prevent calls from ringing the phone.

Idle, Off-Hook, Hold, Shared-Active, Shared-Held, Conferencing, Start-Conf, Start-Xfer

endcallEnd callEnds a call

Connected, Off-hook, Progressing, Start-Xfer, Start-Conf, Conferencing,Releasing, Hold,

holdHoldPuts a call on hold.

Connected, Start-Xfer, Start-Conf, Conferencing,

ignoreDeclineIgnores an incoming call.Ringing
joinJoin

Connects a conference call. If the Conferencing conference host is user A and users B & C are participants, when A presses "Join", A will drop off and users B & C will be connected.

Conferencing

calendar

Calendar

Opens the Meetings list

Idle

newcallNew callBegins a new call.

Idle, Hold, Shared-Active, Shared-Held

park

Call park

Puts a call on hold at a designated "park" number.

Connected

participantsParticipants (n)Displays the meeting participant list, where (n) represents the count of the person who have joined the meeting.

Connected

recentsRecents

Displays the All calls list from call history.

Idle, Off-Hook, Shared-Active, Shared-Held

redial Redial Displays the redial list.

Idle, Connected, Start-Conf,Start-Xfer, Off-Hook (no input), Hold

resumeResumeResumes a call that is on hold.Hold, Shared-Held
settingsSettingsProvides access to phone menus.All

unpark

Call unpark

Resumes a parked call.

Idle, Off-Hook, Connected, Shared-Active

xferTransferTransfers a call.

Requires that Attn Xfer Serv is enabled and there is at least one connected call and one idle call.

Connected, Start-Xfer,

Start-Conf

Configure Speed Dial on a programmable softkey

You can configure programmable softkeys as speed dials. The speed dials can be extensions or phone numbers. You can also configure programmable softkeys with speed dials that perform an action that a vertical service activation code (or a star [*] code) defines. For example, if you configure a programmable softkey with a speed dial for *67, the call is placed on hold.

1

Access the phone administration web page.

2

Select Voice > Phone.

3

In the Programmable Softkeys section, set the Programmable Softkey Enable to Yes.

4

To configure a speed dial PSK, enter the following in any of the PSK[1-16] number field:

fnc=sd;ext=extensionname/starcode@$PROXY;vid=n;nme=name

where:

  • fnc= function of the key (speed dial)
  • extensionname=extension being dialed or the star code action to perform
  • vid= n is the extension that the speed dial will dial out
  • name is the name of the speed dial being configured

The name field displays on the softkey on the IP phone screen. We recommend a maximum of 10 characters for a phone. If more characters are used, the label might be truncated on the phone screen.

5

Edit the following parameters:

  1. Idle Key List: Edit the field as described in the following example:

    redial|1;newcall|2;dnd;psk1

    If any keyword is misspelt or the list contains any keyword that is not supported by the paramater, the phone screen does not display any change.

  2. PSK1:

    fnc=sd;ext=5014@$PROXY;nme=speeddial

    In this example, we are configuring a softkey speeddial on a phone as a speed dial number for extension 5014 (sktest1).

    You can also configure an XML service on the programmable softkey. Enter the string in this format:

    <PSK_1 ua="na">fnc=xml;url=http://xml.service.url;nme=name</PSK_1>
6

Click Submit All Changes.

Configure a PSK with DTMF support

You can configure programmable softkeys (PSK) with dual tone multifrequency (DTMF). This configuration enables the phone to send digital pulses inband (or out-of-band via SIP INFO) to the server during an active call. When you enable a function on a PSK, the user sees the softkey name, and presses it to perform the named function. The applied actions to the DTMF digit string are similar to those applied to Speed Dial, such as the following:

  • Pause represented by ,
  • Wait represented by X

For example, ext=<DTMF_DIGITS>[[,|X][<DTMF_DIGITS>]], where the valid DTMF digits are 0-9,*, #, a, b, c, d, and where the parts in [ ] brackets are optional.

This feature applies only to programmable softkeys. It doesn’t apply to the programmable line keys (PLK) on the desk phones. If you configure any PLK for this feature, the display will present the Circled X icon Ⓧ, and nothing will happen if you press the key.

This feature supports only Connected Key List.

Before you begin

1

Access the phone administration web page.

2

Select Voice > Phone.

3

In the Programmable Softkeys section, set the Programmable Softkey Enable to Yes.

4

To configure a DTMF PSK, enter the following in any of the PSK[1-16] number field:

fnc=dtmf;ext=<dtmf_digits_to_be_outpulsed>;nme=<softkey_display_name>;vid=<extension_n_to_be_associated>

When a phone has more than one registered line, you must include the vid= that is asociated with the particular line or extension in order for the softkey to appear. Otherwise, the softkey will not display.

5

Edit the following parameters:

  1. PSK(n) , where n is a programmable softkey number from 1 to 16. Edit the field as described in the following example:

    fnc=dtmf;ext=<dtmf_digits_to_be_outpulsed>;nme=<softkey_display_name>;vid=<extension_n_to_be_associated>

    When a phone has more than one registered line, you must include the vid= that is asociated with the particular line or extension in order for the softkey to appear. Otherwise, the softkey will not display.

  2. Connected Key List: Edit the PSK keywords according to where on the phone screen you wish the softkey name to appear.

    hold;psk1;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park

    For example, here, the hold softkey name appears in the first position. The softkey name that is listed in the psk1 field appears in the second position, and so on.

6

Select Voice > Ext(n), where n is the extension number you wish to configure.

7

In the Audio Configuration section, set the DTMF Tx Method to one of the following methods from the drop-down list.

  • InBand
  • AVT
  • INFO
  • Auto
  • InBand+INFO
  • AVT+INFO
8

Click Submit All Changes.

Use these examples to help you understand how to configure PSK with DTMF Support options:

Example: PSK toggles when pressed.

  • Voice > Phone > Programmable Softkeys > Programmable Softkey Enable: Yes
  • Connected Key List: psk1|1 ;endcall|2;conf|3;xfer|4;
  • PSK 1: fnc=dtmf;ext=#1;nme=PressStart;ext2=*2;nme2=PressStop;vid=1
  • Voice > Ext 1 > DTMF Tx Method: Auto

Example: Phone sends DTMF digits inband via a PSK softkey.

  • Voice > Phone > Programmable Softkeys > Programmable Softkey Enable: Yes
  • Connected Key List: psk1|1 ;endcall|2;conf|3;xfer|4;
  • PSK 1: fnc=dtmf;ext=#1;nme=PressMe;vid=1
  • Voice > Ext 1 > DTMF Tx Method: Auto

Example: The PSK softkey pauses between digits.

  • Voice > Phone > Programmable Softkeys > Programmable Softkey Enable: Yes
  • Connected Key List: psk1|1 ;endcall|2;conf|3;xfer|4;
  • PSK 1: fnc=dtmf;ext=#1,1006;nme=PressMe;vid=1
  • Voice > Ext 1 > DTMF Tx Method: Auto

Example: The PSK softkey waits for the user's input between digits.

  • Voice > Phone > Programmable Softkeys > Programmable Softkey Enable: Yes
  • Connected Key List: psk1|1;endcall|2;conf|3;xfer|4;
  • PSK 1: fnc=dtmf;ext=#1X1006;nme=PressMe;vid=1
  • Voice > Ext 1 > DTMF Tx Method: Auto