Device Softkeys #

Each supported device can be provided with a keymap during provisioning. Each key provided to the phone will override any keys that have been manually configured on the phone itself.

Key Type	Description
(Default)	Not configured, any key configured locally on the phone will not be overridden.
ACD Login	This key can be used to login and out of ACD queues. Use the 'ACD State Toggle' key to switch between 'Away' and 'Free' states.
ACD State	This key can be used to switch between 'Free' and 'Away' states. Use the 'ACD Login Toggle' to login and out of ACD queues.
BLF	Provides a status update of another device on the system. Enter the extension number of device to monitor.
BLF - User	Provides a status update of another user on the system. Select a user to monitor from the list.
BLF Override	Provides a status update of a device on one of the additional accounts configured on the device.
Call tags	This key can be used to tag a value for one of the predefined Call Tags. Enter a value to assign to the selected tag when pressed. Commonly used for Account Codes or Dispositions. For Yealink & Aastra phones, the value property can be left empty/default, allowing the users to prompted for a selection when they press the key.
Change Caller Id	Select one of the available caller ids to apply to the user when pressed. When toggled off, any specific caller id against the user will be removed.
Conference	Conference calls locally on the phone. Optionally, provide a destination for immediate conference setup.
Do Not Disturb	This key toggles the do-not-disturb status of the user.
DTMF	Send DTMF over an in progress call.
Forward	Enter a number to forward all calls to or leave blank to select the destination when the key is pressed. This key sets the forward on the phones associated user.
Headset	Toggles the phone's headset feature on or off.
Hold	Hold a call locally at the phone.
Hot Desk	Hot desk login/logout toggle.
Intercom	Make direct intercom calls to internal phones. Provide the extension number of the user to contact.
Line	Call/line keys. These keys allows users to manage multiple calls at the phone. All line keys are configured to use the first account on the phone.
Line Override	Specific account call/line keys. These keys allows users to manage calls at on any additional accounts configured on the phone..
None	When programmed, the key will be programmed as an empty key, overriding any locally configured keys.
Open Door	Triggers the opening of a door release.
Park	Program a key to toggle park/pickup at one of the 20 available park slots. Select a value between 1 and 20 when configuring the key.
Personal Park	Program a key to park calls at a personal parking slot. Select the user to park calls for.
Pickup	Used to pickup a call which is currently alerting at another user. Leave the value blank to enter an extension when the key is pressed or provide an extension number for fixed use.
Prefix	Enters the beginning of a number which the user can then append to before dialling.
Pull	The 'Pull' feature is used to pull a call from any of the user's phones. This is useful for pulling a cell phone of softphone call to a desk phone as you change location.
Recall	(Yealink phones only) Dials the number of the last incoming call received to return a call.
Remote Forward	Control the forward status for another user on the system. Leave blank to enter the extension number, password and destination when the key is pressed. To hard-code the key to a specific destination, enter {EXT_NO}{EXT_PASSPWD}{DESTINATION} e.g. 1001123401234567890
Speed Dial	Enter a speed dial number to dial when the softkey is pressed. Use a # and one or more commas to add a pause and allow DTMF to be dialled after answer to automate accessing IVR systems. E.g. 18001234567#,,,,1234
Time rules	Use to toggle a Manual time rule on the PBX between enabled/disabled. This allows customers to have a key which displays the status of the time rule, similar to a legacy PBX Night Mode feature. Select the associated time rule from the drop down list when configuring the key. Multiple keys can be added to control multiple time rules.	*
Transfer	Initiate a transfer and dial the required number (or press a BLF or Speed Dial key). If a value is entered, an immediate transfer will be performed to the provided number.
URL	Invokes the provided URL at the device when pressed.
Video Monitoring	Display a video feed from the provided URL.
Voicemail	Access a local voicemail or a group mailbox. The key will light when there are messages waiting. Leave the value blank for a local mailbox or enter an extension number for a group mailbox.
XML Browser	Invokes the provided URL and displays the provided XML form on the screen.

Supported Keys #

Not all keys are available on all hardware types. The table below shows which softkeys are available for supported phones:

Key Type	Yealink	Poly	Mitel 68xx	Mitel 53xx	Cisco
ACD Login	✔	✔	✔	✔	✔
ACD State	✔	✔	✔	✔	✔
BLF	✔	✔	✔	✔	✔
BLF - User	✔	✔	✔	✔	✔
BLF Override	✔	✔	✔	✔	✔
Call tags	✔	✘	✔	✘	✔
Change Caller Id	✔	✔	✔	✔	✔
Conference	✔	Hard Key	✔	Hard Key	Hard Key
Directory	✔	Hard Key	✔	✔	✘
Do Not Disturb	✔	✔	✔	✔	✔
DTMF	✔	✔	✔	✔	✔
Forward	✔	✔	✔	✔	✔
Headset	✘	✘	✘	✔	✘
Hold	✔	✔	Hard Key	Hard Key	Hard Key
Hot Desk	✔	✔	✔	✔	✔
Intercom	✔	✔	✔	✘	✔
Line	✔	✔	✔	✔	✔
Line Override	✔	✔	✔	✔	✔
None	✔	✔	✔	✔	✔
Open Door	✔	✘	✘	✘	✘
Park	✔	✔	✔	✔	✔
Personal Park	✔	✔	✔	✔	✔
Pickup	✔	✘	✔	✔	✔
Prefix	✔	✘	✘	✘	✘
Pull	✔	✔	✔	✔	✔
Recall	✔	✘	✘	✘	✘
Remote Forward	✔	✘	✔	✔	✔
Speed Dial	✔	✔	✔	✔	✔
Time rule	✔	✔	✔	✔	✔
Transfer	✔	✘	✔	Hard Key	Hard Key
URL	✔	✘	✘	✘	✔
Video Monitoring	✔	✘	✘	✘	✘
Voicemail	✔	✘	✔	✔	✔
XML Browser	✔	✘	✔	✘	✔

info

*To support these keys the generic SIP device must support BLF keys and Speed Dials. For more information, please refer to the Generic SIP page.

tip

'Hard Key' means that the manufacturer does not support this softkey type, but usually does have a hard key available to perform this function.