Yealink SIP VP-T49G Instruction 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.81..................................................... iv
Changes for Release 80, Guide Version 80.80..................................................... 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........................................................ v
Changes for Release 80, Guide Version 80.5........................................................ v
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....................................................... vi
Changes for Release 72, Guide Version 72.1....................................................... vi
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 ................................................. 9
XML Object Definitions................................................................................................ 9
TextMenu Object.................................................................................................... 10
TextScreen Object.................................................................................................. 19
InputScreen Object................................................................................................ 25
Directory Object..................................................................................................... 38

XML Browser Developer’s Guide for Yealink IP Phones
ii
Status Object .......................................................................................................... 46
Execute Object ....................................................................................................... 51
Configuration Object ............................................................................................. 56
FormattedTextScreen Object................................................................................ 57
ImageScreen Object ............................................................................................. 65
ImageMenu Object ............................................................................................... 71
Customizable Soft keys ............................................................................................. 78
XML Objects Pushed to the Phone ........................................................................... 81
Some Development Guidelines ............................................................................... 83
Configuring the HTTP Server .................................................. 85
Configuring the Push XML Server .......................................... 87
Yealink IP Phone XML Configurations .................................... 93
Configuring an XML Browser Key ............................................................................ 93
Configuring the Block XML in Calling ...................................................................... 99
Configuring the Push XML Server Address ........................................................... 100
Configuring the XML SIP Notify............................................................................... 102
Configuring the Default Input Method .................................................................. 104
Troubleshooting .....................................................................107
Troubleshooting Tools............................................................................................... 107
Parsing Error Debug Example................................................................................. 108
Appendix ...............................................................................109
Customizing an Image File ..................................................................................... 109

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 VP-T49G, SIP-T48G, SIP-T46G, SIP-T42G, SIP-T41P, SIP-T40P,
SIP-T29G, SIP-T27P, SIP-T23P/G, SIP-T21(P) E2, SIP-T19(P) E2 and CP860 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 CP860 and SIP VP-T49G IP phones have been
added.
Documentations of the newly released SIP-T40P IP phones have been added.
Major updates have occurred to the following sections:
Execute Object on page 51
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 104
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 9
TextMenu Object on page 10
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 9
Configuring an XML Browser Key on page 93

About This Guide
v
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 9
Customizable Soft keys on page 78
Configuring an XML Browser Key on page 93
Documentations of the newly released SIP-T23P/G 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 9
Customizable Soft keys on page 78
Configuring an XML Browser Key on page 93
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 9
Major updates have occurred to the following section:
Yealink IP Phone XML Objects on page 9
The following sections are new:
XML Format on page 2
Some Development Guidelines on page 83
Troubleshooting on page 107
Appendix on page 109

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 9
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 9
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 9
Major updates have occurred to the following section:
Yealink IP Phone XML Objects on page 9
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 9
Customizable Soft keys on page 78
XML Objects Pushed to the Phone on page 81
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 87

About This Guide
vii
Configuring the Block XML in Calling on page 99
Major updates have occurred to the following section:
Yealink IP Phone XML Objects on page 9