Yealink Yealink SIP-T48G User manual

i
i

Table of Contents
i
Table of Contents....................................................................... i
About This Guide ......................................................................iii
Who should use this guide? ........................................................................................iii
Summary of Changes................................................................................................. iv
Changes for Release 80, Guide Version 80.60..................................................... iv
Changes for Release 80, Guide Version 80.20..................................................... iv
Changes for Release 80, Guide Version 80.6....................................................... iv
Changes for Release 80, Guide Version 80.5....................................................... iv
Changes for Release 73, Guide Version 73.16...................................................... v
Changes for Release 72, Guide Version 72.60...................................................... v
Changes for Release 72, Guide Version 72.30...................................................... v
Changes for Release 72, Guide Version 72.2........................................................ v
Changes for Release 72, Guide Version 72.1........................................................ v
Changes for Release 71, Guide Version 71.165................................................... vi
Changes for Release 71, Guide Version 71.140................................................... vi
Changes for Release 71, Guide Version 71.111................................................... vi
Changes for Release 71, Guide Version 71.110................................................... vi
XML and Yealink IP Phones ...................................................... 1
What is XML? ................................................................................................................ 1
XML Format................................................................................................................... 2
Functionality.................................................................................................................. 3
How does it work?........................................................................................................ 4
Phone initiated application..................................................................................... 4
Server initiated application .................................................................................... 4
XML display control and keys on Yealink IP phones................................................ 5
Yealink IP Phone XML Objects ................................................. 8
XML Object Definitions................................................................................................ 8
TextMenu Object...................................................................................................... 9
TextScreen Object.................................................................................................. 16
InputScreen Object................................................................................................ 21
Directory Object..................................................................................................... 33
Status Object .......................................................................................................... 40
Execute Object ....................................................................................................... 44

XML Browser Developer’s Guide for Yealink IP Phones
ii
Configuration Object ............................................................................................. 49
FormattedTextScreen Object................................................................................ 50
ImageScreen Object ............................................................................................. 57
ImageMenu Object ............................................................................................... 62
Customizable Soft keys ............................................................................................. 68
XML Objects Pushed to the Phone ........................................................................... 71
Some Development Guidelines ............................................................................... 73
Configuring the HTTP Server .................................................. 74
Configuring the Push XML Server .......................................... 75
Yealink IP Phone XML Configurations .................................... 81
Configuring an XML Browser Key ............................................................................ 81
Configuring the Block XML in Calling ...................................................................... 87
Configuring the Push XML Server Address ............................................................. 88
Configuring the XML SIP Notify................................................................................. 90
Configuring the Default Input Method .................................................................... 92
Troubleshooting ...................................................................... 94
Troubleshooting Tools................................................................................................. 94
Parsing Error Debug Example................................................................................... 95
Appendix ................................................................................ 96
Customizing an Image File ....................................................................................... 96

About This Guide
iii
XML browser simply means that the SIP phones’LCD screen display can be managed
by external applications.
This guide shows you how to use XML API to control the LCD screen display of Yealink
IP phones as well as its configuration. The XML API is intended to provide you with
flexibility in developing applications on the phones while tightly integrating into the
phone’s telephony capabilities and functions.
This guide applies to SIP-T48G, SIP-T46G, SIP-T42G, SIP-T41P, SIP-T29G, SIP-T27P,
SIP-T23P/G, SIP-T21(P) E2 and SIP-T19(P) E2 IP phones running firmware version 80 or
later.
This guide is designed specifically to provide development engineers, system
administrators, or network engineers with information for developing and deploying
customized client services to Yealink IP phones using the XML browser feature.
This guide is not intended for end users and does not provide user-level information on
how to use any specific XML applications.
Before reading this guide, you should be familiar with the following:
Basic text editors, or full IDE-like Eclipse or Microsoft Visual Studio for creating or
writing code.
General application and software development.
Adequate planning, creating, and testing resources needed to produce a fully
deployable web-based application.
Yealink IP phones and provisioning methods.
How to use an XML editor.
The XML-based schema and syntax.

