TIPTEL 31xx series User manual

XML API Guide (en)
Version 2.6
tiptel 31xx
tiptel

XML API for Tiptel.com SIP Phones 31xx
Last changes: 09.12.2014
Table of contents
1 Abbreviations..........................................................................................................................................................2
2 XML Services.........................................................................................................................................................3
2.1 Phone initiated service....................................................................................................................................3
2.1.1 Action RL - PBX Sync.........................................................................................................................3
2.1.2 Programmable function key....................................................................................................................3
2.1.3 External XML phone book service.........................................................................................................3
2.2 External initiated service.................................................................................................................................4
2.2.1 HTTP Remote Action- RL....................................................................................................................4
2.2.2 SIP NOTIFY Remote Action- RL.........................................................................................................4
2.2.3 HTTP Push XML....................................................................................................................................5
2.2.4 SIP NOTIFY Push XML.........................................................................................................................5
2.3 XML Format...................................................................................................................................................6
2.4 External RI formats......................................................................................................................................6
2.4.1 RL variables.........................................................................................................................................7
2.5 Internal call control RI formats....................................................................................................................8
2.5.1 Internal RI Dial:...................................................................................................................................8
2.5.2 Internal RI SendDigits:........................................................................................................................8
2.6 Internal device control RI formats................................................................................................................8
2.6.1 Internal RI "Key:"................................................................................................................................9
2.6.2 Internal RI "Led:"...............................................................................................................................10
2.6.3 Internal RI "Command:"....................................................................................................................11
2.6.4 Internal RI "SoftKey:"........................................................................................................................11
3 XML objects.........................................................................................................................................................13
3.1 IPPhoneExecute XML object........................................................................................................................13
3.2 IPPhoneConfiguration XML object..............................................................................................................14
3.3 IPPhoneTextMenu XML object....................................................................................................................14
3.4 IPPhoneTextScreen XML object...................................................................................................................18
3.5 IPPhoneInputScreen XML object.................................................................................................................20
3.6 IPPhoneDirectory XML object (Type A)......................................................................................................25
3.7 IPPhoneStatus XML object...........................................................................................................................28
3.8 IPPhoneDirectory XML object (Type B)......................................................................................................30
3.9 IPPhoneText XML object.............................................................................................................................32
3.10 IPPhoneMenu XML object.........................................................................................................................34
3.11 External XML phone book..........................................................................................................................35
3.12 XML Device Info........................................................................................................................................36
3.13 Sub objects for I XML objects.................................................................................................................37
3.13.1 Sub object "SoftKey" for XML I objects..........................................................................................37
3.13.2 sing the internal object "SoftKey” for customizing hard keys..........................................................38
3.13.3 Sub object "SoftKeyItem" for XML I objects (Type B)...................................................................39
3.14 Special attributes for I XML objects........................................................................................................40
3.14.1 Timeout...............................................................................................................................................40
3.14.2 LockIn.................................................................................................................................................41
3.14.3 triggerDestroyOnExit/ destroyOnExit.................................................................................................41
4 HTTP API.............................................................................................................................................................42
4.1 HTTP GET Device control RLs.................................................................................................................42
4.2 HTTP GET Service RLs.............................................................................................................................42
5 HOW TO..............................................................................................................................................................43
5.1 HOW TO push XML file via HTTP..............................................................................................................43
5.2 HOW TO push XML file on Asterisk via SIP NOTIFY................................................................................43
5.3 HOW TO trigger remote action RL via HTTP...........................................................................................44
Page 1 / 50

XML API for Tiptel.com SIP Phones 31xx
5.4 HOW TO trigger remote action RL on Asterisk via SIP NOTIFY.............................................................44
6 XML Schema, XSL Model...................................................................................................................................45
7 History..................................................................................................................................................................46
List of tables
Table 1: Customizable hard keys in object “SoftKey”..............................................................................................39
Table 2: Customizable hard keys in object “SoftKeyItem”.......................................................................................40
1 Abbreviations
API Application Programming Interface
SIP Session Initiation Protocol
I User Interface
RL Uniform Resource Locator, in this document the same as RI
RI Uniform Resource Identifier RFCs 1630, 3986
XML eXtensible Markup Language
Page 2 / 50

