Soft Keys

Soft keys control what features are available on the row of keys below the phone's screen based on the current call state. File is specified by <softKeyFile> in SEPMAC.cnf.xml. Note: Some phone models do not support certain soft keys and those features may instead be available as Line Keys.

The 8961, 9951 and 9971 models use the Feature Policy to determine what features are available instead unless <softKeyControl> is enabled. Note: For models that have dedicated Transfer, Conference, Hold and EndCall keys those features are also controlled using soft key definitions.

<softKeyCfg>
  <versionStamp>a92f70b3-6320-46f1-bf5e-bc9f59b66daf</versionStamp>
  <typeSoftKey>

Undefined link

Undefined or empty soft key, must have a keyID of Undefined or Null.

    <softKeyDef keyID="Undefined">
      <tag>0</tag>
      <eventID>0</eventID>
      <helpID>0</helpID>
    </softKeyDef>

Redial link

Redials last number dialed.

    <softKeyDef keyID="Redial">
      <tag>1</tag>
      <eventID>1</eventID>
      <helpID>301</helpID>
    </softKeyDef>

NewCall link

Make a new outgoing call.

    <softKeyDef keyID="NewCall">
      <tag>2</tag>
      <eventID>2</eventID>
      <helpID>302</helpID>
    </softKeyDef>

Hold link

Place the currently selected call on hold.

    <softKeyDef keyID="Hold">
      <tag>3</tag>
      <eventID>3</eventID>
      <helpID>303</helpID>
    </softKeyDef>

Transfer link

Transfer the currently selected call. 7900 series only.

    <softKeyDef keyID="Transfer">
      <tag>4</tag>
      <eventID>4</eventID>
      <helpID>304</helpID>
    </softKeyDef>

CFwdAll link

Sets or removes the current call-forwarding target. The phone make a call to x-cisco-serviceuri-cfwdall-XXX where XXX is replaced by the forwarding target dialed by the user. The phone will make a call to x-cisco-serviceuri-cfwdall when clearing the forwarding target. See Dialplan Extensions for an example.

    <softKeyDef keyID="CFwdAll">
      <tag>5</tag>
      <eventID>5</eventID>
      <helpID>305</helpID>
    </softKeyDef>

<< link

Backspace (delete) over a digit you have dialed.

    <softKeyDef keyID="&lt;&lt;">
      <tag>8</tag>
      <eventID>8</eventID>
      <helpID>308</helpID>
    </softKeyDef>

EndCall link

End the currently selected call.

    <softKeyDef keyID="EndCall">
      <tag>9</tag>
      <eventID>9</eventID>
      <helpID>309</helpID>
    </softKeyDef>

Resume link

Retrieve a call you previously placed on hold.

    <softKeyDef keyID="Resume">
      <tag>10</tag>
      <eventID>10</eventID>
      <helpID>310</helpID>
    </softKeyDef>

Answer link

Answer the currently selected ringing call.

    <softKeyDef keyID="Answer">
      <tag>11</tag>
      <eventID>11</eventID>
      <helpID>311</helpID>
    </softKeyDef>

Confrn link

Start a new ad-hoc conference. 7900 series only.

    <softKeyDef keyID="Confrn">
      <tag>13</tag>
      <eventID>13</eventID>
      <helpID>313</helpID>
    </softKeyDef>

Park link

Park the currently selected call.

    <softKeyDef keyID="Park">
      <tag>14</tag>
      <eventID>14</eventID>
      <helpID>314</helpID>
    </softKeyDef>

Join link

Join the list of selected calls together into a conference. 7900 series only.

    <softKeyDef keyID="Join">
      <tag>15</tag>
      <eventID>15</eventID>
      <helpID>315</helpID>
    </softKeyDef>

MeetMe link

Create a meetme conference. The phone will make a call to extension x-cisco-serviceuri-meetme-XXX where XXX is replaced with the meetme number dialed by the user. See Dialplan Extensions for an example.

    <softKeyDef keyID="MeetMe">
      <tag>16</tag>
      <eventID>16</eventID>
      <helpID>316</helpID>
    </softKeyDef>