XML Browser Developer’s Guide for Yealink IP Phones
iv
This section describes the changes to this guide for each release and guide version.
Documentations of the newly released SIP-T19(P) E2 IP phones have been added.
The following section is new:
Configuring the Default Input Method on page 92
Major updates have occurred to the following sections:
XML display control and keys on Yealink IP phones on page 5
Yealink IP Phone XML Objects on page 8
TextMenu Object on page 9
This version is updated to remove SIP-T28P, SIP-T26P, SIP-T22(P), SIP-T21(P), SIP-T20(P) and
SIP-T19(P) IP phones. Documentations of the newly released SIP-T27P and SIP-T21(P) E2
IP phones have also been added.
Major updates have occurred to the following sections:
XML display control and keys on Yealink IP phones on page 5
Yealink IP Phone XML Objects on page 8
Configuring an XML Browser Key on page 81
Documentations of the newly released SIP-T29G IP phones have also been added.
Major updates have occurred to the following sections:
XML display control and keys on Yealink IP phones on page 5
Yealink IP Phone XML Objects on page 8
Customizable Soft keys on page 68
Configuring an XML Browser Key on page 81
Documentations of the newly released SIP-T23P/G IP phones have also been added.
Major updates have occurred to the following sections:

About This Guide
v
XML display control and keys on Yealink IP phones on page 5
Yealink IP Phone XML Objects on page 8
Customizable Soft keys on page 68
Configuring an XML Browser Key on page 81
This version is updated to remove SIP-T3xG and VP530 IP phones. Major updates have
occurred to the following section:
Yealink IP Phone XML Objects on page 8
Major updates have occurred to the following section:
Yealink IP Phone XML Objects on page 8
The following sections are new:
XML Format on page 2
Some Development Guidelines on page 73
Troubleshooting on page 94
Appendix on page 96
Major updates have occurred to the following section:
Yealink IP Phone XML Objects on page 8
This version is updated to incorporate SIP-T48G IP phones. Major updates have
occurred to the following section:
Yealink IP Phone XML Objects on page 8
This version is updated to incorporate SIP-T46G, SIP-T42G and SIP-T41P IP phones. Major
updates have occurred to the following section:
Yealink IP Phone XML Objects on page 8

XML Browser Developer’s Guide for Yealink IP Phones
vi
Major updates have occurred to the following section:
Yealink IP Phone XML Objects on page 8
Major updates have occurred to the following sections:
XML display control and keys on Yealink IP phones on page 5
Yealink IP Phone XML Objects on page 8
Customizable Soft keys on page 68
XML Objects Pushed to the Phone on page 71
Documentations of the newly released SIP-T19(P) and SIP-T21(P) IP phones have also
been added.
The following sections are new:
Configuring the Push XML Server on page 75
Configuring the Block XML in Calling on page 87
Major updates have occurred to the following section:
Yealink IP Phone XML Objects on page 8

XML and Yealink IP Phones
1
XML stands for extensible Markup Language. It is a markup language much like HTML.
HTML is designed to display data and to focus on how data looks, while XML is
designed to describe data and to focus on what data is.
XML enables SIP phones to serve as output devices for many exciting applications.
The XML infrastructure allows the phones to interact with external applications in a
flexible and programmable manner.
The following are characteristics of XML:
XML tags are not predefined. You must define your own tags.
XML uses an XML schema to describe the data.
XML with an XML schema is designed to be self-descriptive.
XML is a W3C Standard Recommendation.
Sample of Basic XML document:
<?xml version="1.0" encoding="ISO-8859-1"?>
<YealinkIPPhoneTextMenu
destroyOnExit="no"
style="numbered"
Beep="no"
Timeout="30"
LockIn="no">
<Title wrap="yes">Phone Services</Title>
<MenuItem>
<Prompt>Ask Google</Prompt>
<URI>http://10.2.11.158/yealink/google/google.php?user=</URI>
<Dial>456</Dial>
</MenuItem>
<MenuItem>
<Prompt>CNN News</Prompt>
<URI>http://10.2.11.158/yealink/rss/rss.php?feed=cnn</URI>
<Dial>1001</Dial>
</MenuItem>
</YealinkIPPhoneTextMenu>
Root element
Child elements of the root
XML Declaration

