manualshive.com logo in svg

TIPTEL 31xx series, Manual

Share
Download
TIPTEL 31xx series Manual Download Page 15

XML API for Tiptel.com SIP Phones 31xx

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 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"

    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

>

Summary of Contents for 31xx series

Page 1: ...XML API Guide en Version 2 6 tiptel 31xx tiptel...

Page 2: ...3 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 IPPhon...

Page 3: ...able 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 UI User...

Page 4: ...ync in Administrator Guide Wiki to configure this kind of URLs for corresponding events 2 1 2 Programmable function key Any Action URL can be triggered manually by hitting a function key configured ac...

Page 5: ...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 URL on device build in Web Server http phoneip cgi...

Page 6: ...phone using proprietary SIP NOTIFY event tiptel xml with XML content Example Page 5 50 POST xmlservice HTTP 1 0 User Agent Wget 1 11 4 Accept Host 192 168 1 20 Connection Keep Alive Content Type text...

Page 7: ...ote quot Apostrophe apos Left angle bracket lt Right angle bracket gt 2 4 External URI formats The generic syntax of en external URI is defined by RFC 3986 All external URIs must begin with a scheme n...

Page 8: ...SIP URI of the default local identity or of the active outgoing identity active_key The function key line key or SoftKey associated with the URL directive or the call For coding syntax see the coding...

Page 9: ...Digits 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...

Page 10: ...ton 1 7 Key line2 SoftKeyN Emulate the soft key button below the display N is the number of soft key button 1 4 Key SoftKey3 keypadN Emulate numeric keypad button 0 9 N is the number of keypad button...

Page 11: ...d 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 va...

Page 12: ...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...

Page 13: ...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...

Page 14: ...e device executes commands without promoting the user XML file description XML file example Used XML objects XML object Type Description TiptelIPPhoneExecute mandatory The root element Beep optional S...

Page 15: ...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 forma...

Page 16: ...RI Dial 004921024280 Dial MenuItem MenuItem Prompt My dentist Prompt URI http server info_about_dentist xml URI Dial line 2 00800123412341234 Dial MenuItem SoftKey index 4 Label Dial Label URI SoftKey...

Page 17: ...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 3 14 1 for more details LockIn Root tag Optional See sec...

Page 18: ...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 Defa...

Page 19: ...URI is executed If cancelAction calls another UI XML object the previous view 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 the...

Page 20: ...reen Title Text Text of screen nthis was a manually set newline Text SoftKey index 3 Label Custom key Label URI http myserver2 de get_it php URI SoftKey TiptelIPPhoneTextScreen xml version 1 0 encodin...

Page 21: ...See section 3 13 1 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...

Page 22: ...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...

Page 23: ...er 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 De...

Page 24: ...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 Input...

Page 25: ...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 Soft...

Page 26: ...rectory 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 Not...

Page 27: ...14 2 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...

Page 28: ...ectory 4 Dial SoftKey Dial 8 plus SoftKey Edit_and_Dial Key processing Key Function description Cursor up down Move focus in list up down Digit key 1 9 0 Select menu item whose index value equals to n...

Page 29: ...n 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 file example Removing message with index 0 XML file exa...

Page 30: ...section 3 14 3 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 Bo...

Page 31: ...n 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 2...

Page 32: ...ses 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 follo...

Page 33: ...edit the number and dial the number Selection keys same function as SoftKey Dial SoftKey Exit Present previous displayed xml view if available Else return to idle screen Cursor left same function as S...

Page 34: ...tScreen does not include any soft key description SoftKey index Name URI 1 Exit SoftKey Exit Key processing Key Function description Cursor up down Scrolling in text up down SoftKey Exit Present previ...

Page 35: ...can be left empty XML file example 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...

Page 36: ...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 Scrolling in text up down SoftKey Ex...

Page 37: ...UTF 8 PbookIPPhoneDirectory DirectoryEntry Name Bob Name Telephone 49116117 Telephone DirectoryEntry DirectoryEntry Name Alice Name Telephone alice myserver local Telephone Telephone 2010 inthecloud c...

Page 38: ...oft 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...

Page 39: ...ftKey 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 3 13 2 Using the internal o...

Page 40: ...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...

Page 41: ...Hard key External URI describing the action to be executed Since Firmware 2 0 65 Since Firmware 3 1 1 0 1 9 0 1 9 UP DOWN LEFT RIGHT OK ESC DEL MENU DIRECTORY NEWDIRECTORY REDIAL MUTE SPEAKER RKEY VO...

Page 42: ...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...

Page 43: ...TP GET Service URLs Device Info FW 1 2 25 or later service devinfo xml CgiServiceAPI XmlDeviceInfo SIP Trace File cgi bin webcgi sip txt CgiServiceAPI Siptrace Wireshark network traffic trace cgi bin...

Page 44: ...s to take effect if Asterisk is already running CLI config reload etc asterisk sip_notify conf Page 43 50 bin sh postfile push xml response result htm pushurl http 192 168 1 30 xmlservice addhdr Conte...

Page 45: ...isk configuration file etc asterisk sip_notify cfg the XML event To trigger the XML service on device 5566 enter on CLI Page 44 50 bin sh response result htm aurl http 192 168 1 1 tiptel3020xml TestAc...

Page 46: ...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 at...

Page 47: ...and_Dial added in IPPhoneTextMenu and IPPhoneDirectory 1 3 19 08 2013 1 1 120 3 3 IPPhoneTextMenu Optional SIP line selection for dialing added 1 3 26 08 2013 1 1 123 3 13 2 3 3 3 4 3 6 Hard keys 0 9...

Page 48: ...XML API for Tiptel com SIP Phones 31xx Page 47 50...

Page 49: ...4 843 13 23 E mail tiptel tiptel online ch Internet www tiptel online ch Tiptel B V Camerastraat 2 NL 1322 BC Almere Telefoon 036 53 666 50 Fax 036 53 678 81 E mail info tiptel nl Internet www tiptel...

Reviews:

No comments

Brands by name

Popular brands

Load more brands