XML API Guide. Version 2.6. tiptel 31xx. tiptel

Transcription

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

2 Last changes: Table of contents 1 Abbreviations XML Services Phone initiated service Action URL - PBX Sync Programmable function key External XML phone book service External initiated service HTTP Remote Action-URL SIP NOTIFY Remote Action-URL HTTP Push XML SIP NOTIFY Push XML XML Format External URI formats URL variables Internal call control URI formats Internal URI Dial: Internal URI SendDigits: Internal device control URI formats Internal URI "Key:" Internal URI "Led:" Internal URI "Command:" Internal URI "SoftKey:" XML objects IPPhoneExecute XML object IPPhoneConfiguration XML object IPPhoneTextMenu XML object IPPhoneTextScreen XML object IPPhoneInputScreen XML object IPPhoneDirectory XML object (Type A) IPPhoneStatus XML object IPPhoneDirectory XML object (Type B) IPPhoneText XML object IPPhoneMenu XML object External XML phone book XML Device Info Sub objects for UI XML objects Sub object "SoftKey" for XML UI objects Using the internal object "SoftKey for customizing hard keys Sub object "SoftKeyItem" for XML UI objects (Type B) Special attributes for UI XML objects Timeout LockIn triggerdestroyonexit/ destroyonexit HTTP API HTTP GET Device control URLs HTTP GET Service URLs HOW TO HOW TO push XML file via HTTP HOW TO push XML file on Asterisk via SIP NOTIFY HOW TO trigger remote action URL via HTTP...44 Page 1 / 50

3 5.4 HOW TO trigger remote action URL on Asterisk via SIP NOTIFY XML Schema, XSL Model History...46 List of tables Table 1: Customizable hard keys in object SoftKey...39 Table 2: Customizable hard keys in object SoftKeyItem Abbreviations API Application Programming Interface SIP Session Initiation Protocol UI User Interface URL Uniform Resource Locator, in this document the same as URI URI Uniform Resource Identifier RFCs 1630, 3986 XML extensible Markup Language Page 2 / 50

4 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) User 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 Action URL - PBX Sync On predefined internal phone and call events the corresponding configured Action-URLs will be triggered automatically by device. See chapter PBX Sync in Administrator Guide / Wiki to configure this kind of URLs for corresponding events Programmable function key Any Action-URL 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 URLs for corresponding keys 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 URL 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-URL 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

5 requested contacts. Option 4) A simply Action-URL can be defined as entry point for a phone book in context of XML-Minibrowser. On the phone with the alpha keyboard the URL-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-URLs 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 HTTP Remote Action-URL The downloading of XML file can be triggered by using HTTP GET method calling remote URL on device build-in Web Server. The query string must contain the URL of XML file minibrowserurl=url The phone returns 200 OK and downloads the XML file. Example: minibrowserurl= This example will induce the phone with IP to download the XML file from Please consider that URL-Variable {ip} should be escaped in form of %7Bip%7D to be RFC conform 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