XML Browser Developer’s Guide for Yealink IP Phones
2
XML is written in the form of XML elements consisting of tags enclosed in angle
brackets (e.g., <YealinkIPPhoneTextMenu>). XML contains 3 kinds of tags: the start
tag, the end tag and the empty-element tag. The empty-element tag has two kinds of
form: in pairs (e.g., <MenuItem></MenuItem>) and not in pairs (e.g., <MenuItem />).
With the exception of the empty-element tag not in pairs, XML tags most commonly
come in pairs like <YealinkIPPhoneTextMenu> and </YealinkIPPhoneTextMenu>. The
first tag in a pair is the start tag (e.g., <YealinkIPPhoneTextMenu>), and the second
tag is the end tag (e.g., </YealinkIPPhoneTextMenu>). XML mainly follows rules as
below:
XML must have root element.
The end tag must have the character “/”.
XML tags are case-sensitive.
Each attribute value should be within double quotations.
The texts within <!-- --> are considered as comments.
XML provides escape facilities for including characters which are problematic to
include directly. For example, the characters "<" and "&" are key syntax markers and
may never appear in content. XML has five predefined entities.
XML conversion table is shown as below:
Character
Name
Escape Sequence
&
Ampersand
&amp;
“
Quote
&quot;
‘
Apostrophe
&apos;
<
Left angle bracket
&lt;
>
Right angle bracket
&gt;
To respect XML recommendations, the following header can be set at the beginning of
the XML document,
<?xml version="1.0" encoding="ISO-8859-1"?>
Or
<?xml version="1.0" encoding="UTF-8"?>
Yealink provides XML object files beginning with the XML declaration “<?xml
version="1.0" encoding="ISO-8859-1"?>”.
For more information on XML, refer to http://www.xml.com/.

XML and Yealink IP Phones
3
The XML browser feature on Yealink IP phones allows users to develop and deploy
custom services which meet user functional requirements on the server. Users can
customize practical applications, such as weather report, stock information, Google
search, news service, etc.
Phone service developers should take it into consideration that the phone is not a web
browser so it cannot parse HTML. Although the content is delivered to the phone
through HTTP messages using a web server, keep in mind that the content is not HTML.
All content comes to the IP phone either as plain text or text packaged in XML objects.
Yealink IP phones support 10 proprietary XML objects, which allow the creation of
powerful XML applications.
There are 2 types of XML objects:
UI objects: XML objects are used to control the LCD screen display of IP phones.
Non UI objects: XML objects have no direct impact on the current LCD screen display
of IP phones.
The supported objects are:
TextMenu object (UI)
TextScreen object (UI)
InputScreen object (UI)
Directory object (UI)
ImageScreen object (UI)
ImageMenu object (UI)
FormattedTextScreen object (UI)
Status object (UI)
Execute object (Non UI)
Configuration object (Non UI)

XML Browser Developer’s Guide for Yealink IP Phones
4
Depending on the IP infrastructure, Yealink has supported developing the XML
browser capability of the phones using HTTP. Yealink IP phones support two modes for
XML browser applications:
Phone-initiated
Server-initiated
You can press the predefined XML Browser key to trigger the phone initiated
application of XML browser. After you press the key, the IP phone issues an HTTP(s)
GET request message to the server, waits for the answer, decodes and displays this
response message like any web browser, such as Microsoft Internet Explorer or Firefox,
and would do as a web client. For more information on how to configure an XML
Browser key, refer to Configuring an XML Browser Key.
Figure1 Yealink IP phone acting as a client
The server initiated application would be more frequently used on the network. In this
mode, end users do not need to do any configuration and operation.
The server can push an XML object to the phone via an HTTP POST. For more
information, refer to XML Objects Pushed to the Phone.

XML and Yealink IP Phones
5
In addition, Yealink IP phones support accepting SIP NOTIFY messages from a SIP
proxy server, and act as limited web servers. For more information on how to configure
the XML SIP Notify, refer to Configuring the XML SIP Notify.
Figure2 Yealink IP phone acting as a server (HTTP(s) post)
Figure3 Yealink IP phone acting as a server (SIP NOTIFY)
This chapter describes the available part of the LCD screen for each phone model of
Yealink IP phones as well as the keys that are controlled by the XML objects.
The LCD screen and keys available for XML applications on a Yealink SIP-T48G IP
phone are:
15 text lines and 1 soft key line for the LCD screen
The left and right arrow navigation keys

