Image RemovedImage Removed
Htek IP Phones XML Browser Developer's Guide
Version 2.0.4.4.24
Feb. 2018
Table of Contents
Instruction
Who should use this guide?
What is XML?
Function:
How does it work?
Htek IP Phone XML objects
TextMenu object
TextScreen Object
Directory Object
Status Object:
Execute Object:
FormattedTextScreen Object:
InputScreen Object:
ImageScreen Object:
Configutation Object:
ImageMenu:
How to customize the softkey?
Configuration a HTTP server
How to configuration the XML Browser via webpage? Anchor_Toc405819184_Toc405819184h1.

Table of Contents

maxLevel	3
indent	20px

Instruction

About XML Browser, XML browser simply means that the SIP phones' LCD screen display can be managed by external applications. This Guide will show you how to use the XML Browser.
Note: Htek IP phones with the firmware version 1.0.3.70 or higher support XML browser applications.

...

Who should use this guide?

This guide is designed specifically to provide development engineers, system administrators, or network engineers with information for developing and deploying XML browser feature to Htek IP phones on the network. This guide is not intended for end users on how to use any specific XML applications.

...

What is XML?

XML stands for extensible Markup Language. It is a markup language much like HTML.
HTML was designed to display data and to focus on how data looks. XML was designed to describe data and to focus on what data is.
The following are characteristics of XML:

...

Sample of Basic XML document:
Image Modified

...

Function

...

The XML Browser in the Htek IP phones allows users to create custom services which meet user functional requirements on the server. Users can customize practical applications, such as weather report, stock information and news service, etc.
Htek IP Phone supported objects are:
...
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

This chapter details all the XML objects supported by the Htek IP phones.

...

TextMenu object

TextMenu object allows users to display a list of menu items on IP phones.
TextMenu XML example:
<?xml version="1.0" encoding="ISO-8859-1"?>
<TextMenu
defaultIndex="1"
style="number"
Beep="yes"
wrapList="yes"
Timeout="45">
<Title wrap="yes" >MenuTitle</Title>
<MenuItem>
<Prompt>First Menu item</Prompt>
<URI> HTTP(s) URL </URI>
<Dial>number</Dial>
<Selection>selection</Selection>
</MenuItem>
<SoftKey index="1">
< AnchorOLE_LINK7OLE_LINK7 AnchorOLE_LINK8OLE_LINK8Label>Select<Selection>
</MenuItem>
<SoftKey index="1">
<Label>Select</Label>
<URI>SoftKey:Select</URI>
</SoftKey>
<SoftKey index="2">
<Label>Custom</Label>
<URI>HTTP(s) URL</URI>
</SoftKey>
<SoftKey index="4">
<Label>Exit</Label>
<URI> AnchorOLE_LINK13OLE_LINK13 AnchorOLE_LINK14OLE_LINK14SoftKey <URI>SoftKey:Exit</URI>
</SoftKey>
</TextMenu>
The parameters of the TextMenu object are listed in the following table:

Parameter	Type	Value	Description
TextMenu	mandatory	none	The root element of the TextMenu.
defaultIndex

anchorOLE_LINK9 AnchorOLE_LINK10OLE_LINK10

OLE_LINK9

optional

Integer

Position of the cursor to enter into the menu interface. If not specified, the cursor is positioned on the first menu item. Default value is 1.

style

optional

"number"
"none"
"radio"

MenuType:
Number(default):Use
digital to indicate the menu order before the menu.
None: No sign before the menu.
Radio: Use circle before the menu.

Beep

optional

"yes"
"no"

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

wrapList

optional

"yes"
"no"

Whether to display the title specified by the Prompt parameter
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 "no".

Timeout

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 45s.

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

MenuItem

mandatory

none

The element of menu item.(Up to 30 instance, minimum is 1)

Prompt

mandatory

string

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

URI

mandatory

URI

The operation of menu item.

Dial

optional

Phone number

The phone will dial out the number by an off-hook action with the cursor on this menu item.

Selection

optional

Anchor

	OLE_LINK11
	OLE_LINK11

Anchor

	OLE_LINK12
	OLE_LINK12

string

If the URI of softkey is the HTTP server address, it will send a request with the "selection=the parameter"