PickUp link

Pick-up a the oldest ringing call on one of the phones in you call group. The phone will make a call to extension x-cisco-serviceuri-pickup. See Dialplan Extensions for an example.

    <softKeyDef keyID="PickUp">
      <tag>17</tag>
      <eventID>17</eventID>
      <helpID>317</helpID>
    </softKeyDef>

GPickUp link

Pick-up the oldest ringing call in a specified call group. The phone will make a call to extension x-cisco-serviceuri-gickup-XXX where XXX is replaced with the group number dialed by the user.See Dialplan Extensions for an example.

    <softKeyDef keyID="GPickUp">
      <tag>18</tag>
      <eventID>18</eventID>
      <helpID>318</helpID>
    </softKeyDef>

RmLstC link

Remove last participant added to the selected ad-hoc conference. 7900 series only.

    <softKeyDef keyID="RmLstC">
      <tag>57</tag>
      <eventID>19</eventID>
      <helpID>319</helpID>
    </softKeyDef>

CallBack link

Activate a call-back for the current outgoing call. Phone will notify you when the extension becomes available. You need to have a ring-tone named Callback.raw to get an audible notification.

    <softKeyDef keyID="CallBack">
      <tag>65</tag>
      <eventID>20</eventID>
      <helpID>320</helpID>
    </softKeyDef>

DND link

Set or remove Do Not Disturb presence status. 7900 series only.

    <softKeyDef keyID="DND">
      <tag>63</tag>
      <eventID>69</eventID>
      <helpID>369</helpID>
    </softKeyDef>

QRT link

Quality reporting tool, indicates that Asterisk should log RTP statistics when the call finishes. <callStats> must be set to true in SEPMAC.cnf.xml.

    <softKeyDef keyID="QRT">
      <tag>75</tag>
      <eventID>22</eventID>
      <helpID>322</helpID>
    </softKeyDef>

MCID link

Identify and log the current call as being malicious.

    <softKeyDef keyID="MCID">
      <tag>76</tag>
      <eventID>27</eventID>
      <helpID>327</helpID>
    </softKeyDef>

Select link

Add or remove the currently selected call to the list of calls to be joined together into a conference. 7900 series only.

    <softKeyDef keyID="Select">
      <tag>78</tag>
      <eventID>29</eventID>
      <helpID>329</helpID>
    </softKeyDef>

ConfList link

Provide a list participants in the currently selected ad-hoc conference. Participants can be muted/un-muted by pressing Mute or removed by pressing Remove. Participants that are muted have their caller ID prefixed with a - (minus) and those that are talking are prefixed with a + (plus).

    <softKeyDef keyID="ConfList">
      <tag>79</tag>
      <eventID>30</eventID>
      <helpID>330</helpID>
    </softKeyDef>

iDivert link

Diverts a ringing call on your phone by sending a busy signal or sends a call to idivert extension if the call is connected. See Dialplan Extensions for an example.

    <softKeyDef keyID="iDivert">
      <tag>80</tag>
      <eventID>31</eventID>
      <helpID>331</helpID>
    </softKeyDef>

OPickUp link

Pick-up the oldest ringing on a phone in your other pickup group. The phone will make a call to extension x-cisco-serviceuri-opickup. See Dialplan Extensions for an example.

    <softKeyDef keyID="OPickUp">
      <tag>91</tag>
      <eventID>34</eventID>
      <helpID>334</helpID>
    </softKeyDef>

HLog link

    <softKeyDef keyID="HLog">
      <tag>92</tag>
      <eventID>35</eventID>
      <helpID>335</helpID>
    </softKeyDef>

AbbrDial link

Use abbreviated (speed) dialing. The phone will make a call to extension x-cisco-serviceuri-abbrdial-XXX where XXX is replaced with the number dialed by the user. See Dialplan Extensions for an example.

    <softKeyDef keyID="AbbrDial">
      <tag>7740</tag>
      <eventID>71</eventID>
      <helpID>371</helpID>
    </softKeyDef>