XML Browser Developer’s Guide for Yealink IP Phones
6
The up and down arrow navigation keys
The soft key line is a command line and will be used to display the labels of the
available actions. Depending on the XML object displayed on the phone, the X key
can also be interpreted as a “cancel” key, and the OK key as a “confirm” key.
The LCD screen and keys available for XML applications on a Yealink SIP-T46G/T29G IP
phone are:
10 text lines and 1 soft key line for the LCD screen
The left and right arrow navigation keys
The up and down arrow navigation keys
The soft key line is a command line and will be used to display the labels of the
available actions. Depending on the XML object displayed on the phone, the X key
can also be interpreted as a “cancel” key, and the OK key as a “confirm” key.
The LCD screen and keys available for XML applications on a Yealink SIP-T42G/T41P IP
phone are:
5 text lines and 1 soft key line for the LCD screen
The left and right arrow navigation keys
The up and down arrow navigation keys
The soft key line is a command line and will be used to display the labels of the
available actions. Depending on the XML object displayed on the phone, the X key
can also be interpreted as a “cancel” key, and the OK key as a “confirm” key.
The LCD screen and keys available for XML applications on a Yealink SIP-T27P IP phone
are:
7 text lines and 1 soft key line for the LCD screen
The left and right arrow navigation keys
The up and down arrow navigation keys

XML and Yealink IP Phones
7
The soft key line is a command line and will be used to display the labels of the
available actions. Depending on the XML object displayed on the phone, the X key
can also be interpreted as a “cancel” key, and the OK key as a “confirm” key.
The LCD screen and keys available for XML applications on a Yealink SIP-
T23P/T23G/T21(P) E2/T19(P) E2 IP phone are:
4 text lines and 1 soft key line for the LCD screen
The left and right arrow navigation keys
The up and down arrow navigation keys
The soft key line is a command line and will be used to display the labels of the
available actions. Depending on the XML object displayed on the phone, the X key
can be interpreted as a “cancel” key, and the OK key as a “confirm” key for
SIP-T23P/T23G/T21(P) E2 IP phones; the key can be as a “confirm” key for SIP-T19(P)
E2 IP phones.

XML Browser Developer’s Guide for Yealink IP Phones
8
Creating interactive service applications is relatively easy when you understand the
XML objects that are defined for Yealink IP phones and the behavior that each XML
object generates.
Regardless of what causes the phone to load an XML page, the phone always
behaves appropriately after it loads a page. Appropriate behavior depends only on
the type of data delivered in the page.
This chapter details all the XML objects supported by Yealink IP phones.
In this chapter:
Yealink IP phones with soft keys are:
Yealink SIP-T46G IP phones
Yealink SIP-T42G IP phones
Yealink SIP-T41P IP phones
Yealink SIP-T29G IP phones
Yealink SIP-T27P IP phones
Yealink SIP-T23P/G IP phones
Yealink SIP-T21(P) E2 IP phones
Yealink SIP-T19(P) E2 IP phones
Yealink IP phones with a color graphical touch screen are:
Yealink SIP-T48G IP phones
This section details each proprietary XML object supported by Yealink IP phones. You
can ask the distributor or Yealink FAE for XML object files or obtain XML object files
online:
http://support.yealink.com/documentFront/forwardToDocumentFrontDisplayPage.
Note
The size of an XML object cannot exceed 10000 bytes (10 kb).
Per XML specifications, only one XML object is supported in an XML document sent to the
phone.
XML objects do not support Chinese characters.

Yealink IP Phone XML Objects
9
The TextMenu object allows users to create a list of menu items on the IP phones. You
can use the TextMenu object to customize some functions such as weather report,
stock information, new services, etc. You can browse the menu items by linking HTTP
requests.
XML description of the TextMenu object:
<?xml version="1.0" encoding="ISO-8859-1"?>
<YealinkIPPhoneTextMenu
destroyOnExit="yes/no"
defaultIndex = "integer"
style = "numbered/none"
Beep = "yes/no"
wrapList="yes/no"
Timeout = "integer"
cancelAction = "URI"
LockIn = "yes/no"
>
<Title wrap = "yes/no">Menu Title</Title>
<MenuItem>
<Prompt>First menu item</Prompt>
<URI>HTTP(s) URL</URI>
<Dial>Number for dial</Dial >
<Selection>Selection</Selection>
</MenuItem>
<!--Additional menu items may be added (up to 30) -->
<!--Additional soft key items may be added -->
</YealinkIPPhoneTextMenu>
The parameters of the TextMenu object are listed in the following table:
Parameter
Position
Type
Value
Description
YealinkIPPh
oneTextMe
nu
Root tag
mandatory
none
The root element of the
TextMenu object.
destroyOn
Exit
Root tag
optional
“yes”
“no”
Select “yes”to return to
the previous XML object
after exit. Select “no”to