SoftKey

optional

XML object

Support "Exit", "Select", "Next", "Previous"

If there is no softkey defined in the TextMenu object, the default softkeys label show as the following table:

Softkey index	Label	URI
1	Select	SoftKey:Select
4	Exit	SoftKey:Exit

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://192.168.0.106/xml_browser/TextScreen.xml</URI>
<Dial></Dial>
<Selection>0&menu_pos=1</Selection>
</MenuItem>
<MenuItem>
<Prompt>Directory</Prompt>
<URI>http://192.168.0.106/xml_browser/Directory.xml</URI>
<Dial>101</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>Status</Prompt>
<URI>http://192.168.0.106/xml_browser/Status.xml</URI>
<Dial>102</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>Execute</Prompt>
<URI>http://192.168.0.106/xml_browser/Execute.xml</URI>
<Dial>103</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>FormattedTextScreen</Prompt>
<URI>http://192.168.0.106/xml_browser/FormattedTextScreen.xml</URI>
<Dial>104</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>InputScreen</Prompt>
<URI>http://192.168.0.106/xml_browser/InputScreen.xml</URI>
<Dial>105</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>ImageScreen</Prompt>
<URI>http://192.168.0.106/xml_browser/ImageScreen.xml</URI>
<Dial>106</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>Configuration</Prompt>
<URI>http://192.168.0.106/xml_browser/Configuration.xml</URI>
<Dial>107</Dial>
<Selection></Selection>
</MenuItem>
<MenuItem>
<Prompt>ImageMenu</Prompt>
<URI>http://192.168.0.106/xml_browser/ImageMenu.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://192.168.0.106/xml_browser/TextScreen.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:
Image Modified

...

TextScreen Object

The TextScreen object allows users to display some texts on the IP phones.
XML description of the TextScreen object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<TextScreen Timeout="15">
<Title>Title name</Title>
<Text>Text contents
</Text>
</TextScreen>
The AnchorOLE_LINK17OLE_LINK17 AnchorOLE_LINK18OLE_LINK18 parameters
The parameters of the TextScreen object are listed in the following table:

Parameter	Type	Value	Description
Timeout	optional	"integer" Unit: second	If there is no operation at a fixed interval on the phone, the phone will automatically exit the TextScreen interface. If it is set to 0, the phone will not exit the TextScreen interface until pressing the "Exit" soft key. Default value is 15.
Title	mandatory

AnchorOLE_LINK19OLE_LINK19 AnchorOLE_LINK20OLE_LINK20

	string	The title of the screen text.
Text	mandatory	string	The content of the screen text. (Text length must be within 2000B)

If there is no softkey defined in the TextMenu object, the default softkeys label show as the following table:

Softkey index	Label	URI
1

AnchorOLE_LINK21OLE_LINK21 AnchorOLE_LINK22OLE_LINK22

Exit

SoftKey:Exit

An example of the TextMenu object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<TextScreen Timeout="15">
<Title>1 ESPN and Associated Press Sports Headlines</Title>
<Text>Stewart sits race after hitting, killing racer (ESPN)
Broncos LB Trevathan (knee) out 6-8 weeks (Jeff Legwold)
Ballmer can run Clippers; NBA sues Sterling ( )
Sources: LeBron back to Miami for Christmas (Marc Stein)
Failed test, ban humble Dallas' Scandrick (Tim MacMahon)
Manning 'not a fan' as Broncos fight at camp (Jeff Legwold)
Pettine: Hoyer 'absolutely not' expendable (Pat McManamon)
Ex-Ohio St. QB Pryor 'wrong' for infractions (Terry Blount)
</Text>
</TextScreen>
The screenshot of the UC924 phone user interface for reference is shown as below:
Image Modified

...

Directory Object

The Directory object allows users to browse an online directory in real time. The Directory object is just AnchorOLE_LINK100OLE_LINK100 AnchorOLE_LINK101OLE_LINK101 like just like are remote phonebook. It displays an automatically numbered list of contacts. After selecting a contact with the cursor, the contact can be dialed directly by pressing the "Dial" softkey.
XML description of the Directory object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<Directory
defaultIndex="1"
Beep="yes"
Timeout="50">
<Title wrap="yes">Menu Title</Title>
<MenuItem>
<Prompt>Contact name</Prompt>
<URI>number</URI>
</MenuItem>
</ AnchorOLE_LINK23OLE_LINK23 AnchorOLE_LINK24OLE_LINK24Directory>
The parameters of the Directory object are listed in the following table:

Parameter	Type	Value	Description
Directory	mandatory	none	The root element of the Directory
defaultIndex	optional	Integer	Position of the cursor to enter into the menu interface. If not specified, the cursor is positioned on the first menu item. Default value is 1.
Beep	optional	"yes" "no"	Whether to play a tone when entering into the menu. Default value is "Yes".
Timeout	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 50s.
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".
MenuItem	mandatory	none	The element of menu item.(Up to 30 instance, minimum is 1)
Prompt	mandatory	string	The label of menu item, its display is controlled by "wrap List".
URI	mandatory	URI	The operation of menu item.

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

Softkey index	Label	URI
1	Exit	SoftKey:Exit
2	Previous	The URI specified by "Previous" of the Directory Object, "SoftKey:Previous"
3	Next	The URI specified by "Next" of the Directory Object, "SoftKey:Next"
4	Dial	SoftKey:Dial

An example of the Directory object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<Directory
defaultIndex="1"
Beep="yes"
Timeout="50">
<Title wrap="yes">Directory</Title>
<MenuItem>
<Prompt>nancy</Prompt>
<URI>100</URI>
</MenuItem>
<MenuItem>
<Prompt>max</Prompt>
<URI>101</URI>
</MenuItem>
<MenuItem>
<Prompt>vincent</Prompt>
<URI>102</URI>
</MenuItem>
<MenuItem>
<Prompt>simon</Prompt>
<URI>103</URI>
</MenuItem>
<MenuItem>
<Prompt>joe</Prompt>
<URI> 105</URI>
</MenuItem>
<MenuItem>
<Prompt>monica</Prompt>
<URI>106</URI>
</MenuItem>
<MenuItem>
<Prompt>nico</Prompt>
<URI>107</URI>
</MenuItem>
</Directory>
The screenshot of the UC924 phone user interface for reference is shown as below:
Image Modified

...

Status Object

The Status object allows users to display a status message on a single designated line on the phone's idle screen when XML information is pushed from the servers. The Status object an remind users of received messages, missed calls, news, notify, etc.
XML description of the Status object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<PhoneStatus
Beep="yes"
SessionID="12"
Timeout="30">
<Message
Size=" AnchorOLE_LINK31OLE_LINK31 AnchorOLE_LINK32OLE_LINK32normal/small/double/large"
Align="center/left/right"
Color="red"
Account=""
Icon="">Message</Message>
</PhoneStatus>
The parameters of the Status object are listed in the following table:

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_LINK27
	OLE_LINK27

Anchor

	OLE_LINK28
	OLE_LINK28

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

optional

"center"
"left"
"right"

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

Color

Anchor

	OLE_LINK34
	OLE_LINK34

Anchor

	OLE_LINK35
	OLE_LINK35

optional

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

Color of the line.

Account

Anchor

	OLE_LINK36
	OLE_LINK36

Anchor

	OLE_LINK37
	OLE_LINK37

optional

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:
Image Modified

...

Execute Object

The Execute object allows an external application to ask the phone to execute a sequence of local commands using URIs. The phone will execute each specified command in order.
XML description of the Execute object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<PhoneExecute Beep="yes">
<ExecuteItem URI="URI "/>
</PhoneExecute>
The parameters of the Execute object are listed in the following table:

...

OLE_LINK47OLE_LINK47

Parameter

Type

Value

Description

PhoneExecute

AnchorOLE_LINK44OLE_LINK44 AnchorOLE_LINK45OLE_LINK45


PhoneExecute	mandatory	none	The root element of the Execute
Beep	optional	"yes" "no"	Whether to play a tone when entering into the menu. Default value is "Yes".
ExecuteItem URI	mandatory	URI	The operation of command item, such as call user, data download from server according to the URL, etc. Valid values are listed in the following tables.

Commonly used commands:

Name	URI Value	Function
Supported URI	http(s)://myserver.com/ TextMenu.xml	Execute "TextMenu.xml" from the root directory on the server "myserver.com".
	Dial:XXXXX	Dial out the number
	Led:XXXX=on/off/slowflash/fastflash	Control the LEDs according to the commands
Phone Reset

AnchorOLE_LINK48OLE_LINK48 AnchorOLE_LINK49OLE_LINK49

Command:Reset

Reset to the factory

AnchorOLE_LINK50OLE_LINK50 AnchorOLE_LINK51OLE_LINK51


Phone Reboot	Command:Reboot	Phone Reboot
Clear	Command:ClearCallersList	Clear local call record list
	Command:ClearDirectory	Clear contact list
	Command:ClearRedialList	Clear placed calls list

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.

...

FormattedTextScreen Object

The FormattedTextScreen object allows IP phones to display formatted (alignment, size, color and scrolling) texts on the LCD screen.
XML description of the FormattedTextScreen object:
<?xml version="1.0" encoding="ISO-8859-1"?>
< AnchorOLE_LINK56OLE_LINK56 AnchorOLE_LINK57OLE_LINK57FormattedTextScreen <FormattedTextScreen
Beep="yes"
Timeout="60">
<Line Color="green">Header line1</Line>
<Line Color="red" Align="right" Size="large">Header line2</Line>
<Scroll>
<Line Size="large" Align="center">Scroll line1</Line>
</Scroll>
<Line Size="large" Align="center" Color="white">Footer line1</Line>
</FormattedTextScreen>
The parameters of the FormattedTextScreen object are listed in the following table:

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_LINK60
	OLE_LINK60

Anchor

	OLE_LINK61
	OLE_LINK61

optional

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

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

Softkey index	Label	URI
1	Exit	SoftKey:Exit

An example of the FormattedTextScreen object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<FormattedTextScreen
Beep="yes"
Timeout="60">
<Line Color="green">Header line1</Line>
<Line Color="red" Align="right" Size="large">Header line2</Line>
<Scroll>
<Line Size="large" Align="center">Scroll line1</Line>
<Line Align="right" Color="red">Scroll line2</Line>
<Line Align="right" Color="green">Scroll line3</Line>
<Line Size="large" Align="center">Scroll line4</Line>
<Line Align="right" Color="red">Scroll line5</Line>
<Line Align="right" Color="green">Scroll line6</Line>
<Line Align="left" Color="blue">Scroll line7</Line>
<Line Align="center" Color="blue">Scroll line8</Line>
<Line Align="left" Color="yellow">Scroll line9</Line>
<Line Align="center" Color="black">Scroll line10</Line>
</Scroll>
<Line Size="large" Align="center" Color="white">Footer line1</Line>
</FormattedTextScreen>
The screenshot of the UC924 phone user interface for reference is shown as below:
Image Modified
Note: The UC802/UC803/UC804/UC806 don't support the FormattedTextScreen Object.

...

InputScreen Object

The InputScreen object allows users to create a screen capable of gathering user input. It constructs and displays an input form, which prompts the users to input content, then sends the input content to the target URL. You can use Input Screen object for user login or saving some information to server. You can define the content and format of the input content.
XML description of the InputScreen object:
<?xml version="1.0" encoding="ISO-8859-1"?>
< AnchorOLE_LINK64OLE_LINK64 AnchorOLE_LINK65OLE_LINK65InputScreen
<InputScreen
type="string"
Beep="yes"
Password="no"
Timeout="0"
inputLanguage="English"
AnchorOLE_LINK71OLE_LINK71 AnchorOLE_LINK72OLE_LINK72 displayMode = "normal"
AnchorOLE_LINK75OLE_LINK75 AnchorOLE_LINK76OLE_LINK76 defaultIndex
Password="no"
Timeout="0"
inputLanguage="English"
displayMode = "normal"
defaultIndex="2" >
<Title wrap="yes">Menu Title</Title>
<URL>Target receiving the input</URL>
<InputField type="string" password="no" editable="yes">
<Prompt>Name</Prompt>
<Parameter>parameter name add to URL</Parameter>
<Selection>Selection</Selection>
<Default>Default Value</Default>
</InputField>
</InputScreen>
The parameters of the InputScreen object are listed in the following table:

Parameter	Type	Value	Description
InputScreen