Record link

Record the currently selected call, the separate inbound and outbound audio streams of the call duplicated on the phone and sent to the record extension. See Dialplan Extensions for an example.

    <softKeyDef keyID="Record">
      <tag>7747</tag>
      <eventID>74</eventID>
      <helpID>374</helpID>
    </softKeyDef>
  </typeSoftKey>
  <softKeySets>

softKeySet link

Specify what soft keys to display in a call state. There is a maximum of 16 soft keys for each state.

On Hook link

Valid soft keys are Redial, NewCall (mandatory), DND, CFwdALL, HLog, PickUp, GPickUp, OPickUp, CallBack, MeetMe, QRT and Undefined.

    <softKeySet id="On Hook">
      <softKey keyID="Redial" />
      <softKey keyID="NewCall" />
      <softKey keyID="DND" />
      <softKey keyID="CFwdAll" />
    </softKeySet>

Off Hook link

Valid soft keys are Redial, EndCall, DND, CFwdALL, HLog, PickUp, GPickUp, OPickUp, AbbrDial and Undefined.

    <softKeySet id="Off Hook">
      <softKey keyID="Redial" />
      <softKey keyID="EndCall" />
      <softKey keyID="PickUp" />
    </softKeySet>

Off Hook With Feature link

Valid soft keys are Redial, EndCall, DND, AbbrDial and Undefined.

    <softKeySet id="Off Hook With Feature">
      <softKey keyID="Redial" />
      <softKey keyID="EndCall" />
    </softKeySet>

Digits After First link

Valid soft keys are EndCall, << (mandatory), DND, AbbrDial and Undefined.

    <softKeySet id="Digits After First">
      <softKey keyid="&lt;&lt;" />
      <softKey keyID="EndCall" />
    </softKeySet>

Ring Out link

Valid soft keys are EndCall, DND, CallBack and Undefined.

    <softKeySet id="Ring Out">
      <softKey keyID="Undefined" />
      <softKey keyID="EndCall" />
    </softKeySet>

Connected link

Valid soft keys are Hold, EndCall (mandatory), Transfer, Park, Confrn, ConfList, RmLstC, Record, iDivert, DND, HLog, QRT, MCID, Select, Join and Undefined.

    <softKeySet id="Connected">
      <softKey keyID="Hold" />
      <softKey keyID="EndCall" />
      <softKey keyID="Transfer" />
      <softKey keyID="Confrn" />
      <softKey keyID="ConfList" />
      <softKey keyID="Park" />
    </softKeySet>

Connected No Feature link

Valid soft keys are EndCall and Undefined.

    <softKeySet id="Connected No Feature">
      <softKey keyID="Undefined" />
      <softKey keyID="EndCall" />
    </softKeySet>

Connected Transfer link

Valid soft keys are EndCall, Transfer (mandatory), CallBack, QRT and Undefined.

    <softKeySet id="Connected Transfer">
      <softKey keyID="Undefined" />
      <softKey keyID="EndCall" />
      <softKey keyID="Transfer" />
    </softKeySet>

Connected Conference link

Valid soft keys are EndCall, Confrn (mandatory), DND, QRT and Undefined.

    <softKeySet id="Connected Conference">
      <softKey keyID="Undefined" />
      <softKey keyID="EndCall" />
      <softKey keyID="Confrn" />
    </softKeySet>

On Hold link

Valid soft keys are Resume (mandatory), NewCall, iDivert, DND, Select, Join and Undefined.

    <softKeySet id="On Hold">
      <softKey keyID="Resume" />
      <softKey keyID="NewCall" />
    </softKeySet>

Ring In link

Valid soft keys are Answer, iDivert, DND and Undefined.

    <softKeySet id="Ring In">
      <softKey keyID="Answer" />
      <softKey keyID="iDivert" />
      <softKey keyID="DND" />
    </softKeySet>
    <softKeySet id="Remote In Use" />
  </softKeySets>
</softKeyCfg>