XML Browser Developer’s Guide for Yealink IP Phones
10
Parameter
Position
Type
Value
Description
return to the previous
screen, and keep in the
same XML object after
exit. Default value is
“no”.
defaultInde
x
Root tag
optional
Integer
Position of the cursor. If
the value is not specified
or exceeds the number
of menu items, the cursor
will be positioned on the
first menu item. Default
value is 1.
style
Root tag
optional
“numbered
”
“none”
numbered (default):Add
a digit before each menu
item for index.
none: No sign before
each menu item.
Beep
Root tag
optional
“yes”
“no”
Whether to play a tone
when the XML object is
opened. Default value is
“yes”.
wrapList
Root tag
optional
“yes”
“no”
Whether to display the
title of the menu item
specified by the Prompt
parameter in multi-lines
when the content of the
title is more than one
line. Select “yes” to
display the title in
multi-lines, and “no” for
one line. Default value is
“yes”. (only for
SIP-T48G/T46G/T29G IP
phones)
Note: It needs to add a
space to indicate a new
line.
Timeout
Root tag
optional
“integer”
If there is no operation at
a fixed interval (in
seconds) on the phone,

Yealink IP Phone XML Objects
11
Parameter
Position
Type
Value
Description
the phone will
automatically exit from
the TextMenu screen. If it
is set to 0, the phone will
not automatically exit
from the TextMenu
screen until pressing the
“Exit”soft key or “X”key.
Default value is 45.
Note: Pressing the “X”
key is not applicable to
SIP-T19(P) E2 IP phones.
Note: If “cancelAction” is
not left blank, the
function of “X” key is
calling the URI defined
by “cancelAction”.
If “cancelAction” is left
blank, the function of “X”
key is returning to the
idle screen.
cancelActi
on
Root tag
optional
URI
Define the URI to be
called when the user
cancels the XML object.
LockIn
Root tag
optional
“yes”
“no”
If it is set to “yes”, the
phone ignores specified
function key events.
Default value is “no”. For
more information, refer
to the function keys and
soft keys table shown
next.
Title
Body
mandatory
string
The title of the text menu.
wrap
Title tag
optional
“yes”
“no”
Whether to display the
title of the menu in
multi-lines when the
content of the title is
more than one line (up to
3 lines for SIP-T27 IP
phones; up to 2 lines for

XML Browser Developer’s Guide for Yealink IP Phones
12
Parameter
Position
Type
Value
Description
SIP-T42G/T41P/T23P/T23G/
T21(P) E2/T19(P) E2 IP
phones; not limit for
SIP-T48G/T46G/T29G with
space in title).
Select “yes” to display in
multi-lines, and “no” for
one line. Default value is
“yes”.
MenuItem
Body
mandatory
none
The element of the menu
item.
(Up to 30 instances,
minimum is 1)
Prompt
MenuItem
body
mandatory
string
The label of the menu
item.
URI
MenuItem
body
mandatory
URI
URI to be used if the user
presses the “Select”soft
key or “OK/√” key with
the cursor on this menu
item.
Dial
MenuItem
body
optional
Phone
number
Define what number will
be dialed when the user
picks up the handset, or
presses the
speakerphone key or the
line key.
Selection
MenuItem
body
optional
string
If “URI” is set to an HTTP
URL, the “?selection= xxx
(defined by the Selection
parameter)" will be
appended to the URI
when the user presses
the “Select”soft key or
the “OK/√” key.
Note: If a “?” already
exists in the URI, then a
“&” is used to separate
the URI and the Selection
parameters. The
parameter name