XML definitions can use various modules of the phone in order to access variables, run functions etc.

The functions presented here can be used via the request action.


Please note that the modules were designed to be used in the phone's internal XML implementation. They are subject to internal code changes and are not part of the officially tested Snom software. For this reason, we cannot guarantee full functionality of the modules in all versions and on all phones. Please test the used modules before implementing them in production and use at your own risk.


Index:



BusyLampField

Functions

handle_selected

Goal: this function acts as if the contact_number parameter were selected from the Pool. Depending on current phone state, it will call the number or do a transfer using this number.


Parameters:

  • contact_number

Example: call or transfer to number 100

<request when="on press" function="handle_selected" module="BusyLampField" result_destination="my_local_var">
	<parameter name="contact_number" value="100"/>
</request>


CallInterface

Functions

make_call

Goal: Make a call


Parameters:

  • remote - remote number to call
  • identity - ID of identity to use (example: '1' for identity1)
  • device - SPEAKER, HEADSET or OFFHOOK


Example: make a call to number 100 using Identity 2 via SPEAKER:

      <request when="on press" function="make_call" module="CallInterface">
        <parameter name="remote" value="100"/>
        <parameter name="identity" value="2"/>
        <parameter name="device" value="SPEAKER"/>
      </request>

ad_hoc_conference

Goal: Start a conference between given local identity and two remote numbers


Parameters:

  • identity - ID of identity to use (example: '1' for identity1)
  • remote1 - first remote number
  • remote2 - second remote number


Example: start a conference between local identity 2 and remote numbers 100 and 102:

  <request when="on press" function="ad_hoc_conference" module="CallInterface" result_destination="my_var">
	<parameter name="identity" value="2"/>
	<parameter name="remote1" value="100"/>
	<parameter name="remote2" value="102"/>
  </request>

ad_hoc_conference_escalation

Goal: while already in a call with a remote number, this function can be used to conference in a second remote number


Parameters

  • remote2 - second remote number to add


Example: Extension 100 is in a call with 101. To move this call to a conference and add extension 102 to the conversation:

  <request when="on press" function="ad_hoc_conference_escalation" module="CallInterface" result_destination="my_var">
	<parameter name="remote2" value="102"/>
  </request>


CallLists

Functions

clear

Goal: clear the call lists, either all or the one specifically provided


Parameters:

  • name: list_type - defines which call list to clear. When it's not provided or contains an invalid value: all call lists will be cleared
  • valid values: Missed, Dialed, Received , Parked
  • returns: OK (always)


Example:

 <request when="on press" function="clear" module="CallLists" result_destination="my_local_var">
   <parameter name="list_type" value="dialed"/>
 </request>

 

LabelDisplay & Smartlabel

Variables:

current_label_page (rw)

setting a new value will try to change the current page to this value

Arrays:

fkey_ranges_of_label_pages (r)

fkey index of first and last key of each label page (eg. 0,7,15,23,31)

Functions:

next_page

go to next label page

previous_page

go to previous label page

trigger_smartlabel (smartlabel only)

trigger smartlabel with source fkey