Versions Compared

Version Old Version 3 New Version 4
Changes made by

HTEK_admin (Unlicensed)

HTEK_admin (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3
indent20px

...

Some of these objects also support customizable softkeys that are declared as an independent object.

How does it work?

Htek has developed the XML browser capability on the phone using the HTTP transport protocol.
You can press the predefined key to trigger the phone initiated application of XML browser. After pressing the key, the IP phone issues an HTTP(s) GET command to the server, waits for the answer, decodes and displays the answer on the LCD screen.
. Image Modified

...

 Figure1: Htek IP Phone as a client

Htek IP Phone XML objects

...

An example of the TextMenu object:

<?xml version="1.0" encoding="ISO-8859-1"?>
<TextMenu
defaultIndex="1"
style="number"
Beep="yes"
wrapList="yes"
Timeout="45">
<Title wrap="yes">TextMenu</Title>
<MenuItem>
<Prompt>TextScreen</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/TextScreen.xml<xml</URI>
<Dial></Dial>
<Selection>0&menu_pos=1</Selection>
</MenuItem>
<MenuItem>
<Prompt>Directory</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/Directory.xml<xml</URI>
<Dial>101</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>Status</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/Status.xml<xml</URI>
<Dial>102</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>Execute</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/Execute.xml<xml</URI>
<Dial>103</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>FormattedTextScreen</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/FormattedTextScreen.xml<xml</URI>
<Dial>104</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>InputScreen</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/InputScreen.xml<xml</URI>
<Dial>105</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>ImageScreen</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/ImageScreen.xml<xml</URI>
<Dial>106</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>Configuration</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/Configuration.xml<xml</URI>
<Dial>107</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>ImageMenu</Prompt>
<URI>http <URI>http://192.168.0.106/xml_browser/ImageMenu.xml<xml</URI>
<Dial>107</Dial>
<Selection></Selection>
</MenuItem>
<SoftKey index="1">
<Label>Select</Label>
<URI>SoftKey:Select</URI>
</SoftKey>
<SoftKey index="2">
<Label>Custom</Label>
<URI>http <URI>http://192.168.0.106/xml_browser/TextScreen.xml<xml</URI>
</SoftKey>
<SoftKey index="4">
<Label>Exit</Label>
<URI>SoftKey:Exit</URI>
</SoftKey>
</TextMenu>
The screenshot of the UC924 phone user interface for reference is shown as below:

...

optionaloptional

OLE_LINK33

optional

optional

optional

Parameter

Type

Value

Description

PhoneStatus

mandatory

none

The root element of the Status.

Beep

optional

"yes"
"no"

Whether to play a tone when entering into the menu.
Default value is "Yes".

SessionID

optional

Anchor
OLE_LINK29
OLE_LINK29
Anchor
OLE_LINK30
OLE_LINK30
string

Session ID is used to mark different Status Objects.

Timeout

Anchor
OLE_LINK27OLE_LINK27
Anchor
OLE_LINK28OLE_LINK28

"integer"
Unit: sec

If the user has no operation at a fixed interval, the phone will automatically exit the menu interface. Default value is 30s.

Message

optional

string

Message to be displayed or empty to reset the message. (Up to 10 instances.)

Size

optional

"normal"
"small"
"double"
"large"

Font size of the text.
"small": 12 pt
"normal": 18 pt
"double": 24 pt
"large": 28 pt
Default value is "large".

Align

Anchor

OLE_LINK33

"center"
"left"
"right"

Alignment of the message display.
Default value is "left".

Color

Anchor
OLE_LINK34OLE_LINK34
Anchor
OLE_LINK35OLE_LINK35

"white"
"black"
"red"
"green"
"brown"
"blue"
"magenta"
"cyan"
"lightgray"
"darkgray"
"lightred"
"lightgreen"
"yellow"
"lightblue"
"lightmagenta"
"lightcyan"

Color of the line.

Account

anchor

OLE_LINK36OLE_LINK36
Anchor
OLE_LINK37OLE_LINK37

string

Specify the registered account for the status.

Icon

optional

Forward
DND
Message

Icon used to index status message

An example of the Status object:

<?xml version="1.0" encoding="ISO-8859-1"?>
<PhoneStatus
Beep="yes"
SessionID="12"
Timeout="30"
wrapList="no">
<Message Size="large" Align="left" Color="red" Account="" Icon="">Foward to 101</Message>
<Message Size="large" Align="left" Color="white" Icon="Forward" >Foward to 102</Message>
<Message Align="right" Color="blue" Icon="Forward" Account="">DND</Message>
<Message Align="left" Color="red" Icon="Forward" Account="">Foward to 103</Message>
</PhoneStatus>
The screenshot of the UC924 phone user interface for reference is shown as below:

...

An example of the Execute object:

<?xml version="1.0" encoding="ISO-8859-1"?>
<PhoneExecute Beep="yes">
<ExecuteItem URI="Led:MEMO5_GREEN=fastflash"/>
<ExecuteItem URI="Led:LINE3=on"/>
<ExecuteItem URI="Dial:860"/>
</PhoneExecute>
The IP phone enters into the phone Execute interface.

...

optional

Parameter

Type

Value

Description

FormattedTextScreen

mandatory

none

The root element of the FormattedTextScreen

Beep

optional

"yes"
"no"

Whether to play a tone when entering into the menu.
Default value is "Yes".

Timeout

Anchor
OLE_LINK58
OLE_LINK58
Anchor
OLE_LINK59
OLE_LINK59
optional

"integer"
Unit: sec

If the user has no operation at a fixed interval, the phone will automatically exit the menu interface. Default value is 60s.

Line

mandatory

string

Text to be displayed on the line. If the length of the text is too long to be displayed on the LCD screen, the line will be cropped to the last word. The Header block can display two lines at most, and the Footer block can display only one line.

Size

optional

"normal"
"small"
"double"
"large"

Font size of the text.
"small": 12 pt
"normal": 18 pt
"double": 24 pt
"large": 28 pt
Default value is "large".

Align

optional

"center"
"left"
"right"

Alignment of the message display.
Default value is "left".

Color

Anchor
OLE_LINK60OLE_LINK60
Anchor
OLE_LINK61OLE_LINK61

"white"
"black"
"red"
"green"
"brown"
"blue"
"magenta"
"cyan"
"lightgray"
"darkgray"
"lightred"
"lightgreen"
"yellow"
"lightblue"
"lightmagenta"
"lightcyan"

Color of the line.

Scroll

optional

none

Define the scrolling content for display. The Line above the Scroll is as Header, under the Scroll is as Footer.

...

OLE_LINK70

optional

OLE_LINK73

optional

OLE_LINK77

Parameter

Type

Value

Description

InputScreen

mandatory

none

The root element of the InputScreen

Type

mandatory

"IP"
"string"
"number"

Data input options:
1.IP
2.string(default)
3.number

Beep

optional

"yes"
"no"

Whether to play a tone when entering into the menu.
Default value is "Yes".

Password

optional

"yes"
"no"

Whether to mask the input by "*" characters. Default value is "no".

Timeout

Anchor
OLE_LINK69OLE_LINK69
Anchor

OLE_LINK70

"integer"
Unit: sec

If the user has no operation at a fixed interval, the phone will automatically exit the menu interface. Default value is 0s.

inputLanguage

Anchor

OLE_LINK73
Anchor
OLE_LINK74OLE_LINK74

"English"

The language of user input.
Default value is English.

displayMode

Anchor
OLE_LINK77

optional

"normal"
"condensed"

normal (default):
Display the prompt and input box in two lines.
condensed:
Display the prompt and input box in one line.

defaultIndex

optional

integer

Position of the cursor. If the value is not specified or exceeds the number of input boxes, the cursor is positioned on the first input box. Default value is 2.

Title

mandatory

string

The content of the menu item.

wrap

optional

"yes"
"no"

Whether to display the title in multi-lines when the content of the title is longer than one line.
Select "yes" to display in multi-lines, and "no" for one line.
Default value is "Yes".

URI

mandatory

URI

The operation of menu item.

InputField

optional

none

Set several input boxes.
(Value ranges from 1to 6.)

editable

optional

"yes"
"no"

Whether to allow users to input something. Default value is "yes". Users can not input anything if it is set to "no".
Applicable scenario: only allow some users to login.

Prompt

mandatory

string

The label of menu item, its display is controlled by "wrap List".

Parameter

mandatory

string

Name of parameter to be added after the URL.

Selection

optional

string

If "URI" is set to an HTTP URL, the phone will send a request with "selection= xxx" when the user presses the "Select" soft key.

Default

optional

string

Default value to be displayed
in input field.

Note: The InputField parameter in the XML file is optional. You can use this parameter to customize more input fields on the IP phone.

If there is no softkey defined in the InputScreen object, the LCD screen displays the following default softkey:

...

An example of the InputScreen object:

<?xml version="1.0" encoding="ISO-8859-1"?>
<InputScreen
type="string"
Beep="yes"
Password="no"
Timeout="0"
inputLanguage="English"
displayMode = "normal"
defaultIndex="2" >
<Title wrap="yes">Input Info</Title>
<URL>http://192.168.0.106/xml_browser/Directory.xml</URL>
<InputField type="number" password="no" editable="no">
<Prompt>User ID:</Prompt>
<Parameter>userid</Parameter>
<Selection>1QQQQ</Selection>
<Default>21501</Default>
</InputField>
<InputField type="IP" password="no" editable="yes">
<Prompt>IP Address:</Prompt>
<Parameter>IP</Parameter>
<Selection>2</Selection>
<Default>192.168.0.138</Default>
</InputField>
<InputField type="string" password="no" editable="yes">
<Prompt>Name:</Prompt>
<Parameter>user</Parameter>
<Selection>5QQQQ</Selection>
<Default>jxz</Default>
</InputField>
<InputField type="string" password="yes" editable="no">
<Prompt>password:</Prompt>
<Parameter>passwd</Parameter>
<Selection>4</Selection>
<Default>123456</Default>
</InputField>
</InputScreen>
The screenshot of the UC924 phone user interface for reference is shown as below:

...

An example of the Configuration object:

<?xml version="1.0" encoding="ISO-8859-1"?>
<Configuration
Beep="yes" >
<P271 para="Account1.Active">1</P271>
<P47 para="Account1.Sipserver">192.168.0.9</P47>
<P20000 para="Account1.Lable">531</P20000>
<P35 para="Account1.SipUserId">531</P35>
<P36 para="Account1.AuthenticateID">531</P36>
<P34 para="Account1.AuthenticatePassword">test11</P34>
<P3 para="Account1.DispalyName">531</P3>
</Configuration>
The IP phone registers account 531 on line 1:

...

An example of the ImageMenu object:

<?xml version="1.0" encoding="ISO-8859-1"?>
<ImageMenu Beep="yes" Timeout="120" mode="regular">
<Image
verticalAlign="top" horizontalAlign="left">http://192.168.0.106/xml_browser/ImageMenu.jpg</Image>
<URIList base="http://192.168.0.106/xml_browser/">
<URI key="#">http://192.168.0.106/xml_browser/TextMenu.xml</URI>
<URI key="0">http://192.168.0.106/xml_browser/Directory.xml</URI>
<URI key="1">http://192.168.0.106/xml_browser/InputScreen.xml</URI>
</URIList>
</ImageMenu>
The screenshot of the UC924 phone user interface for reference is shown as below:

...

Htek IP Phone support downloading by HTTP(s) protocol . You can setup a HTTP(s) server and place the XML files on the server for downloading.
We recommend using the XAMPP application.
Step 1: Double click the XAMPP Control Panel.exe.
Step 2: Click Config of Apache and click Apache (httpd.conf). Edit the name and port that the server uses to identify itself. Default port is 80. Edit the server's root directory. Default root directory is ../xampp/htdocs.
Step 3: Click Start of Apache. Put the XML files into the root directory of the HTTP server.

How to configuration the XML Browser via webpage?

Step 1: Log in the IP Phone's webpage
Step 2: Function keys->Line key (Memory key), select the XML Browser in Type field and input the XML Browser's URL in the value field.

Step 3: Click the "SaveSet" button to accept the change.
Step 4: Press the Line key 4, you can browse the XML content.