meta data for this page
How to setup XML browser
Introduction
XML browser is a simple browser based on XML language and http/https services for SIP phone. Tools or programming languages like Php, javascript can be used on servers to generate proper XML files for SIP phone to download via http/https.
With XML browser, personalized configuration can be realized, for example, check the weather forecast, stock, date/time or contact; search on google; play music or configure other terminal devices.
XML Browser supports the following four kinds of XML files：
1.TextMenu: It is text format menu like content.Click a link to access the detail.
2.Text Screen: Display the detail text.
3.InputScreen: User input, it is like account register interface.
4.Directory: Download phone book.
XML Browser configuration
Configure XML Browser key via Web interface
1.Enter device’s IP to access the web interface;
2.Select any line key, soft key, function key or DSS key on Phone→Key/Display or DSS Key directory. Set the type as XML browser, enter the correct URL of xml files in value field then click submit to save the change.
3.Users can set up the local server with specific xml browser files or fill in remote server address such as http://65.205.71.13/xml/weather/weather.php in value field to gain data or information.
XML Browser server configuration
XML Browser supports Http/Https/tftp/ftp download.
1.Build up Http/Https/tftp/ftp server.
2.Put XML browser files on the specific directory as below tftp example:
3.Run tftp32.exe.
4.Enter XML files’ URL to the value field to complete the configuration
Configure XML Browser via Device LCD
1.Go to Menu → Features → Programmable Keys → Line Keys/Soft Keys/Function Keys/DSS keys.
2.Select XML Browser as type and input the server URL as below.
3.On the idle interface, press the XML browser key to access the target XML files.
XML File Format
Press XML browser key to access the XML interface. You may see the 4 types of interface as follow.
TextMenu
TextMenu Object XML template
<****TextMenu defaultIndex = “some integer” style = “numbered/none/radio” Beep = “yes/no” Timeout = “some integer”LockIn = “yes/no” WrapList = “yes/no”> <Title wrap = “yes/no” showlistcount="yes/no">Menu Title</Title> <MenuItem> <Prompt>First Choice</Prompt> <URI>http://somepage.xml</URI> <Dial>Number to dial</ Dial > <Selection>Selection</ Selection > </ MenuItem > <!-Additional Menu Items may be added (up to 30) - -> <!-Additional Softkey Items may be added (softkey phones) - -> </****TextMenu >
In the string “TextMenu”, “” can be replaced with any other string.
Example of TextMenu Object XML file
<?xml version="1.0" encoding="ISO-8859-1"?>
<IPPhoneTextMenu style="radio" Beep="yes" wrapList="yes" Timeout=”30” LockIn="yes">
<Title Wrap=”yes”Showlistcount=”no”>Phone Services </Title>
<MenuItem>
<Prompt>Area Code</Prompt>
<URI>http://10.1.0.105/aastra/area/area.php</URI>
<Dial>220</ Dial >
</MenuItem>
<MenuItem>
<Prompt>Ask Google</Prompt>
<URI>http:// 10.1.0.105/aastra/google/google.php?user=</URI>
<Dial>220</ Dial >
</MenuItem>
<MenuItem>
<Prompt>CNN News</Prompt>
<URI>http:// 10.1.0.105/aastra/rss/rss.php?feed=cnn</URI>
<Dial>220</ Dial >
</MenuItem>
</IPPhoneTextMenu>
TextMenu XML Specification
| XML Label | Type | Value | Description |
|---|---|---|---|
| IPPhoneTextMenu | Compulsory | None | Root Label |
| DefaultIndex | Optional | Integer | Menu default index is “1” |
| Style | Optional | “numbered”“none”“radio” | numbered: use number as index None: no index Radio:use radio button as index |
| Beep | Optional | “yes” “no” | Ring tone |
| wrapList | Optional | “yes” “no” | Use Multi-Line if menu item title is more than one line |
| Timeout | Optional | “integer” | Return to idle interface if timeout. Default value is 45 |
| Lockin | Optional | “yes” “no” | If the value is “yes”, the phone will not respond to any other keys unless softkey. Default value is “no” |
| InputType | Optional | “ABC” “abc” “123” “1Ab”“Abc” | Configure the default input type when access to the XML browser |
| Title | Optional | String | The title name on menu interface |
| Wrap | Optional | “yes” “no” | Use Multi-Lines when the length of title exceed one line. |
| Showlistcount | Optional | “yes” “no” | Show the number of list |
| MenuItem | Compulsory | none | Identify menu item |
| Prompt | Compulsory | String | Title for menu item effected by warplist |
| URI | Compulsory | URI | The action event for menuitem |
| Dial | Optional | Telephone number | When the menu item is selected, pick up the handset, the specific number will be called |
| Selection | Optional | String | If softkey URI is server address, the http request will be added this string “?selection=setting parameter” such as “http://10.1.0.105/menu1.xml?selection=0&menu_pos=1” |
| Softkey | Optional | Xml Object | Refer to soft key object |
If text menu object XML file does not specify softkey, the default softkey is shown below:
| Softkey index | Name | URI |
|---|---|---|
| 1 | Exit | Softkey：Exit |
| 4 | Select | Softkey：Select |
Key specification when using TextMenu XML browser
| Key name | Key description | Feature |
|---|---|---|
| Up/Down | Move Up/Down | Select menu item |
| Digit key | Number from 1 - 9 | Jump to specific index on menu. |
| Select | Softkey,URI=”softkey:select ” | Call URI action like http, dial.etc |
| Exit | Softkey,URI=”softkey:Exit ” | Replay the previous XML interface,if fails, return to idle interface. |
| OffHook/Linekey/Handfree | Off hook/line key/ handfree key | If menu item contain dial label, the specific number will be dialed |
| Cancel | The “X”key on device | Return to Idle interface |
| OK | The “OK” key on device | If Lockin is “no”, Ok key is equivalent to Select softkey. |
| Dss key without sip trunk | The DSS key(Including the expansion module) | If Lockin is “yes”, Dss key won’t work. |
TextScreen
TextScreen Object XML template
<****TextScreen doneAction = “URI” Beep = “yes/no” Timeout = “some integer” LockIn = “yes/no”> <Title wrap = “yes/no” showlistcount=”yes/no”>Screen Title</ Title > <Text>The screen text goes here</Text> <!-Additional Softkey Items may be added (softkey phones) - -> </****TextScreen >
Example of TextScreen Object XML file
<?xml version="1.0" encoding="ISO-8859-1"?> <IPPhoneTextScreen doneAction="http://10.1.0.105/cancel.php" Timeout="5" LockIn="no" Beep="yes"> <title wrap="yes">Screen Title </Title> <Text>The screen text goes here</Text> </IPPhoneTextScreen>
TextScreen Object XML specification
| XML Label | Type | Value | Description |
|---|---|---|---|
| IPPhoneTextScreen | Compulsory | None | Root Label |
| Beep | Optional | “yes”“no” | Ring tone |
| doneAction | Optional | URI | Execute specific URI when done key is selected |
| Timeout | Optional | “integer” | Return to idle interface if timeout. Default value is 45 |
| Lockin | Optional | “yes”“no” | If the value is “yes”, the phone will not respond to any other keys unless softkey. Default value is “no” |
| InputType | Optional | “ABC”“abc”“123”“1Ab”“Abc” | Configure the default input type when access to the XML browser |
| Title | Optional | String | The title name |
| Wrap | Optional | “yes”“no” | Use Multiple Lines when the length of title exceeds one line. |
| Text | Compulsory | String | Text content |
| Softkey | Optional | Xml Object | Refer to soft key object |
If TextScreen Object XML file does not specify softkey, the default softkey is shown below:
| Softkey index | Name | URI |
|---|---|---|
| 1 | Exit | Softkey：Exit |
Key function specification when access to TextScreen XML
| Key name | Key description | Feature |
|---|---|---|
| Up/Down | Up/Down | Select menu item |
| Digit key | Number from 1 - 9 | jump to specific index on menu. |
| Exit | Softkey,URI=”softkey:Exit ” | Replay the previous xml interface,if fails, return to idle interface. |
| OffHook/Linekey/Handfree | Off hook/line key/ handfree key | If menu item contain dial label, the specific numberwill be dialed |
| Cancel | The “X” key on device | Return to Idle interface |
| OK | The “OK” key on device | Call done action. |
InputScreen
InputScreen Object XML template
<****InputScreen type = “IP/string/number/timeUS/timeInt/dateUS/dateInt” password = “yes/no” editable = “yes/no” Beep = “yes/no” Timeout = “some integer” LockIn = “yes/no” defaultIndex = “some integer 1 to 6” displayMode = “normal/condensed” inputLanguage = “English/French/German/Italian/Spanish”> <Title wrap = “yes/no” showlistcount=”yes/no”>Title string</Title> <Prompt>Guidance for the input</Prompt> <URL>Target receiving the input</URL> <Parameteremptyable="yes"> name of the parameter add to URL</Parameter> <Default>Default Value (1)</Default> <InputField type = “IP/string/number/timeUS/timeInt/dateUS/dateInt/empty”password = “yes/no” editable = “yes/no”> <Prompt>Guidance for the input</Prompt> <URL>Target receiving the input</URL> <Parameter> parameter name add to URL</Parameter> <Default>Default Value</Default> <Selection>Selection</Selection> <!-Additional Softkey Items may be added (softkey phones) - -> </InputField> <!-Additional Input fields Items may be added - -> <!-Additional Softkey Items may be added (softkey phones) - -> </****InputScreen >
Example of TextScreen Object XML file
<IPPhoneInputScreen type="IP" Timeout="5" Beep="no"> <Title>Proxy Server</Title> <Prompt>Server IP:</Prompt> <URL>http://10.1.0.105/menu.php</URL> <Parameter>proxy</Parameter> <Default>10.1.0.105</Default> </IPPhoneInputScreen>
InputScreen Object XML specification
If Input screen object XML file does not specify softkey, the default softkey is shown below:
| Softkey index | Name | URI |
|---|---|---|
| 1 | Back | Softkey:Exit |
| 2 | 123 | SoftKey:Change mode |
| 3 | Delete | SoftKey:Backspace |
| 4 | Save | SoftKey: Submit |
Key specification when access inputScreen object XML.
| Key name | Key description | Feature |
|---|---|---|
| Up/Down | Move Up/Down | |
| Left/Right | Move Left/Right | |
| Digit key | Number from 1 - 9 | Jump to specific index on menu. |
| BackSpace | Softkey,URI=”SoftKey:Backspace” | Delete input string |
| Submit | Softkey,URI=”SoftKey:Submit” | Execute URI event action |
| 2aB | Softkey,URI=”SoftKey:ChangeMode” | Switch input type among “2aB” ”ABC”“abc” and “123” |
| OffHook/Linekey/Handfree | Off hook/line key/ handfree key | If menu item contain dial label, the specific number will be dialed |
| Cancel | The X key | Return to Idle interface |
| OK | The “OK” key | If Lockin is “no”, OK key is equivalent to Select softkey. If Lockin is “yes”, OK key won’t work |
| DSS key without sip trunk | DSS keys | If Lockin is “yes”, DSS key won’t work. |
InputScreen Object XML specification
| XML Label | Type | Value | Description |
|---|---|---|---|
| IPPhoneTextMenu | compulsory | None | Root Label |
| Type | Optional | “IP”“string”“number”“timeUS”“timeInt”“dateUS”“dateInt”“empty” | timeUS:12-hours format timeInt:24-hours format dateUS：MM/DD/YYYY \\dateInt:DD/MM/YYYY \\Empty:empty line. |
| Beep | Optional | “yes”“no” | Ring tone |
| Password | Optional | “yes”“no” | If the value is “yes”, user input will be displayed as  |
| Timeout | Optional | “integer” | Return to idle interface if timeout. Default value is 45 |
| Lockin | Optional | “yes”“no” | If the value is “yes”, the phone will not respond to any other keys unless softkey. Default value is “no” |
| InputType | Optional | “ABC”“abc”“123”“1Ab”“Abc” | Configure the default input type when access to the XML browser |
| InputLanguage | Optional | “English”“French”“German”“Italian”“Spanish” | Default input language is “English” |
| displayMode | Optional | “normal”“condensed” | Normal: Input box and prompt are displayed on different line. Condensed: Input box and prompt are displayed on the same line |
| defaultIndex | Optional | Integer | If multiple intput box exist, the index of default input box is 1 |
| Title | Compulsory | String | The input title name |
| Wrap | Optional | “yes”“no” | Use Multi-Lines when the length of title exceed one line. |
| Prompt | Optional | String | Prompt for user input |
| URL | Compulsory | URL | Send the input to URL |
| Parameter | Compulsory | String | The parameters in URL,for example, URL?<Parameter> |
| Default | Optional | String | Default input |
| Input field | Optional | None | Allow more input fields |
| editable | Optional | “yes”“no” | Allow user input if the value is “yes” |
| Softkey | Optional | XML object | Refer to Softkey Object |
If Input screen object XML file does not specify softkey, the default softkey is shown below:
| Softkey index | Name | URI |
|---|---|---|
| 1 | Back | Softkey:Exit |
| 2 | 123 | SoftKey:Change mode |
| 3 | Delete | SoftKey:Backspace |
| 4 | Save | SoftKey: Submit |
Key specification when access inputScreen object XML.
| Key name | Key description | Feature |
|---|---|---|
| Up/Down | Move Up/Down | |
| Left/Right | Move Left/Right | |
| Digit key | Number from 1 - 9 | Jump to specific index on menu. |
| BackSpace | Softkey,URI=”SoftKey:Backspace” | Delete input string |
| Submit | Softkey,URI=”SoftKey:Submit” | Execute URI event action |
| 2aB | Softkey,URI=”SoftKey:ChangeMode” | Switch input type among “2aB” ”ABC”“abc” and “123” |
| OffHook/Linekey/Handfree | Off hook/line key/ handfree key | If menu item contain dial label, the specific number will be dialed |
| Cancel | The X key | Return to Idle interface |
| OK | The “OK” key | If Lockin is “no”, OK key is equivalent to Select softkey. If Lockin is “yes”, OK key won’t work |
| DSS key without sip trunk | DSS keys | If Lockin is “yes”, DSS key won’t work. |
Directory
Directory Object XML template
<****Directory Next = “some URI” Previous = “some URI” Selection=”some URI” Beep = “yes/no” Timeout = “some integer” LockIn = “yes/no”> <Title wrap = “yes/no”showlistcount=”yes/no”>Directory Title</Title> <MenuItem> <Prompt>Contact Name</Prompt> <URI>number</URI> </MenuItem> <!-Additional Menu Items may be added - -> <!-Additional Softkey Items may be added - -> </****Directory>
Example of Directory Object XML file
<?xml version="1.0" encoding="utf-8" ?> <IPPhoneDirectory defaultIndex="1" style="none"Beep="no" wrapList="no" Next="http://192.168.1.98:80/?action=getphonebook&menu=search" Selection="http://192.168.1.98:80/?action=getphonebook&"> <DirectoryEntry> <Name>User_202</Name> <Telephone>202</Telephone> <Presence>INCOMING</Presence> <Selection>detail=202</Selection> </DirectoryEntry> <DirectoryEntry> <Name>User_201</Name> <Presence>INCOMING</Presence> <URI>http://192.168.1.98:80/?action=getphobenook&menu=selectnumber</URI> </DirectoryEntry> ......... <SoftKey index="1"> <Label>Exit</Label> <URI>SoftKey:Exit</URI> </SoftKey> <SoftKey index="2"> <Label>Search</Label> <URI>SoftKey:Next</URI> </SoftKey> (*) <SoftKey index="3"> <Label>Detail</Label> <URI>SoftKey:Select</URI> </SoftKey> (**) <SoftKey index="4"> <Label>Enter</Label><URI>SoftKey:Dial</URI></SoftKey> (***) </IPPhoneDirectory>
Directory XML Specification
| XML Label | Type | Value | Description |
|---|---|---|---|
| IPPhoneDirectory | Compulsory | None | Root Label |
| Next | Optional | URI | Configure URI for “Next” softkey |
| Previous | Optional | URI | Configure URI for “Previous” softkey |
| Selection | Optional | Integer | Configure URI for “Select” softkey |
| Beep | Optional | “yes”“no” | Ring tone |
| Timeout | Optional | “integer” | Return to idle interface if timeout. Default value is 45 |
| Lockin | Optional | “yes”“no” | If the value is “yes”, the phone will not respond to any other keys unless softkey. Default value is “no” |
| InputType | Optional | “ABC”“abc”“123”“1Ab”“Abc” | Configure the default input type when access to the XML browser |
| Title | Compulsory | String | The title name for directory |
| Wrap | Optional |
“no” | Use Multi-Lines when the length of title exceeds one line. |
| MenuItem | Compulsory | None | Index for directory item(value:1-15) |
| Prompt | Compulsory | String | Title for menu item |
| URI | Compulsory | URI | The action event for menu item |
| Softkey | Optional | Xml Object | Refer to soft key object |
If directory object XML file does not specify softkey, the default softkey is shown below:
| Softkey index | Name | URI |
|---|---|---|
| 1 | Exit | Softkey:Exit |
| 2 | Next | SoftKey:Next |
| 3 | Select | SoftKey:Select |
| 4 | Dial | SoftKey: Dial |
Key specification when access directory object XML.
| Key name | Key Description | Feature |
|---|---|---|
| Up/Down | Move Up/Down | |
| Digit key | Number from 1 - 9 | Jump to specific index on menu. |
| Dial | Softkey,URI=”SoftKey:Submit” | Call specific number behind a selected item |
| Previous | Softkey,URI=”SoftKey:ChangeMode” | Call URI in <Previous> Label |
| Next | Softkey,URI=”SoftKey:Next” | Call URI in <Next> Label |
| Select | Softkey,URI=”SoftKey:Select” | Send the content in <Selection> label |
| Exit | Softkey,URI=”SoftKey:Exit” | Replay previous XML interface |
| OffHook/Linekey/Handfree | Off hook/line key/ handfree key | If menu item contain dial label, the specific number will be dialed |
| Cancel | The “X” key | Return to Idle interface |
| OK | The “OK” key | If Lockin is “no”, OK key is equivalent to Select softkey. |
| Dss key without sip trunk | DSS keys | If Lockin is “yes”, DSS key won’t work. |