6 NOTIFY SIP/2.0 Via: SIP/2.0/UDP :5060;branch=ad5jh4ut9dsnf3jtf;rport From: To: 3030 Contact: Call-ID: 65835h8s46f2x429 CSeq: 20 NOTIFY Max-Forwards: 1 Event: tiptel-actionurl Content-Type: text/plain Content-Length: 37 This example will trigger the phone with IP-Addr and MAC-Addr. 000CC download the XML file from HTTP Push 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: POST /xmlservice HTTP/1.0 User-Agent: Wget/ Accept: */* Host: Connection: Keep-Alive Content-Type: text/xml Content-Length: 140 <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneExecute Beep="yes"> <ExecuteItem URI="Led:BACKLIGHT=on"/> </TiptelIPPhoneExecute> This example will turn the display back light on, See IPPhoneExecute object and URI Led for more details SIP NOTIFY Push XML XML data can be send directly to the phone using proprietary SIP NOTIFY event "tiptel-xml" with XML content. Example: Page 5 / 50

7 NOTIFY SIP/2.0 Via: SIP/2.0/UDP :5060;branch=ad5jh4ut9dsnf3jtf;rport From: To: 3030 Contact: Call-ID: 65835h8s46f2x429 CSeq: 20 NOTIFY Event: tiptel-xml Content-Type: application/xml Content-Length: 140 <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneExecute Beep="yes"> <ExecuteItem URI="Led:BACKLIGHT=on"/> </TiptelIPPhoneExecute> 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.0"?> <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="iso "?> If the encoding parameter is missing the default encoding is UTF-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 & " Quote " ' Apostrophe &apos; < Left angle bracket < > Right angle bracket > 2.4 External URI formats The generic syntax of en external URI is defined by RFC All external URIs must begin with a scheme name (download protocol), followed by a colon character (":"). Valid URIs witch scheme names for external resources and XML files are: Page 6 / 50

8 tftp://xxxx/yyy/file.xml ftp://xxxx/yyy/file.xml sip:xxxx tel:xxxx Please note that http URIs with query parameters in XML files must be written in escape encoding (e.g. & &) URL variables Any external URL 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 {mac} {ip} {model} {firmware} {local} or {active_url} {display_local} {active_user} {active_host} {active_key} {remote} {display_remote} {call_id} {duration} {calldirection} {filter} {search_key} Description MAC address of the phone Current IP address of the phone The phone model The firmware version of the phone The SIP URI of the default local identity or of the active outgoing identity The display name of the default local identity or of the active outgoing identity The user part of the SIP URI of the default local identity or of the active outgoing call identity The host part of the SIP URI of the default local identity or of the active outgoing identity The function key, line key or SoftKey associated with the URL directive or the call. For coding syntax see the coding of internal URL Key: The SIP URI of the remote identity (only in context of PBX sync URL) The display name of the remote identity (only in context of PBX sync URL) The call-id of the active call (only in context of PBX sync URL) The call duration in seconds (only in context of PBX sync URL) Indication of the call as sender or recipient (only in context of PBX sync URL) Search filter of remote XML phonebook Example: The pressed Key ititated URL query as alphanumeric or URL-escaped code. Example: 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

9 2.5 Internal call control URI formats Phones supports some proprietary URI schemas to allow the call control. Dial:XXXXXX initiates a new call to the specified phone number/address SendDigits:XXXXXX generates DTMF tones Internal URI Dial: The Dial URI initiates a new call. URI format: Dial:number Example: <?xml version="1.0"?> <TiptelIPPhoneExecute> <ExecuteItem URI="Dial: "/> </TiptelIPPhoneExecute> Internal URI SendDigits: The SendDigits URI 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: <?xml version="1.0"?> <TiptelIPPhoneExecute> <ExecuteItem URI="SendDigits:*8"/> </TiptelIPPhoneExecute> 2.6 Internal device control URI formats Phones supports some proprietary URI schemas to address internal phone resources and allow the device control. Page 8 / 50

10 Key:XXX emulate a key event Led:XXX control the LED state Command: XXX execute commands Internal URI "Key:" The internal proprietary URI "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 fkeynn.m linen SoftKeyN Emulate the press event of a free programmable function key on the phone device. NN is the number of function key (1-12) Emulate 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. Emulate the display selection button (line key) to the right of the display. N is the number of selection button (1-7) Emulate the soft key button below the display. N is the number of soft key button (1-4) keypadn Emulate numeric keypad button 0-9 N is the number of keypad button (0-9) Key:fkey5 Key:fkey5.0 Key:fkey5.1 Key:line2 Key:SoftKey3 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 Navigation up key Key:up down Navigation down key Key:down left Navigation left key Key:left right Navigation 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_n Alpha 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

11 Example: <?xml version="1.0"?> <TiptelIPPhoneExecute> <ExecuteItem URI="Key:fkey2"/> <ExecuteItem URI="Key:line3"/> </TiptelIPPhoneExecute> Internal URI "Led:" The internal proprietary URI "Led:" 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 fkeynn.s_ccc fkeynn.m_ccc Controls the LEDs of phone function keys NN is the number of function key (1-12) CCC is the color value. (red green amber) The specification of the module number 0 is optional. Supported since Firmware 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 value. (red green amber) The specification of the module number s is mandatory. 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 value. (red green amber) The specification of the module number is mandatory. Led:fkey5_red=fastflash Led:fkey5.0_red=fastflash Led:fkey8=off Led:fkey8.0=off Led:fkey8.0_green=off Led:fkey1.s_red=fastflash Led:fkey2.s_green=slowflash Led:fkey3.s_green=on Led:fkey3.s_red=off Led:fkey3.s=off 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: <?xml version="1.0"?> <TiptelIPPhoneExecute> <ExecuteItem URI="Led:mwi=slowflash"/> <ExecuteItem URI="Led:backlight=on"/> <ExecuteItem URI="Led:fkey2_red=on"/> <ExecuteItem URI="Led:fkey7.0_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> Page 10 / 50

12 2.6.3 Internal URI "Command:" The internal proprietary URI "Command:" allows to execute service commands. URI format: Command:XXXXXX Where XXXXXX variable is one of the following predefined commands: Command Description Example Reset Reboot Resync Reset the configuration to factory defaults and reboot The command will be executed only if there are no voice connections. Restart device. The command will be executed only if there are no voice connections. Downloads autoprovisioning files. The command will be executed only if there are no voice connections. Command:Reset Command:Reboot 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: <?xml version="1.0"?> <TiptelIPPhoneExecute> <ExecuteItem URI="Command:ClearRedialList"/> <ExecuteItem URI="Command:ClearCallersList"/> <ExecuteItem URI="Command:Reboot"/> </TiptelIPPhoneExecute> Internal URI "SoftKey:" Some user interface XML objects support predefined internal URIs. Available object commands "SoftKey:Exit " is available for all UI XML objects and redraws the previous XML object present in the phone browser. Does not appear if LockIn set to "yes". "SoftKey:Select " is available for TiptelPPhoneTextMenu only and calls the URI tag of the selected MenuItem. "SoftKey:Dial " is available 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 available in IPPhoneDirectory XML object (Type A). "SoftKey:Previous" is only available in IPPhoneDirectory XML object (Type A). Page 11 / 50

13 "SoftKey:Submit " is available for TiptelPPhoneInputScreen only and calls the URL tag. "SoftKey:Edit_and_Dial " is available 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 view. Availability of SoftKeys per object SoftKey IPPhoneTextMenu IPPhoneTextScreen IPPhoneInputScree n IPPhoneDirectory (Type A) Exit x x x x Select x Dial x x Next Previous Submit Edit_and_Dial x x x x x Custom defined x x x x SoftKey IPPhoneText IPPhoneDirectory (Type B) Exit x x Select Dial Next Previous Submit Edit_and_Dial x x x Custom defined x x Page 12 / 50

14 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) Device 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: <****IPPhoneExecute Beep = "yes/no" triggerdestroyonexit= yes/no > <ExecuteItem URI="URI"/> <ExecuteItem URI="URI" line="2"/> <!-up to 30 ExecuteItem may follow -> </****IPPhoneExecute> XML file example: <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneExecute Beep="yes/no"> <ExecuteItem URI=" <ExecuteItem URI="Dial: "/> <ExecuteItem URI="Dial:215" line="3"/> <ExecuteItem URI="Command:Resync/> </TiptelIPPhoneExecute> Used 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

15 triggerdestroyonexit optional Set = "yes" to exit the XML UI view. 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 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: <****IPPhoneTextMenu Beep = "yes/no" LockIn = "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> Note: The "****" in "****IPPhoneTextMenu" can be any string, also can be left empty.. XML file example 1: Simple menu Page 14 / 50

16 <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneTextMenu Beep = "yes" style = "numbered" Timeout="30"> <Title>Menu</Title> <MenuItem> <Prompt>Item 1</Prompt> <URI> </MenuItem> <MenuItem> <Prompt>Item 2</Prompt> <URI> </MenuItem> </TiptelIPPhoneTextMenu> XML file example 2: Phone register <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneTextMenu Beep = "yes" style = "numbered"> <Title>Phone register</title> <MenuItem> <Prompt>Tiptel.com</Prompt> <URI> <Dial> </Dial> </MenuItem> <MenuItem> <Prompt>My dentist</prompt> <URI> <Dial line= 2 > </Dial> </MenuItem> <SoftKey index="4"> <Label>Dial</Label> <URI>SoftKey:Select</URI> </SoftKey> </TiptelIPPhoneTextMenu> XML file example 3: TextMenu user selection Page 15 / 50

17 <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneTextMenu Beep = "yes" style = "numbered" defaultindex="1"> <Title>Menu</Title> <MenuItem> <Prompt>First selection</prompt> <URI> <Selection>dataToAppend_1</Selection> </MenuItem> <MenuItem> <Prompt>Second selection</prompt> <URI> <Selection>dataToAppend_2</Selection> </MenuItem> <SoftKey index="3"> <Label>Custom key</label> <URI> </SoftKey> </TiptelIPPhoneTextMenu> When the user selects item 1 and presses soft key 3, the URI requested is Notes: If a "?" already exists in the URI, 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 URI. 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) Used 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 view within the time, the phone will exit to the standby interface. Default is 45 s See section for more details. LockIn Root tag Optional See section for details. Default is "no". cancel Action Root tag Optional Defines the URI to be called when the user cancels the view. defaultindex Root tag Optional Position of the cursor when the XML object is presented. Default is 1 (valid values: 1..30) destroyonexit Root tag Optional yes indicates that the object will be removed 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 for more details. Page 16 / 50

18 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 values or not set: the phone uses the default line. Selection MenuItem body Optional Custom SoftKey with external URI SoftKey Optional See section 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 Cursor up/down Digit key 1-9, 0 Function description Move focus in list up/down Select menu item whose index value 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 is setup with an URL (see ) the above type of selection is disabled. 1-9, 0, *, # If hard keys are user defined, URI is executed. (See ) SoftKey "Dial" SoftKey "Edit_and_Dial" Dial the corresponding number in <Dial> of the selected menu item. Copies the corresponding number in <Dial> of the selected menu item into Page 17 / 50

19 Key Selection keys Cursor right SoftKey "Select" SoftKey "Exit" Cursor left Esc Ok OffHook/ Linekey/ Handfree key/ Headset offhook Function description dialing preparation view. There the user can edit the number and dial the number. Select the corresponding menu item and dial the the corresponding number in <dial>. If there is no <dial> entry call the URI. Dial the the corresponding number of the selected menu item. If there is no <Dial> entry call the URI. Call corresponding URI command of the selected menu item. Present previous displayed xml view if available. Else return to idle screen. same function as SoftKey "Exit" Return to idle screen. If 'cancelaction' is defined the URI is executed. If 'cancelaction" calls another UI XML object the previous view is kept on the stack. 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 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: <****IPPhoneTextScreen Beep = "yes/no" LockIn = "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> Note: The "****" in "****IPPhoneTextScreen" can be any string, also can be left empty.. XML file example 1: Page 18 / 50

20 <?xml version="1.0" 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"> <Label>Custom key</label> <URI> </SoftKey> </TiptelIPPhoneTextScreen> XML file example 2: user defined soft keys and hard keys <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneTextScreen Beep = "yes"> <Title>Title of screen</title> <Text>Press 0..9 to search name in all phone books.</text> <SoftKey name="0"> <URI> </SoftKey> <SoftKey name="9"> <URI> </SoftKey> <SoftKey name="#"> <URI> </SoftKey> <SoftKey name="*"> <URI> </SoftKey> <SoftKey index="1"> <Label>Custom key 1</Label> <URI> </SoftKey> <SoftKey index="2"> <Label>Custom key 2</Label> <URI> </SoftKey> </TiptelIPPhoneTextScreen> Used 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 view within the time, the phone will exit to the standby interface. Default is 45 s See section for more details. Page 19 / 50

21 XML object Position Type Description LockIn Root tag Optional See section for details. Default is "no". cancel Action Root tag Optional Defines the URI to be called when the user cancels the view. doneaction Root tag Optional Defines the URI to be called when the user acknowlegdes the view with 'Ok'-Key. destroyonexit Root tag Optional yes indicates that the object will be removed 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 for more details. Title Body Mandatory The title of text notes Text Body Mandatory The text to be displayed SoftKey Optional See section for details Default soft keys: The following default soft key will be presented if the XML file of IPPhoneTextScreen does not include any soft key description: SoftKey index Name URI 1 Exit SoftKey:Exit Key processing: Key Cursor up/down SoftKey "Exit" Esc Ok Function description Scrolling in text up/down Present previous displayed xml view if available. Else return to idle screen. Return to idle screen. If 'cancelaction' is defined the URI is executed. If 'cancelaction" calls another UI XML object the previous view is kept on the stack. Present previous displayed xml view if available. Else return to idle screen. If 'doneaction' is defined the URI is executed. If 'doneaction" calls another UI XML object the previous view is kept on the stack. 1-9, 0, *, # If hard keys are user defined, URI is executed. (See ) 3.5 IPPhoneInputScreen XML object XML file description: Page 20 / 50

22 <****IPPhoneInputScreen Beep = "yes/no" LockIn = "yes/no" Timeout = "some integer" type = "IP/string/number/timeInt/dateInt" password = "yes/no" editable = "yes/no" cancelaction = "some URI" defaultindex = "1" destroyonexit = "yes/no" > <Title>any text</title> <Prompt>any text</prompt> <URL>target receiving the input</url> <Parameter>name of param added to URL</Parameter> <Default>default value</default> <InputField type = "IP/string/number/timeInt/dateInt" password = "yes/no" editable = "yes/no" > <Prompt>local any text</prompt> <URL>local target receiving the input</url> <Parameter>local name of param added to URL</Parameter> <Default>local default value</default> <Selection>selection</Selection> <!-SoftKey items may be added --> </InputField> <!-up to 6 InputField items may be added --> <!-SoftKey items may be added --> </****IPPhoneInputScreen> XML file example: Page 21 / 50

23 <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneInputScreen Timeout="180" type="string" cancelaction=" <Title>I'm the title</title> <Prompt>Guidance</Prompt> <URL> <InputField type="string" editable="yes" > <Prompt>User</Prompt> <Parameter>User</Parameter> <Default>Default </Default> <Selection>1</Selection> </InputField> <InputField type="number" editable="yes" > <Prompt>Code</Prompt> <Parameter>Code</Parameter> <Default></Default> <Selection>2</Selection> </InputField> <InputField type="timeint" editable="yes" > <Prompt>input 3</Prompt> <Parameter>time</Parameter> <Default>12:34</Default> <Selection>3</Selection> </InputField> <InputField type="dateint" editable="yes" > <Prompt>input 4</Prompt> <Parameter>date</Parameter> <Default> </Default> <Selection>4</Selection> </InputField> </TiptelIPPhoneInputScreen> Note: In this example, when the user presses "Ok" or "SoftKey:Submit" on the phone after entering "frank" for user and "2222" for code, the phone will call the following URLs: if the "Ok" key is pressed while editing the "User" field, if the "Ok" key is pressed while editing the "Code" field. Used XML objects: XML object Position Type Description TiptelIPPhoneInputS creen Root tag Mandatory Root element Beep Root tag Optional Set = "yes" to generate a notification beep by phone. Default is "no" type Root tag Mandatory Specifies the type of input. Posible values are: "IP", "string", "number", "timeint" and "dateint" Default is "string" The type number includes integers plus * and # password Root tag Optional Specifies if the input is masked by '*' characters. Default is "no" editable Root tag Optional Specifies if the user is allowed to modify the input. Default is "no" Page 22 / 50

24 XML object Position Type Description Timeout Root tag Optional If there are no operations from users after entering into the view within the time, the phone will exit to the standby interface. Default is 45 s See section for more details. LockIn Root tag Optional See section for details. Default is "no". Cancel Action Root tag Optional Defines the URI to be called when the user cancels the view. defaultindex Root tag Optional Default is 1 (valid values: 1..6) destroyonexit Root tag Optional yes indicates that the object will be removed 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 for more details. Title Body Mandatory The title of text notes Prompt Body Optional The text to be displayed. Value is used as default for each input field URL Body Mandatory URI is called when user completes the input with "Ok" or "SoftKey:Submit". Parameter Body Optional The parameter name following the URL, i.e. URL? Parameter setting name=user input contents Value is used as default for each input field Default Body Optional The default input content. Value is used as default for each input field SoftKey InputField tag Optional See section for details Inputfield Body Mandatory Up to 6 items type InputField tag Mandatory Specifies the type of input. Posible values are: "IP", "string", "number", "timeint" and "dateint" Default is "string" Overrides the value set in the root tag. password InputField tag Optional Specifies if the input is masked by '*' characters. Default is "no" editable InputField tag Optional Specifies if the user is allowed to modify the input. Default is "no" Prompt InputField tag Optional The text to be displayed. Value is used as default for each input field Parameter InputField tag Optional The parameter name following the URL, i.e. URL? Parameter setting name=user input contents Default InputField tag Optional The default input content. Selection InputField tag Optional Add selection=preset parameter after http address when sending request if the SoftKey URI is the server s http address. e.g. SoftKey InputField tag Optional See section for details Default soft keys: Page 23 / 50

25 The following default soft keys will be presented if the XML file of IPPhoneInputScreen does not include any soft ley description: Note: the name varies according the default language of the phone Default soft keys: type = IP SoftKey index Name URI 1 Exit SoftKey:Exit 2. SoftKey:Dot 3 <-- SoftKey:BackSpace 4 Ok SoftKey:Submit Default soft keys:type = number SoftKey index Name URI 1 Exit SoftKey:Exit 3 <-- SoftKey:BackSpace 4 Ok SoftKey:Submit Default soft keys:type = string SoftKey index Name URI 1 Exit SoftKey:Exit 2 2ab, 123,... SoftKey:ChangeMode (no function on phone with alpha keyboard) 3 <-- SoftKey:BackSpace 4 Ok SoftKey:Submit 5. SoftKey:Dot 6 space SoftKey:NextSpace Default soft keys: type = time, date SoftKey index Name URI 1 Exit SoftKey:Exit 4 Ok SoftKey:Submit Key processing: Key Cursor up/down "SoftKey:Exit" Esc Ok, "SoftKey:Submit" Function description Scrolling in text up/down Present previous displayed xml view if available. Else return to idle screen. Return to idle screen. If 'cancelaction' is defined the URI is executed. If 'cancelaction" calls another UI XML object the previous view is kept on the stack. If LockIn is set "no", the function of the"ok" key is the same as "SoftKey:Submit". If it is "yes", there will be no response Page 24 / 50

26 Key Digit key 1-9, 0 Alpha key, +, - Backspace, "SoftKey:BackSpace" Space, "SoftKey:NextSpace" "SoftKey:Dot" "SoftKey:Colon" "SoftKey:ChangeMode" Function description If input field is selected Add "." at the cursor s position on the focused-on item. Add ":" at the cursor s position on the focused-on item. Change of keyset depending on type of input field. (no function on phone with alpha keyboard) 3.6 IPPhoneDirectory XML object (Type A) The IPPhoneDirectory XML object can be used to display a simple phone register. Since the term IPPhoneDirectory is used in several XML objects the phone auto detects the correct application. XML file description: <****IPPhoneDirectory Beep = "yes/no" LockIn = "yes/no" style = "numbered/none" Next = " Previous = " Timeout = "some integer" cancelaction = "some URI" destroyonexit = "yes/no" > <Title>any text"</title> <MenuItem> <Prompt>Contact Name</Prompt> <URI>number</URI> </MenuItem> <!-Additional menu items may be added - -> <!-SoftKey items may be added - -> </****IPPhoneDirectory> Note: The "****" in "****IPPhoneDirectory" can be any string, also can be left empty.. XML file example: Page 25 / 50

27 <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneDirectory Next = " Previous = " > <Title>Title of directory"</title> <MenuItem> <Prompt>Tiptel.com</Prompt> <URI> </URI> </MenuItem> <SoftKey index="1"> <Label>Exit</Label> <URI>SoftKey:Exit</URI> </SoftKey> <SoftKey index="2"> <Label>Previous</Label> <URI>SoftKey:Previous</URI> </SoftKey> <SoftKey index="3"> <Label>Next</Label> <URI>SoftKey:Next</URI> </SoftKey> <SoftKey index="4"> <Label>Dial</Label> <URI>SoftKey:Dial</URI> </SoftKey> <SoftKey index="8"> <Label>plus</Label> <URI>SoftKey:Edit_and_Dial</URI> </SoftKey> </TiptelIPPhoneDirectory> Used XML objects: XML object Position Type Description TiptelIPPhoneDirecto ry Root tag Mandatory Root element Beep Root tag Optional Set = "yes" to generate a notification beep by phone. Default is "no" style Root tag Optional "numbered" or "none" indicate the style of the menu. Default is "numbered" Next Root tag Optional The corresponding URI of SoftKey "Next" Previous Root tag Optional The corresponding URI of SoftKey "Previous" Timeout Root tag Optional If there are no operations from users after entering into the view within the time, the phone will exit to the standby interface. Default is 45 s See section for more details. LockIn Root tag Optional See section for details. Default is "no". Cancel Action Root tag Optional Defines the URI to be called when the user cancels the view. destroyonexit Root tag Optional yes indicates that the object will be removed from the XML browser stack after exit. If not specified or set no the object is kept in the XML browser after exit. Page 26 / 50

28 XML object Position Type Description See section for more details. Title Body Mandatory The title of text notes MenuItem Body Mandatory Up to 15 items Prompt MenuItem Body Mandatory The text to be displayed URI MenuItem Body Mandatory Phone number or IP-Address to be dialed SoftKey Optional See section for details 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 IPPhoneDirectory does not include any soft key description: SoftKey index Name URI 1 Exit SoftKey:Exit 2 Previous The URI specified by "Previous" in the root tag of the XML -object IPPhoneDirectory 3 Next The URI specified by "Next" in the root tag of the XML -object IPPhoneDirectory 4 Dial SoftKey:Dial 8 plus SoftKey:Edit_and_Dial Key processing: Key Cursor up/down Digit key 1-9, 0 Function description Move focus in list up/down Select menu item whose index value equals to number's key press and dial the the corresponding number. Note: if any hard key is setup with an URL (see ) the above type of selection is disabled. 1-9, 0, *, # If hard keys are user defined, URI is executed. (See ) SoftKey "Dial" SoftKey "Edit_and_Dial" Selection keys SoftKey "Previous", SoftKey "Next" SoftKey "Exit" Cursor left Esc Dial the corresponding number of the selected menu item. Copies the corresponding number of the selected menu item into dialing preparation view. There the user can edit the number and dial the number. same function as SoftKey "Dial" Call the URI command in "Previous"/ "Next" Present previous displayed xml view if available. Else return to idle screen. same function as SoftKey "Exit" Return to idle screen. If 'cancelaction' is defined the URI is executed. If 'cancelaction" calls another UI XML object the previous view is kept on the stack. Page 27 / 50

29 Key Ok OffHook/ Linekey/ Handfree key/ Headset offhook Function description If LockIn is set "no", the function of the "OK" key will be the same as SoftKey "Dial", if it is "yes", there will be no response 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.7 IPPhoneStatus XML object The IPPhoneStatus XML object can be used to display messages via Push XML. There are two output modes: Presentation in a tree view in full screen mode Presentation in status area on idle screen XML file description: <****IPPhoneStatus Beep = "yes/no" Embedded = "yes/no" triggerdestroyonexit = "yes/no" > <Session>Any Session ID</Session> <Message index="index" type="alert" Timeout="timeout in s" >Message text </Message> <!-Up to 10 message items may be added - -> </****IPPhoneStatus> Note: The "****" in "****IPPhoneStatus" can be any string, also can be left empty.. XML file example: Full screen presentation of all messages in a scrollable tree view. <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneStatus Beep="yes"> <Message index="0">i'm the message text</message> <Message index="4" type="alert" Timeout="60">this is message 4 </Message> </TiptelIPPhoneStatus> XML file example: Removing message with index 0 <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneStatus Beep="yes"> <Message index="0"></message> </TiptelIPPhoneStatus> XML file example: presentation of maximum one message in status area on idle screen Page 28 / 50

30 If the message does not fit to the output area the full message can be seen after pressing soft key Messages 1 in the full screen presentation. Used XML objects: <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneStatus Beep="yes" Embedded="yes"> <Message index="0">this message is presented\non the idle screen</message> </Message> </TiptelIPPhoneStatus> XML object Position Type Description TiptelIPPhoneStatus Root tag Mandatory Root element Beep Root tag Optional Set = "yes" to generate a notification beep by phone. Default is "no" Embedded Root tag Optional Set = "yes" to present message index= 0 on idle screen. Default is "no" Messages with other indexes will not be presented on idle screen! triggerdestroyonexit Root tag Optional If this XML object is sent with triggerdestroyonexit = yes while an UI XML object with an attribute destroyonexit = yes is visible the UI XML object is triggered to exit. If no other UI XML object is on the stack which has to be presented the IPPhoneStatus XML object is presented. See section for more details. Session Body Optional Session Id can be any string. Session ID used to identify the application displaying message. It allows message change and message reset. Message Body Mandatory Message to be displayed or empty to reset the message. Up to 10 items index Message Body Mandatory Index of the message for the session, the index starts at 0. type Message Body Optional Type of message, only "alert" is supported. If not specified the message stays on the screen until it is reset by an empty message or exiting the screen with SoftKey:Exit Timeout Message Body Optional Timeout of the "alert" message, overrides the 3s default value. Default soft keys: The following soft keys will be presented: SoftKey index Name URI 1 Exit SoftKey:Exit Returns to the standard idle screen. Key processing: 1 Labelling of soft key according current language setting. Page 29 / 50

31 Key Cursor up/down SoftKey "Exit", Esc, Ok Function description Scrolling in text messages up/down Returns to standard idle screen. The internal list of messages is not removed and will be shown again if any content of the list is changed. 3.8 IPPhoneDirectory XML object (Type B) The IPPhoneDirectory XML object can be used to display a simple phone register. Since the term IPPhoneDirectory is used in several XML objects the phone auto detects the correct application. This XML object is supported since Firmware XML file description: <****IPPhoneDirectory track = "yes/no" > <Title>any text"</title> <DirectoryEntry> <Name>Contact Name</Name> <Telephone>number</Telephone> </DirectoryEntry> <!-Additional directory entries may be added - -> <!-SoftKeyItem items may be added - -> </****IPPhoneDirectory> Note: The "****" in "****IPPhoneDirectory" can be any string, also can be left empty.. XML file example: Page 30 / 50

32 <?xml version="1.0" encoding="utf-8"?> <IPPhoneDirectory> <Title>Title of directory"</title> <DirectoryEntry> <Name>Tiptel.com</Name> <Telephone> </Telephone> </DirectoryEntry> <DirectoryEntry> <Name>Police</Name> <Telephone>110</Telephone> </DirectoryEntry> <SoftKeyItem> <Name>F1</Name> <Label>exit</Label> <URL>SoftKey:Exit</URL> </SoftKeyItem> <SoftKeyItem> <Name>1</Name> <Label>exit</Label> <URL> </SoftKeyItem> </IPPhoneDirectory> Used XML objects: XML object Position Type Description IPPhoneDirectory Root tag Mandatory Root element track Root tag Optional no indicates that the object will be removed from the XML browser stack after exit. If not specified or set yes the object is kept in the XML browser after exit. Title Body Mandatory The title of text notes DirectoryEntry Body Mandatory Up to 500 items Name DirectoryEntry Body Mandatory The text to be displayed Telephone DirectoryEntry Body Mandatory Phone number to be dialed SoftKeyItem Optional See section for details Name SoftKeyItem Body Mandatory Addresses the SoftKey or Hardkey Label SoftKeyItem Body Mandatory Text of SoftKeyItem URL SoftKeyItem Body Mandatory Internal or external URL describing the action to be executed Default soft keys: The following default soft keys will be presented if the XML file of IPPhoneDirectory does not include any SoftKeyItem description: SoftKey index Name URI 1 Exit SoftKey:Exit 3 plus SoftKey:Edit_and_Dial Page 31 / 50

33 SoftKey index Name URI 4 Dial SoftKey:Dial Key processing: Key Cursor up/down Digit key 1-9, 0 Function description Move focus in list up/down Select menu item whose index value equals to number's key press and dial the the corresponding number. Note: if any hard key is setup with an URL (see ) the above type of selection is disabled. 1-9, 0, *, # If hard keys are user defined, URI is executed. (See ) SoftKey "Dial" SoftKey "Edit_and_Dial" Selection keys SoftKey "Exit" Cursor left Esc Ok OffHook/ Linekey/ Handfree key/ Headset offhook Dial the corresponding number of the selected menu item. Copies the corresponding number of the selected menu item into dialing preparation view. There the user can edit the number and dial the number. same function as SoftKey "Dial" Present previous displayed xml view if available. Else return to idle screen. same function as SoftKey "Exit" Return to previous or idle screen. Dial the corresponding number of the selected menu item. Dial the corresponding number of the selected menu item. 3.9 IPPhoneText XML object The IPPhoneText XML object can be used to display a non-formatted text in a scrollable window. This XML object is supported since Firmware XML file description: <****IPPhoneText track = "yes/no"> <Title>any text</title> <Text>any text</text> <!-SoftKeyItem items may be added --> </****IPPhoneText> Note: The "****" in "****IPPhoneText" can be any string, also can be left empty.. XML file example: user defined soft keys and hard keys Page 32 / 50

34 <?xml version="1.0" encoding="utf-8"?> <IPPhoneText> <Title>Title of screen</title> <Text>Press *, # to search name in all phone books.</text> <SoftKeyItem> <Name>#</Name> <URL> </SoftKeyItem> <SoftKeyItem> <Name>*</Name> <URL> </SoftKeyItem> <SoftKeyItem> <Name>F1</Name> <Label>Softkey 1</Label> <URL> </SoftKeyItem> <SoftKeyItem> <Name>F2</Name> <Label>Softkey 2</Label> <URL> </SoftKeyItem> </IPPhoneText> Used XML objects XML object Position Type Description TiptelIPPhoneText Root tag Mandatory Root element track Root tag Optional no indicates that the object will be removed from the XML browser stack after exit. If not specified or set yes the object is kept in the XML browser after exit. Title Body Mandatory The title of text notes Text Body Mandatory The text to be displayed SoftKeyItem Optional See section for details Default soft keys: The following default soft key will be presented if the XML file of IPPhoneTextScreen does not include any soft key description: SoftKey index Name URI 1 Exit SoftKey:Exit Key processing: Key Cursor up/down SoftKey "Exit" Function description Scrolling in text up/down Present previous displayed XML view if available. Else return to idle screen. Page 33 / 50

35 Key Esc Ok Function description Return to idle screen. Present previous displayed XML view if available. Else return to idle screen. 1-9, 0, *, # If hard keys are user defined, URI is executed. (See ) 3.10 IPPhoneMenu XML object The IPPhoneMenu XML object can be used to display a non-formatted menu in a scrollable window. This XML object is supported since Firmware XML file description: <****IPPhoneMenu track = "yes/no"> <Title>any text</title> <MenuItem> <Name>name of menu item</name> <URL>to be called</url> </MenuItem> <!-SoftKeyItem items may be added --> </****IPPhoneMenu> Note: The "****" in "****IPPhoneMenu" can be any string, also can be left empty.. XML file example: <?xml version="1.0" encoding="utf-8"?> <IPPhoneMenu> <Title>Title of screen</title> <MenuItem> <Name>first menu item</name> <URL> </MenuItem> <MenuItem> <Name>second menu item</name> <URL> </MenuItem> </IPPhoneMenu> Used XML objects XML object Position Type Description TiptelIPPhoneMenu Root tag Mandatory Root element track Root tag Optional no indicates that the object will be removed from the XML browser stack after exit. Page 34 / 50

36 XML object Position Type Description Title Body Mandatory The title of text notes MenuItem Body Mandatory The text to be displayed Name MenuItem body Mandatory Text of menu item If not specified or set yes the object is kept in the XML browser after exit. URL MenuItem body Optional Internal or external URL describing the action to be executed Keys to start the action: OK/ Cursor right SoftKeyItem Optional See section for details Default soft keys: The following default soft keys will be presented if the XML file of IPPhoneMenu does not include any soft key description: SoftKey index Name URI 1 Exit SoftKey:Exit 4 Select SoftKey:Select Key processing: Key Cursor up/down SoftKey "Exit" Esc SoftKey "Select" Ok Function description Scrolling in text up/down Present previous displayed XML view if available. Else return to idle screen. Return to idle screen. Call corresponding URI command of the selected menu item. Present previous displayed XML view if available. Else return to idle screen. 1-9, 0, *, # If hard keys are user defined, URI is executed. (See ) 3.11 External XML phone book The phone provides a build-in service to merge an external XML phone book in to internal phone book. For historical compatibility reasons the XML notation reuses the root element ***IPPhoneDirectory. XML file description: Page 35 / 50

37 <****IPPhoneDirectory> <DirectoryEntry> <Name>The name of the entry</name> <Telephone>The telephone number</telephone> <Telephone>Optional 2. telephone number</telephone> <Telephone>Optional 3. telephone number</telephone> </DirectoryEntry> <!-up to 1000 DirectoryEntries may follow -> </***IPPhoneDirectory> XML file example: <?xml version="1.0" encoding="utf-8"?> <PbookIPPhoneDirectory> <DirectoryEntry> <Name>Bob</Name> <Telephone> </Telephone> </DirectoryEntry> <DirectoryEntry> <Name>Alice</Name> </DirectoryEntry> </PbookIPPhoneDirectory> Used XML objects XML object Type Description PbookIPPhoneDirectory mandatory The root element DirectoryEntry optional Directory item (up to 30 instances) Name mandatory Label of the entry (max. 32 UTF8 chars) Telephone mandatory Phone number or SIP address to be dialed (max. 126 Bytes) 3.12 XML Device Info The phone provides device information in a XML file on request with HTTP GET Service URL "device info". XML file description: <TiptelIPPhoneDeviceInfo> <Firmware>Firmware Version X.Y.Z</Firmware> <Vendor>Tiptel</Vendor> <Device>Model abeviation</device> <MAC>MAC-Address</MAC> <SipUser1>SIP User name</sipuser1> </TiptelIPPhoneDeviceInfo> Page 36 / 50

38 XML file example: <?xml version="1.0" encoding="utf-8"?> <TiptelIPPhoneDeviceInfo> <Firmware>2.0.0</Firmware> <Vendor>Tiptel</Vendor> <Device>t3130</Device> <MAC>000CC </MAC> <SipUser1>201</SipUser1> </TiptelIPPhoneDeviceInfo> Used XML objects XML object Type Description TiptelIPPhoneDeviceInfo mandatory The root element Firmware mandatory Firmware Version Major.Minor.Revisioin Vendor mandatory Vendor string Tiptel or OEM-String Device mandatory Model string MAC mandatory MAC Address SipUser1 optional SIP Account 1, user name 3.13 Sub objects for UI XML objects Sub object "SoftKey" for XML UI objects The SoftKey object can be used to override the default soft keys in some user interface (UI) XML objects: IPPhoneTextMenu (3.3) IPPhoneTextScreen (3.4) IPPhoneInputScreen (3.5) IPPhoneDirectory (Type A) (3.6) It allows developers to link arbitrary URIs to keys in the XML screens and invoke soft key behavior native to each XML screen type. The phone has two layers with four soft keys. The user can toggle the soft key layer with the lowermost select key on the right side of the display if an arrow is shown right of the forth soft key.. Notes: custom soft keys are only available for the UI XML objects. if you use custom soft keys, the default soft keys of the XML object are not displayed anymore. This means they have to be recreated as custom soft eys. The texts/labels of internal soft keys change if the language of the user interface changes. Predefined internal URIs are listed in The soft key object is also used for custumizing a selection of hard keys. See section for details. XML file description: Page 37 / 50

39 <SoftKey index = "1-8" name="key"> <Label>text</Label> <URI>any uri</uri> </SoftKey> Used XML objects XML object Position Type Description SoftKey Body Optional index SoftKey root tag Optional Indicates the SoftKey number valid values: 1-8 If "index" is skipped then the defined SoftKeys get indexes automatically starting at index 1. name SoftKey root tag Optional Indicates setting up a hard key. See section for details. If the attribute name is not set a regular soft key is assumed. Label SoftKey Body Mandatory if index is set Text of SoftKey URI SoftKey Body Mandatory Soft key: Internal URI (2.6.4) or external URI describing the action to be executed Hard key: External URI describing the action to be executed Using the internal object "SoftKey for customizing hard keys For some applications there is the need to call URLs by pressing the keys 0-9, '#', '*' or others. This feature is available in the following objects: IPPhoneTextMenu (3.3) IPPhoneTextScreen (3.4) IPPhoneInputScreen (3.5) IPPhoneDirectory (Type A) (3.6) XML file description: <SoftKey name = "key"> <URI>any external uri</uri> </SoftKey> Used XML objects XML object Position Type Description SoftKey Body Optional Page 38 / 50

40 XML object Position Type Description name SoftKey root tag Optional Indicates setting up a hard key. The supported hard keys are listed in Table 1: Customizable hard keys in object SoftKey URI SoftKey Body Mandatory External URI describing the action to be executed An example can be found in 3.4 Since Firmware Since Firmware , 1,..., 9, #, * 0, 1,..., 9, #, * Table 1: Customizable hard keys in object SoftKey UP DOWN LEFT RIGHT OK ESC DEL MENU DIRECTORY NEWDIRECTORY REDIAL MUTE SPEAKER RKEY VOL_UP VOL_DOWN Sub object "SoftKeyItem" for XML UI objects (Type B) The SoftKeyItem object can be used to override the default soft keys in user interface (UI) XML objects IPPhoneText (3.9), IPPhoneDirectory (3.8) and IPPhoneMenu (3.10). It allows developers to link arbitrary URIs to keys in the XML screens and invoke soft key behavior native to each XML screen type. The phone has two layers with four soft keys. The user can toggle the soft key layer with the lowermost select key on the right side of the display if an arrow is shown right of the forth soft key.. Notes: custom SoftKeyItems are only available for the above mentioned UI XML objects. if you use custom SoftKeyItems, the default SoftKeyItems of the XML object are not displayed anymore. This means they have to be recreated as custom SoftKeyItems. The texts of internal SoftKeyItems change if the language of the user interface changes. Predefined internal URIs are listed in The SoftKeyItem object is also used for customizing a selection of hard keys. XML file description: Page 39 / 50

41 <SoftKeyItem> <Name>addresses the soft key or hard key</name> <Label>text</Label> <URI>any internal or external uri</uri> </SoftKeyItem> Used XML objects XML object Position Type Description SoftKeyItem Body Optional Name SoftKeyItem root tag Mandatory Adresses the key: Soft keys (first layer) F1..F4 Soft keys (second layer) F5..F8 The supported hard keys are listed in Table 2: Customizable hard keys in object SoftKeyItem Label SoftKeyItem Body Mandatory Text of SoftKeyItem URI SoftKeyItem Body Mandatory Soft key: Internal URI (2.6.4) or external URI describing the action to be executed Hard key: External URI describing the action to be executed Since Firmware Since Firmware , 1,..., 9, #, * 0, 1,..., 9, #, * Table 2: Customizable hard keys in object SoftKeyItem UP DOWN LEFT RIGHT OK ESC DEL MENU DIRECTORY NEWDIRECTORY REDIAL MUTE SPEAKER RKEY VOL_UP VOL_DOWN 3.14 Special attributes for UI XML objects Timeout The Timeout attribute is an optional root tag attribute for all of the current UI XML objects. When the phone receives an XML object with this attribute set it will override the default 45 seconds timeout specified for custom Page 40 / 50

42 applications. Setting Timeout to "0" will disable the timeout feature. This timeout is reset by button presses LockIn The LockIn attribute is an optional root tag attribute for all of the current UI XML objects. This attribute allows the XML designer to specify that a screen can not be cancelled. When a phone receives an UI XML object with the attribute set to "yes" it ignores all events that would cause the screen to exit without using the keys defined by the object. Default is "no". Setting LockIn will disable the default timeout feature (45 seconds) unless the Timeout attribute is also set in the root tag. Note: An incoming call still cancels the "locked" screen triggerdestroyonexit/ destroyonexit The triggerdestroyonexit is an optional root tag attribute for IPPhoneExecute. Its default value is no. By default, if a UI XML object receives a non-ui XML object as an answer to an exit URI or URL the UI XML object is not destroyed and stays on the phone display even its destroyonexit tag is set to yes. By setting triggerdestroyonexit to yes the previous UI XML object is removed if its destroyonexit tag is set to yes. Page 41 / 50

43 4 HTTP API 4.1 HTTP GET Device control URLs Action URL Make call Drop activ call Reboot Make screenshot /cgi-bin/remote/devctl?minibrowserurl=<url> /cgi-bin/remote/devctl?makecall=<number>&line=<id> /cgi-bin/remote/devctl?drop /cgi-bin/remote/devctl?reboot /cgi-bin/remote/devctl?screenshot Example: Make call using browser URL to Number 110 using SIP-Account HTTP GET Service URLs Device Info (FW or later) SIP Trace File Wireshark network traffic trace Syslog trace Significant device events log files Startup log file Download screenshots /service/devinfo.xml?cgiserviceapi=xmldeviceinfo /cgi-bin/webcgi/sip.txt?cgiserviceapi=siptrace /cgi-bin/webcgi/net.pcap?cgiserviceapi=pcap /cgi-bin/webcgi/trace.tar?cgiserviceapi=syslog /cgi-bin/webcgi/devlogs.tar?cgiserviceapi=phonelog /cgi-bin/webcgi/boot.txt.gz?cgiserviceapi=bootlog /cgi-bin/webcgi/screenshots.tar?cgiserviceapi=screenshots Page 42 / 50

44 5 HOW TO 5.1 HOW TO push XML file via HTTP Phone IP: XML file to push:./push.xml" #!/bin/sh postfile="./push.xml" response="./result.htm" pushurl=" addhdr="content-type: text/xml" usr=admin pw=admin wget - user $usr -password $pw -O ${response} --header "${addhdr}" --post-file ${postfile} $pushurl 5.2 HOW TO push XML file on Asterisk via SIP NOTIFY Add to the Asterisk configuration file /etc/asterisk/sip_notify.cfg the XML event. [tiptel-xmlexec-reboot] Event=>tiptel-xml Content-type=>application/xml Content=><?xml version="1.0" encoding="utf-8"?> Content=><TiptelIPPhoneExecute Beep="yes"> Content=><ExecuteItem URI="Command:Reboot"/> Content=></TiptelIPPhoneExecute> Content=> To send the XML data to phone address 2011 enter on CLI *CLI> sip notify tiptel-xmlexec-reboot 2011 Note: You must reload the configuration file for the changes to take effect if Asterisk is already running *CLI> config reload /etc/asterisk/sip_notify.conf Page 43 / 50

45 5.3 HOW TO trigger remote action URL via HTTP Phone IP: HTTP Server IP: #!/bin/sh response="./result.htm" aurl=" phoneurl=" usr=admin pw=admin wget - user $usr -password $pw -O ${response} $phoneurl Note: Although the URL Variable {ip} use brace notation wget will convert it to proper hex codes before send to device. 5.4 HOW TO trigger remote action URL on Asterisk via SIP NOTIFY Add to the Asterisk configuration file /etc/asterisk/sip_notify.cfg the XML event. [tiptel-xmlremote] Event=>tiptel-actionurl Content-type=>text/plain Content=> Content=> To trigger the XML service on device 5566 enter on CLI *CLI> sip notify tiptel-xmlremote 5566 Page 44 / 50

46 6 XML Schema, XSL Model <?xml version="1.0" encoding="iso "?> <xs:schema xmlns:xs=" <xs:simpletype name="textattributeyesno"> <xs:restriction base="xs:string"> <xs:pattern value="yes no" /> </xs:restriction> </xs:simpletype> <xs:simpletype name="texturi"> <xs:restriction base="xs:string"> <xs:maxlength value="510"/> <xs:minlength value="1"/> </xs:restriction> </xs:simpletype> <xs:simpletype name="textphonenr"> <xs:restriction base="xs:string"> <xs:maxlength value="126"/> <xs:minlength value="1"/> </xs:restriction> </xs:simpletype> <xs:element name="tiptelipphoneexecute"> <xs:complextype> <xs:sequence> <xs:element name="executeitem" minoccurs="0" maxoccurs="30"> <xs:complextype> <xs:attribute name="uri" type="texturi" /> </xs:complextype> </xs:element> </xs:sequence> <xs:attribute name="beep" type="textattributeyesno" default="no" /> </xs:complextype> </xs:element> <xs:element name="pbookipphonedirectory"> <xs:complextype> <xs:sequence> <xs:element name="directoryentry" minoccurs="0" maxoccurs="1000"> <xs:complextype> <xs:sequence> <xs:element name="name" minoccurs="1"> <xs:simpletype> <xs:restriction base="xs:string"> <xs:maxlength value="32"/> <xs:minlength value="1"/> </xs:restriction> </xs:simpletype> </xs:element> <xs:element name="telephone" type="textphonenr" minoccurs="1" maxoccurs="3" /> </xs:sequence> </xs:complextype> </xs:element> </xs:sequence> </xs:complextype> </xs:element> Page 45 / 50

47 </xs:schema> 7 History Doc Version Date Firmwar e Chapter Changes type 'number' includes 0-9, '*', '#' Writing corrected: Softkey:BackSpace, Softkey:NextSpace, Softkey:ChangeMode, Make screenshot using HTTP GET Device control URL Optional attribute line for Execute URI IPPhoneStatus: presentation of (maximum one) message on idle screen added Comments and example modified , 3.3, 3.4, 3.6, 3.5, Several XML UI objects: added attribute destroyonexit IPPhoneExecute: added attribute triggerdestroyonexit IPPhoneStatus:added attribute triggerdestroyonexit New internal URI Command:Resync for XML Execute object , 3.6 SoftKey Edit_and_Dial added in IPPhoneTextMenu and IPPhoneDirectory IPPhoneTextMenu: Optional SIP line selection for dialing added , 3.3, 3.4, 3.6, , 4.2 XmlDeviceInfo Service URL Runtime URL-Variable {filter} added , 3.9, Hard keys 0-9, *. # can be setup with URLs. IPPhoneTextMenu, IPPhoneDirectory, IPPhoneTextScreen New: IPPhoneText and IPPhoneDirectory (Type B) , 3.9 Default soft keys added: IPPhoneText and IPPhoneDirectory (Type B) External phone book services , Runtime URL-Variable {search_key} added New: internal LED URIs Led:mute= and Led:speaker= any 2.4 Corrections >= New: internal LED URIs for selection keys >= , >= Corrections >= New: IPPhoneMenu Customization of hard keys enhanced for user interface (UI) XML objects. Page 46 / 50

48 Page 47 / 50

49 Tiptel.com GmbH Business Solutions Halskestraße 1 D Ratingen Tel.: * Vanity Tel.: Internet: International: Internet: TIPTEL* Tiptel GmbH Ricoweg 30/B1 A Wiener Neudorf Tel.: 02236/ Fax: 02236/ [email protected] Internet: Tiptel AG Bahnstrasse 46 CH Regensdorf Tel.: Fax: [email protected] Internet: Tiptel B.V. Camerastraat 2 NL 1322 BC Almere Telefoon: Fax: [email protected] Internet: Tiptel NV Leuvensesteenweg 510 bus 4 B 1930 Zaventem Telefoon: (1,12 Euro / min.) Fax: [email protected] Internet: *(1,49 Euro/Min. aus dem Festnetz der Deutschen Telekom, abweichende Mobilfunkpreise möglich) Tiptel sarl 23, avenue René Duguay-Trouin F Voisins-Le-Bretonneux Tél. : 01 / Fax : 01 / [email protected] (en) 12/2014 Internet : Page 48 / 50