XML API for Tiptel.com SIP Phones 31xx
2 XML Services
The phone provides two methods to run the XML service,
–initiated by phone device
–initiated by external server
There are basically 3 types of XML objects:
1) ser Interface objects are XML objects which will use the display of the phone to show the content of
XML file.
2) Device control objects are XML objects used to execute commands or configure the phone. There are no
interaction witch user.
3) XML phone book for build-in Merge-Service
2.1 Phone initiated service
The phone use TFTP, FTP or HTTP(S) GET command to download the XML file from the external server. Each
time the phone try to interpret downloaded data. If there defined XML objects are detected the content will be
accordingly processed.
2.1.1 Action URL - PBX Sync
On predefined internal phone and call events the corresponding configured Action- RLs will be triggered
automatically by device. See chapter PBX Sync in Administrator Guide / Wiki to configure this kind of RLs for
corresponding events.
2.1.2 Programmable f nction key
Any Action- RL can be triggered manually by hitting a function key configured accordingly on the phone or
extension module. See chapter DSS Key and EXT Key in Administrator Guide / Wiki to configure this kind of
RLs for corresponding keys.
2.1.3 External XML phone book service
Since firmware version 2.x there are different ways to entry the default phone book.
Option 1)
There are a build-in service to merge an external XML phone book in to internal phone book. The RL of XML
file and pooling interval must be configured to use this service. The XML-File should contain IPPhoneDirectory
object type A or B.
Option 2)
An external LDAP-Server can be used.
Option 3)
An external WEB-Service can be used to get filtered contacts. Therefore a Service- RL using {filter} runtime
variable must be defined. The phone device collects the user input, replaces the variable by characters and performs
http GET. The Web-Service should evaluate the search request and must deliver the IPPhoneDirectory-Object witch
Page 3 / 50

XML API for Tiptel.com SIP Phones 31xx
requested contacts.
Option 4)
A simply Action- RL can be defined as entry point for a phone book in context of XML-Minibrowser. On the
phone with the alpha keyboard the RL-Variable {search_key} will help to send a initial search filter character to
the server. IPPhoneMenu-Object can be used to show entries. The Softkey- RLs for keys “1” till “9” should be
defined to collect the pressed keys by Web-Service and perform the look up queries on basis of T9-Model.
2.2 External initiated service
In the context of remote access there are different ways to initiate the downloading of XML file or send the XML
data directly to the phone.
2.2.1 HTTP Remote Action-URL
The downloading of XML file can be triggered by using HTTP GET method calling remote RL on device build-in
Web Server.
http://phoneip/cgi-bin/remote/devctl?minibrowserurl=url
The query string must contain the RL of XML file
minibrowserurl=url
The phone returns 200 OK and downloads the XML file.
Example:
This example will induce the phone with IP 192.168.1.103 to download the XML file from
http://myserver/mymenu_192.168.1.1 3.xml
Please consider that RL-Variable {ip} should be escaped in form of %7Bip%7D to be RFC conform.
2.2.2 SIP NOTIFY Remote Action-URL
The downloading of XML file can be triggered by using proprietary SIP NOTIFY event "tiptel-actionurl"
Example:
Page 4 / 50
http://192.168.1.1 3/cgi-bin/remote/devctl?
minibrowserurl=http://myserver/mymenu_%7Bip%7D.xml

