[FAQ] Using Enhanced Feature Keys / EFK macros to change softkey functions or remove softkeys [ Edited ]

[SteffenBaierUK]

This post explains the possibility using Enhanced Feature Keys / EFK macros to change softkey functions or remove softkeys.

Many other examples involving Soft Keys can be found using the Forum Search.

NOTE: This feature is available on SoundPoint IP 32x/33x, 450, 550, 560, 650, and 670, SoundStation IP 5000, 6000 and 7000, and VVX 1500 running UCS 3.3.0 or newer.

Please be aware that limited functionality on certain Platforms may occur if an older Version like SIP 3.2.x or older is used.

This functionality has only been implemented since SIP 3.0.0 and older Versions are unable to change the Softkey functionality as described below (No support for SPIP300 & SPIP500). 

In this example below we are going to remove the new call softkey, change the function of the forward softkey to forward to the voicemail extension and add a new softkey to dial the voicemail and add our extension and pin automatically.

NOTE: Below has been tested against UCS 3.3.3!

Standard Idle Screen:

Running UCS 3.3.x and using below code:

<feature>
    <feature.enhancedFeatureKeys feature.enhancedFeatureKeys.enabled="1"></feature.enhancedFeatureKeys>
  </feature>
  <softkeyoff>
  <softkey softkey.feature.newcall="0" softkey.feature.forward="0"/>
  </softkeyoff>
  <softkey2>
  <softkey softkey.1.action="$FDivert$$FSelect$$FSoftKey2$" softkey.1.enable="1" softkey.1.label="Forward" softkey.1.use.idle="1" />
  </softkey2>
  <softkey3>
  <softkey softkey.2.action="8500$Tinvite$$Cwaitconnect$$Cpause4$3001$Tdtmf$$Cpause4$0000$Tdtmf$" softkey.2.enable="1" softkey.2.label="VM" softkey.2.use.idle="1" />
  </softkey3>
  <divertcontact>
  <divert divert.1.contact="8500"/>
  </divertcontact>

 Running UCS 4.x.x and using below code:

<WEB
feature.enhancedFeatureKeys.enabled="1"
softkey.feature.forward="0"
softkey.feature.newcall="0"
dreg.1.fwdContact="8500"
softkey.1.action="$FDivert$$FSelect$$FSoftKey2$"
softkey.2.action="8500$Tinvite$$Cwaitconnect$$Cpause4$3001$Tdtmf$$Cpause4$0000$Tdtmf$"
softkey.1.enable="1"
softkey.2.enable="1"
softkey.1.label="Forward"
softkey.2.label="VM"
softkey.1.use.idle="1"
softkey.2.use.idle="1"
/>

• The efk/ enhanced feature key feature is activated via feature.enhancedFeatureKeys.enabled="1"
  
  
• The 2 original softkey's are deactivated via softkey.feature.newcall="0" softkey.feature.forward="0"
  
  
• The macro for the call forward is "$FDivert$$FSelect$$FSoftKey2$", this emulates the Button presses via the menu.
  
  
• The softkey is then activated via softkey.1.enable="1"
  
  
• The name for the softkey is defined via softkey.1.label="Forward" and it is only displayed when idle via softkey.1.use.idle="1"
  
  
• The macro for the voicemail is "8500$Tinvite$$Cwaitconnect$$Cpause4$3001$Tdtmf$$Cpause4$0000$Tdtmf$" . This dials 8500 and wait until connected, pauses for 4 seconds and sends the extension 3001 via DTMF, pauses for 4 seconds and sends the password 0000 via DTMF
  
  
• The softkey is then activated via softkey.2.enable="1"
  
  
• The name for the softkey is defined via softkey.2.label="VM" and it is only displayed when idle via softkey.2.use.idle="1"

NOTE: This is only an example and numbers may need to be changed to match the local setup. The Admin Guide and the Feature Descriptions & Technical Notifications Page contain additional examples.

The Phone now shows the new softkey's:

Pressing Forward will toggle between call forward on or off