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 URL - 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-URL....................................................................................................................4
2.2.2 SIP NOTIFY Remote Action-URL.........................................................................................................4
2.2.3 HTTP Push XML....................................................................................................................................5
2.2.4 SIP NOTIFY Push XML.........................................................................................................................5
2.3 XML Format...................................................................................................................................................6
2.4 External URI formats......................................................................................................................................6
2.4.1 URL variables.........................................................................................................................................7
2.5 Internal call control URI formats....................................................................................................................8
2.5.1 Internal URI Dial:...................................................................................................................................8
2.5.2 Internal URI SendDigits:........................................................................................................................8
2.6 Internal device control URI formats................................................................................................................8
2.6.1 Internal URI "Key:"................................................................................................................................9
2.6.2 Internal URI "Led:"...............................................................................................................................10
2.6.3 Internal URI "Command:"....................................................................................................................11
2.6.4 Internal URI "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 UI XML objects.................................................................................................................37
3.13.1 Sub object "SoftKey" for XML UI objects..........................................................................................37
3.13.2 Using the internal object "SoftKey” for customizing hard keys..........................................................38
3.13.3 Sub object "SoftKeyItem" for XML UI objects (Type B)...................................................................39
3.14 Special attributes for UI 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 URLs.................................................................................................................42
4.2 HTTP GET Service URLs.............................................................................................................................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 URL via HTTP...........................................................................................44
Page 1 / 50