AnchorOLE_LINK66OLE_LINK66

	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

AnchorOLE_LINK67OLE_LINK67 AnchorOLE_LINK68OLE_LINK68

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

Anchor

	OLE_LINK70
	OLE_LINK70

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 0s.

inputLanguage

Anchor

	OLE_LINK73
	OLE_LINK73

Anchor

	OLE_LINK74
	OLE_LINK74

optional

"English"

The language of user input.
Default value is English.

displayMode

Anchor

	OLE_LINK77
	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

anchorOLE_LINK80 AnchorOLE_LINK81OLE_LINK81

OLE_LINK80

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:

Softkey index	Label	URI
1	Exit	SoftKey:Exit
2	123	SoftKey:ChangeMode
3	Delete	SoftKey:Delete
4	Submit	SoftKey:Submit

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:
Image Removed

...

below:
Image Added

ImageScreen Object

The ImageScreen object allows users to display simple image on the IP phones. The user can specify where the image should be placed by setting horizontal and vertical alignment of the upper left hand corner, along with the height and width of the image. But this Object is only applies to color IP Phone.
XML description of the ImageScreen object
<?xml version="1.0" encoding="ISO-8859-1"?>
<ImageScreen
Beep="yes"
Timeout="45"
mode="regular">
<Image
horizontalAlign="middle"
verticalAlign="bottom" >Image as hexadecimal characters or URL</Image>
</ImageScreen>
The parameters of the ImageScreen object are listed in the following table:

Parameter	Type	Value	Description
ImageScreen	mandatory	none	The root element of the ImageScreen.
Beep	optional	"yes" "no"	Whether to play a tone when entering into the menu. Default value is "Yes".

AnchorOLE_LINK86OLE_LINK86 AnchorOLE_LINK87OLE_LINK87


Timeout	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 45s.
mode	optional	"regular" "full screen"	The display mode of the image. If not specified, the default value is "regular".

AnchorOLE_LINK90OLE_LINK90 AnchorOLE_LINK91OLE_LINK91


horizontalAlign	optional	"left" "middle" "right"	Vertical position of the image. Default value is "middle".
verticalAlign	optional	"top" "middle" "bottom"	Horizontal position of the image. Default value is "middle".
height	mandatory	integer	Height in pixels. Must match the image height.
width	mandatory	integer	Width in pixels. Must match the image width.

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

Softkey index	Label	URI
1	Exit	SoftKey:Exit

An example of the ImageScreen object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<ImageScreen
Beep="yes"
Timeout="45"
mode="regular">
<Image
horizontalAlign="middle"
verticalAlign="bottom" >http://192.168.0.106/xml_browser/APDirIcon.png</Image>
</ImageScreen>
The screenshot of the UC924 phone user interface for reference is shown as below:
Image Modified
Note: The UC802/UC803/UC804/UC806 also support ImageScreen Object, but the image's depth must be 1bit.

...

Configuration Object

The Configuration object allows an external application to modify configuration of the IP phones dynamically. The configuration parameters are ones that are used in configuration files.
XML description of the Configuration object
<?xml version="1.0" encoding="ISO-8859-1"?>
<Configuration
Beep="yes" >
<Item> parameter= value</Item>
</Configuration>
AnchorOLE_LINK84OLE_LINK84 AnchorOLE_LINK85
OLE_LINK85The parameters of the Configuration object are listed in the following table:

Parameter	Type	Value	Description
Configuration	mandatory	none	The root element of the Configuration object.
Beep	optional	"yes" "no"	Whether to play a tone when entering into the menu. Default value is "Yes".
Item	mandatory	none	The item consists of a Capital letter P and 2 to 5 digit numeric numbers. i.e., P2 is associated with "Admin Password" in

the Advanced Page.

...

the Advanced Page.

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:
Image Modified

...

ImageMenu:

The ImageMenu object allows users to create an image list of menu items on the IP phones. The user can specify the image menu items to link HTTP requests.
XML description 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(s) URL </Image>
<URIList base="URL">
<URI key="0-9" or "#"> URL </URI>
</URIList>
</ImageMenu>
The parameters of the ImageMenu object are listed in the following table:

...

Parameter	Type	Value	Description
ImageMenu

