Features/Mass Deployment/Setting Files/XML/Function Keys/XmlSubTags/action

From Snom User Wiki

Jump to: navigation, search

Action-tags define what should happen when the key is used.

Action-tags define these attributes:

  • onPressDial, (obsolete, may be removed in future) dials the given number/uri when fkey is pressed
  • onReleaseDial, (obsolete, may be removed in future) dials the given number/uri when fkey is released

As of versions 8.2.25 and 8.4.2 the above definitions are obsolete. You need to use these instead:

<action>
  <dial when="on press" state="ringing" target="$(remote_uri)" request_uri="$(remote_uri)" replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
  <dial target="xyz*" when="on press" states="connected,holding"/>
  <dial target="xyz" when="on press"/>
  <url target="uvw" when="on release"/>
</action>

As you can see in the above example, action-tags may have several sub-tags. The name of each sub tag defines the nature of the action. Currently there only is one type of action subtag:

  • <dial\> (8.2.25/8.4.2) to dial a number/uri, the dial tag has one specific attribute:
    • target to define the number/uri to be dialed
  • <url\> (8.2.35/8.4.3) to request an action-url to be shown in the phone gui, the url tag has one specific attribute:
    • target to define the action-url to be shown

All action-sub-tags may have one of these attributes (8.2.25/8.4.2):

  • when (required). Defines when the action is to be taken. Currently the phone understands these values:
    • on release - the action will be taken when the fkey is released;
    • on press - the action will be taken when the fkey is pressed;
  • state (optional) - when set, the action is taken only when the fkey-state matches the state defined here. When no state is provided, the action counts as the default/fallback action that is taken only when none of the state-dependent actions match.

Additional attributes for action-sub-tags as of 8.7.2:

  • states (optional). When set, the action is taken only when the fkey-state matches one of the states defined here (comma-separated list). When no state is provided, the action counts as the default/fallback action that is taken only when none of the state-dependent actions match.
  • replaces (conditional). Required for dial-actions that should pick up a call. When set, the action will be to pickup a call using the here-described replaces-header within the sip-invite.

As of FW v8.7.2, the attribute values of almost all attributes may use variables fetched from the xml (see NotifyParsingRules). They're referred to by writing $(id_of_variable) -> the $(..) will be replaced ba the variable-content when the action is fired. These attributes do not support the variables "state", "states", and "when".

Personal tools
Interoperability