XML API for Tiptel.com SIP Phones 31xx
This example will trigger the phone with IP-Addr. 192.168.1.103 and MAC-Addr. 000CC4300086 download the
XML file from http://192.168.1.1/myfiles/mymenu_000CC4300086.xml
2.2.3 HTTP P sh XML
XML data can be send to the phone using HTTP POST method. The Content-Type Header must be set to
text/xml . Require user 'admin'
Example:
This example will turn the display back light on, See IPPhoneExecute object and URI ed for more details.
2.2.4 SIP NOTIFY P sh XML
XML data can be send directly to the phone using proprietary SIP NOTIFY event "tiptel-xml" with XML content.
Example:
Page 5 / 50
POST /xmlservice HTTP/1.
User-Agent: Wget/1.11.4
Accept: */*
Host: 192.168.1.2
Connection: Keep-Alive
Content-Type: text/xml
Content-Length: 14
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneExecute Beep="yes">
<ExecuteItem URI="Led:BACKLIGHT=on"/>
</TiptelIPPhoneExecute>
NOTIFY sip:3 3 @192.168.1.1 3:5 6 SIP/2.
Via: SIP/2. /UDP 192.168.1.1 1:5 6 ;branch=ad5jh4ut9dsnf3jtf;rport
From: <sip:3 2 @192.168.1.1 1:5 6 >;tag=54dg7853c4
To: 3 3 <sip:3 3 @192.168.1.1 3:5 6 >
Contact: <sip:3 2 @192.168.1.1 1>
Call-ID: 65835h8s46f2x429
CSeq: 2 NOTIFY
Max-Forwards: 1
Event: tiptel-actionurl
Content-Type: text/plain
Content-Length: 37
http://192.168.1.1/myfiles/mymenu_{mac}.xml

XML API for Tiptel.com SIP Phones 31xx
2.3 XML Format
The XML data must be well-formed according W3C XML 1.0 specifications. The XML header should be set at the
beginning of the XML document. Actually following header variants are supported:
<?xml version="1. " ?>
<?xml version="1. " encoding="UTF-8" ?>
<?xml version="1. " encoding="ISO-8859-1" ?>
If the encoding parameter is missing the default encoding is TF-8 according W3C XML 1.0 specifications.
All XML element names and attribute names are case sensitive.
Special characters must be escape encoded:
Character Name Escape sequence
& Ampersand &amp;
" Quote &quot;
' Apostrophe &apos;
< Left angle bracket &lt;
> Right angle bracket &gt;
2.4 External URI formats
The generic syntax of en external RI is defined by RFC 3986. All external RIs must begin with a scheme name
(download protocol), followed by a colon character (":"). Valid RIs witch scheme names for external resources
and XML files are:
Page 6 / 50
NOTIFY sip:3 2 @192.168.1.1 1:5 6 SIP/2.
Via: SIP/2. /UDP 192.168.1.1 1:5 6 ;branch=ad5jh4ut9dsnf3jtf;rport
From: <sip:3 2 @192.168.1.1 1:5 6 >;tag=54dg7853c4
To: 3 3 <sip:2 @1 .3 .1 .1 3:5 6 >
Contact: <sip:3 2 @192.168.1.1 1>
Call-ID: 65835h8s46f2x429
CSeq: 2 NOTIFY
Event: tiptel-xml
Content-Type: application/xml
Content-Length: 14
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneExecute Beep="yes">
<ExecuteItem URI="Led:BACKLIGHT=on"/>
</TiptelIPPhoneExecute>

XML API for Tiptel.com SIP Phones 31xx
tftp://xxxx/yyy/file.xml
ftp://xxxx/yyy/file.xml
http://xxxx/yyy/file.cgi?querykey=queryvar
https://xxxx/yyy/file.php?querykey=queryvar
sip:xxxx
tel:xxxx
Please note that http RIs with query parameters in XML files must be written in escape encoding
(e.g. & → &amp;).
2.4.1 URL variables
Any external RL may contain runtime variables. This variables will be dynamically replaced by the phone with
the valid values at runtime shortly before download the resource.
Variable Description
{mac} MAC address of the phone
{ip} Current IP address of the phone
{model} The phone model
{firmware} The firmware ersion of the phone
{local}
or
{acti e_url}
The SIP URI of the default local identity or of the acti e outgoing identity
{display_local} The display name of the default local identity or of the acti e outgoing identity
{acti e_user} The user part of the SIP URI of the default local identity or of the acti e outgoing call identity
{acti e_host} The host part of the SIP URI of the default local identity or of the acti e outgoing identity
{acti e_key} The function key, line key or SoftKey associated with the URL directi e or the call. For coding syntax see the
coding of internal URL Key:
{remote} The SIP URI of the remote identity
(only in context of PBX sync URL)
{display_remote} The display name of the remote identity
(only in context of PBX sync URL)
{call_id} The call-id of the acti e call
(only in context of PBX sync URL)
{duration} The call duration in seconds
(only in context of PBX sync URL)
{callDirection} Indication of the call as sender or recipient
(only in context of PBX sync URL)
{filter} Search filter of remote XML phonebook
Example: http://pbx.ip/php/phonebook/book.php?book=tpb.xml&name={filter}
{search_key} The pressed Key ititated URL query as alphanumeric or URL-escaped code.
Example: http://pbx.ip/php/phonebook/book.php?book=tpb.xml&key={search_key}
The variables must be enclosed in curly braces. For historical compatibility instead of braces is allowed to use the
dollar sign ( $ ) to mark the the start of variable.
Example:
Page 7 / 50
http://192.168.2 .1/cgi-bin/onnewcall.php?from={remote}&to={local}
http://192.168.2 .1/cgi-bin/onregister.php?addr=$ip

XML API for Tiptel.com SIP Phones 31xx
2. Internal call control URI formats
Phones supports some proprietary RI schemas to allow the call control.
–Dial:XXXXXX initiates a new call to the specified phone number/address
–SendDigits:XXXXXX generates DTMF tones
2.5.1 Internal URI Dial:
The Dial RI initiates a new call.
URI format:
Dial:number
Example:
2.5.2 Internal URI SendDigits:
The SendDigits RI order the phone to send a sequence of DTMF tones. This will be performed only if a
connected call exist. The method used to send DTMF tones (In-Band or RFC2833) must be configured for
concerned line.
URI format:
SendDigits:dtmfDigits
Example:
2.6 Internal device control URI formats
Phones supports some proprietary RI schemas to address internal phone resources and allow the device control.
Page 8 / 50
<?xml version="1. " ?>
<TiptelIPPhoneExecute>
<ExecuteItem URI="SendDigits:*8"/>
</TiptelIPPhoneExecute>
<?xml version="1. " ?>
<TiptelIPPhoneExecute>
<ExecuteItem URI="Dial: 4921 2428 "/>
</TiptelIPPhoneExecute>

XML API for Tiptel.com SIP Phones 31xx
–Key:XXX emulate a key event
–Led:XXX control the LED state
–Command: XXX execute commands
2.6.1 Internal URI "Key:"
The internal proprietary RI "Key:" allows to emulate the pressing a button that physically exists on a device.
URI format:
Key:XXXXXX
Where XXXXXX variable is one of the following predefined key ids:
Key id Description Example
fkeyNN
fkeyNN.0
Emulate the press e ent of a free programmable function key on the phone de ice.
NN is the number of function key (1 - 12)
Key:fkey5
Key:fkey5.0
fkeyNN.MEmulate the key of on an extension module
NN is the number of a key on module (1 - 27)
M is the module number (1 - 3)
The specification of the module number is mandatory.
Key:fkey5.1
lineNEmulate the display selection button (line key) to the right of the display.
N is the number of selection button (1 - 7)
Key:line2
SoftKeyNEmulate the soft key button below the display.
N is the number of soft key button (1 - 4)
Key:SoftKey3
keypadNEmulate numeric keypad button 0-9
N is the number of keypad button (0 - 9)
Key:keypad2
star (*) Star button Key:star
pound (#) Pound button Key:pound
increase (+) Increase button Key:increase
decrease (-) Decrease button Key:decrease
cancel (ESC) Escape/Cancel Button Key:cancel
settings (Menu) Settings menu button Key:settings
del (Del) Delete button Key:del
ok (Ok) Ok button Key:ok
up Na igation up key Key:up
down Na igation down key Key:down
left Na igation left key Key:left
right Na igation right key Key:right
directory Directory button Key:directory
mute Mute button Key:mute
rkey R button Key:rkey
redial Redial button Key:redial
speaker Speaker button Key:speaker
alpha_NAlpha keyboard ASCII button
N is the alpha character
Key:alpha_A
Key:alpha_b
space Alpha keyboard space button Key:space
return Alpha keyboard return button Key:return
backspace Alpha keyboard backspace button Key:backspace
Page 9 / 50

XML API for Tiptel.com SIP Phones 31xx
Example:
2.6.2 Internal URI "Led:"
The internal proprietary RI " ed:" allows to control the LED status of free programmable function keys on the
phone and extension modules, message waiting indicator, as well as display back light.
URI format:
Led:XXXXXX=on | off | fastflash | slowflash
Where XXXXXX variable is one of the following predefined key ids:
Key id Description Example
backlight Turns the display back light on / off / ... Led:backlight=on
mwi Turns the message waiting indicator on / off / ... Led:mwi=slowflash
mute Turns the LED on mute button on / off / ... Led:mute=on
speaker Turns the LED on speaker button on / off / ... Led:speaker=fastflash
fkeyNN_CCC
fkeyNN.0_CCC
Controls the LEDs of phone function keys
NN is the number of function key (1 - 12)
CCC is the color alue. (red | green | amber)
The specification of the module number 0 is optional.
Led:fkey5_red=fastflash
Led:fkey5.0_red=fastflash
Led:fkey8=off
Led:fkey8.0=off
Led:fkey8.0_green=off
fkeyNN.s_CCC Supported since Firmware 3.0.0. on phones with colour displays
Controls the LED icons of phone selection keys presented on the right side
of the display.
NN is the number of function key (1 - 6)
CCC is the color alue. (red | green | amber)
The specification of the module number s is mandatory.
Led:fkey1.s_red=fastflash
Led:fkey2.s_green=slowflash
Led:fkey3.s_green=on
Led:fkey3.s_red=off
Led:fkey3.s=off
fkeyNN.M_CCC Controls the LEDs of an extension module
NN is the number of a key on module (1 - 27)
M is the module number (1 - 3)
CCC is the color alue. (red | green | amber)
The specification of the module number is mandatory.
Led:fkey5.1_red=fastflash
Led:fkey6.1_green=slowflash
Led:fkey7.1_green=on
Led:fkey8.1_red=off
Led:fkey8.1=off
Example:
Page 10 / 50
<?xml version="1. " ?>
<TiptelIPPhoneExecute>
<ExecuteItem URI="Led:mwi=slowflash"/>
<ExecuteItem URI="Led:backlight=on"/>
<ExecuteItem URI="Led:fkey2_red=on"/>
<ExecuteItem URI="Led:fkey7. _green=fastflash"/>
<ExecuteItem URI="Led:fkey3.1_green=slowflash"/>
<!-- LED icon of first selection key on display -->
<ExecuteItem URI="Led:fkey1.s_amber=fastflash"/>
</TiptelIPPhoneExecute>
<?xml version="1. " ?>
<TiptelIPPhoneExecute>
<ExecuteItem URI="Key:fkey2"/>
<ExecuteItem URI="Key:line3"/>
</TiptelIPPhoneExecute>

XML API for Tiptel.com SIP Phones 31xx
2.6.3 Internal URI "Command:"
The internal proprietary RI "Command:" allows to execute service commands.
URI format:
Command:XXXXXX
Where XXXXXX variable is one of the following predefined commands:
Command Description Example
Reset Reset the configuration to factory defaults and reboot
The command will be executed only if there are no oice connections.
Command:Reset
Reboot Restart de ice.
The command will be executed only if there are no oice connections.
Command:Reboot
Resync Downloads autopro isioning files.
The command will be executed only if there are no oice connections.
Command:Resync
Lock Lock the phone keys Command:Lock
Unlock Unlock the phone keys Command:Unlock
ClearCallersList Clear local incoming call record list Command:ClearCallersList
ClearRedialList Clear redial list (outgoing call record) Command:ClearRedialList
ClearDirectory Clear local contact list Command:ClearDirectory
Example:
2.6.4 Internal URI "SoftKey:"
Some user interface XML objects support predefined internal RIs.
Available object commands
➢ "SoftKey:Exit " is a ailable for all UI XML objects and redraws the pre ious XML object present in the phone
browser. Does not appear if LockIn set to "yes".
➢ "SoftKey:Select " is a ailable for TiptelPPhoneTextMenu only and calls the URI tag of the selected
MenuItem .
➢ "SoftKey:Dial " is a ailable to screens that allow input. The dial string for the "Dial" function is taken from
the menu items URI on the Menu Screen.
➢ "SoftKey:Next" is only a ailable in IPPhoneDirectory XML object (Type A).
➢ "SoftKey:Previous" is only a ailable in IPPhoneDirectory XML object (Type A).
Page 11 / 50
<?xml version="1. " ?>
<TiptelIPPhoneExecute>
<ExecuteItem URI="Command:ClearRedialList"/>
<ExecuteItem URI="Command:ClearCallersList"/>
<ExecuteItem URI="Command:Reboot"/>
</TiptelIPPhoneExecute>

XML API for Tiptel.com SIP Phones 31xx
➢ "SoftKey:Submit " is a ailable for TiptelPPhoneInputScreen only and calls the URL tag .
➢ "SoftKey:E it_an _Dial " is a ailable to screens that allow input. The dial string for the "Dial" function is
taken from the menu items URI on the Menu Screen and copied to the dialing preparation iew.
Availability of SoftKeys per object
SoftKey IPPhoneTextMenu IPPhoneTextScreen IPPhoneInputScree
n
IPPhone irectory
(Type A)
Exit x x x x
Select x
Dial x x
Next x
Previous x
Submit x
Edit_and_Dial x x
Custom defined x x x x
SoftKey IPPhoneText IPPhone irectory
(Type B)
Exit x x
Select x
Dial x
Next
Previous
Submit
Edit_and_Dial x
Custom defined x x
Page 12 / 50

XML API for Tiptel.com SIP Phones 31xx
3 XML objects
User interface objects
➢IPPhoneTextMenu (3.3)
➢IPPhoneTextScreen (3.4)
➢IPPhoneInputScreen (3.5)
➢IPPhoneDirectory (Type A) (3.6)
➢IPPhoneStatus (3.7)
➢IPPhoneDirectory (Type B) (3.8)
➢IPPhoneText (3.9)
➢IPPhoneMenu (3.10)
evice control objects
➢IPPhoneConfiguration (3.2)
➢IPPhoneExecute (3.1)
➢IPPhoneDirectory (3.11)
3.1 IPPhoneExecute XML object
The IPPhoneExecute XML object forces the phone to perform a series of actions. The device executes commands
without promoting the user.
XML file description:
XML file example:
sed XML objects
XML object Type Description
TiptelIPPhoneExecute mandatory The root element
Beep optional Set = "yes" to generate a notification beep by phone. Default = "no"
Page 13 / 50
<****IPPhoneExecute Beep = "yes/no" triggerDestroyOnExit=”yes/no”>
<ExecuteItem URI="URI"/>
<ExecuteItem URI="URI" line="2"/>
<!-up to 3 ExecuteItem may follow ->
</****IPPhoneExecute>
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneExecute Beep="yes/no">
<ExecuteItem URI="http://myserver/notify.php?dev=$mac"/>
<ExecuteItem URI="Dial: 49116117"/>
<ExecuteItem URI="Dial:215" line="3"/>
<ExecuteItem URI="Command:Resync/>
</TiptelIPPhoneExecute>

XML API for Tiptel.com SIP Phones 31xx
triggerDestroyOnExit optional Set = "yes" to exit the XML UI iew. If the XML object is sent as an answer to a user
interface object this will trigger the currently presented UI object to exit if its attribute
destroyOnExit is set “yes”. See section 3.14.3 for more details. Default = "no"
ExecuteItem optional Execute item (up to 30 instances)
URI mandatory Any internal or external URI describing the action to be executed. (max. 510 Bytes)
line optional Account to use. If not present or 0 the default account is used
3.2 IPPhoneConfiguration XML object
Not yet implemented.
3.3 IPPhoneTextMenu XML object
The IPPhoneTextMenu XML object can be used to display a non-formatted menu.
XML file description:
Note: The "****" in "****IPPhoneTextMenu" can be any string, also can be left empty..
XML file example 1: Simple menu
Page 14 / 50
<****IPPhoneTextMenu
Beep = "yes/no"
ockIn = "yes/no"
style = "numbered/none/radio"
Timeout = "some integer"
cancelAction = "some URI"
defaultIndex = "some integer"
destroyOnExit = "yes/no"
>
<Title>any text</Title>
<MenuItem>
<Prompt>any Text</Prompt>
<URI></URI>
<Dial line=”SIP line”></Dial>
<Selection></Selection>
</MenuItem>
<!-up to 30 MenuItem items may follow -->
<!-SoftKey items may be added -->
</****IPPhoneTextMenu>

XML API for Tiptel.com SIP Phones 31xx
XML file example 2: Phone register
XML file example 3: TextMenu user selection
Page 15 / 50
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneTextMenu Beep = "yes" style = "numbered">
<Title>Phone register</Title>
<MenuItem>
<Prompt>Tiptel.com</Prompt>
<URI>http://server/more_info_about_tiptel.xml</URI>
<Dial> 4921 2428 </Dial>
</MenuItem>
<MenuItem>
<Prompt>My dentist</Prompt>
<URI>http://server/info_about_dentist.xml</URI>
<Dial line=”2”> 8 123412341234</Dial>
</MenuItem>
<SoftKey index="4">
< abel>Dial</ abel>
<URI>SoftKey:Select</URI>
</SoftKey>
</TiptelIPPhoneTextMenu>
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneTextMenu Beep = "yes" style = "numbered" Timeout="3 ">
<Title>Menu</Title>
<MenuItem>
<Prompt>Item 1</Prompt>
<URI>http://server/item_1.xml</URI>
</MenuItem>
<MenuItem>
<Prompt>Item 2</Prompt>
<URI>http://server/item_2.xml</URI>
</MenuItem>
</TiptelIPPhoneTextMenu>

XML API for Tiptel.com SIP Phones 31xx
When the user selects item 1 and presses soft key 3, the RI requested is
http://server/do_handle_selection.php?selection=dataToAppend_1
Notes:
•If a "?" already exists in the RI, then a "&" is used to separate the parameters. Note the parameter name
"selection" is always added. If the Selection attribute is omitted, then nothing extra is appended to the RI.
•The Selection attribute can contain more than one parameter, for instance, the following selection attribute
is valid <Selection>bla1&action=delete</Selection>
Don’t forget to escape encode the attribute for the '&' in the XML file. (→ 2.3)
sed XML objects
XML object Position Type Description
TiptelIPPhoneTextM
enu
Root tag Mandatory Root element
Beep Root tag Optional Set = "yes" to generate a notification beep by phone.
Default = "no"
style Root tag Optional "numbered", "none" and "radio" indicate the style of the
menu. Default is "numbered"
Timeout Root tag Optional If there are no operations from users after entering into
the iew within the time, the phone will exit to the
standby interface. Default is 45 s
See section 3.14.1 for more details.
LockIn Root tag Optional See section 3.14.2 for details. Default is "no".
cancel Action Root tag Optional Defines the URI to be called when the user cancels the
iew.
defaultIndex Root tag Optional Position of the cursor when the XML object is presented.
Default is 1 ( alid alues: 1..30)
destroyOnExit Root tag Optional “yes” indicates that the object will be remo ed from the
XML browser stack after exit.
If not specified or set “no” the object is kept in the XML
browser after exit.
See section 3.14.3 for more details.
Page 16 / 50
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneTextMenu Beep = "yes" style = "numbered" defaultIndex="1">
<Title>Menu</Title>
<MenuItem>
<Prompt>First selection</Prompt>
<URI>http://server/item_1.xml</URI>
<Selection>dataToAppend_1</Selection>
</MenuItem>
<MenuItem>
<Prompt>Second selection</Prompt>
<URI>http://server/item_2.xml</URI>
<Selection>dataToAppend_2</Selection>
</MenuItem>
<SoftKey index="3">
< abel>Custom key</ abel>
<URI>http://server/do_handle_selection.php</URI>
</SoftKey>
</TiptelIPPhoneTextMenu>

XML API for Tiptel.com SIP Phones 31xx
XML object Position Type Description
Title Body Mandatory Title of menu
MenuItem Body Mandatory Up to 30 items
Prompt MenuItem body Mandatory Text of menu item
URI MenuItem body Optional Internal or external URI describing the action to be
executed
Keys to start the action:
OK/ Cursor right/ SoftKey:Select
Dial MenuItem body Optional The phone will dial out this number.
Keys or actions to start dialling:
OffHook/ Linekey/ Handfree key/ Headset offhook/
SoftKey:Dial
line Dial body Optional Values 1..8: The phone uses the selected SIP line.
Other alues or not set: the phone uses the default line.
Selection MenuItem body Optional Custom SoftKey with external URI
SoftKey Optional See section 3.13.1 for details
Note: Hard keys (3.13.2) cannot be defined for each
menu item! Please define them global in the body of the
root object.
Label SoftKey Body Mandatory Text of SoftKey
URI SoftKey Body Mandatory Internal or external URI describing the action to be
executed
Default soft keys:
The following default soft keys will be presented if the XML file of IPPhoneTextMenu does not include any soft
key description:
SoftKey index Name URI
1 Exit SoftKey:Exit
4 Select SoftKey:Select
Key processing:
Key Function description
Cursor up/down Mo e focus in list up/down
Digit key 1-9, 0 Select menu item whose index alue equals to number's key press and
dial the the corresponding number in <Dial>. If there is no <dial> entry call
the URI.
Note: if any hard key “0”...”9” is setup with an URL (see 3.13.2) the abo e
type of selection is disabled.
1-9, 0, *, # If hard keys are user defined, URI is executed. (See 3.13.2)
SoftKey "Dial" Dial the corresponding number in <Dial> of the selected menu item.
SoftKey "Edit_and_Dial" Copies the corresponding number in <Dial> of the selected menu item into
Page 17 / 50

XML API for Tiptel.com SIP Phones 31xx
Key Function description
dialing preparation iew. There the user can edit the number and dial the
number.
Selection keys Select the corresponding menu item and dial the the corresponding
number in <dial>. If there is no <dial> entry call the URI.
Cursor right Dial the the corresponding number of the selected menu item. If there is
no <Dial> entry call the URI.
SoftKey "Select" Call corresponding URI command of the selected menu item.
SoftKey "Exit" Present pre ious displayed xml iew if a ailable. Else return to idle
screen.
Cursor left same function as SoftKey "Exit"
Esc Return to idle screen. If 'cancelAction' is defined the URI is executed.
If 'cancelAction" calls another UI XML object the pre ious iew is kept on
the stack.
Ok If LockIn is set "no", the function of the "OK" key will be the same as
SoftKey "Select", if it is "yes", there will be no response
OffHook/ Linekey/ Handfree key/
Headset offhook
If LockIn is set "no", the function of the key will be the same as SoftKey
"Dial", if it is "yes", there will be no response.
3.4 IPPhoneTextScreen XML object
The IPPhoneTextScreen XML object can be used to display a non-formatted text in a scrollable window.
XML file description:
Note: The "****" in "****IPPhoneTextScreen" can be any string, also can be left empty..
XML file example 1:
Page 18 / 50
<****IPPhoneTextScreen
Beep = "yes/no"
ockIn = "yes/no"
Timeout = "some integer"
cancelAction = "some URI"
doneAction = "some URI"
destroyOnExit = "yes/no"
>
<Title>any text</Title>
<Text>any text</Text>
<!-SoftKey items may be added -->
</****IPPhoneTextScreen>

XML API for Tiptel.com SIP Phones 31xx
XML file example 2: user defined soft keys and hard keys
sed XML objects
XML object Position Type Description
TiptelIPPhoneTextSc
reen
Root tag Mandatory Root element
Beep Root tag Optional Set = "yes" to generate a notification beep by phone.
Default is "no"
Timeout Root tag Optional If there are no operations from users after entering into
the iew within the time, the phone will exit to the
standby interface. Default is 45 s
See section 3.14.1 for more details.
Page 19 / 50
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneTextScreen Beep = "yes">
<Title>Title of screen</Title>
<Text>Text of screen\nthis was a manually set newline</Text>
<SoftKey index="3">
< abel>Custom key</ abel>
<URI>http://myserver2.de/get_it.php</URI>
</SoftKey>
</TiptelIPPhoneTextScreen>
<?xml version="1. " encoding="UTF-8"?>
<TiptelIPPhoneTextScreen Beep = "yes">
<Title>Title of screen</Title>
<Text>Press ..9 to search name in all phone books.</Text>
<SoftKey name=" ">
<URI>http://myserver2.de/get_pb.php?key= </URI>
</SoftKey>
<SoftKey name="9">
<URI>http://myserver2.de/get_pb.php?key=9</URI>
</SoftKey>
<SoftKey name="#">
<URI>http://myserver2.de/get_pb.php?key=B</URI>
</SoftKey>
<SoftKey name="*">
<URI>http://myserver2.de/get_pb.php?key=A</URI>
</SoftKey>
<SoftKey index="1">
< abel>Custom key 1</ abel>
<URI>http://myserver2.de/get_it.php?opt=1</URI>
</SoftKey>
<SoftKey index="2">
< abel>Custom key 2</ abel>
<URI>http://myserver2.de/get_it.php?opt=2</URI>
</SoftKey>
</TiptelIPPhoneTextScreen>