Yealink administrator guide is intended for administrators who need to properly configure,
customize, manage, and troubleshoot the IP phone system rather than end-users. This guide
helps you understand the Voice over Internet Protocol (VoIP) network and Session Initiation
Protocol (SIP) components, and provides descriptions of all available phone features.
This guide describes three methods for configuring IP phones: central provisioning, web user
interface and phone user interface. It helps you perform the following tasks:
Configure your IP phone on a provisioning server
Configure your phone’s features and functions via web/phone user interface
Introduction
Troubleshoot some common phone issues
Many of the features described in this guide involve network settings, which could affect the IP
phone’s performance in the network. So an understanding of IP networking and a prior
knowledge of IP telephony concepts are necessary.
The information detailed in this guide is applicable to firmware version 82 or higher. The
firmware format is like x.x.x.x.rom. The second x from left must be greater than or equal to 82
(for example, the firmware version of SIP-T46G IP phone: 28.82.0.20.rom).
See the
Yealink Products Regulatory Notices guide
Chapters in This Guide
This administrator guide includes the following chapters:
Chapter 1, “Product Overview” describes the SIP IP phones and expansion modules.
Chapter 2, “Getting Started” describes how Yealink phones fit in your network and how to
install and connect IP phones, and also gives you an overview of IP phone’s initialization
process.
Chapter 3, “Setting Up Your System” describes some essential information on how to set
up your phone network and set up your phone with a provisioning server.
for all regulatory and safety guidance.
Chapter 4, “Configuring Basic Features” describes how to configure the basic features on IP
phones.
Chapter 5, “Configuring Advanced Features” describes how to configure the advanced
features on IP phones.
Chapter 6, “Configuring AudioFeatures” describes how to configure the audio features on
IP phones.
v
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
Chapter 7, “Configuring SecurityFeatures” describes how to configure the security features
on IP phones.
Chapter 8, “Troubleshooting” describes how to troubleshoot IP phones and provides some
common troubleshooting solutions.
Chapter 9, “Appendix” provides the glossary, time zones, trusted certificates, auto
provisioning flowchart, reference information about IP phones compliant with RFC 3261,
SIP call flows and some other function lists (for example, DSS keys, reading icons).
Related Documentations
This guide covers SIP-T54S, SIP-T52S, SIP-T48G/S, SIP-T46G/S, SIP-T42G/S, SIP-T41P/S,
SIP-T40P/G, SIP-T29G, SIP-T27P/G, SIP-T23P/G, SIP-T21(P) E2 and SIP-T19(P) E2 IP phones. The
following related documents are available:
Quick Start Guides, which describe how to assemble IP phones and configure the most
basic features available on IP phones.
User Guides, which describe how to configure and use the basic and advanced features
available on IP phones via phone user interface or via web user interface.
Auto Provisioning Guide, which describes how to provision IP phones using the boot file
and configuration files.
The purpose of
Auto Provisioning Guide
is to serve as a basic guidance for provisioning
Yealink IP phones with a provisioning server. If you are new to this process, it is helpful to
read this guide.
Description of Configuration Parameters in CFG Files, which describes all configuration
parameters in configuration files.
Note that Yealink administrator guide contains most of parameters. If you want to find out
more parameters which are not listed in this guide, please refer to
Configuration Parameters in CFG Files
y000000000000.boot template boot file.
<y0000000000xx>.cfg and <MAC>.cfg template configuration files.
IP Phones Deployment Guide for BroadSoft UC-One Environments, which describes how to
guide.
Description of
configure BroadSoft features on the BroadWorks web portal and IP phones.
IP Phone Features Integrated with BroadSoft UC-One User Guide, which describes how to
configure and use IP phone features integrated with BroadSoft UC-One on Yealink IP
phones.
vi
When the SIP server type is set to BroadSoft, please refer to these two guides to have a
better knowledge of configuring and using features integrated with Broadsoft UC-One.
For support or service, please contact your Yealink reseller or go to Yealink Technical Support
online: http://support.yealink.com/.
Conventions Used in Yealink Documentations
Convention
Description
Bold
Highlights the web/phone user interface items such as menus,
menu selections, soft keys, or directory names when they are
involved in a procedure or user action (for example, Click on
Settings->Upgrade.).
Also used to emphasize text (for example, Important!).
Italics
Used to show the format of examples (for example,
http(s)://[IPv6
address]
), or to show the title of a section in the reference
documentations available on the Yealink Technical Support
Website (for example,
Triggering the IP phone to Perform the Auto
Provisioning
).
Blue Text
Used for cross references to other sections within this
documentation (for example, refer to Ring Tones on page 713), for
hyperlinks to non-Yealink websites (for example, RFC 3315) or for
hyperlinks to Yealink Technical Support website.
Blue Text in Italics
Used for hyperlinks to Yealink resources outside of this
documentation such as the Yealink documentations (for example,
Yealink_SIP_IP_Phones_Auto_Provisioning_Guide_V81
).
Convention
Description
<>
Indicates that you must enter information specific to phone or
network. For example, when you see <MAC>, enter your phone’s
12-digit MAC address. If you see <phoneIPAddress>, enter your
phone’s IP address.
->
Indicates that you need to select an item from a menu. For
example, Settings->Basic Settings indicates that you need to
select Basic Settings from the Settings menu.
Yealink documentations contain a few typographic conventions and writing conventions.
You need to know the following basic typographic conventions to distinguish types of in-text
information:
Introduction
You also need to know the following writing conventions to distinguish conditional information:
Reading the Configuration Parameter Tables
The feature descriptions discussed in this guide include two tables. One is a summary table of
provisioning methods that you can use to configure the features. The other is a table of details
of the configuration parameters that you configure to make the features work.
vii
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
This brief section describes the conventions used in the summary table and configuration
parameter table. In order to read the tables and successfully perform configuration changes, an
understanding of these conventions is necessary.
Summary Table Format
The following summary table indicates three provisioning methods (central provisioning, web
user interface and phone user interface, refer to Provisioning Methods for more information)
you can use to configure a feature. Note that the type of provisioning methods available for
each feature varies; not every feature uses all these three methods.
The central provisioning method requires you to configure parameters located in CFG format
configuration files that Yealink provides. For more information on configuration files, refer to
Configuration Files on page 101. As shown below, the table specifies the configuration file name
and the corresponding parameters. That is, the <MAC>.cfg file contains the
account.X.auto_answer
feature.auto_answer_delay
parameter, and the <y0000000000xx>.cfg file contains the
parameter.
The web user interface method requires you to configure features by navigating to the specified
link. This navigation URL can help you quickly locate the webpage where you can configure the
feature.
viii
Configuration Parameter Table Format
Sometimes you will see the words “Refer to the following content” in the Permitted Values or
cannot be configured via web/phone user interface.
The following configuration parameter table describes the parameter that you can configure to
make the feature (for example, auto answer) work.
Introduction
Note
Default field. It means the permitted value or the default value of the parameter has the model
difference or there are many permitted values of the parameter, you can get more details from
the following Description field.
The word “None” in the Web User Interface or Phone User Interface field means this feature
The above table also indicates three methods for configuring the feature.
Method 1: Central Provisioning
This table specifies the details of
the auto answer feature. This parameter is disabled by default. If you want to enable the auto
answer feature, open the MAC.cfg file and locate the parameter name
Set the parameter value to “1” to enable the auto answer feature or “0” to disable the auto
answer feature.
Note that some parameters described in this guide contain one or more variables (for example,
X or Y). But the variables in the parameters described in the CFG file are all replaced with specific
value in the scope of variable. You may need to assign a value to the variable before you search
account.X.auto_answer
parameter, which enables or disables
account.X.auto_answer
.
ix
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
and locate the specific parameter in the CFG file.
For example, if you want to enable the auto answer feature for account 1, you need to locate the
account.1.auto_answer
account.1.auto_answer = 1). If you want to configure the SIP server 1 for account 1, you can
locate the
example, account.1.sip_server.1.address = 10.2.1.48).
The following shows a segment of MAC.cfg file:
account.1.sip_server.1.address
in the MAC.cfg file and then configure it as required (for example,
in the MAC.cfg file and configure it as required (for
Method 2: Web User Interface
As described in the chapter SummaryTableFormat, you can directly navigate to the specified
webpage to configure the feature. You can also first log into the web user interface, and then
locate the feature field according to the web path (for example, Account->Basic->Auto
Answer) to configure it as required.
x
Introduction
As shown in the following illustration:
To successfully log into the web user interface, you may need to enter the user name (default:
admin) and password (default: admin). For more information, refer to Web User Interface on
page 98.
Method 3: Phone User Interface
You can configure features via phone user interface. Access to the desired feature according to
the phone path (for example, Menu->Features->Auto Answer->Line X->Auto Answer) and
then configure it as required.
As shown in the following illustration:
Recommended References
For more information on configuring and administering other Yealink products not included in
this guide, refer to product support page at Yealink Technical Support.
To access the latest Release Notes or other guides for Yealink IP phones, refer to the Document
Downloadpage for your phone at Yealink Technical Support.
xi
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
If you want to find Request for Comments (RFC) documents, type
http://www.ietf.org/rfc/rfcNNNN.txt
browser.
This guide mainly takes the SIP-T46G IP phones as example for reference. For more details on
other IP phones, refer to
For other references, look for the hyperlink or web info throughout this administrator guide.
Yealink phone-specific user guide
(NNNN is the RFC number) into the location field of your
.
Understanding VoIP Principle and SIP Components
This section mainly describes the basic knowledge of VoIP principle and SIP components, which
will help you have a better understanding of the phone’s deployment scenarios.
VoIP Principle
VoIP
VoIP (Voice over Internet Protocol) is a technology using the Internet Protocol instead of
traditional Public Switch Telephone Network (PSTN) technology for voice communications.
It is a family of technologies, methodologies, communication protocols, and transmission
techniques for the delivery of voice communications and multimedia sessions over IP networks.
The H.323 and Session Initiation Protocol (SIP) are two popular VoIP protocols that are found in
widespread implementation.
H.323
H.323 is a recommendation from the ITU Telecommunication Standardization Sector (ITU-T)
that defines the protocols to provide audio-visual communication sessions on any packet
network. The H.323 standard addresses call signaling and control, multimedia transport and
control, and bandwidth control for point-to-point and multi-point conferences.
It is widely implemented by voice and video conference equipment manufacturers, is used
within various Internet real-time applications such as GnuGK and NetMeeting and is widely
deployed by service providers and enterprises for both voice and video services over IP
networks.
xii
SIP
SIP (Session Initiation Protocol) is the Internet Engineering Task Force’s (IETF’s) standard for
multimedia conferencing over IP. It is an ASCII-based, application-layer control protocol
(defined in RFC 3261) that can be used to establish, maintain, and terminate calls between two
or more endpoints. Like other VoIP protocols, SIP is designed to address functions of signaling
and session management within a packet telephony network. Signaling allows call information
to be carried across network boundaries. Session management provides the ability to control
attributes of an end-to-end call.
Introduction
SIP provides capabilities to:
Determine the location of the target endpoint -- SIP supports address resolution, name
mapping, and call redirection.
Determine media capabilities of the target endpoint -- Via Session Description Protocol
(SDP), SIP determines the “lowest level” of common services between endpoints.
Conferences are established using only media capabilities that can be supported by all
endpoints.
Determine the availability of the target endpoint -- A call cannot be completed because
the target endpoint is unavailable, SIP determines whether the called party is already on
the IP phone or does not answer in the allotted number of rings. It then returns a message
indicating why the target endpoint is unavailable.
Establish a session between the origin and target endpoint -- The call can be completed,
SIP establishes a session between endpoints. SIP also supports mid-call changes, such as
the addition of another endpoint to the conference or the change of a media characteristic
or codec.
Handle the transfer and termination of calls -- SIP supports the transfer of calls from one
endpoint to another. During a call transfer, SIP simply establishes a session between the
transferee and a new endpoint (specified by the transferring party) and terminates the
session between the transferee and the transferring party. At the end of a call, SIP
terminates the sessions between all parties.
SIP Components
SIP is a peer-to-peer protocol. The peers in a session are called User Agents (UAs). A user agent
can function as one of following roles:
User Agent Client (UAC) -- A client application that initiates the SIP request.
User Agent Server (UAS) -- A server application that contacts the user when a SIP request is
received and that returns a response on behalf of the user.
User Agent Client (UAC)
The UAC is an application that initiates up to six feasible SIP requests to the UAS. The six
requests issued by the UAC are: INVITE, ACK, OPTIONS, BYE, CANCEL and REGISTER. When the
SIP session is being initiated by the UAC SIP component, the UAC determines the information
essential for the request, which is the protocol, the port and the IP address of the UAS to which
the request is being sent. This information can be dynamic and will make it challenging to put
through a firewall. For this reason, it may be recommended to open the specific application type
on the firewall. The UAC is also capable of using the information in the request URI to establish
the course of the SIP request to its destination, as the request URI always specifies the host
which is essential. The port and protocol are not always specified by the request URI. Thus if the
request does not specify a port or protocol, a default port or protocol is contacted. It may be
preferential to use this method when not using an application layer firewall. Application layer
xiii
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
firewalls like to know what applications are flowing through which ports and it is possible to use
content types of other applications other than the one you are trying to let through what has
been denied.
User Agent Server (UAS)
UAS is a server that hosts the application responsible for receiving the SIP requests from a UAC,
and on reception it returns a response to the request back to the UAC. The UAS may issue
multiple responses to the UAC, not necessarily a single response. Communication between UAC
and UAS is client/server and peer-to–peer.
Typically, a SIP endpoint is capable of functioning as both a UAC and a UAS, but it functions only
as one or the other per transaction. Whether the endpoint functions as a UAC or a UAS depends
on the UA that initiates the request.
xiv
Table of Contents
Table of Contents
Introduction.................................................................................... v
About This Guide ....................................................................................................................................................................... v
Chapters in This Guide ............................................................................................................................................................. v
Related Documentations ....................................................................................................................................................... vi
Conventions Used in Yealink Documentations ........................................................................................................... vii
Reading the Configuration Parameter Tables .............................................................................................................. vii
Summary Table Format ............................................................................................................................................... viii
Configuration Parameter Table Format .................................................................................................................. ix
Recommended References ................................................................................................................................................... xi
Understanding VoIP Principle and SIP Components ................................................................................................ xii
VoIP Principle ................................................................................................................................................................... xii
SIP Components ............................................................................................................................................................. xiii
Table of Contents ......................................................................... xv
Getting Started ............................................................................... 3
What IP Phones Need to Meet ............................................................................................................................................. 3
Yealink IP Phones in a Network ........................................................................................................................................... 3
Initialization Process Overview ............................................................................................................................................. 4
Setting Up Your System ................................................................ 7
Setting Up Your Phone Network ......................................................................................................................................... 7
Configuring Transmission Methods of the Internet Port and PC Port .................................................... 23
Configuring PC Port Mode ........................................................................................................................................ 26
Web Server Type ............................................................................................................................................................ 28
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
IPv6 Support .................................................................................................................................................................... 52
Quality of Service (QoS) .............................................................................................................................................. 81
Boot Files, Configuration Files and Resource Files .......................................................................................... 99
Setting Up a Provisioning Server .......................................................................................................................... 108
Keeping User Personalized Settings after Auto Provisioning ................................................................... 121
Configuring Basic Features ....................................................... 131
Power Indicator LED ............................................................................................................................................................. 133
Customizing a Screen Saver XML Template File ............................................................................................. 153
Power Saving .......................................................................................................................................................................... 169
Bluetooth .................................................................................................................................................................................. 179
Linekey Length in Short ...................................................................................................................................................... 190
Multiple Line Keys per Account ...................................................................................................................................... 199
Display Method on Dialing ............................................................................................................................................... 211
Time and Date ........................................................................................................................................................................ 213
NTP Time Server ........................................................................................................................................................... 214
Time and Date Settings ............................................................................................................................................. 219
Daylight Saving Time (DST) ..................................................................................................................................... 224
Language .................................................................................................................................................................................. 231
Loading Language Packs .......................................................................................................................................... 232
Specifying the Language to Use............................................................................................................................ 240
Specifying the Default Input Method.................................................................................................................. 246
Logo Customization ............................................................................................................................................................. 247
Customizing a Logo Template File ....................................................................................................................... 248
Configuring the Logo Shown on the Idle Screen ........................................................................................... 249
Key As Send ............................................................................................................................................................................. 261
Send Tone ................................................................................................................................................................................ 263
Key Tone ................................................................................................................................................................................... 264
Dial Plan .................................................................................................................................................................................... 265
Dial Plan using XML Template Files ..................................................................................................................... 266
Dial Plan using Digit Map String Rules ............................................................................................................... 281
Off Hook Hot Line Dialing ................................................................................................................................................. 297
Directory List ........................................................................................................................................................................... 299
Customizing a Directory Template File .............................................................................................................. 299
Search Source List In Dialing ............................................................................................................................................ 302
Customizing a Super Search Template File ...................................................................................................... 303
Save Call Log ................................................................................................................................................................. 306
Backing up the Call Logs .......................................................................................................................................... 308
Call List Show Number ........................................................................................................................................................ 311
Local Directory ....................................................................................................................................................................... 314
Customizing a Local Contact File .......................................................................................................................... 315
Backing up the Local Contacts ............................................................................................................................... 332
Live Dialpad ............................................................................................................................................................................. 334
Auto Redial .............................................................................................................................................................................. 342
Auto Answer ............................................................................................................................................................................ 345
IP Direct Auto Answer ......................................................................................................................................................... 350
Allow IP Call ............................................................................................................................................................................. 351
Accept SIP Trust Server Only ............................................................................................................................................ 352
Do Not Disturb (DND) ......................................................................................................................................................... 363
Busy Tone Delay .................................................................................................................................................................... 378
Return Code When Refuse ................................................................................................................................................ 380
Early Media .............................................................................................................................................................................. 381
180 Ring Workaround ......................................................................................................................................................... 382
Use Outbound Proxy in Dialog ....................................................................................................................................... 384
xvii
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
Call Hold ................................................................................................................................................................................... 392
Music on Hold (MoH) ................................................................................................................................................ 397
Call Transfer ............................................................................................................................................................................. 423
Local Conference ......................................................................................................................................................... 428
Transfer on Conference Hang Up .................................................................................................................................. 431
Transfer Mode via Dsskey.................................................................................................................................................. 432
Allow Trans Exist Call ........................................................................................................................................................... 434
Group Call Pickup ................................................................................................................................................................. 443
Dialog Info Call Pickup ........................................................................................................................................................ 450
Recent Call In Dialing .......................................................................................................................................................... 452
Call Number Filter ................................................................................................................................................................. 456
Call Park .................................................................................................................................................................................... 458
Calling Line Identification Presentation (CLIP) .......................................................................................................... 468
Connected Line Identification Presentation (COLP) ............................................................................................... 473
SIP Send MAC ......................................................................................................................................................................... 491
Reserve # in User Name ..................................................................................................................................................... 495
Unregister When Reboot ................................................................................................................................................... 499
Reboot in Talking .................................................................................................................................................................. 502
Answer By Hand .................................................................................................................................................................... 504
USB Recording ....................................................................................................................................................................... 505
CSTA Control ........................................................................................................................................................................... 506
CFG File Version Information Customization ............................................................................................................ 509
xviii
Table of Contents
Configuring Advanced Features ............................................... 511
Remote Phone Book ............................................................................................................................................................ 512
Customizing Remote Phone Book Template File ........................................................................................... 512
Visual Alert and Audio Alert for BLF Pickup ..................................................................................................... 537
BLF LED Mode ............................................................................................................................................................... 540
Configuring BLF LED Status and BLF DSS Key Behavior .............................................................................. 543
Configuring a BLF DSS Key ...................................................................................................................................... 556
Using BLF DSS Key to Initiate an Intercom Call .............................................................................................. 559
Busy Lamp Field (BLF) List ................................................................................................................................................. 561
Short Message Service (SMS) .......................................................................................................................................... 590
Dsskey Recording (Record and URL Record) ............................................................................................................ 607
Hot Desking ............................................................................................................................................................................. 614
Action URI ................................................................................................................................................................................ 641
Configuring Trusted IP Address for Action URI .............................................................................................. 645
Scenario A - Capturing the Current Screen of the Phone .......................................................................... 648
Scenario B - Placing a Call via Web User Interface ........................................................................................ 649
Server Redundancy............................................................................................................................................................... 650
Server Domain Name Resolution .......................................................................................................................... 665
Static DNS Cache................................................................................................................................................................... 669
Real-Time Transport Protocol (RTP) Ports .................................................................................................................. 677
XML Browser ........................................................................................................................................................................... 685
Configuring a Custom Key ....................................................................................................................................... 707
xix
Administrator’s Guide for SIP-T2 Series/T19(P) E2/T4 Series/T5 Series IP Phones
Example Macros ........................................................................................................................................................... 710
Configuring Audio Features ...................................................... 713
Redial Tone .............................................................................................................................................................................. 713
Ring Tones ............................................................................................................................................................................... 714
Distinctive Ring Tones ......................................................................................................................................................... 719
Voice Mail Tone ..................................................................................................................................................................... 734
Ringer Device for Headset ................................................................................................................................................ 735
Packetization Time (PTime) ..................................................................................................................................... 751
Automatic Gain Control (AGC) ............................................................................................................................... 755
Transfer via DTMF ........................................................................................................................................................ 770
Play Local DTMF Tone ............................................................................................................................................... 772
Configuring Security Features .................................................. 793
User and Administrator Passwords................................................................................................................................ 793
Auto Logout Time ................................................................................................................................................................. 795
Exporting All the Diagnostic Files ......................................................................................................................... 850
Ping and Traceroute ................................................................................................................................................... 851
IP Address Issues.......................................................................................................................................................... 853
Time and Date Issues ................................................................................................................................................. 854
Phone Book Issues ...................................................................................................................................................... 855
Wi-Fi and Bluetooth Issues ...................................................................................................................................... 856
Firmware and Upgrading Issues ............................................................................................................................ 857
System Log Issues ....................................................................................................................................................... 859
Logo Issues ..................................................................................................................................................................... 869
Power and Startup Issues ......................................................................................................................................... 869
Other Issues ................................................................................................................................................................... 870
Appendix B: Time Zones .................................................................................................................................................... 875
RFC and Internet Draft Support ............................................................................................................................. 912
Successful Call Setup and Disconnect ................................................................................................................ 921
Unsuccessful Call Setup—Called User is Busy .................................................................................................. 923
Unsuccessful Call Setup—Called User Does Not Answer ............................................................................ 925
Successful Call Setup and Call Hold .................................................................................................................... 927
Successful Call Setup and Call Waiting .............................................................................................................. 930
Call Transfer without Consultation ....................................................................................................................... 934
Call Transfer with Consultation .............................................................................................................................. 938