AnchorOLE_LINK88OLE_LINK88

AnchorOLE_LINK89OLE_LINK89

mandatory	none	The root element of the ImageMenu Object.
Beep	optional	"yes" "no"	Whether to play a tone when entering into the menu. Default value is "Yes".
Timeout	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 45s.
mode	optional	"regular" "fullscreen"	The display mode of the image. If not specified, the default value is "regular".
Image

AnchorOLE_LINK92OLE_LINK92 AnchorOLE_LINK93

OLE_LINK93

mandatory	string	Image as hexadecimal characters or URL.
horizontalAlign	optional	"left" "middle" "right"	Vertical position of the image. Default value is "middle".
verticalAlign	optional	"top" "middle" "bottom"	Horizontal position of the image. Default value is "middle".
height	mandatory	integer	Height in pixels. Must match the image height.
width	mandatory	integer	Width in pixels. Must match

the image width.

URIList

AnchorOLE_LINK94OLE_LINK94 AnchorOLE_LINK95OLE_LINK95

the image width.
URIList	mandatory	none	Master tag of the URI list linked to a keypad key (0-9, * and #).
Base	optional	string	The Base value is the parent directory of the URI value.
URI

AnchorOLE_LINK96OLE_LINK96 AnchorOLE_LINK97OLE_LINK97

	mandatory	string	URI to be used if the user presses the value of "Key".
Key	mandatory	"0-9,*"and "#"	Define the key to trigger the URI.

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

...

OLE_LINK109

Softkey index	Label	URI
1	Exit	SoftKey:Exit

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:
Image Modified

...

How to customize the softkey?

Htek IP phones allow users to create softkeys with customizable labels, positions and actions o be taken when the softkeys is pressed. The customizable softkeys can override the default softkeys in each XML object.
XML descriptions of customizable softkeys :
<SoftKey index="2">
<Label>Custom</Label>
<URI>URL</URI>
</SoftKey>
The parameters of the softkey are listed in the following table:

Parameter	Type	Value	Description
softkey

AnchorOLE_LINK104OLE_LINK104anchorOLE_LINK105

OLE_LINK105

mandatory

none

The softkey

index

mandatory

Integer

Indicatethe softkey number.
(Value ranges from 1~4.)

Label

mandatory

string

Anchor

	OLE_LINK106
	OLE_LINK106

Anchor

	OLE_LINK107
	OLE_LINK107

The label of the softkey.

URI

mandatory

string

The action of the softkey.

An example of the customizable softkeys used with the TextMenu object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<TextMenu
defaultIndex="1"
style="number"
Beep="yes"
wrapList="yes"
Timeout="45"
LockIn="no">
<Title wrap="yes" >TextMenu</Title>
<MenuItem>
<Prompt>TextScreen</Prompt>
<URI>http://192.168.0.106/xml_browser/TextScreen.xml</URI>
<Dial></Dial>
<Selection>0&menu_pos=1</Selection>
</MenuItem>
…
<MenuItem>
<Prompt>ImageMenu</Prompt>
<URI>http://192.168.0.106/xml_browser/ImageMenu.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://192.168.0.106/xml_browser/TextScreen.xml</URI>
</SoftKey>
<SoftKey index="4">
<Label>Exit</Label>
<URI>SoftKey:Exit</URI>
</SoftKey>
</TextMenu>
The screenshot of the IP phone user interface for reference is shown as below:
Image Modified

...

Configuration a HTTP server

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.
Image Modified
Step 3: Click the "SaveSet" button to accept the change.
Step 4: Press the Line key 4, you can browse the XML content.

Version	Old Version 2	New Version 3
Changes made by	HTEK_admin (Unlicensed)	HTEK_admin (Unlicensed)
Saved on	Jun 26, 2018	Jun 26, 2018

Page Comparison

Versions Compared

Key

Instruction

Who should use this guide?

What is XML?

Function

How does it work?

Htek IP Phone XML objects

TextMenu object

TextScreen Object

Directory Object

Status Object

Execute Object

FormattedTextScreen Object

InputScreen Object

ImageScreen Object

Configuration Object

ImageMenu:

How to customize the softkey?

Configuration a HTTP server

How to configuration the XML Browser via webpage?