Yealink AX83H Administrator's Manual
  1. Manuals
  2. Brands
  3. Yealink Manuals
  4. IP Phone
  5. AX83H
  6. Administrator's manual
Yealink AX83H Administrator's Manual

Yealink AX83H Administrator's Manual

Wi-fi ip phone
Hide thumbs Also See for AX83H:
1
Table Of Contents
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
Table of Contents

Advertisement

Quick Links

Download this manual

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the AX83H and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Yealink AX83H

Summary of Contents for Yealink AX83H

  • Page 2: Table Of Contents

    Administrator Guide Network Configurations Network Configurations Wi-Fi Wi-Fi Wi-Fi Wi-Fi You can configure the phones to operate in IPv4, IPv6, or dual-stack (IPv4/IPv6) mode and configure IPv4 or IPv6 wireless network settings manually. Wi-Fi Configuration Wi-Fi Configuration The following table lists the parameters you can use to configure Wi-Fi. Configuration parameter Configuration parameter static.wifi.function.enable...

  • Page 3: Static.wifi.function.enable

    Administrator Guide When the Wi-Fi signal strength of the static.netw device drops below this configured ork.wifi.roa value, the device will scan for a Integer from -100 to -30 ming_thres hotpot above the threshold value hold[1] and connect to it. It configures the time to wait Integer from 0 to 1440 (minutes) for the phone to switch to 0-The phone will not switch as long as...

  • Page 4: Static.wifi.x.security_Mode

    Administrator Guide It configures the priority for a specific wireless network. 5 is the highest priority, 1 is the lowest priority. static.wifi.X Integer from 1 to 5 .priority[2]  NOTE NOTE It works only if “static.wifi.enable” is set to 1 (Enabled).

  • Page 5: Static.wifi.f

    Administrator Guide It configures the EAP authentication username of a specific wireless network. static.wifi.X  NOTE NOTE .eap_user_ ASCII code from 1 to 32 in length Blank It works only if name[2] “static.wifi.enable” is set to 1 (Enabled) and “static.wifi.X.security_mode” is set to 802.1x EAP.
  • Page 6 Administrator Guide [2]X is Wi-Fi ID. X=1-5. Set via the Web User Interface Set via the Web User Interface On the web user interface, go to: Network Network > Wi-Fi Wi-Fi > Wi-Fi Active Wi-Fi Active Wireless Network IP Addressing Mode Configuration Wireless Network IP Addressing Mode Configuration The following table lists the parameters you can use to configure IP addressing mode for the wireless network.
  • Page 7 Administrator Guide 0-IPv4 It configures the IP addressing mode for the wireless static.network.wifi.ip_ 1-IPv6 network. address_mode 2-IPv4 & IPv6 It specifies IPv4 or IPv6 as the preferred wireless network in a Dual-Stack mode. static.network.wifi.pre  NOTE NOTE 0-IPv6 ference 1-IPv4 It works only if “static.network.wifi.ip_address_mode”...

  • Page 8: Static.netw

    Administrator Guide It configures the Internet port type for the IPv4 wireless network. static.netw  NOTE NOTE ork.wifi.inte 0-DHCP rnet_port.ty 2-Static IP It works only if “static.network.wifi.ip_address_mode” is set to 0 (IPv4) or 2 (IPv4 & IPv6). It configures the IPv4 address for the wireless network. static.netw ...
  • Page 9 Administrator Guide It configures the primary IPv4 DNS server for the wireless network.  NOTE NOTE static.netw It works only if ork.wifi.pri IPv4 Address Blank “static.network.wifi.ip_address_mode” is set to 0 mary_dns (IPv4) or 2 (IPv4 & IPv6). In the DHCP environment, you also need to make sure “static.network.wifi.static_dns_enable"...
  • Page 10 Administrator Guide by using SLAAC (ICMPv6), DHCPv6, or by manually entering an IP address. Ensure that your network environment supports IPv6. Contact your ISP for more information. When you enable both SLAAC and DHCPv6 on the phone, the server can specify the IP phone to obtain the IPv6 address and other network settings either from SLAAC or from DHCPv6, if the SLAAC server is not working, the phone will try to obtain the IPv6 address and other network settings via DHCPv6.
  • Page 11 Administrator Guide It configures the IPv6 default gateway for the wireless network. static.netwo  NOTE NOTE rk.wifi.ipv6_i IPv6 Address Blank It works only if nternet_port "static.network.wifi.ipv6_internet_port.type" is set to .gateway 1 (Static IP). It triggers the static IPv6 DNS feature to on or off for the 0-Off, the phone wireless network.

  • Page 12: How To Access The Web User Interface

    Administrator Guide It enables or disables the phone to obtain IPv6 wireless network settings via SLAAC (Stateless Address Autoconfiguration). static.netwo rk.wifi.ipv6_i 0-Disabled  NOTE NOTE cmp_v6.ena 1-Enabled It works only if “static.network.wifi.ipv6_internet_port.type” is set to 0 (DHCP). Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Network Network >...

  • Page 13: Ipv4 And Ipv6 Network Settings

    Host Configuration Protocol (DHCPv4 or DHCPv6) server. We recommend using DHCP where possible to eliminate repetitive manual data entry. You can also configure IPv4 or IPv6 network settings manually.  NOTE NOTE Yealink devices comply with the DHCPv4 specifications documented in 2131, and DHCPv6 specifications documented in 4443. IP Addressing Mode Configuration IP Addressing Mode Configuration You can configure IP addressing mode for the Wi-Fi network.

  • Page 14: Ipv4 Configuration

    Administrator Guide 1. On the web user interface, go to Network Network > Wi-Fi Wi-Fi > Internet Port Internet Port. Configuration Parameter Configuration Parameter static.network.wifi.ip_address_mode static.network.wifi.preference Permitted Permitted Parameter Parameter Default Default Description Description Values Values 0 0 -IPv4 static.network.wifi.ip_addr 1 1 -IPv6 It configures the IP addressing mode.

  • Page 15: Configuration Parameter

    Administrator Guide Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Network Network > Wi-Fi Wi-Fi > IPv4 Config IPv4 Config. Configuration Parameter Configuration Parameter static.phone_setting.auto_switch_internet_port_type.enable static.phone_setting.auto_switch_internet_port_type.time static.network.wifi.internet_port.type static.network.wifi.internet_port.ip static.network.wifi.internet_port.mask static.network.wifi.internet_port.gateway static.network.wifi.static_dns_enable...
  • Page 16 Administrator Guide static.network.wifi.interne 0 0 -DHCP It configures the Internet port type t_port.type[1] 2 2 -Static IP for IPv4. It configures the IPv4 address.  NOTE NOTE static.network.wifi.interne IPv4 Address Blank It works only if t_port.ip[1] static.network.wifi.internet_port.t is set to 2 (Static IP). It configures the IPv4 subnet mask.

  • Page 17: Static.network.wifi.secondary_Dns

    Administrator Guide It triggers the static DNS feature to on or off. 0-Off, the phone will use the IPv4 DNS obtained static.network.wifi.static_ from DHCP.  NOTE NOTE dns_enable[1] 1-On, the phone will use It works only if manually configured static.network.wifi.internet_port.t is set to 0 (DHCP).

  • Page 18: Ipv6 Configuration

    Administrator Guide [1]If you change this parameter, the phone will reboot to make the change take effect. IPv6 Configuration IPv6 Configuration If you configure the network settings on the phone for an IPv6 wired network, you can set up an IP address for the phone by using SLAAC (ICMPv6), DHCPv6, or by manually entering an IP address.
  • Page 19 Administrator Guide It configures the Internet port type for IPv6. static.network. 0 0 -DHCP (using  NOTE NOTE wifi.ipv6_inter SLAAC by default) It works only if static.network.ip_address_mode net_port.type[ 1 1 -Static IP set to 1 (IPv6) or 2 (IPv4 & IPv6). It configures the IPv6 address.

  • Page 20: Dhcp Option For Ipv4

    Administrator Guide It configures the primary IPv6 DNS server.  NOTE NOTE static.network. It works only ifstatic.network.ip_address_mode wifi.ipv6_prim IPv6 Address Blank set to 1 (IPv6) or 2 (IPv4 & IPv6). In DHCP ary_dns[1] environment, you also need to make sure is set to 1 static.network.wifi.ipv6_static_dns_enable (On).

  • Page 21: Supported Dhcp Option For Ipv4

    Administrator Guide Supported DHCP Option for IPv4 Supported DHCP Option for IPv4 The following table lists common DHCP options for IPv4 supported by Yealink phones. DHCP DHCP Parameters Parameters Description Description Option Option Subnet Mas Specify the client’s subnet mask.
  • Page 22 Description Description Yealink phones support using the NTP server address offered by DHCP. DHCP option 42 is used to specify a list of NTP servers available to the client by IP address. NTP servers should be listed in order of preference.
  • Page 23 Administrator Guide Configuration parameter Configuration parameter static.network.dhcp_host_nam Parameter Parameter Permitted Values Permitted Values Default Default Description Description static.network.dhcp_ho String within 99 SIP-Txx(you It specifies a hostname for the phone st_name[1] characters device model) when using DHCP. [1]If you change this parameter, the phone will reboot to make the change take effect. DHCP Option 60 DHCP Option 60 Description...
  • Page 24 3925. static.auto_provision.d It configures the vendor hcp_option.option60_v String within 99 characters yealink class identifier string to use alue in the DHCP interaction. Troubleshooting Troubleshooting To facilitate your confirmation of whether the phone has obtained the DHCP URL, T3X/T4XU/T5XW SIP phones have added a configuration option in versions x.86.0.129 and later to control whether to display the DHCP-obtained URL.

  • Page 25: Supported Dhcp Option For Ipv6

    Administrator Guide 1. On the web user interface, go to Settings Settings > Auto Provision Auto Provision > DHCP Server URL DHCP Server URL .  NOTE NOTE DHCP Server URL can not be edited. DHCP Option for IPv6 DHCP Option for IPv6 Introduction Introduction The phone can obtain IPv6-related parameters in an IPv6 network via DHCP option.

  • Page 26: Real-Time Transport Protocol (Rtp) Ports

    Administrator Guide DHCP Option 59 and Custom Option DHCP Option 59 and Custom Option During the startup, the phone automatically detects the DHCP option for obtaining the provisioning server address. The priority is as follows: custom option > option 59. Related Topic Related Topic DHCP Provision Configuration...

  • Page 27: Network Address Translation (Nat)

    The phones can traverse NAT gateways to establish and maintain connections with external devices. Yealink phones support three NAT traversal techniques: manual NAT, STUN, and ICE. If you enable manual NAT and STUN, the phone will use the manually configured external IP address for NAT traversal. The TURN protocol is used...
  • Page 28 Administrator Guide NAT Traversal Configuration NAT Traversal Configuration Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Network Network > NAT NAT. Configuration Parameter Configuration Parameter account.X.nat.nat_traversal static.network.static_nat.enable static.network.static_nat.addr static.sip.nat_stun.enable static.sip.nat_stun.server static.sip.nat_stun.port...

  • Page 29: Static.network.static_Nat.enable

    Administrator Guide static.networ 0 0 -Disabled k.static_nat. It enables or disables the manual NAT feature. 1 1 -Enabled enable[2] It configures the IP address to be advertised in SIP signaling. It should match the external IP address used by the NAT device. static.networ k.static_nat.

  • Page 30: Keep Alive

    [1]X is the account ID. [2]If you change this parameter, the phone will reboot to make the change take effect. Keep Alive Keep Alive Yealink phones can send keep-alive packets to the NAT device for keeping the communication port open.

  • Page 31: Parameter

    Administrator Guide Keep Alive Configuration Keep Alive Configuration Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Account Account > Advanced Advanced > Keep Alive Type Keep Alive Type /Keep Alive Interval(Seconds) Keep Alive Interval(Seconds).
  • Page 32 Administrator Guide Rport Rport Rport allows a client to request that the server sends the response back to the source IP address and port from which the request originated. It helps the phone traverse symmetric NATs. Rport feature depends on support from a SIP server. For more information, refer to 3581.
  • Page 33 Administrator Guide SIP Port and TLS Port SIP Port and TLS Port You can configure the SIP and TLS source ports on the phone. Otherwise, the phone uses default values (5060 for UDP/TCP and 5061 for TLS). If NAT is disabled, the port number shows in the Via and Contact SIP headers of SIP messages. If NAT is enabled, the phone uses the NAT port number (and NAT IP address) in the Via and Contact SIP headers of SIP messages, but still using the configured source port.
  • Page 34 Administrator Guide About VPN About VPN VPN (Virtual Private Network) is a network that uses a public telecommunication infrastructure, such as the Internet, to provide remote offices or traveling users with secure access to a central organizational network. VPN gives the organization the advantage of creating secure channels of communication, while at the same time reducing costs, improving security, and increasing performance.
  • Page 35 Administrator Guide SSL VPN uses the SSL protocol and Transport Layer Security (TLS) protocol to provide a secure connection between remote users and internal network resources. It can be used with a standard web browser and does not require the installation of specialized client software on the end user's device.
  • Page 36 Administrator Guide The following steps illustrate the principles of a VPN client-server interaction: 1. The VPN client connects to a VPN server via an external network interface. 2. The VPN server assigns an IP address to the VPN client from the VPN server's subnet. The client gets an internal IP address 192.168.1.192, for example, and creates a virtual network interface through which it will send encrypted packets to the other tunnel endpoint (the device at the other end of the tunnel).
  • Page 37 Administrator Guide OpenVPN server (e.g., OpenVPN 2.1.4.tar.gz) on the Linux platform (e.g., Centos 5.8 and kernel: 2.6.18 308.el5 i686). Before the installation, make sure the hardware and system meet the following requirements: Dual network cards. The system kernel supports the Universal TUN/TAP device driver (kernel 2.6.0 above) and the TUN/TAP module is loaded into the kernel.
  • Page 38 Administrator Guide To install the LZO module: To install the LZO module: 1. Open a terminal window. 2. Extract the installation package to the /etc directory. [root@localhost~]# cd /etc/ [root@localhost etc]# tar zvxf /lzo 2.02.tar.gz 3. Enter into the extracted directory. [root@localhost etc]# cd lzo 2.02 4.
  • Page 39 Country Name (2 letter code) [CN]: State or Province Name (full name) [FJ]: Locality Name (eg, city) [XM]: Organization Name (eg, company) [yealink.com]: Organizational Unit Name (eg, section) []:yealink.com Common Name (eg, your name or your server's hostname) [yealink.com CA]:server Name []: Email Address [admin@yealink.com]:...
  • Page 40 State or Province Name (full name) [FJ]: Locality Name (eg, city) [XM]: Organization Name (eg, company) [yealink.com]: Organizational Unit Name (eg, section) []:yealink.com Common Name (eg, your name or your server's hostname) [yealink.com CA]:server Name []: Email Address [admin@yealink.com]: yealink.com Please enter the following 'extra' attributes...
  • Page 41 State or Province Name (full name) [FJ]: Locality Name (eg, city) [XM]: Organization Name (eg, company) [yealink.com]: Organizational Unit Name (eg, section) []:yealink.com Common Name (eg, your name or your server's hostname) [yealink.com CA]:server Name []: Email Address [admin@yealink.com]: Please enter the following 'extra' attributes...
  • Page 42 Administrator Guide 6. Generate a dh1024.pem file for the server. [root@localhost 2.0]# ./build dh The screen prompts the following information: Generating DH parameters, 1024 bit long safe prime, generator 2 This is going to take a long time If the screen prompts “./build dh: line 7: dhparam: command not found”, you need to edit the file “build dh”...
  • Page 43 Administrator Guide 6. Edit the file “server.conf” according to your actual network environment and save the change. [root@localhost ~]# vi /etc/openvpn/server.conf Press the “I” key to enter into the Insert Mode and modify the desired parameters, and then press the “Esc” key to return to the Command Mode and enter “wq!”.
  • Page 44 The following parameters should be configured as the same as that of the server. remote 218.107.220.201 1194 udp dev tun dev type tun The following defines the OpenVPN certificates and key for Yealink phones: ca ca.crt cert client.crt key client.key...
  • Page 45 Administrator Guide To package the TAR file on the Linux platform: To package the TAR file on the Linux platform: 1. Enter the following commands to package the TAR file. [root@localhost ~]# cd /etc/openvpn/client [root@localhost client]# tar cvpf openvpn.tar * An openvpn.tar file is generated in the client directory.
  • Page 46 Country Name (2 letter code) [CN]: State or Province Name (full name) [FJ]: Locality Name (eg, city) [XM]: Organization Name (eg, company) [Yealink]: Organizational Unit Name (eg, section) []: Common Name (eg, your name or your server's hostname) []: CA...
  • Page 47 Country Name (2 letter code) [CN]: State or Province Name (full name) [FJ]: Locality Name (eg, city) [XM]: Organization Name (eg, company) [Yealink]: Organizational Unit Name (eg, section) []: Common Name (eg, your name or your server's hostname) []: Server Email Address [admin@yealink.com]:...
  • Page 48 Country Name (2 letter code) [CN]: State or Province Name (full name) [FJ]: Locality Name (eg, city) [XM]: Organization Name (eg, company) [Yealink]: Organizational Unit Name (eg, section) []: Common Name (eg, your name or your server's hostname) []: Client Email Address [admin@yealink.com]:...
  • Page 49 Administrator Guide 4. Edit the file “server.ovpn” according to your actual network environment and save the change. The following shows an example: According to the actual network environment, configure the network settings of the server, such as the TCP/IP forwarding feature, Internet connection sharing feature and routing entries between the VPN clients and the Intranet.
  • Page 50 Administrator Guide 4. Set “IPEnableRouter” “IPEnableRouter” to 1. To enable Internet connection sharing for inside network card: To enable Internet connection sharing for inside network card: 1. Open network connections. 2. Right click the local area network for the inside network card and select Properties Properties.
  • Page 51 The following parameters should be configured as the same as that of the server. remote 218.107.220.201 1194 udp dev tun dev type tun The following defines the OpenVPN certificates and key for Yealink phones: ca ca.crt cert client.crt key client.key The following figure shows a portion of the vpn.cnf file for reference:...
  • Page 52 Administrator Guide 5. Select tar from the Archive format drop down menu. 6. Click the OK OK button. An openvpn.tar file is generated in the directory C:/openvpn. Configure OpenVPN Feature on Phones Configure OpenVPN Feature on Phones OpenVPN feature is disabled on phones by default. You can enable the OpenVPN feature using configuration files, via the web user interface or phone user interface.

  • Page 53: Note Note

    Administrator Guide 1. On the web user interface, go to Network Network > Advanced Advanced > VPN VPN. Configuration parameter Configuration parameter static.network.vpn_enable static.openvpn.url static.network.openvpn_file.url Parameter Parameter Permitted Values Permitted Values Default Default Description Description static.network.vpn_ 0 0 -Disabled It enables or disables the OpenVPN feature. enable[1] 1 1 -Enabled URL within 511...
  • Page 54 Administrator Guide 1. Ensure that the OpenVPN server is up and running. If the OpenVPN server is running properly, a virtual IP address assigning to the OpenVPN server will appear when you hover your mouse pointer over the VPN icon. The VPN icon in the notification area of the system tray is shown as below: 2.
  • Page 55 Administrator Guide 4. Ensure that the following configurations in the server configuration file and client configuration file are exactly matched. 5. Ensure that the time and date on the phone is within the validity time of the certificate. 6. Check if the signature algorithm of the client certificate is supported by the phone. Phones support MD5 and SHA 1 signature algorithms.

  • Page 56: Example Configuration Files

    2. Ensure that an appropriate log level is set in the client configuration file. Yealink recommends you to set the log level to 3 (“verb 3” in the client configuration file). If the log level is set too high, the phone will log phone events frequently. This may cause phone performance issues.
  • Page 57 Administrator Guide Configurations may vary between different network environments. Server Configuration File Server Configuration File Client Configuration File Client Configuration File...

  • Page 58: Quality Of Service (Qos)

    Administrator Guide Quality of Service (QoS) Quality of Service (QoS) Introduction Introduction VoIP is extremely bandwidth and delay-sensitive. QoS is a major issue in VoIP implementations, regarding how to guarantee that packet traffic is not delayed or dropped due to interference from other lower priority traffic. VoIP can guarantee high-quality QoS only if the voice and the SIP packets are given priority over other kinds of network traffic.
  • Page 59 Administrator Guide  NOTE NOTE For voice and SIP packets, the phone obtains DSCP info from the network policy if LLDP feature is enabled, which takes precedence over manual settings. For more information on LLDP, refer to LLDP Configuration. Voice and SIP QoS Configuration Voice and SIP QoS Configuration Set via the Web User Interface Set via the Web User Interface...

  • Page 60: Authentication Configuration

    Administrator Guide 802.1x Authentication 802.1x Authentication About 802.1X About 802.1X Introduction Introduction The IEEE 802.1X standard defines a Port-based Network Access Control (PNAC) and authentication protocol that restricts unauthorized clients from connecting to a LAN. The IEEE 802.1X defines the encapsulation of the Extensible Authentication Protocol (EAP) defined in RFC3748 which is known as “EAP over LAN”...
  • Page 61 Administrator Guide 1. On the web user interface, go to Network Network > Advanced Advanced > 802.1x 802.1x. Configuration Parameter Configuration Parameter static.network.802_1x.root_cert_url static.network.802_1x.client_cert_url Permitted Permitted Parameter Parameter Default Default Description Description Values Values It configures the URL for uploading the 802.1x CA certificate. The format of the certificate must be *.pem, *.crt, *.cer or *.der.
  • Page 62 Administrator Guide 802.1X Authentication Flow 802.1X Authentication Flow Reboot the phone to activate the 802.1X authentication on the phone. The 802.1X authentication process is divided into two basic stages: Pre-authentication Pre-authentication The 802.1X pre-authentication process begins with the IP phone that contains a supplicant service used for negotiation and authentication.
  • Page 63 Administrator Guide 1. The supplicant sends an “EAPOL-Start” packet to the authenticator. 2. The authenticator responds with an “EAP-Request/Identity” packet to the supplicant. 3. The supplicant responds with an "EAP-Response/Identity" packet to the authenticator. 4. The authenticator strips the Ethernet header and encapsulates the remaining EAP frame in the RADIUS format, and then sends it to the authentication server.
  • Page 64 Administrator Guide Authentication Process Using EAP-TLS Protocol Authentication Process Using EAP-TLS Protocol Authentication Process Authentication Process The following figure illustrates the scenario of a successful 802.1X authentication process using the EAP-TLS protocol. 1. The supplicant sends an “EAPOL-Start” packet to the authenticator. 2.
  • Page 65 Administrator Guide 11. The supplicant responds with an “EAP-Response” packet to the authenticator. The packet includes a TLS change cipher spec message, a client certificate message, a client key exchange message, and a certificate verify message. 12. The authenticator passes the response to the authentication server. 13.
  • Page 66 Administrator Guide 1. The supplicant sends an “EAPOL-Start” packet to the authenticator. 2. The authenticator responds with an “EAP-Request/Identity” packet to the supplicant. 3. The supplicant responds with an "EAP-Response/Identity" packet to the authenticator. 4. The authenticator strips the Ethernet header and encapsulates the remaining EAP frame in the RADIUS format, and then sends it to the authentication server.
  • Page 67 Administrator Guide 9. The authentication server sends an “EAP-Request” packet to the authenticator. The packet includes a TLS server hello handshake message, a server certificate message, and a server hello done message. 10. The authenticator passes the request to the supplicant. 11.
  • Page 68 Administrator Guide 30. The authenticator passes the message to the supplicant. After the supplicant is authenticated successfully, the authenticator provides network access permissions. If the supplicant does not provide proper identification, the authentication server responds with a rejection message. The authenticator passes the message to the supplicant and blocks access to the LAN. If the supplicant is disabled or reset after successful authentication, the supplicant sends an EAPOL-Logoff message, which prompts the authenticator to block access to the LAN.

  • Page 69: Tr069 Device Management

    If the phone is authenticated successfully, capture the packet and feed it back to your network administrator. 4. Contact Yealink FAE for support when the above steps cannot solve your problem. a) Capture the packet and export configurations of the phone, switch, and authentication server.

  • Page 70: Supported Rpc Methods

    CPE and an ACS. An ACS can get or set parameters to configure and monitor the CPE by using the RPC methods. The following table provides a description of RPC methods supported by Yealink IP phones: RPC Method...
  • Page 71 Administrator Guide SetParamete This method is used to modify attributes associated with one or more CPE parameters. rAttributes Reboot This method causes the CPE to reboot. This method is used to cause the CPE to download a specified file from the designated location.
  • Page 72 Administrator Guide 1. On the web user interface, go to Settings Settings > TR069 TR069. Parameter Parameter Description Description Enable TR069 It enables or disables the TR-069 feature. It configures the TR-069 ACS server user name used to authenticate the phone. Leave ACS Username it blank if no authentication is required.
  • Page 73 Administrator Guide Permitted Permitted Parameter Parameter Default Default Description Description Values Values static.managementserver.en 0 0 -Disabled It enables or disables the TR-069 feature. able 1 1 -Enabled It configures the TR-069 ACS server user String within static.managementserver.us name used to authenticate the phone. Blank ername Leave it blank if no authentication is...

  • Page 74: Normative References

    Yealink_TR-069_DataModel_V4.0.xlsx . Contact the Yealink technical support for the data model file. Each of the parameters is marked as writable or non- writable. The phone does not permit the change of any parameter marked as read-only. Values applicable for the parameter, their type, and meaning are also precisely defined in the document.
  • Page 75 Administrator Guide Register Status: It shows the registration status of the current account. Register Status Line Active: You can enable/disable the account. Line Active Label: It is shown on the LCD to identify the account. Label Display Name: It is shown as a caller ID when placing a call. Display Name...
  • Page 76 Administrator Guide User Name: It is provided by ITSP for registration (necessary). Please connect with your VOIP Service provider to User Name get this information. Register Name: It is an authenticated ID for authentication provided by ITSP (necessary) Please connect with your Register Name VOIP Service provider to get this information.
  • Page 77 Administrator Guide String account.X.p within 99 Blank It configures password of the account. assword[1] characters account.X.si Integer p_server.ad It configures what SIP server to use for registering an account. from 1 to 10 dress It configures the re-registration period (in seconds) after the account registration fails.

  • Page 78: Registration Settings Configuration

    Administrator Guide Registration Settings Configuration Registration Settings Configuration The following table lists the parameters you can use to change the registration settings. Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Account Account >...

  • Page 79: Outbound Proxy In Dialog Configuration

    Administrator Guide It enables or disables the phone to account.X.subscribe_regi 0 0 -Disabled subscribe to the registration state ster[1] 1 1 -Enabled change notifications. phone_setting.disable_ac It enables or disables the phone to 0 0 -Disabled count_without_username disable the account whose 1 1 -Enabled .enable username is empty.

  • Page 80: Server Redundancy

    Administrator Guide 1. On the web user interface, go to Features Features > General Information General Information > Use Outbound Proxy In Dialog Use Outbound Proxy In Dialog . Configuration Parameter Configuration Parameter sip.use_out_bound_in_dialog Parameter Parameter Permitted Values Permitted Values Default Default Description...
  • Page 81 Administrator Guide Failover: In this mode, the full phone system functionality is preserved by having a second equivalent Failover capability call server take over from the one that has gone down/offline. This mode of operation should be done using the DNS mechanism from the primary to the secondary server. Therefore, if you want to use this mode, the server must be configured with a domain name.
  • Page 82 Working Server: Server 1 is configured with the domain name of the working server. For example Working Server yealink.pbx.com. The DNS mechanism is used such that the working server is resolved to multiple servers with different IP addresses for failover purposes. The working server is deployed in redundant pairs, designated as primary and secondary servers.

  • Page 83: Appendix A: Sip Server Name Resolution Configuration

    DNS cache for the phone. The phone will attempt to resolve the domain name of the server with a static DNS cache. For more information on static DNS cache, refer to Appendix B: Static DNS Cache. Configure Yealink Phones Configure Yealink Phones Set via the Web User Interface Set via the Web User Interface...
  • Page 84 Administrator Guide 4. Configure the parameters of SIP server 1 and SIP server 2 in the corresponding fields. 5. If you use outbound proxy servers, do the following: 1)Select Enabled Enabled from the Enable Outbound Proxy Server Enable Outbound Proxy Server drop-down menu. 2)Configure parameters of the outbound proxy server 1 and outbound proxy server 2 in the corresponding fields.
  • Page 85 Administrator Guide 3. Configure the registration parameters of the selected account in the corresponding fields. 4. Configure the parameters of the SIP server 1 or SIP server 2 in the corresponding fields. You must set the port of the SIP server to 0 for NAPTR, SRV, and A queries. 5.
  • Page 86 Administrator Guide 0 0 - It configures the registration mode in fallback mode. Concurrent account.X.fall registration back.redund  NOTE NOTE 1 1 - ancy_type[1] It is not applicable to outbound proxy servers. Successive registration It configures the time interval (in seconds) for the phone to detect whether the working server is available by sending the registration request after the fallback server takes over call account.X.fall...
  • Page 87 Administrator Guide It enables or disables the phone to only send requests to the registered server when encountering a failover. account.X.si p_server.Y. 0 0 -Disabled  NOTE NOTE only_signal 1 1 -Enabled It works only if _with_regis account.X.sip_serv tered[1] [2] er.Y.register_on_en is set to 1 able...
  • Page 88 Administrator Guide It configures the timeout (in seconds) for the phone to retry to send requests to the primary server after failing over to the current working server. If you set the parameter to 0, the phone will not send requests to the primary server until a account.X.si...
  • Page 89 Administrator Guide [1] X is the account ID. [2] Y is the server ID. Y=1-2. Appendix Appendix Appendix A: SIP Server Name Resolution Configuration Appendix A: SIP Server Name Resolution Configuration Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Account Account >...
  • Page 90 Administrator Guide It configures the transport sip.dns_tran 0 0 -UDP protocol the phone uses to sport_type 1 1 -TCP perform a DNS query. It configures the interval (in static.networ seconds) at which the phone k.dns.query_ Integer from 0 to 65535 retries to resolve a domain name timeout[3] when the DNS server does not...
  • Page 91 Administrator Guide dns_cache_naptr.X.service account.X.static_cache_pri[1 account.X.dns_cache_type dns_cache_naptr.X.name dns_cache_naptr.X.order dns_cache_naptr.X.preference dns_cache_naptr.X.replace dns_cache_naptr.X.ttl dns_cache_srv.X.name dns_cache_srv.X.port dns_cache_srv.X.priority dns_cache_srv.X.target dns_cache_srv.X.weight dns_cache_srv.X.ttl dns_cache_a.X.name dns_cache_a.X.ip dns_cache_a.X.ttl static.network.dns.ttl_enable static.network.dns.last_cache_expired static.network.dns.last_cache_expired.enable Parameter Parameter Permitted Values Permitted Values Default Default Description Description 0 0 -Perform real-time DNS query rather It configures whether the phone than using DNS cache.
  • Page 92 Administrator Guide dns_cache_n SIP+D2U-SIP over UDP SIP+D2U It configures the transport aptr.X.servic SIP+D2T-SIP over TCP SIP+D2T Blank protocol available for the SIP e[2] SIPS+D2T-SIPS over TLS SIPS+D2T server in NAPTR record X. It configures the time interval (in dns_cache_n seconds) that NAPTR record X Integer from 30 to 2147483647 aptr.X.ttl[2] may be cached before the record...
  • Page 93 This example shows how to configure a static DNS cache when your DNS server does not return A records. In this case, the static DNS cache on the phone provides A records. When the static DNS cache is used, the configurations would look as below: account.1.sip_server.1.address = yealink.pbx.com account.1.sip_server.1.port = 5060 account.1.sip_server.1.transport_type = 3 dns_cache_a.1.name = yealink.pbx.com...
  • Page 94 Administrator Guide account.1.sip_server.1.address = yealink.pbx.com account.1.sip_server.1.port = 0 account.1.sip_server.1.transport_type = 3 dns_cache_srv.1.name = _sip._tcp.yealink.pbx.com dns_cache_srv.1.port = 5060 dns_cache_srv.1.priority = 0 dns_cache_srv.1.target = server1.yealink.pbx.com dns_cache_srv.1.weight = 1 dns_cache_srv.1.ttl = 3600 dns_cache_srv.2.name = _sip._tcp.yealink.pbx.com dns_cache_srv.2.port = 5060 dns_cache_srv.2.priority = 0 dns_cache_srv.2.target = server2.yealink.pbx.com dns_cache_srv.2.weight = 2...

  • Page 95: Logon Wizard

    Administrator Guide Logon Wizard Logon Wizard Logon Wizard Logon Wizard Logon wizard allows the phones to provide the logon wizard during the first startup. It works only if there is no registered account on the IP phone. Logon Wizard Configuration Logon Wizard Configuration The following table lists the parameters you can use to configure the logon wizard.
  • Page 96 Administrator Guide It enables or disables the phone to provide an input field of password on the logon wizard after startup when there is no registered account. hotdesking.start 0-Disabled up_password_en  NOTE NOTE 1-Enabled able It works only if “phone_setting.logon_wizard” is set to 1 (Enabled).

  • Page 97: Local Directory

    1000 contacts and 48 groups. Contacts and groups can be added either one by one or in batches using a local contact file. Yealink phones support both *.xml and *.csv format contact files, but you can only customize the *.xml format contact file.
  • Page 98 Administrator Guide Local Contact File Elements and Attributes Local Contact File Elements and Attributes The following table lists the elements and attributes you can use to add groups or contacts in the local contact file. We recommend that you do not edit these elements and attributes. Elements Elements Attributes...
  • Page 99 [1] X is the account ID. Local Contacts Backup Local Contacts Backup Yealink phones support storing all local contacts to a contact file named . You can back up this <MAC>-contact.xml file to the server, avoiding data loss. Once the contacts update, the phone will automatically upload this file to the provisioning server or a specific server.
  • Page 100 Administrator Guide provisioning.The contact file is named after the MAC address of the IP phone. For example, if the MAC address of an IP phone is 00156574B150, the name of the contact file is 00156574B150-contact.xml (uppercase).  TIP MAC address, a unique 12-digit serial number is assigned to each phone. You can obtain it from the bar code on the back of the phone.

  • Page 101: Directory List For Directorydir Soft Key

    You can add the desired lists to the directory list using a directory list file (favorite_setting.xml). Directory List File Customization Directory List File Customization You can ask the distributor or Yealink FAE for a directory template. You can also refer to the following template:...
  • Page 102 Administrator Guide <?xml version="1.0"?> <root_favorite_set> <item id_name="localdirectory" display_name="Local Directory" priority="1" enable="1" dev="common"/> <item id_name="history" display_name="History" priority="2" enable="0" dev="common"/> <item id_name="networkcalllog" display_name="Network Call Log" priority="3" enable="0" dev="common"/> <item id_name="remotedirectory" display_name="Remote Phone Book" priority="4" enable="0" dev="common"/> <item id_name="ldap" display_name="LDAP" priority="5" enable="0" dev="T19 T21 T23 T40 T40G T27 T27G T29 T41 T42 T42 <item id_name="broadsoftdirectory"...
  • Page 103 Administrator Guide localdirecto history networkcall remotedire ctory ldap broadsoftdi rectory plcmdirecto gabdirector The existing directory list (For example, “localdirectory” for the local directory id_name list). pabdirector Note: Do not edit this field. metaswitch contacts metaswitch calllog uc_buddies mobilecont blocklist googledirec presencelist...

  • Page 104: Customizing Directory List File

    Administrator Guide Local Directory History Network CallLog Remote Phone Book LDAP Network Directories PhoneBook Global Address The display name of the directory list. Book display_na Note: We recommend that you do not edit this field. Network Directories and Personal Network CallLog lists are hidden for phones in GA firmware, GA firmware which Address is designed for the BroadWorks environment.
  • Page 105 Administrator Guide 2. To configure each directory list, edit the values within double quotes in the corresponding field. For example, enable the local directory, disable the history and specify a priority. <item id_name="localdirectory" display_name="Local Directory" priority="1" enable="1" dev="common"/ > <item id_name="history" display_name="History" priority="2" enable="0" dev="common"/ > Save the change and place this file to the provisioning server.
  • Page 106 Administrator Guide Integer greater directory_setting.ldap It configures the display priority of the LDAP. than or equal to .priority Example: Configuring a Directory List Example: Configuring a Directory List The following example shows the configuration for the directory list. Customize the directory list file, and then place this file to the provisioning server “http://192.168.10.25”. Example Example static.directory_setting.url = http://192.168.10.25/favorite_setting.xml...
  • Page 107 Administrator Guide It configures the IP address of the enterprise directory server. You need to configure the complete address (port is required), such as https://11.11.182.202/ser vices:443.  NOTE NOTE It works only if features.enter "features.enterprise_directory.enable" is set prise_director String Blank to 1 (Enabled).

  • Page 108: Lightweight Directory Access Protocol (Ldap)

    Administrator Guide It configures the password used for authentication of the enterprise directory. features.enter  NOTE NOTE prise_director String Blank It works only if y.password "features.enterprise_directory.authentication _type" is set to 1. Lightweight Directory Access Protocol (LDAP) Lightweight Directory Access Protocol (LDAP) Introduction Introduction LDAP (Lightweight Directory Access Protocol) is a client/server protocol for accessing a directory service.
  • Page 109 Administrator Guide Configure Yealink Phones Configure Yealink Phones Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Directory Directory > LDAP LDAP > LDAP enable LDAP enable , and then enter the desired values in the corresponding fields.
  • Page 110 Enable LDAP: Enabled LDAP Name Filter: (|(cn=%)(sn=%)) LDAP Number Filter: (|(telephoneNumber=%)(mobile=%)(ipPhone=%)) LDAP TLS Mode: LDAP Server Address: 10.3.6.128 Port: 389 Base: dc=yealink,dc=com Username: cn=Manager,dc=yealink,dc=com Password: secret Max Hits (1~32000): 50 LDAP Name Attributes: cn sn LDAP Number Attributes: mobile telephoneNumber ipPhone...

  • Page 111: Ldap.name_Filter

    Administrator Guide It configures the search criteria for LDAP contact names lookup. The “*” symbol in the filter stands for any character. The “%” symbol in the filter stands for the name entered by the user. Example: Example: ldap.name_filter = (|(cn=%)(sn=%)) When the cn or sn of the LDAP contact matches the ldap.name_ String within 99...

  • Page 112: Ldap.host

    Blank characters decreases directory search time. Example: Example: ldap.base = dc=yealink,dc=cn It configures the user name used to log into the LDAP server. This parameter can be left blank in case the server String within 512 allows anonymity to log into. Otherwise, you will ldap.user...

  • Page 113: Ldap.name_Attr

    Administrator Guide It configures the name attributes of each record to be returned by the LDAP server. It compresses the search results. You can configure multiple name ldap.name_ String within 512 attributes separated by spaces. Blank attr characters Example: Example: ldap.name_attr = cn sn This requires the “cn”...
  • Page 114 Administrator Guide It enables or disables the phone to search the telephone numbers starting with ”+” symbol and “00” from the LDAP server if the incoming phone number starts with”+” or “00”. When completing the LDAP search, all the search results will be displayed on the phone screen.
  • Page 115 60004 Size requested by the phone exceeds the attributes. limit exceeded server limits. 0x00030000000 Yealink FAE will do further analysis to give you a 60005 Phone error. solution ASAP. Compare False 0x00030000000 Yealink FAE will do further analysis to give you a 60006 Phone error.
  • Page 116 Yealink FAE can extension is requested by the phone. do further analysis. unavailable 0x00030000000 Yealink FAE will do further analysis to give you a 60010 No such Phone error. solution ASAP. attribute 1. Check the server.
  • Page 117 Loop detected comparison so that Yealink FAE can do further analysis. 0x00030000000 60050 Other (e.g., Yealink FAE will do further analysis to give you a Phone error. implementatio solution ASAP. n specific) error...
  • Page 118 3. If the above methods do not solve the problem, please provide the diagnostic file in the working scenario for comparison so that Yealink FAE can do further analysis. 0x00030000000 Yealink FAE will do further analysis to give you a 600c6 Local Phone error. solution ASAP. error...
  • Page 119 Administrator Guide 0x00030000000 Yealink FAE will do further analysis to give you a 600be Phone error. solution ASAP. Out of memory 0x00030000000 Yealink FAE will do further analysis to give you a 600bd Connect Phone error. solution ASAP. error 0x00030000000...
  • Page 120 Phone compatibility error. The phone 1. Adjust the server algorithm. 0x00030000000 and the server fail to negotiate a TLS 2. Yealink FAE will also do further analysis to give 60130 algorithm when using LDAPS. you a solution ASAP. 1. Change the phone TLS protocol version by pushing the configuration line security.default_ssl_method...
  • Page 121 Administrator Guide 1. Double-click the OpenLDAP application to start the installation. You will be prompted for the installation. 2. Click Yes Yes to continue the installation. 3. Follow the default settings and click Next Next until the Destination Folder Destination Folder screen appears. 4.
  • Page 122 Administrator Guide 5. Follow the default settings and click Next Next until the Ready to install OpenLDAP for Windows Ready to install OpenLDAP for Windows screen appears. 6. Click Install Install to start the installation. 7. Click Close Close to exit the Setup Wizard. For more information on how to install the OpenLDAP server for windows, refer to the website online: http://www.userbooster.de/en/support/feature-articles/openldap-for-windows-installation.aspx.
  • Page 123 Suffix "dc=yealink,dc=com" Rootdn "cn=Manager,dc=yealink,dc=com " The suffix line means that the domain name of the LDAP directory is yealink.com. The Rootdn line defines a management user named as Manager. If the domain name contains additional components, for example, yealink.com.cn, the suffix line will be edited as below: Suffix "dc=yealink,dc=com,dc=cn"...
  • Page 124 Open the LDIF file with your favorite text editor and input the corresponding content. The following shows an example of the content of the LDIF file: dn: dc=yealink,dc=com objectClass: top objectClass: dcObject...
  • Page 125 Administrator Guide dn: ou=roles,dc=yealink,dc=com objectClass: top objectClass: organizationalUnit ou: roles dn: ou=people,dc=yealink,dc=com objectClass: top objectClass: organizationalUnit ou: people dn: cn=Test Users,ou=roles,dc=yealink,dc=com objectClass: groupOfUniqueNames cn: Test Users uniqueMember: uid=sspecial,ou=people,dc=yealink,dc=com uniqueMember: uid=jbloggs,ou=people,dc=yealink,dc=com dn: cn=Special Users,ou=roles,dc=yealink,dc=com objectClass: groupOfUniqueNames cn: Special Users uniqueMember: uid=sspecial,ou=people,dc=yealink,dc=com...
  • Page 126 Administrator Guide 1. Click Start Start > Run Run. 2. Execute cmd cmd in the dialog and click OK OK to enter the command line interface. 3. Access the server installation path. For example, execute the following commands to access the server installation path at D:\OpenLDAP D:\OpenLDAP.
  • Page 127 Administrator Guide 4. Enter a name in the Configuration name Configuration name field under the Configuration Configuration tab. 5. Enter the domain name or IP address of the LDAP server in the Server name or IP Server name or IP field under the Server Server tab.
  • Page 128 The user DN and password correspond with the Rootdn and Rootpw defined in the slapd.conf file. For example, according to the manager information defined in the slapd.conf file: Rootdn "cn=Manager,dc=yealink,dc=com" Rootpw secret Enter cn=Manager,dc=yealink,dc=com cn=Manager,dc=yealink,dc=com in the User DN User DN field and secret secret in the Password Password field under the Connection tab.
  • Page 129 Administrator Guide 2. Right-click the root entry, and then select Add Add to add a new entry. 3. Enter the desired values in the corresponding fields. Parent DN: It will be automatically generated according to the server configuration. Parent DN Entry RDN: The format is cn=XXX.
  • Page 130 Administrator Guide 4. Select the desired attributes for the object class. Must attributes: Double-click attributes to add them to the entry node. All attributes listed in the Must Must attributes Must attributes field must be added and each value of the attribute must be set. attributes May attributes: Double-click the desired attributes to add them to the entry node.
  • Page 131 Administrator Guide 5. Right-click the selected attribute and then select Add value Add value. The screenshot of adding a new entry is shown as below: 6. Click Save Save to confirm the configuration. 7. Repeat steps 2 to 6 to add more contact entries. You can find the added entries at the left of the LDAP catalog.
  • Page 132 Administrator Guide Install the Microsoft Active Directory Domain Services Install the Microsoft Active Directory Domain Services This section shows you how to install an active directory on a Microsoft Windows Server 2008 R2 Enterprise 64-bit system. To install the Microsoft Active Directory Domain Services: To install the Microsoft Active Directory Domain Services: 1.
  • Page 133 Administrator Guide 4. Read the provided information and click Next Next. 5. Select the Create a new domain in a new forest Create a new domain in a new forest check box and click Next Next.
  • Page 134 Administrator Guide 6. Enter an appropriate domain name for the forest root domain and click Next Next. The wizard will check if the domain name is in use on the local network.
  • Page 135 Administrator Guide 7. Select the desired forest functional level from the Forest functional level Forest functional level drop-down menu, and click Next Next. For more information, click domain and forest functional levels domain and forest functional levels . 8. Select the desired domain functional level from the Domain functional level Domain functional level drop-down menu, and click Next Next.
  • Page 136 Administrator Guide  NOTE NOTE If you select Windows Server 2008 R2 Windows Server 2008 R2 for the forest functional level, you will not be prompted to select a domain functional level. The wizard will check if the DNS is properly configured on the local network.
  • Page 137 Administrator Guide 9. Select additional options for this domain controller if required, and click Next Next.  NOTE NOTE You may get a warning telling you that the server has one or more dynamic IP addresses. We recommend assigning a static IP address to the server. 10.
  • Page 138 Administrator Guide 11. Specify the desired paths for the database, log files, and SYSVOL folders, and click Next Next. For more information, click placing Active Directory Domain Services files placing Active Directory Domain Services files . 12. Configure the password for the active directory recovery mode, and click Next Next.
  • Page 139 Administrator Guide 13. Review your selection and click Next Next. The wizard will prompt that the system begins to create the Active Directory Domain Services.
  • Page 140 Administrator Guide 14. Click Finish Finish to complete the installation and exit the wizard. Install Active Directory Lightweight Directory Services Role Install Active Directory Lightweight Directory Services Role You should also install the Active Directory Lightweight Directory Services role on the Windows Server 2008 system. To install the Active Directory Lightweight Directory Services role: To install the Active Directory Lightweight Directory Services role: 1.
  • Page 141 Administrator Guide 3. The Add Roles Wizard will pop up, click Next Next. 4. Select the Active Directory Lightweight Directory Services Active Directory Lightweight Directory Services check box and click Next Next.
  • Page 142 Administrator Guide 5. Follow the default settings and click Next Next. 6. When the installation is completed, click Close Close. After the installation succeeds, you will find the Active Directory Lightweight Directory Services Active Directory Lightweight Directory Services role listed in the roles of the server manager.
  • Page 143 Administrator Guide 3. Right-click the domain name created above (e.g., ldap.yealink.com), and then select New New > Organizational Organizational Unit. Unit 4. Enter the desired name of the organizational unit. 5. Click OK OK to accept the change.
  • Page 144 Administrator Guide 6. Right-click the organizational unit created above, and then select New New > Contact Contact. 7. Enter the desired values in the corresponding fields. 8. Click OK OK to accept the change. 9. Double click the contact created above.
  • Page 145 ##Create a new organizational unit## dn: OU=yealink,DC=ldap,DC=yealink,DC=com changetype: add objectClass: top objectClass: organizationalUnit ou: yealink name: yealink ##create a new contact## dn: CN=san zhang,OU=yealink,DC=ldap,DC=yealink,DC=com changetype: add objectClass: top objectClass: person objectClass: organizationalPerson objectClass: contact cn: san zhang sn: zhang givenName: san...
  • Page 146 Administrator Guide To import the test.ldif file: To import the test.ldif file: 1. Click Start Start > Run Run. 2. Enter cmd cmd in the pop-up dialogue box and click OK OK to enter the command line interface. 3. Execute the command cd cd to access the path of the test.ldif file.
  • Page 147 Administrator Guide The first line lists the attributes of the entries. The second line lists the values of an organizational unit in the corresponding attribute columns. The other lines list the values of contacts in the corresponding attribute columns. To import the test.csv file: To import the test.csv file: 1.
  • Page 148 Roles > Active Directory Domain Services Active Directory Domain Services > Active Directory Users and Active Directory Users and Computers. Computers 3. Select the domain name created above (e.g., ldap.yealink.com). 4. Right click Users Users, and then select New New > User User.
  • Page 149 Administrator Guide 5. Enter desired values in the corresponding fields and click Next Next. 6. Enter the password for the user, select the appropriate options and click Next Next. The password should be a combination of upper case letters, lower case letters, numbers, and special characters.
  • Page 150 Administrator Guide 7. Click Finish Finish to complete the creation of the user account. Microsoft Active Directory Application Mode Microsoft Active Directory Application Mode Microsoft Active Directory Application Mode (ADAM) is a new mode of Active Directory that is designed specifically for directory-enabled applications.
  • Page 151 Administrator Guide 2. The Active Directory Application Mode Service Park 1 Installation Wizard will appear after a short while, click Next. Next...
  • Page 152 Administrator Guide 3. Read the software license agreement and select I Agree I Agree check box. And then click Next Next. The installation progress screen will be shown as below:...
  • Page 153 Administrator Guide 4. Click Finish Finish to complete the installation and exit the wizard. To create an ADAM instance: To create an ADAM instance: 1. Click Start Start > Programs Programs > ADAM ADAM > Create an ADAM instance Create an ADAM instance . It will prompt the following interface and click Next Next.
  • Page 154 Administrator Guide 3. Enter the desired name in the Instance name Instance name field and click Next Next. 4. Keep the default ports and click Next Next.
  • Page 155 Administrator Guide 5. Select the Yes, create an application directory partition Yes, create an application directory partition check box and enter the desired name (e.g., o=Yealink,c=CN) in the Partition name Partition name field, and then click Next Next. 6. Specify the desired paths for the data and data recovery files, and click Next Next.
  • Page 156 Administrator Guide It will pop up the following prompt box. Read the provided information and click Yes Yes. 8. Select the first check box to assign the administrative permissions for ADAM to the currently logged on user (e.g., USER-E5F3EA4782) and click Next Next.
  • Page 157 Administrator Guide 11. Review your selection and click Next Next. The installing progress is shown as below:...
  • Page 158 Administrator Guide 12. Click Finish Finish to complete the installation and exit the wizard. Configure the ADAM ADSI Edit Configure the ADAM ADSI Edit To configure the ADAM ADSI Edit: To configure the ADAM ADSI Edit: 1. Click Start Start > Programs Programs >...
  • Page 159 Distinguished name (DN) or naming context check box and enter the desired value (e.g., o=Yealink,c=CN) in the following field. 5. Click OK When the ADAM ADSI Edit connects an application directory partition (e.g., o=Yealink,c=CN) successfully, it will show as below: To create the object for ADAM:...
  • Page 160 Administrator Guide 1. Select and right click O=Yealink,c=CN O=Yealink,c=CN, and then select New New > Object Object. 2. Select organizationalUnit organizationalUnit and click Next Next. 3. Enter the desired value (e.g., ou1) in the Value Value field and click Next Next.
  • Page 161 Administrator Guide 4. Click Finish Finish to complete the creation of this object. You can also click More Attributes More Attributes to set more attributes for this object. 5. Select and right click OU=ou1 OU=ou1, and then select New New > Object Object.
  • Page 162 Administrator Guide 6. Select user user and click Next Next. 7. Enter the desired value (e.g., user1001) in the Value Value field and click Next Next.
  • Page 163 Administrator Guide 8. Click More Attributes More Attributes to set more attributes for this user. 9. In the dialog of Attributes, select the telephoneNumber telephoneNumber from the Select a property to view Select a property to view drop-down menu. Enter the desired telephone number (e.g., 1003) in the Edit Attribute Edit Attribute field and click Set Set.
  • Page 164 If you want to use the user created above to manage and search for information of LDAP, you need to add the user to the administrator group in advance. To add the user to the administrator group: To add the user to the administrator group: 1. Click ADAM1 ADAM1 > O=Yealink, c=CN O=Yealink, c=CN > CN=Roles CN=Roles.
  • Page 165 Administrator Guide 2. Select and right click CN=Administrators CN=Administrators, and then select Properties Properties. 3. Select the member member attribute in the Attributes Attributes box and click Edit Edit.
  • Page 166 Add ADAM Account . 5. In the dialog of adding the ADAM account, enter the desired distinguished name (e.g., CN=user1001,OU=ou1,o=Yealink,c=CN) in the field. 6. Click OK OK to accept the change and close the dialog of adding the ADAM account.
  • Page 167 Administrator Guide 2. Execute the command view permissions of o=Yealink,c=CN. dsacls \\localhost:389\o=Yealink,c=CN Sun One Directory Server Sun One Directory Server Sun One Directory Server, also known as Sun Java System Directory Server, is a component of the Java Enterprise System. Sun One Directory Server can be installed on multiple platforms, such as Windows, Linux, Solaris and so on.
  • Page 168 Administrator Guide 4. Save the hosts file. The following shows you how to install the Java Development Kit (JDK) 6 on your computer. You can download it online: http://www.oracle.com/technetwork/java/javase/downloads/index.html. To install the Java Development Kit (JDK) 6: To install the Java Development Kit (JDK) 6: 1.
  • Page 169 Administrator Guide...
  • Page 170 Administrator Guide 4. Click Finish Finish to finish the installation. After the installation, you need to configure environment variables. To configure environment variables: To configure environment variables: 1. Right click the My Computer My Computer icon and select Properties Properties. 2.
  • Page 171 Administrator Guide 6. Enter the variable value as the installation path (e.g., C:\Program Files\Java\jdk1.6.0_22) for the Java Development Kit. 7. Click OK 8. Repeat steps 4-7 to create a new system variable. Variable name: classpath Variable value: .;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar The dot “.” stands for the current path and it can’t be deleted. %JAVA_HOME% references the value of the specified JAVA_HOME variable created before.
  • Page 172 Administrator Guide 2. Enter cmd cmd in the dialog and click OK OK to enter the command line interface. 3. Execute the command java -version java -version to check the java version. 4. Execute the command java java to run the application.
  • Page 173 Administrator Guide 5. Execute the command javac javac to compile java files into class files. Install the Sun One Directory Install the Sun One Directory To install the Sun One Directory: To install the Sun One Directory: 1. Unpack the compressed files named Sun Java System Directory Server.5.2.P4.Windows.full.rar. 2.
  • Page 174 Administrator Guide 3. The Sun Java™ System Directory Distribution Version 5.2 Install Wizard will appear after a short while, click Next. Next 4. Read the software license agreement and click Yes (Accept License) Yes (Accept License).
  • Page 175 Administrator Guide 5. Enter the fully qualified name of the computer (e.g., ldapsun.yealinktest.com) in the Fully Qualified Computer Fully Qualified Computer Name field and click Next Name Next. The fully qualified name of the computer was planned before. For more information, refer to modify the hosts file of your computer.
  • Page 176 Administrator Guide 7. Select the Custom Custom check box and click Next Next. 8. Specify the desired installation directory and click Next Next. It prompts the following window. And you can click Create Directory Create Directory to create the directory or click Choose Choose New to select another path.
  • Page 177 Administrator Guide 9. Select the desired installation components and click Next Next. 10. Select The new instance will be the configuration Directory Server The new instance will be the configuration Directory Server check box and click Next Next.
  • Page 178 Administrator Guide 11. Select the Store data in the new Directory Server Store data in the new Directory Server check box and click Next Next. 12. Enter the value “ldapsun” in the Server Identifier Server Identifier field and keep the default values in the other two fields. And then click Next Next.
  • Page 179 Administrator Guide 13. Configure the password for the Directory Server Administrator and click Next Next. 14. Follow the default setting and click Next Next.
  • Page 180 Administrator Guide 15. Configure the password for the Directory Manager and click Next Next. The password must be at least 8 characters long. 16. Select the Create Sample Organizational Structure Create Sample Organizational Structure check box and click Next Next.
  • Page 181 Administrator Guide 17. Select the Populate with sample date Populate with sample date check box and click Next Next.
  • Page 182 Administrator Guide 18. Follow the default settings and click Next Next for the following two steps. 19. View the items to be installed and click Install Now Install Now.
  • Page 183 Administrator Guide The installing progress is shown as below: After the installation, it will enter the configuring screen.
  • Page 184 Administrator Guide 20. After the configuration, click Next Next to enter the installation summary screen. You can view the directory server installation status and click Details Details for more information. You can also click Close Close to close the Sun Java™ System Directory Distribution Version 5.2 Install Wizard.
  • Page 185 Administrator Guide 1. Click Start Start > Program Program > Sun Java™ System Server Products Sun Java™ System Server Products > Sun Java™ System Server Console 5.2. Sun Java™ System Server Console 5.2. It will enter the login screen. You should enter the administrator user name and its password in the User ID User ID field and Password Password field respectively.
  • Page 186 Administrator Guide 2. Double click ldapsun.yealinktest.com ldapsun.yealinktest.com > Server Group Server Group > Directory Server(ldapsun) Directory Server(ldapsun). It will enter the Directory Tasks interface. 3. Click the Directory Directory tab.
  • Page 187 Administrator Guide 4. Select and right click the dc=yealinktest,dc=com (6 acis) dc=yealinktest,dc=com (6 acis), and then select New New > Organizational Unit Organizational Unit. 5. Enter the desired name of the organizational unit. 6. Click OK OK to accept the change.
  • Page 188 Administrator Guide 7. Select and right click the organizational unit created above, and then select New New > User User. 8. Enter the desired values in the corresponding fields.
  • Page 189 Administrator Guide 9. Click OK OK to accept the change. You can view the user (User ID is ulin) created above under the organizational unit named ou2. Add Entries to the Directory Server Using the ldifde Tool Add Entries to the Directory Server Using the ldifde Tool You can use an LDIF file to perform a batch import of all entries to the Directory Server.
  • Page 190 Administrator Guide To import the test.ldif file: To import the test.ldif file: 1. On the home page of Sun Java™ System Server Console, double click ldapsun.yealinktest.com ldapsun.yealinktest.com > Server Group Server Group > Directory Server(ldapsun) Directory Server(ldapsun). It will enter the Directory Tasks Tasks interface.

  • Page 191: Remote Phone Book

    Administrator Guide You can view the imported the organizational unit (e.g., ou3) and user (e.g., uid=utest) under the path: Directory > dc=yealinktest,dc=com (6 acis) Directory dc=yealinktest,dc=com (6 acis). Remote Phone Book Remote Phone Book Introduction Introduction...

  • Page 192: Remote Phone Book File Customization

    You can add multiple contacts at a time and/or share contacts between the phones using the supplied template files (Menu.xml and Department.xml). You can ask the distributor or Yealink FAE for a remote phone book template. You can also refer to the following template: <YealinkIPPhoneDirectory>...

  • Page 193: Remote Phone Book Configuration

    Administrator Guide Specify a department/group file for a key: <SoftKeyItem> Specify *key, # key or digit key between <Name> <Name>#</Name> Menu.xml <URL>http://10.2.9.1:99/Department. </Name> xml</URL> Specify the department/group access URL between </SoftKeyItem> <URL> </URL> Customize Remote Phone Book File Customize Remote Phone Book File 1.
  • Page 194 Administrator Guide 1. On the web user interface, go to Directory Directory > Remote Phone Book Remote Phone Book . Configuration Parameter Configuration Parameter remote_phonebook.data.X.url remote_phonebook.data.X.name remote_phonebook.data.X.username remote_phonebook.data.X.password remote_phonebook.display_name features.remote_phonebook.enable features.remote_phonebook.flash_time remote_phonebook.assignment.enable handset.X.remote_phonebook_access Permitted Permitted Parameter Parameter Default Default Description Description Values Values...

  • Page 195: Errors And Solutions

    The following example shows the configuration for the remote phone book. Customize the “Department.xml “and “Menu.xml“ files, and then place these files to the provisioning server “http://192.168.10.25”. Example Example remote_phonebook.data.1.url = http://192.168.10.25/Menu.xml remote_phonebook.data.1.name = Yealink remote_phonebook.data.2.url = http://192.168.10.25/Market.xml remote_phonebook.data.2.name = Market Errors and Solutions Errors and Solutions...

  • Page 196: Xml Phonebook Configuration

    Ping feature. unavailable failure. Phone error. The 0x00090000 phone has 01060005 problems when Yealink FAE will also do further analysis to give you a solution ASAP. load remote loading the dir error contacts. XML Phonebook Configuration XML Phonebook Configuration Introduction...

  • Page 197: Directory Search Settings

    Administrator Guide You can get contacts by searching an XML phonebook in real time. For more information about XML Browser, please refer to XML Browser XML Phonebook Configuration XML Phonebook Configuration Configuration Parameter Configuration Parameter The following table lists the parameters you can use to configure the XML phonebook. xml_phonebook.data.X.url xml_phonebook.data.X.name xml_phonebook.data.X.username...
  • Page 198 Administrator Guide Introduction Introduction You can configure how the phones search contacts. Directory Search Settings Configuration Directory Search Settings Configuration Configuration Parameter Configuration Parameter directory.search_type directory.containing_search.additional_sorting_mode Parameter Parameter Permitted Values Permitted Values Default Default Description Description 0 0 -Approximate string matching, the phone will search the contact numbers or It configures the search type names containing the entered...
  • Page 199 Administrator Guide need to use regular expression matching to associate the incoming call number with the contact information. Number Matching Settings Configuration Number Matching Settings Configuration Configuration Parameter Configuration Parameter phone_setting.reverse_lookup.contact_list.replace.pattern phone_setting.reverse_lookup.contact_list.replace.with phone_setting.reverse_lookup.incoming_call.replace.pattern phone_setting.reverse_lookup.incoming_call.replace.with phone_setting.call_number_display.replace.pattern phone_setting.call_number_display.replace.with Permitted Permitted Parameter Parameter Default Default Description...
  • Page 200 Introduction Introduction Yealink phones record and maintain phone events to a call log, also known as a call list. Call log consists of four lists: Missed Calls, Placed Calls, Received Calls, and All Calls. Each call log list supports up to 100 entries.

  • Page 201: Call Log Configuration

    Administrator Guide Shows the name of the remote party. Name Number Shows the number of the remote party. Time Shows the call initiation time. Duration Shows the duration of the call. Shows what happened to the call. The valid display contents are: •...
  • Page 202 Administrator Guide features.save_call_history account.X.missed_calllog pstn.account.X.missed_calllog features.call_log_show_num features.calllog_detailed_information features.save_init_num_to_history.enable features.call_out_history_by_off_hook.enable features.call_log_merge.enable features.local_calllog.received.replace_rule Parameter Parameter Description Description Permitted Values Permitted Values Default Default It enables or disables the phone to log the call history (missed calls, placed calls, received calls and forwarded calls) in the call lists. 0-Disabled, the phone cannot log the features.sa placed calls, received calls, missed calls...
  • Page 203 Administrator Guide It configures the display type of the other parties’ information in the 0-Name, the name is displayed call log lists. preferentially; if there is no name, the features.cal number is displayed l_log_show  NOTE NOTE 1-Number _num 2-Name & Number, the name and It works only if number are displayed;...
  • Page 204 [1]X is the account ID. Call Logs Backup Call Logs Backup Yealink phones support storing all call logs to a call log file named . You can back up this file to <MAC>-calllog.xml the server, avoiding data loss. Once the call logs update, the phone will automatically upload this file to the provisioning server or a specific server.
  • Page 205 Administrator Guide  TIP MAC address, a unique 12-digit serial number is assigned to each phone. You can obtain it from the bar code on the back of the phone. The following table lists the parameters you can use to back up the call log. Configuration Parameter Configuration Parameter static.auto_provision.local_calllog.backup.enable...
  • Page 206 Administrator Guide It configures a path or URL for the phone to upload/download the file. <MAC>-calllog.xml If it is left blank, the phone connects to the provisioning server URL, and uploads/downloads the contact file “ <MAC>- ”. calllog.xml Example: static.auto_provision.local_ calllog.backup.path = http://192.168.1.20/calllog Once the call logs update,...

  • Page 207: Google Contacts Configuration

    Administrator Guide It configures the delay time (in seconds) for the phone to upload the <MAC>- file each time the calllog.xml call logs update. static.auto_ provision.lo  NOTE NOTE cal_calllog. Integer from 10 to 600 It works only if write_delay “static.auto_provision .terminated .local_calllog.backup.e...
  • Page 208 Administrator Guide It enables or disables the google_contact 0-Disabled phone to connect to the Google _server.enable 1-Enabled Contact Server. It configures the display mode of the Google contacts. 0-All downloaded Google contacts will be google_contact  NOTE NOTE displayed on the phone. _server.display 1-Only the Google contacts whose It works only if...
  • Page 209 Comparison of different contacts Comparison of different contacts Yealink supports multiple contact formats, and you may want to understand the differences, advantages, and disadvantages of different contact storage methods. This chapter aims to present the distinctions between various contact formats as comprehensively as possible.
  • Page 210 During the regular use of the functionality, you may encounter various issues. This article will primarily address common problems and provide corresponding solutions. If this article does not resolve your issue, please contact technical support for further assistance. https://ticket.yealink.com/index  NOTE NOTE The suggestions are for troubleshooting purposes and may or may not solve the issue.

  • Page 211: Xml Phonebook

    Administrator Guide This is normal in such cases. If you uploaded contacts using Autop or imported an XML file through the web interface, it will overwrite the existing contact data. Make sure that the newly uploaded file includes the existing contact data.
  • Page 212 Administrator Guide 1. Check network connectivity: Ensure that the phone can successfully ping the server's IP address. On the web user interface, go to Network Network > Diagnostics Diagnostics. 2. Verify certificate settings: Confirm that the device and server have the correct certificate settings (HTTPS). Both the server and the phone should have uploaded the appropriate certificates.
  • Page 213 3. Mismatched TLS versions or unsupported encryption algorithms can cause issues. Yealink devices default to supporting TLS 1.2. If you're using V81 firmware and unable to use TLS 1.2, please contact Yealink technical support for assistance.
  • Page 214 Client ID, please refer to the Google official website. 2. You can also contact Yealink technical support for assistance and they can provide you with a solution. Google Contacts login abnormality, with the same account, may require two login attempts to be successful.

  • Page 215: Audio Features

    LDAP server because different users have different naming conventions. It is challenging for the terminal devices to be compatible with all situations. Therefore, Yealink provides only three fields on the device to display the numbers in the order they are returned by the server. As a result, the displayed numbers may not match your expected display.ll situations.
  • Page 216 Administrator Guide On the web user interface, go to Features Features > Audio Audio > Redial Tone Redial Tone/Key Tone Key Tone/Send Tone Send Tone. Configuration Parameter Configuration Parameter features.call.dialtone_time_out phone_setting.outgoing_call_answer_tone.enable features.voice_mail_tone_enable Parameter Parameter Permitted Values Permitted Values Default Default Description Description It configures that after you enter a specific...
  • Page 217 Administrator Guide 0 0 -Default (depend on the country tone by account.X.dial_ton “voice.tone.country”) It configures the dial tone for the phone. 1 1 -440/250,0/250 2 2 -1000/250,0/250 It configures the duration time (in seconds) features.call.dialto that a dial tone plays before a call is Integer from 0 to 65535 ne_time_out dropped.

  • Page 218: Supported Tones

    Administrator Guide Introduction Introduction When receiving a message, the phone will play a warning tone. You can customize tones or select specialized tone sets (vary from country to country) to indicate different conditions of the IP phone. Supported Tones Supported Tones The default tones used on the phones are the US tone sets.

  • Page 219: Tones Configuration

    Administrator Guide Busy Busy When the callee is busy Call Waiting Call Waiting Call waiting tone (For more information on call waiting, refer to Call Waiting) Tones Configuration Tones Configuration Set via the Web User Interface Set via the Web User Interface 1.
  • Page 220 Administrator Guide Custom, Australia, Austria, Brazil, Belgium, Chile, China, Czech, Czech ETSI, Denmark, Finland, France, Germany, Great Britain, Greece, voice.tone.c It configures the country tone for the Hungary, Lithuania, India, Italy, Custom ountry phones. Japan, Mexico, New Zealand, Netherlands, Norway, Portugal, Spain, Switzerland, Sweden, Russia, United States It customizes the dial tone.
  • Page 221 Administrator Guide It customizes the ringback tone. The value format is Freq/Duration. For more information on the value format, refer to the parameter “voice.tone.dial”.  NOTE NOTE voice.tone.r String Blank It works only if “voice.tone.country” is set to Custom. If you want to disable this warning tone, set it to 0.
  • Page 222 Administrator Guide It configures the return code to play the congestion tone. Multiple codes are separated by commas. Example: features.congestion_tone.codelist = features.co 403,503,603 ngestion_to any code that the server can return Blank ne.codelist  NOTE NOTE The congestion tone can be customized by "voice.tone.congestion".
  • Page 223 Administrator Guide It customizes the info tone. The phone will play the info tone with the special information, for example, the number you are calling is not in service. The value format is Freq/Duration. For more information on the value format, refer to the parameter voice.tone.i “voice.tone.dial”.
  • Page 224 Administrator Guide It customizes the tone when the phone receives a text message. The value format is Freq/Duration. For more information on the value format, refer to the parameter “voice.tone.dial”.  NOTE NOTE It works only if voice.tone. String Blank “voice.tone.country”...
  • Page 225 Administrator Guide It customizes the dial tone when DND or call forward is activated or the phone has a new voice message. The value format is Freq/Duration. For more information on the value format, refer to the parameter “voice.tone.dial”.  NOTE NOTE voice.tone.s It works only if...

  • Page 226: Ringer Device Configuration

    Administrator Guide It enables or disables the phone to play a specified dial tone when the phone has a new voice message. The dial tone is configured by voice.tone.s "voice.tone.stutterdial". tutter_dial_ 0-Disabled tone.apply_ 1-Enabled to_vm.enab  NOTE NOTE It works only if “voice.tone.country”...

  • Page 227: Audio Volume

    Administrator Guide 1. On the web user interface, go to Features Features > Audio Audio > Ringer Device for Headset. Ringer Device for Headset. Configuration Parameter Configuration Parameter features.ringer_device.is_use_headset Permitted Permitted Parameter Parameter Default Default Description Description Values Values features.ringer_device.is_use_hea 0 0 -Use Speaker It configures the ringer device for the dset...

  • Page 228: Distinctive Ring Tones

    The distinctive ring tone priority is higher than the normal incoming calling tone setting. Supported Alert-Info Headers Format Supported Alert-Info Headers Format Yealink phones support Alert-Info headers in four formats: Bellcore-drN, ringtone-N (or MyMelodyN), and info=info text;x-line-id=0.  TIP If the Alert-Info header contains multiple types of keywords, the phone will process the keywords in the following order: AutoAnswer >...
  • Page 229 Administrator Guide Ring Tone Ring Tone Ring Tone Ring Tone Value of N Value of N (features.alert_info_tone = 1) (features.alert_info_tone = 1) (features.alert_info_tone = 0) (features.alert_info_tone = 0) Bellcore-dr1 Ring1.wav Bellcore-dr2 Ring2.wav Bellcore-dr3 Ring3.wav Bellcore-dr4 Ring4.wav Bellcore-dr5 Ring5.wav Ring6.wav Ring7.wav Ring8.wav Silent.wav Splash.wav...
  • Page 230 Administrator Guide Ringing Long 1025 Silent 2975 4000 4400 Ringing Short Silent Ringing Long 1000 1100 Bellcore-dr4 Silent Ringing Short Silent 2975 4000 4400 Bellcore-dr5 Ringing  NOTE NOTE If the user is waiting for a call, “Bellcore-dr5” is a splash ring tone reminding the user that the DND or Always CalForward feature is enabled on the server side.
  • Page 231 Administrator Guide Ring4.wav Ring4.wav Ring5.wav Ring5.wav Ring6.wav Ring6.wav Ring7.wav Ring7.wav Ring8.wav Ring8.wav Silent.wav Silent.wav Splash.wav Splash.wav N<1 or N>10 Ring1.wav Alert-Info: < URL > Alert-Info: < URL > When the Alert-Info header contains a remote URL, the phone will try to download the WAV ring tone file from the URL and then play the remote ring tone if is set to 1 (or the item called Distinctive Distinctive...

  • Page 232: Distinctive Ring Tones Configuration

    Administrator Guide Alert-Info: Auto Answer Alert-Info: info = alert-autoanswer Alert-Info: answer-after = 0 (or Alert-Info: Answer-After = 0) Alert-Info: Intercom If the auto answer tone feature is enabled, the phone plays a warning tone to alert you before answering an incoming call.

  • Page 233: Audio Codecs

    Administrator Guide Integer from 1 to 10 (the digit stands for the appropriate ring tone) or ring tone name: 1 1 or Ring1.wav Ring1.wav 2 2 or Ring2.wav Ring2.wav 3 or Ring3.wav Ring3.wav 4 4 or Ring4.wav Ring4.wav 5 5 or Ring5.wav Ring5.wav 6 6 or Ring6.wav Ring6.wav...

  • Page 234: Audio Codecs Configuration

    Administrator Guide PCMA(G.711A) G.711 a-law RFC 3551 64 Kbps 8 Ksps 20 ms PCMU(G.711μ) G.711 u-law RFC 3551 64 Kbps 8 Ksps 20 ms G729(G729A) G.729 RFC 3551 8 Kbps 8 Ksps 20 ms G726-16 G.726 RFC 3551 16 Kbps 8 Ksps 20 ms G726-24...
  • Page 235 Administrator Guide 1. On the web user interface, go to Account Account > Codec Codec > Audio Codec Audio Codec . Configuration Parameter Configuration Parameter account.X.codec.<payload_type>.enable account.X.codec.<payload_type>.priority phone_setting.talking_codec_display Permitted Permitted Parameter Parameter Default Default Description Description Values Values When the audio codec is G722, the default...
  • Page 236 Administrator Guide audio codec g729 g729-G729(G729A) g726_16 g726_16-G726-16 G729(G729A g726_24 g726_24-G726-24 account.X.c ), the g726_32 g726_32-G726-32 odec. 0 0 -Disabled default g726_40 g726_40-G726-40 <payload_t 1 1 -Enabled value is 1; ilbc ilbc-iLBC ype>.enabl When the Example Example: e[1] audio codec account.1.codec.g722.enable = 1 is G726-16, the default...
  • Page 237 Administrator Guide value is 3; pcma pcma-PCMA(G.711A) When the g729 g729-G729(G729A) audio codec g726_16 g726_16-G726-16 g726_24 g726_24-G726-24 G729(G729A g726_32 g726_32-G726-32 account.X.c ), the g726_40 g726_40-G726-40 odec. default ilbc ilbc-iLBC Integer <payload_t value is 4; Example Example: from 0 to 10 ype>.priorit When the account.1.codec.g722.priority = 1...

  • Page 238: Packetization Time (Ptime)

    Administrator Guide Packetization Time (PTime) Packetization Time (PTime) Introduction Introduction PTime is a measurement of the duration (in milliseconds) of how long the audio data in each RTP packet is sent to the destination, and defines how much the network bandwidth is used for the RTP stream transfer. Before establishing a conversation, codec and ptime are negotiated through SIP signaling.

  • Page 239: Early Media

    Administrator Guide Configuration Parameter Configuration Parameter account.X.ptime Permitted Permitted Parameter Parameter Default Default Description Description Values Values 0 0 -Disabled 10-10 20-20 account.X.ptime[1 It configures the ptime (in milliseconds) for the 30-30 codec. 40-40 50-50 60-60 Early Media Early Media Introduction Introduction The early media refers to the media (for example, audio and video) played to the caller before a SIP call is actually...

  • Page 240: Early Media Configuration

    Acoustic Clarity Technology Introduction Introduction To optimize the audio quality in your network, Yealink phones support acoustic clarity technology: Background Noise Suppression (BNS), Automatic Gain Control (AGC), Voice Activity Detection (VAD), Comfort Noise Generation (CNG), and jitter buffer. Noise Suppression...

  • Page 241: Background Noise Suppression (Bns)

    Administrator Guide The impact noise in the room is picked-up, including paper rustling, coffee mugs, coughing, typing, and silverware striking plates. These noises, when transmitted to remote participants, can be very distracting. You can enable the Noise Suppression feature to suppress these noises. Noise Suppression Configuration Noise Suppression Configuration voice.tns.enable...
  • Page 242 Administrator Guide Permitted Permitted Parameter Parameter Default Default Description Description Values Values 0 0 -Disabled It enables or disables the AEC (Acoustic Echo Canceller) voice.vad 1 1 -Enabled feature. Automatic Gain Control (AGC) Automatic Gain Control (AGC) Automatic Gain Control (AGC) applies to the hands-free operation and is used to keep audio output at nearly a constant level by adjusting the gain of signals in some circumstances.

  • Page 243: Comfort Noise Generation (Cng)

    Generation) feature. Jitter Buffer Jitter Buffer Yealink phones support two types of jitter buffers: fixed fixed and adaptive adaptive. A fixed jitter buffer adds the fixed delay to voice packets. You can configure the delay time for the static jitter buffer on the phones. An adaptive jitter buffer is...
  • Page 244 Administrator Guide added to packets can be also configured on the phones. Jitter Buffer Configuration Jitter Buffer Configuration Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Settings Settings > Voice Voice >...
  • Page 245 Administrator Guide It configures the maximum delay time (in milliseconds) of the jitter buffer in the wired network. Integer voice.jib.ma  NOTE NOTE from 0 to It works only if is set to 1 (Adaptive). The voice.jib.adaptive value of this parameter should be less than or equal to that of “voice.jib.normal”.
  • Page 246 Administrator Guide  NOTE NOTE The phones will not send the DTMF sequence when the call is placed on hold or is held. Transmit DTMF Digit Transmit DTMF Digit Three methods of transmitting DTMF digits on SIP calls: RFC 2833 ‒ DTMF digits are transmitted by RTP Events compliant with RFC 2833. You can configure the payload RFC 2833 type and sending times of the end RTP Event packet.
  • Page 247 Administrator Guide Permitted Values Permitted Values Parameter Parameter Default Default Description Description 0 0 -INBAND, DTMF digits are transmitted in the voice band. 1 1 -RFC2833, DTMF digits are transmitted by RTP Events compliant to RFC 2833. account.X.d 2 2 -SIP INFO, DTMF digits are It configures the DTMF type.
  • Page 248 Administrator Guide It configures the duration time (in milliseconds) for each digit when a sequence of DTMF tones is played out automatically.  NOTE NOTE If the time interval between two DTMF features.dt digits is less than this value, two or mf.duration Integer from 0 to 700 more same DTMF digits could be...

  • Page 249: Voice Quality Monitoring (Vqm)

    Voice quality monitoring feature allows the phones to generate various quality metrics for listening quality and conversational quality. These metrics can be sent between the phones in RTCP-XR packets. These metrics can also be sent in SIP PUBLISH messages to a central voice quality report collector. Yealink phones support two...
  • Page 250 Administrator Guide mechanisms for voice quality monitoring: RTCP-XR RTCP-XR and VQ-RTCPXR VQ-RTCPXR. RTCP-XR RTCP-XR The RTCP-XR mechanism, compliant with RFC 3611-RTP ControExtended Reports (RTCP XR) , provides the metrics contained in RTCP-XR packets for monitoring the quality of calls. These metrics include network packet loss, delay metrics, analog metrics, and voice quality metrics.
  • Page 251 Administrator Guide VQ-RTCPXR VQ-RTCPXR The VQ-RTCPXR mechanism, compliant with 6035, sends the service quality metric reports contained in SIP PUBLISH messages to the central report collector. A wide range of performance metrics are generated in the following three ways: Based on current values, such as jitter, jitter buffer max, and round trip delay. Covers the time period from the beginning of the call until the report is sent, such as network packet loss.
  • Page 252 Administrator Guide phone_setting.vq_rtcpxr.session_report.enable phone_setting.vq_rtcpxr.interval_report.enable phone_setting.vq_rtcpxr_interval_period phone_setting.vq_rtcpxr_moslq_threshold_warning phone_setting.vq_rtcpxr_moslq_threshold_critical phone_setting.vq_rtcpxr_delay_threshold_warning phone_setting.vq_rtcpxr_delay_threshold_critical Permitted Permitted Parameter Parameter Default Default Description Description Values Values phone_setti It enables or disables the phone to send a session quality report ng.vq_rtcpx 0 0 -Disabled to the central report collector at the r.session_re 1 1 -Enabled end of each call.
  • Page 253 Administrator Guide It configures the threshold value of the listening MOS score (MOS-LQ) multiplied by 10. The threshold value of MOS-LQ causes the phone to send a critical alert quality report to the central report collector. phone_setti For example, a configured value of 28 corresponds to the MOS ng.vq_rtcpx Integer score 2.8.
  • Page 254 Administrator Guide VQ-RTCPXR Display Configuration VQ-RTCPXR Display Configuration Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Settings Settings > Voice Monitoring Voice Monitoring > Display Report Options on Web Display Report Options on Web.
  • Page 255 Administrator Guide 1. On the web user interface, go to Account Account > Advanced Advanced > VQ RTCP-XR Collector Name/VQ RTCP-XR Collector VQ RTCP-XR Collector Name/VQ RTCP-XR Collector Address/VQ RTCP-XR Collector Port. Address/VQ RTCP-XR Collector Port Configuration Parameter Configuration Parameter account.X.vq_rtcpxr.collector_name account.X.vq_rtcpxr.collector_server_host account.X.vq_rtcpxr.collector_server_port...
  • Page 256 Administrator Guide system or specific line registration. To set the custom ring tones, you need to upload the custom ring tones to the IP phone in advance. You can also specify a period after which the phone will stop ringing if the call is not answered. Custom Ringtone Limit Custom Ringtone Limit The ringtone format must meet the following:...
  • Page 257 Administrator Guide It configures a ring tone. Example: Common, Ring1.wav, Ring2.wav, Ring3.wav, account.1.ringtone.ring_type = Ring4.wav, Ring5.wav, Ring6.wav, Ring3.wav Ring7.wav, Ring8.wav, Silent.wav, It means configuring Ring3.wav Splash.wav or custom ring tone name (for account.X.ri for account1. example, Custom ring.wav) ngtone.ring Common account.1.ringtone.ring_type = For T3 phones: _type[1]...
  • Page 258 Administrator Guide [1]X is the account ID. [2]X is the PSTN account ID. X=1-2. Set via the Web User Interface Set via the Web User Interface On the web user interface, go to: Account Account > Basic Basic > Ring Type Ring Type The priority of ringtone.
  • Page 259 Administrator Guide 2. Group Ringtone 2. Group Ringtone On the web user interface, go to Directory Directory > Local Directory Local Directory > > Group Setting. 3. Account Ringtone 3. Account Ringtone On the web user interface, go to Account Account >...
  • Page 260 Administrator Guide 4. Default Ringtone 4. Default Ringtone On the web user interface, go to Settings Settings > Preference Preference > Ring Type Ring Type . Smart Noise Filtering Smart Noise Filtering Smart Noise Filtering Smart Noise Filtering The phones can block out the slight noise from the far party when there is no speech in a call, and at the same time filter out the common transient noise (door closing, table knocking, and so on).

  • Page 261: Call Features

    Administrator Guide The following table lists the parameters you can use to configure smart noise filtering. Configuration Parameter Configuration Parameter features.noise_filtering_rev.enable Permitted Permitted Parameter Parameter Description Description Default Default Values Values It enables or disables the phone to block out the slight noise features.nois from the far end when there is no speech in a call.

  • Page 262: Basic Regular Expression Syntax For Four Patterns

    Pattern Description Description Replace Replace an alternative string that replaces the numbers entered by the user. Yealink phones support up rule rule replace rules. a string used to match numbers entered by the user. When entered numbers match the Dial now...

  • Page 263: Replace Rule File Customization

    The replace rule file helps create multiple replace rules. At most 100 replace rules can be added to the IP phone. You can ask the distributor or Yealink FAE for the replacement rule file template. You can also refer to the following template: <?xml version="1.0"...

  • Page 264: Replace Rule Configuration

    Administrator Guide You can ask the distributor or Yealink FAE for the dial now file template. You can also refer to the following template: <?xml version="1.0" encoding="UTF-8"?> <dialnow> <Data DialNowRule="1001" LineID="0" /> </dialnow> Dial Now File Attributes Dial Now File Attributes...
  • Page 265 Administrator Guide 1. On the web user interface, go to Settings Settings > Dial Plan Dial Plan > Replace Rule Replace Rule. Configuration Parameter Configuration Parameter dialplan.replace.prefix.X dialplan.replace.replace.X dialplan.replace.line_id.X dialplan_replace_rule.url Permitted Permitted Parameter Parameter Default Default Description Description Values Values dialplan.rep String lace.prefix.
  • Page 266 Administrator Guide Dial Now Configuration Dial Now Configuration You can configure dial now rules either one by one or in batches using a dial now template. Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Settings Settings >...

  • Page 267: Area Code Configuration

    Administrator Guide It configures the delay time (in seconds) for the dial now rule. When entered numbers match the predefined dial now rule, the phone_setti Integer phone will automatically dial out the entered number after the ng.dialnow_ from 0 to 14 designated delay time.
  • Page 268 Administrator Guide Permitted Permitted Parameter Parameter Default Default Description Description Values Values It configures the area code to be added before the entered numbers when dialing out. dialplan.are String  NOTE NOTE a_code.cod within 16 Blank The length of the entered number must be between the characters minimum length configured by the parameter and the maximum length...
  • Page 269 Administrator Guide 1. On the web user interface, go to Settings Settings > Dial Plan Dial Plan > Block Out Block Out. Configuration Parameter Configuration Parameter dialplan.block_out.number.X dialplan.block_out.line_id.X Permitted Permitted Parameter Parameter Default Default Description Description Values Values It configures the block out numbers. dialplan.bloc String Example...

  • Page 270: Auto Redial

    Administrator Guide After provisioning, the rules defined in this file are added to the IP phone, and you can use the replace rules on the phone. Auto Redial Auto Redial Auto Redial Auto Redial You can set the phone to automatically redial the last dialed number when the callee is temporarily unavailable. Both the number of attempts and waiting time between redials are configurable.

  • Page 271: Live Dialpad

    Administrator Guide Live Dialpad Live Dialpad Live Dialpad Live Dialpad Live Dialpad allows the phones to automatically dial out the entered phone number without pressing the send key after a designated period of time. Live Dialpad Configuration Live Dialpad Configuration The following table lists the parameters you can use to configure a live dialpad.

  • Page 272: Emergency Dialplan And Enhanced

    You can dial the emergency telephone number (emergency services number) at any time when the phone is powered on and has been connected to the network. It is available even if your phone keypad is locked or no SIP account is registered. Yealink phones support emergency dialplan and enhanced 911. Emergency Dial Plan Emergency Dial Plan You can configure the emergency dial plan for the phone (for example, emergency number, and emergency routing).

  • Page 273: Emergency Dialplan Configuration

    Administrator Guide the calling party. For example, if a caller makes an emergency call to E911, the feature extracts the caller's information for the police department to identify the caller's location immediately. Emergency Dialplan Configuration Emergency Dialplan Configuration Configuration parameter Configuration parameter dialplan.emergency.enable dialplan.emergency.asserted_id_source...
  • Page 274 Administrator Guide A number with 10 to 25 digits - for example, A number with 10 to 25 digits 1234567890. The SIP URI constructed from the number and SIP server (for example, abc.com) is included in the P-Asserted- Identity (PAI) header (for example, It configures the custom <sip:1234567890@abc.com >...

  • Page 275: Enhanced 911 Configuration

    Administrator Guide It configures the port of emergency server X to be used for routing calls. dialplan.em ergency.ser Integer from 0 to 65535 5060  NOTE NOTE ver.X.port[1 It works only if dialplan.emergency.enable is set to 1 (Enabled). It configures the transport protocol the phones use to communicate with the dialplan.em...
  • Page 276 Administrator Guide dialplan.emergency.held.server_url dialplan.emergency.held.secondary.server_url dialplan.emergency.held.request_type dialplan.emergency.held.request_element.X.name dialplan.emergency.held.request_element.X.value dialplan.emergency.held.username dialplan.emergency.held.password dialplan.emergency.held.secondary.username dialplan.emergency.held.secondary.password dialplan.emergency.held.nai.enable dialplan.emergency.held.location_retry_timer dialplan.emergency.held.prompt_enable dialplan.emergency.sip_header.geolocation_routing.enable sip.emgr.header dialplan.emergency.held.non_lldp.chassisid_portid_enable dialplan.emergency.held.resync_period Parameter Parameter Permitted Values Permitted Values Default Default Description Description It configures the primary Location Information Server URL for the phone to send HELD location request.
  • Page 277 Administrator Guide It configures the type of location SIMPLE or REDSKY SIMPLE REDSKY or YEALINK YEALINK request message. If it is set to SIMPLE SIMPLE, the phone will send the location request message  NOTE NOTE dialplan.eme defined in RFC5985.
  • Page 278 String Blank  NOTE NOTE password It works only if dialplan.emergency.held.request_ is set to YEALINK YEALINK or type REDSKY. REDSKY It configures the user name authentication when the phone sends location information to the secondary E911 Location Information Server.
  • Page 279 String Blank  NOTE NOTE secondary.p It works only if assword dialplan.emergency.held.request_ is set to YEALINK YEALINK or type REDSKY. REDSKY It enables or disables the phone to send Network Access Identifier (nai) information to the E911 Location Information Server.
  • Page 280 0 0 -Disabled prompt_ena 1 1 -Enabled  NOTE NOTE It works only if dialplan.emergency.held.request_ is set to YEALINK YEALINK or type REDSKY. REDSKY It enables or disables the phone to carry the geolocation-routing header 0 0 -The information "Geolocation- information in the E911 INVITE Routing: no"...
  • Page 281 If you lift the handset, press the Speakerphone key or the off- hook key, and do nothing for a specified time interval, the phone will automatically dial out the hotline number. Yealink phones only support one hotline number.  NOTE NOTE If you do not specify a line, the phone uses the first available line to dial out the hotline number by default.

  • Page 282: Off Hook Hot Line Dialing Configuration

    Administrator Guide Off Hook Hot Line Dialing Off Hook Hot Line Dialing For security reasons, the phones support off hook hotline dialing feature, which allows the phone to automatically dial out the pre-configured number when you call any number. The SIP server may then prompt you to enter an activation code for call service.

  • Page 283: Speed Dial

    Administrator Guide It enables or disables the phone to 0 0 -Disabled account.X.a automatically dial out a pre- 1 1 -Enabled, the phone will dial out the uto_dial_en configured number when a user pre-configured number (configured by able[1] calls any number. account.X.auto_dial_num It configures the number that the phone automatically dials out when...

  • Page 284: Call Timeout Configuration

    Administrator Guide Configuration Parameter Configuration Parameter features.key.x.speeddial_label features.key.x.speeddial_number features.key.x.speeddial_line Parameter Parameter Description Description Permitted Values Permitted Values Default Default features.key.x.speedd It configures the speed dial number String within 128 Blank ial_label identification of the numeric keys. characters features.key.x.speedd It configures the corresponding speed dial X =1-9.

  • Page 285: Anonymous Call Configuration

    Administrator Guide phone_setting.ringback_timeout phone_setting.ringing_timeout Permitted Permitted Parameter Parameter Default Default Description Description Values Values It configures the duration time (in seconds) in the phone_setting.ringb Integer from ringback state. ack_timeout 1 to 3600 If it is set to 180, the phone will cancel the dialing if the call is not answered after 180 seconds.
  • Page 286 Administrator Guide Configuration parameter Configuration parameter account.X.anonymous_call account.X.send_anonymous_code account.X.anonymous_call_oncode account.X.anonymous_call_offcode features.anonymous.feature_key_sync.enable Parameter Parameter Permitted Values Permitted Values Default Default Description Description 0 0 -Off account.X.a 1 1 -On, the phone will block its identity from It triggers the anonymous nonymous_ showing to the callee when placing a call.

  • Page 287: Call Number Filter

    Administrator Guide It configures the anonymous call off code. account.X.a The phone will send the nonymous_ String within 32 characters Blank code to deactivate the call_offcod anonymous call feature on e[1] server-side when you deactivate it on the phone. It enables or disables features.an synchronizing the onymous.fe...

  • Page 288: Ip Address Call Configuration

    Administrator Guide features.call_num_filter Permitted Permitted Parameter Parameter Default Default Description Description Values Values It configures the characters the phone filters when dialing. If the dialed number contains configured characters, the phone will automatically filter these characters when dialing. Example Example: features.call_num_filter = - If you dial 3-61, the phone will filter the character - and then features.call...

  • Page 289: Auto Answer

    Administrator Guide Configuration Parameter Configuration Parameter features.direct_ip_call_enable Permitted Permitted Parameter Parameter Default Default Description Description Values Values It enables or disables to allow IP address call. features.direct_ip_c 0 0 -Disabled  NOTE NOTE all_enable 1 1 -Enabled If you want to receive an IP address call, make sure is set to 0 (Disabled).

  • Page 290: Auto Answer Configuration

    Administrator Guide Auto Answer Configuration Auto Answer Configuration Set via the Web Interface Set via the Web Interface On the web user interface, go to: Account Account > Basic Basic > Account Account > Auto Answer Auto Answer Configuration Parameter Configuration Parameter account.x.auto_answer Parameter...

  • Page 291: Anonymous Call Rejection Configuration

    Administrator Guide Anonymous Call Rejection Anonymous Call Rejection Introduction Introduction Anonymous call rejection allows phones to automatically reject incoming calls from callers whose identity has been deliberately concealed. Anonymous call rejection can be performed locally or on the server. When performing anonymous call rejection locally, the phone sends the server a status message ”Status-Line: SIP/2.0 433 Anonymity Disallowed”.

  • Page 292: Call Waiting Configuration

    You can enable call waiting feature and set the phone to play a warning tone to avoid missing important calls during a call. Yealink phones also support call waiting on code and off code to activate and deactivate server-side call waiting feature. They may vary on different servers.
  • Page 293 Administrator Guide Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Features Features > General Information General Information > Call Waiting Call Waiting. 2. On the web user interface, go to Features Features >...
  • Page 294 Administrator Guide 0 0 -Disabled, a new incoming call is automatically rejected by the phone call_waiting It enables or disables the call- with a busy message during a call. .enable waiting feature. 1 1 -Enabled, the phone screen will present a new incoming call during a call.

  • Page 295: Call Hold Configuration

    Administrator Guide Call Hold Configuration Call Hold Configuration Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Features Features > General Information General Information > RFC 2543 Hold RFC 2543 Hold/Play Hold Tone Play Hold Tone/Play Hold Play Hold Tone Delay/Held Tone Interval...
  • Page 296 Administrator Guide 0 0 -Disabled, SDP media direction attribute It enables or disables the phone to use inactive “a=sendonly” is used outgoing hold signaling. when placing a call on account.X.h hold.  NOTE NOTE old_use_ina 1 1 -Enabled, SDP media ctive[1] direction attribute It works only if...

  • Page 297: Music On Hold (Moh) Configuration

    Administrator Guide It configures the time (in seconds) to wait for the phone to play the initial call held tone. If it is set to 30 (30s), the phone will wait 30 seconds to play the initial call held tone after you are held by the other party.
  • Page 298 Default Default Description Description It configures the address of the Music On Hold server. Examples for valid values: <10.1.3.165>, 10.1.3.165, sip:moh@sip.com, sip:moh@sip.com <yealink.com > or account.X.mu SIP URI within 256 yealink.com. sic_server_uri Blank characters  NOTE NOTE The DNS query in this parameter only...

  • Page 299: Call Forward Settings Configuration

    Administrator Guide 0 0 -Calling the Music On Hold server before account.X.mu holding the call It configures the way to process Music On Hold sic_on_hold_t 1 1 -Calling the Music On when placing an active call on hold. ype[1] Hold server after holding the call [1] X is the account ID.

  • Page 300: Call Forward Feature Configuration

    Call Forward Feature Configuration Call Forward Feature Configuration Yealink phones support call forward on code and off code to activate and deactivate server-side call forward feature. They may vary on different servers. Set via the Web User Interface Set via the Web User Interface 1.
  • Page 301 Administrator Guide Configuration parameter Configuration parameter account.X.always_fwd.enable account.X.always_fwd.target account.X.always_fwd.on_code account.X.always_fwd.off_code account.X.busy_fwd.enable account.X.busy_fwd.target account.X.busy_fwd.on_code account.X.busy_fwd.off_code account.X.timeout_fwd.enable account.X.timeout_fwd.target account.X.timeout_fwd.timeout account.X.timeout_fwd.on_code account.X.timeout_fwd.off_code account.x.fwd_diversion_hdr.enable Parameter Parameter Permitted Values Permitted Values Default Default Description Description It triggers always forward feature to on or off. 0 0 -Off 1 1 -On, incoming calls to the account account.X.a X are forwarded to the destination...
  • Page 302 Administrator Guide It configures the destination number of the always forward. account.X.a  NOTE NOTE lways_fwd.t String within 32 characters Blank It works only if features.fwd.allow arget[1] set to 1 (Enabled) and is set to 1 features.fwd_mode (Custom). It configures the always forward on code to activate the server-side always forward feature.
  • Page 303 Administrator Guide 0 0 -Off 1 1 -On, incoming calls to the account account.X.b X are forwarded to the destination It triggers the busy forward feature to usy_fwd.en number (configured by the on or off. able[1] parameter ) when the account.X.busy_fwd.target callee is busy.
  • Page 304 Administrator Guide It configures the busy forward off code to deactivate the server-side busy forward feature. The phone will send the busy forward off code to the server when you deactivate the busy forward feature on account.X.b the phone. usy_fwd.off String within 32 characters Blank _code[1]...

  • Page 305: Call Forward Synchronization For Server-Side Configuration

    Administrator Guide It configures the no answer forward on code to activate the server-side no answer forward feature. The phone will send the no answer forward on code and the pre-configured destination number (configured by the parameter account.X.timeout_fwd.target account.X.ti to the server when you activate the no meout_fwd.

  • Page 306: Call Transfer

    B, party A can transfer this call to party C (the third party). Then, party B will begin a new call with party C, and party A will disconnect. Yealink phones support call transfer using the REFER method specified in RFC 3515...

  • Page 307: Call Transfer Configuration

    Administrator Guide Transfer a call directly to another party without consulting. Blind transfer is implemented by Blind Transfer a simple REFER method without replacing the Refer-To header. Transfer a call after hearing the ringback tone. The semi-attended transfer is implemented Semi- by a REFER method with Replaces in the Refer-To header.
  • Page 308 Administrator Guide 0 0 -Disabled, call transfer feature is not features.tran It enables or disables the call available to users. sfer.allow transfer feature. 1 1 -Enabled 0 0 -Disabled, when the user presses the TRAN key after hearing the ringback tone, transfer.semi the phone will blind transfer the call.

  • Page 309: Do Not Disturb (Dnd)

    Administrator Guide 1.It enables or disables the phone to transfer the local conference call to the other two parties after the conference initiator drops the local conference call. transfer.tran 0 0 -Disabled _others_after 1 1 -Enabled _conf_enable  NOTE NOTE It works only if "account.X.conf_type"...

  • Page 310: Dnd Feature Configuration

    Administrator Guide 1. On the web user interface, go to Features Features > General Information General Information > Return Code When DND Return Code When DND. Configuration Parameter Configuration Parameter features.dnd.allow features.dnd_refuse_code Parameter Parameter Permitted Values Permitted Values Default Default Description Description 0 0 -Disabled, DND cannot be...
  • Page 311 Administrator Guide Yealink phones support DND on code and off code to activate and deactivate server-side DND features. They may vary on different servers. The following table lists the parameters you can use to configure DND. Set via the Web User Interface Set via the Web User Interface 1.

  • Page 312: Dnd Synchronization For Server-Side Configuration

    Administrator Guide It configures the DND on code to activate the server-side DND feature. The phone will send the DND on code to the server when you activate the DND feature on the phone. account.X.d nd.on_code[ String within 32 characters Blank ...
  • Page 313 Administrator Guide 0 0 -Disabled 1 1 -Enabled, the phone features.fea It enables or disables to synchronize the feature sends a SUBSCRIBE ture_key_sy status between the IP phone and the server. message with event nc.enable “as-feature-event”. It enables or disables the DND feature synchronization for account X.

  • Page 314: Conference Type Configuration

    603-Decline Conference Conference Introduction Introduction The Yealink phones support local conferences and network conferences. Conference Type Configuration Conference Type Configuration You can specify which type of conference to establish. Set via the Web User Interface Set via the Web User Interface 1.

  • Page 315: Network Conference Configuration

    Administrator Guide Configuration Parameter Configuration Parameter account.X.conf_type Permitted Permitted Parameter Parameter Default Default Description Description Values Values 0 0 -Local account.X.conf_typ Conference It configures the conference type for a specific account. e[1] 2 2 -Network Conference account.x.local_con 0 0 -Disabled It is used to configure whether to enable the Transfer on f.transfer_mode 1 1 -Enabled...

  • Page 316: Local Conference Configuration

    Local Conference Configuration Local Conference Configuration The local conference requires a host phone to process the audio of all parties. Yealink phones support up to 3 parties (5 parties for CP930W/CP935W)(including yourself) in a local conference call. Configuration Parameter...

  • Page 317: Multicast Paging Group Configuration

    Yealink phones support the following 31 channels: 0 0 : Broadcasts are sent to channel 0. Note that the Yealink phones running old firmware versions (an old paging mechanism) can be regarded as listening to channel 0. It is the default channel.
  • Page 318 Administrator Guide Configuration Parameter Configuration Parameter features.send_paging.enable multicast.paging_address.X.ip_address multicast.paging_address.X.label multicast.paging_address.X.channel Parameter Parameter Permitted Values Permitted Values Default Default Description Description Configure whether to enable Paging and Paging List features.  NOTE NOTE features.send 0 0 : Disable If set to 0, it will synchronize _paging.enabl 1 1 : Enable the hiding of functionality...

  • Page 319: Multicast Listening Group Configuration

    Administrator Guide 0 0 -all the Yealink phones running old firmware version or Yealink phones listen to channel 0 or third-party available devices in the paging group can receive the RTP stream. multicast.pagi It configures the channel of the 1 to 25-the Polycom or Yealink phones 1 to 25 ng_address.X.
  • Page 320 1 to 25 phone listens to. l[1] respectively from Yealink or Polycom phones. 26 to 30 -the phone can receive the RTP stream of the 26 to 30 pre-configured multicast address on the channel 26 to 30 respectively from Yealink phones.

  • Page 321: Multicast Paging Settings

    Administrator Guide Multicast Paging Settings Multicast Paging Settings You can configure some general settings for multicast paging, for example, specify a codec, and configure the volume and audio device for listening to a paging call. By default, all the listening groups are considered with a certain priority from 1 (lower priority) to 31 (higher priority).
  • Page 322 Administrator Guide 1. On the web user interface, go to Features Features > General Information General Information > Multicast Codec Multicast Codec. 2. On the web user interface, go to Directory Directory > Multicast IP Multicast IP > Ignore DND Ignore DND/Paging Priority Active Paging Priority Active/Paging Barge Paging Barge.
  • Page 323 Administrator Guide Parameter Parameter Permitted Values Permitted Values Default Default Description Description multicast.c It configures the codec for PCMU, PCMA, G729, G722 G722 odec multicast paging. 0 0 -Disabled, the phone will ignore the incoming multicast paging calls when It enables or disables the phone there is an active multicast paging call on multicast.re to handle the incoming multicast...
  • Page 324 Administrator Guide It configures the volume of the speaker when receiving the multicast paging calls. If it is set to 0, the current volume of the speaker takes effect. The volume of the speaker can be adjusted by pressing the Volume multicast.li key in advance when the phone is sten_addre...
  • Page 325 Call Mute Call Mute You can mute the microphone of the active audio device (handset, headset or speakerphone) on Yealink phones during an active call or when the phone is on the pre-dialing/dialing/calling/ringing screen. The call is automatically muted when setting up successfully. Muting before a call is answered prevents the other party from hearing the local discussion.
  • Page 326 Administrator Guide Keep mute, also known as persistent mute, allows you to keep the mute state persisting across calls. In a call center or meeting room, if incoming calls are answered automatically, the callers may hear the local discussion. Therefore, you can mute the phone in an idle state to prevent an unintended situation. The mute state persists across calls until you unmute the microphone manually or until the phone restarts.

  • Page 327: Security Features

    You can also customize the access permission for the configurations on the web user interface and phone/handset user interface. Yealink phones support the access levels of admin, var, and user. When logging into the web user interface or accessing advanced settings on the phone, as an administrator, you need an administrator password to access various menu options.
  • Page 328 Administrator Guide Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Security Security > Password Password. Configuration Parameter Configuration Parameter static.security.user_name.user static.security.user_name.admin static.security.user_name.var static.security.user_password static.security.custom_password_rule.X static.security.password_use_default.mode Parameter Parameter Permitted Values Permitted Values Default Default...
  • Page 329 Administrator Guide It configures the password. The phone uses “user” as the default user password, "var" as the default var password and “admin” as the default administrator password. The valid value format is :. Example: Example static.security.user_password = user:123 means setting the password of user to 123.

  • Page 330: User Access Level Configuration

    [1]If you change this parameter, the phone will reboot to make the change take effect. User Access Level Configuration User Access Level Configuration For more information, refer to Yealink SIP IP Phones Configuration Guide for User Access Level Configuration Parameter Configuration Parameter static.security.var_enable static.web_item_level.url...

  • Page 331: Auto Logout Time

    Administrator Guide [1]If you change this parameter, the phone will reboot to make the change take effect. Auto Logout Time Auto Logout Time Introduction Introduction Auto logout time defines how long the phone will log out of the web user interface automatically when you do not perform any actions on the web user interface.

  • Page 332: Phone Lock

    Administrator Guide Integer wui.login_wa It is used to configure the allowed duration before logging into from 1 to it_time the Web GUI configuration interface. Integer It is used to configure the allowed duration of inactivity after wui.stay_acti from 1 to logging into the Web GUI configuration interface (unit: ve_wait_time minutes).
  • Page 333 Administrator Guide It configures the idle time (in seconds) before the phone is automatically locked. The default value is 30 (the phone is locked only by long phone_settin pressing the # key). 0 0 or Integer g.phone_lock from 10 to .lock_time_o ...

  • Page 334: Transport Layer Security (Tls)

    Yealink phones support TLS version 1.2. When TLS is enabled for an account, the SIP message of this account will be encrypted, and a lock icon will appear on the LCD screen after the successful TLS negotiation.

  • Page 335: Supported Trusted And Server Certificates

    *.pem and *.cer and the maximum file size is 5MB. A unique A unique It is unique to an IP phone (based on the MAC address) and issued by the Yealink Certificate server server Authority (CA).
  • Page 336 Administrator Guide DigiCert High Assurance EV Root CA Deutsche Telekom Root CA 2 Equifax Secure Certificate Authority Equifax Secure eBusiness CA-1 Equifax Secure Global eBusiness CA-1 GeoTrust Global CA GeoTrust Global CA2 GeoTrust Primary Certification Authority GeoTrust Primary Certification Authority G2 GeoTrust Universal CA GeoTrust Universal CA2 Thawte Personal Freemail CA...

  • Page 337: Tls Configuration

     NOTE NOTE Yealink endeavors to maintain a built-in list of the most commonly used CA Certificates. Due to memory constraints, we cannot ensure a complete set of certificates. If you are using a certificate from a commercial Certificate Authority not in the list above, you can send a request to your local distributor. You can now upload your particular CA certificate into your phone.
  • Page 338 Administrator Guide Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Account Account > Register Register > SIP Server Y SIP Server Y > Transport Transport. 2. On the web user interface, go to Security Security >...
  • Page 339 Administrator Guide account.X.sip_server.Y.transport_type template.X.sip_server.Y.transport_type static.security.default_ssl_method static.security.server_ssl_method static.security.trust_certificates static.security.ca_cert static.security.cn_validation static.security.dev_cert static.trusted_certificates.url static.trusted_certificates.delete static.server_certificates.url static.server_certificates.delete static.phone_setting.reserve_certs_enable security.e911.ca_cert security.e911.dev_cert security.e911.cn_validation security.e911.trust_certificates Parameter Parameter Permitted Values Permitted Values Default Default Description Description account.X.si p_server.Y.t 0 0 -UDP ransport_ty 1 1 -TCP pe[1] [2] 2 2 -TLS It configures the type of template.X.
  • Page 340 Administrator Guide It enables or disables the phone to mandatorily validate the static.securi 0 0 -Disabled CommonName or ty.cn_valid 1 1 -Enabled SubjectAltName of the ation[3] certificate sent by the server. It configures the type of static.securi 0 0 -Default Certificates device certificates for the ty.dev_cert[ 1 1 -Custom Certificates...

  • Page 341: Secure Real-Time Transport Protocol (Srtp)

    Administrator Guide static.phon It enables or disables the e_setting.re 0 0 -Disabled phone to reserve custom Blank serve_certs 1 1 -Enabled certificates after it is reset _enable to factory defaults. It configures the type of certificates in the Trusted 0 0 -Default Certificates Certificates list for the security.e91 1 1 -Custom Certificates...

  • Page 342: Srtp Configuration

    Administrator Guide m=audio 11780 RTP/SAVP 0 8 18 9 101 a=crypto:1 AES_CM_128_HMAC_SHA1_80 > inline:NzFlNTUwZDk2OGVlOTc3YzNkYTkwZWVkMTM1YWFj a=crypto:2 AES_CM_128_HMAC_SHA1_32 > inline:NzkyM2FjNzQ2ZDgxYjg0MzQwMGVmMGUxMzdmNWFm a=crypto:3 F8_128_HMAC_SHA1_80 inline:NDliMWIzZGE1ZTAwZjA5ZGFhNjQ5YmEANTMzYzA0 a=rtpmap:0 PCMU/8000 a=rtpmap:8 PCMA/8000 a=rtpmap:18 G729/8000 a=fmtp:18 annexb=no a=rtpmap:9 G722/8000 a=fmtp:101 0-15 a=rtpmap:101 telephone-event/8000 a=ptime:20 a=sendrecv The callee receives the INVITE message with the RTP encryption algorithm and then answers the call by responding with a 200 OK message which carries the negotiated RTP encryption algorithm.

  • Page 343: Encrypting And Decrypting Files

    AES_CM_128_HMAC_SHA1_80, need to be separated by commas. AES_CM_128_HMAC_SHA1_32 Encrypting and Decrypting Files Encrypting and Decrypting Files Introduction Introduction Yealink phones support downloading encrypted files from the server and encrypting files before/when uploading them to the server.

  • Page 344: Configuration Files Encryption Tools

    , - . : = ? @ [ ] ^ _ { } ~. Configuration Files Encryption Tools Configuration Files Encryption Tools Yealink provides three configuration file encryption tools: Config_Encrypt_Tool.exe (via graphical tool for Windows platform) Config_Encrypt.exe (via DOS command line for Windows platform)
  • Page 345 Administrator Guide Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Settings Settings > Auto Provision Auto Provision > Common AES Key Common AES Key/MAC-Oriented AES Key MAC-Oriented AES Key. Configuration Parameter Configuration Parameter static.auto_provision.update_file_mode...
  • Page 346 Administrator Guide 0 0 -Disabled, the phone will download the configuration files (for example, sip.cfg, account.cfg, ) from the server <MAC>- local.cfg during auto provisioning no matter whether the files are encrypted or not. And then resolve these files and update settings static.auto_ It enables or disables the onto the phone system.
  • Page 347 Administrator Guide It configures the plaintext AES key for encrypting/decrypting the Common CFG/Custom CFG file. The valid characters contain: 0 ~ 9, A ~ Z, a ~ z and the following special characters are also supported: # $ % * + , - . : = ? @ [ ] ^ _ { } ~.
  • Page 348 Administrator Guide It configures the plaintext AES key for encrypting/decrypting the MAC-Oriented files <MAC>.cfg <MAC>- local.cfg <MAC>- contact.xml The valid characters contain: 0 ~ 9, A ~ Z, a ~ z and the following special characters are also supported: # $ % * + , - . : = ? @ [ ] ^ _ { } ~.
  • Page 349 Administrator Guide It configures the plaintext AES key for decrypting the Common CFG file. static.autop If it is configured, it has a rovision.X.c 16 characters Blank higher priority than the om_aes[1] value configured by the parameter static.auto_provision.aes_ke y.com It configures the plaintext AES key for decrypting the MAC-Oriented CFG file.

  • Page 350: Example: Encrypting Configuration Files

    The following example describes how to use “Config_Encrypt_Tool.exe” to encrypt the account.cfg file. For more information on the other two encryption tools, refer to Yealink Configuration Encryption Tool User Guide The way the phone processes other configuration files is the same as that of the account.cfg file.

  • Page 351: Incoming Network Signaling Validation Configuration

    Introduction Introduction Yealink phones support the following three optional levels of security for validating incoming network signaling: Source IP address validation : ensure the request is received from an IP address of a server belonging to the set Source IP address validation of target SIP servers.

  • Page 352: General Features

    If it is left blank, all events will be validated. General Features General Features Line Identification Presentation Line Identification Presentation Introduction Introduction Yealink phones can derive calling and connected line identification from SIP headers and display the name associated with the telephone number on the LCD screen.
  • Page 353 Calling Line Identification Presentation (CLIP) : It allows the phones to display the caller identity, derived from Calling Line Identification Presentation (CLIP) a SIP header contained in the INVITE message when receiving an incoming call. Yealink phones can derive caller identity from three types of SIP header: From...
  • Page 354 Administrator Guide account.X.cid_source account.X.cid_source_privacy account.X.cid_source_ppi sip.cid_source.preference account.X.cp_source Parameter Parameter Permitted Values Permitted Values Default Default Description Description 0 0 -FROM 1 1 -PAI 2 2 -PAI-FROM 3 3 -RPID-PAI-FROM account.X.c 4 4 -PAI-RPID-FROM It configures the identity of the id_source[1 5 5 -RPID-FROM caller.
  • Page 355 Administrator Guide It configures the priority order for the sources of caller identity information.  NOTE NOTE Preferred- Yealink phones can derive Identity, P- sip.cid_sour caller identity from the Asserted- ce.preferen String following SIP headers: From, Identity, P-Asserted-Identity (PAI), P-...
  • Page 356 Administrator Guide Return Code for Refused Call and not answer Configuration Return Code for Refused Call and not answer Configuration Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Features Features >...

  • Page 357: Accept Sip Trust Server Only Configuration

    Administrator Guide 404-Not Found 480- features.un Temporaril It configures a return code and reason for SIP response usual_refus messages when the phone rejects an incoming call unusually. A e_code Unavailable specific reason is displayed on the caller’s phone screen. 486-Busy Here 603-Decline 404-Not...

  • Page 358: Reliable Retransmission

    Administrator Guide 1. On the web user interface, go to Features Features > General Information General Information > Accept SIP Trust Server Only Accept SIP Trust Server Only . Configuration parameter Configuration parameter sip.trust_ctrl Parameter Parameter Permitted Values Permitted Values Default Default Description...

  • Page 359: Reliable Retransmission Configuration

    0a4f113b", qop=auth, nc=00000001 Content-Type: application/sdp Allow: INVITE, INFO, PRACK, ACK, BYE, CANCEL, OPTIONS, NOTIFY, REGISTER, SUBSCRIBE, REFER, PUBLISH, UPDATE, MESSAGE Max-Forwards: 70 User-Agent: Yealink T57W 96.86.0.70 Supported: 100rel Allow-Events: talk,hold,conference,refer,check-sync Content-Length: 302 100 Reliable Retransmission Configuration 100 Reliable Retransmission Configuration...

  • Page 360: Sip Session Timer Configuration

    Administrator Guide account.X.100rel_enab 0 0 -Disabled It enables or disables the 100 reliable le[1] 1 1 -Enabled retransmission feature. [1] X is the account ID. SIP Session Timer SIP Session Timer Introduction Introduction SIP session timers T1, T2 and T4 are SIP transaction layer timers defined in 3261.

  • Page 361: Session Timer

    Administrator Guide Configuration parameter Configuration parameter sip.timer_t1 sip.timer_t2 sip.timer_t4 Parameter Parameter Permitted Values Permitted Values Default Default Description Description sip.timer_t1 Float from 0.5 to 10 It configures the SIP session timer T1 (in seconds). sip.timer_t2 Float from 2 to 40 It configures the SIP session timer T2 (in seconds).

  • Page 362: Session Timer Configuration

    From: "10111" <sip:10111@10.2.1.48:5060 > ;tag=2170397024 To: <sip:1058@10.2.1.48:5060 > ;tag=200382096 Call-ID: 4_1556494084@10.10.20.32 CSeq: 2 UPDATE Contact: <sip:10111@10.10.20.32:5060 > Max-Forwards: 70 User-Agent: Yealink AX83H 96.86.0.70 Session-Expires: 90;refresher=uac Supported: timer Content-Length: 0 Session Timer Configuration Session Timer Configuration Set via the Web User Interface Set via the Web User Interface 1.

  • Page 363: Reboot In Talking Configuration

    Administrator Guide 0 0 -Disabled account.X.s 1 1 -Enabled, the phone will send ession_time periodic UPDATE requests to It enables or disables the session timer. r.enable[1] refresh the session during a call. It configures the interval (in seconds) for refreshing the SIP session during a call. An UPDATE will be sent after 50% of its value has elapsed.
  • Page 364 Administrator Guide 1. On the web user interface, go to Features Features > General Information General Information > Reboot in Talking Reboot in Talking. Configuration parameter Configuration parameter features.reboot_in_talk_enable Permitted Permitted Parameter Parameter Default Default Description Description Values Values features.reboot_in_ 0 0 -Disabled It enables or disables the phone to reboot during a call talk_enable...
  • Page 365 Contact: <sip:1010%23@10.3.20.6:5060> Content-Type: application/sdp Allow: INVITE, INFO, PRACK, ACK, BYE, CANCEL, OPTIONS, NOTIFY, REGISTER, SUBSCRIBE, REFER, PUBLISH, UPDATE, MESSAGE Max-Forwards: 70 User-Agent: Yealink AX83H 96.86.0.70 Allow-Events: talk,hold,conference,refer,check-sync Content-Length: 300 Reserve # in User Name Configuration Reserve # in User Name Configuration...

  • Page 366: Busy Tone Delay Configuration

    Administrator Guide Busy Tone Delay Busy Tone Delay Introduction Introduction The busy tone is an audible signal to indicate that the call is released by the other party. You can define the amount of time that the busy tone lasts. Busy Tone Delay Configuration Busy Tone Delay Configuration Set via the Web User Interface...
  • Page 367 Administrator Guide 0 0 -the phone will not play a busy tone. 1 1 -1s, a busy tone lasts for features.bus It configures the duration (in seconds) that the 1 second on the phone. y_tone_dela busy tone lasts when the call is released by the 3 3 -3s, a busy tone lasts for remote party.

  • Page 368: Advanced Features

    Call Pickup You can use call pickup to answer someone else’s incoming call on your phone. The Yealink phones support Directed Call Pickup and Group Call Pickup: Directed Call Pickup: allows you to pick up incoming calls to a specific phone.
  • Page 369 Administrator Guide It configures the directed call pickup code on a phone basis. Features > features.pic Pick up &  NOTE NOTE kup.direct_ String within 32 Park > Blank The code configured by pickup_cod characters Directed "account.X.direct_pickup_code” Call Pickup takes precedence over that Code configured by this parameter.
  • Page 370 Administrator Guide Group Call Pickup Group Call Pickup Group call pickup is used for picking up incoming calls within a predefined group. When any phone within a predefined group of phones receives an incoming call, you can pick up that call easily on the phone. If you enable group call pickup, the phone screen will display a GPickup soft key when picking up the handset, and pressing the Speakerphone key.
  • Page 371 Administrator Guide It configures the group call pickup code on a phone basis. Features > features.pic Pick up &  NOTE NOTE kup.group_ String within 32 Park > Blank The code configured by pickup_cod characters Group Call “account.X.group_pickup_code Pickup ” takes precedence over that Code configured by this parameter.

  • Page 372: Dialog Info Call Pickup

    Administrator Guide Dialog Info Call Pickup Dialog Info Call Pickup While some SIP servers implement directed call pickup using a directed call pickup code, others also support implementing this feature through SIP signals.  NOTE NOTE In this way, you do not need to configure the directed call pickup code. If you enable the phone to implement directed call pickup through SIP signals, the phone picks up an incoming call via an SIP INVITE message with a Replaces header.
  • Page 373 CSeq: 1 INVITE Contact: <sip:1010@10.10.20.18:5060> Content-Type: application/sdp Allow: INVITE, INFO, PRACK, ACK, BYE, CANCEL, OPTIONS, NOTIFY, REGISTER, SUBSCRIBE, REFER, PUBLISH, UPDATE, MESSAGE Max-Forwards: 70 User-Agent: Yealink SIP-T46G 28.82.0.20 Replaces: 0_1756536024@10.10.20.34;to-tag=3779921438;from-tag=3408640225 Allow-Events: talk,hold,conference,refer,check-sync Supported: replaces Content-Length: 304 Dialog Info Call Pickup Configuration Dialog Info Call Pickup Configuration The following table lists the parameters you can use to configure dialog Info call pickup.

  • Page 374: Call Completion

    Callee does not answer Callee actively rejects the incoming call before answering Yealink phones support call completion using the SUBSCRIBE/NOTIFY method, which is specified in draft-poetzl- sipping-call-completion-00, to subscribe to the busy party and receive notifications of their status changes.
  • Page 375 To: <sip:1000@10.2.1.48:5060>;tag=4025601441 Call-ID: 4_2103527761@10.10.20.32 CSeq: 2 SUBSCRIBE Contact: <sip:10111@10.10.20.32:5060> Accept: application/dialog-info+xml Max-Forwards: 70 User-Agent: Yealink SIP-T46G 28.82.0.20 Expires: 60 Event: dialog Content-Length: 0 Example of a NOTIFY message Example of a NOTIFY message The subscription (SUBSCRIBE message) of the dialog event “Call Completion” is confirmed by the busy party: NOTIFY sip:10111@10.10.20.32:5060 SIP/2.0...
  • Page 376 Via: SIP/2.0/UDP 10.10.20.31:5060;branch=z9hG4bK3431394016 From: <sip:1000@10.2.1.48:5060>;tag=1558968605 To: "10111" <sip:10111@10.2.1.48:5060>;tag=140677866 Call-ID: 0_2584152566@10.10.20.32 CSeq: 5 NOTIFY Contact: <sip:1000@10.10.20.31:5060> Content-Type: application/dialog-info+xml Max-Forwards: 70 User-Agent: Yealink SIP-T46G 28.82.0.20 Subscription-State: active;expires=48 Event: dialog Content-Length: 217 <?xml version="1.0"?> <dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" version="4" state="partial" entity="sip:1000@10.2.1.48:5060"> <dialog id="65644"> <state>terminated</state> </dialog>...

  • Page 377: Call Park And Retrieve

    Administrator Guide Example: Using Call Completion Example: Using Call Completion The following example shows the configuration for call completion. Example： features.call_completion_enable = 1 After provisioning, when you place a call and the callee is temporarily unavailable to answer the call, the phone screen will prompt whether to wait for the callee party.
  • Page 378 Administrator Guide features.call_park.park_mode features.call_park.enable features.call_park.park_code features.call_park.park_retrieve_code features.call_park.direct_send.enable features.call_park.line_restriction.enable features.call_park.performby_holdhardkey.enable Parameter Parameter Description Description Permitted Values Permitted Values Default Default 1 1 -FAC, park a call through dialing the call park features.cal It configures the call park code. l_park.park mode. 2 2 -Transfer, blind transfer the call to a shared _mode parking lot.
  • Page 379 Administrator Guide It enables or disables the phone to park a call using the specific line of the Call Park key. features.cal 0 0 -Disabled, the call is parked by the current line, l_park.line_  NOTE NOTE which is in call state. restriction.e 1 1 -Enabled It works only if...

  • Page 380: Shared Line

    Shared Line Shared Line Yealink phones support Shared Call Appearance (SCA) and Bridged Line Appearance (BLA) to share a line. Shared call appearances and bridged line appearances are similar signaling methods that enable more than one phone to share the same line or registration. The methods you use vary with the SIP server you are using.
  • Page 381 In the SCA scenario, an incoming call can be presented to multiple phones simultaneously. Any IP phone can be used to originate or receive calls on the shared line. Yealink phones support SCA using a SUBSCRIBE/NOTIFY mechanism as specified in 3265. The events used are: “call-info”...
  • Page 382 Administrator Guide 0 0 -Disabled, user registers name to barge in, the phone sends INVITE request with the It enables or disables the phone to use features.barge_i registered name when barging in the user name of the account to barge n_via_username a call in an active call.
  • Page 383 After provisioning, an Intercom key for Bill (4603) is available on the phone. You can press the Intercom key to place an intercom call to Bill (4603). Outgoing Intercom Configuration Outgoing Intercom Configuration Yealink phones support two methods for initialing intercom calls. The following table lists the parameters you can use to configure outgoing intercom.
  • Page 384 Administrator Guide Configuration parameter Configuration parameter features.intercom.mode features.intercom.feature_access_code account.X.call_info Parameter Parameter Description Description Permitted Values Permitted Values Default Default 0 0 -SIP features.int 1 1 -FAC, the feature access ercom.mod It configures the intercom mode. code is configured by “features.intercom.feat ure_access_code”.
  • Page 385 Administrator Guide features.intercom.allow features.intercom.mute features.intercom.tone features.intercom.barge features.intercom.barge_in_dialing.enable features.intercom.headset_prior.enable account.X.alert_info Parameter Parameter Description Description Permitted Values Permitted Values Default Default 0 0 -Disabled, the phone will handle an incoming intercom features.int call like a normal incoming It enables or disables the phone to answer an ercom.allo call.
  • Page 386 Administrator Guide It enables or disables the phone to answer an incoming intercom call while there is already an active call on the IP phone. 0 0 -Disabled  NOTE NOTE features.int 1 1 -Enabled, the phone will It works only if ercom.barg automatically answer the “features.intercom.allow”...

  • Page 387: Remote Control

    Administrator Guide Remote Control Remote Control CSTA Control CSTA Control User Agent Computer Supported Telecommunications Applications (uaCSTA) is explained in detail in Using CSTA for SIP Phone User Agents (uaCSTA) Services for Computer Supported Telecommunications Applications Phase III. The uaCSTA feature on the phone may be used for remote control of the phone from computer applications such as PC softphone.

  • Page 388: Action Url

    Administrator Guide Action URL Action URL Action URL allows the phones to interact with web server applications by sending an HTTP or HTTPS GET request. You can specify a URL that triggers a GET request when a specified event occurs. Action URL can only be triggered by the predefined events (for example, Open DND).
  • Page 389 Administrator Guide Off Hook When the phone is off hook. On Hook When the phone is on hook. Incoming When the phone receives an incoming call. Call Outgoing When the phone places a call. Call Established When the phone establishes a call. Terminated When the phone terminates a call.
  • Page 390 Administrator Guide When the phone enables the busy forward.  NOTE NOTE Busy When the forward mode is Phone, the phone sends the action URL for all accounts; when Forward On the forward mode is Custom, the phone only sends the action URL for the corresponding account.
  • Page 391 Administrator Guide Mute When the phone mutes a call. UnMute When the phone un-mutes a call. Missed Call When the phone misses a call. IP Changed When the IP address of the phone changes. Idle To Busy When the state of the phone changes from idle to busy. Busy To Idle When the state of the phone changes from busy to idle.
  • Page 392 Administrator Guide Variable Values List Variable Values List The following table lists predefined variable values. Variable Variable Description Description Value Value $mac The MAC address of the phone. The IP address of the phone. $model The phone model. $firmware The firmware version of the phone. The SIP URI of the current account when the phone places a call, receives an incoming call or $active_url establishes a call.
  • Page 393 Administrator Guide $wifi_numb The number of connected Wi-Fi dongles. $bluetooth The number of connected Bluetooth dongles. _number $vpn_ip The phone IP address assigned by the VPN server. The CFG configuration file contains all current configurations of the phone. $cfg_all  NOTE NOTE The valid URI is: http:// /?variable name=$variable value.
  • Page 394 Administrator Guide action_url.setup_completed action_url.registered action_url.unregistered action_url.register_failed action_url.off_hook action_url.on_hook action_url.incoming_call action_url.outgoing_call action_url.call_established action_url.call_terminated action_url.dnd_on action_url.dnd_off action_url.always_fwd_on action_url.always_fwd_off action_url.busy_fwd_on action_url.busy_fwd_off action_url.no_answer_fwd_on action_url.no_answer_fwd_off action_url.transfer_call action_url.blind_transfer_call action_url.attended_transfer_call action_url.hold action_url.unhold action_url.held action_url.unheld action_url.mute action_url.unmute action_url.missed_call action_url.busy_to_idle action_url.idle_to_busy action_url.ip_change action_url.reject_incoming_call action_url.answer_new_incoming_call action_url.forward_incoming_call action_url.transfer_finished action_url.transfer_failed action_url.setup_autop_finish action_url.call_waiting_on action_url.call_waiting_off action_url.headset action_url.handfree...
  • Page 395 Administrator Guide It configures the action URL the phone sends after startup. URL within action_url.setup_c Example: Blank ompleted action_url.setup_completed = characters http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends after an account is registered. URL within action_url.register Example: Blank action_url.registered = http://192.168.0.20/help.xml? characters IP=$ip...

  • Page 396: Action_Url.call_Established

    Administrator Guide It configures the action URL the phone sends when establishing a call. URL within action_url.call_est Example: Blank ablished action_url.call_established = characters http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when terminating a call. URL within action_url.call_ter Example: Blank minated action_url.call_terminated =...

  • Page 397: Action_Url.no_Answer_Fwd_On

    Administrator Guide It configures the action URL the phone sends when the no answer forward feature is activated. URL within action_url.no_ans Example: Blank wer_fwd_on action_url.no_answer_fwd_on = characters http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when the no answer forward feature is deactivated. URL within action_url.no_ans Example:...

  • Page 398: Action_Url.mute

    Administrator Guide It configures the action URL the phone sends when URL within muting a call. action_url.mute Blank Example: characters action_url.mute = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when unmuting a call. URL within action_url.unmute Example: Blank action_url.unmute = http://192.168.0.20/help.xml? characters IP=$ip...

  • Page 399: Action_Url.transfer_Failed

    Administrator Guide It configures the action URL the phone sends when completing a call transfer. URL within action_url.transfer Example: Blank _finished action_url.transfer_finished = characters http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when failing to transfer a call. URL within action_url.transfer Example: Blank...

  • Page 400: Action_Url.call_Remote_Canceled

    Administrator Guide It configures the action URL the phone sends when the outgoing call is rejected. URL within action_url.remote Example: Blank _busy action_url.remote_busy = http://192.168.0.20/help.xml? characters IP=$ip It configures the action URL the phone sends when the remote party cancels the outgoing call in the ringing URL within action_url.call_re state.

  • Page 401: Action Uri

    Action URI Action URI Yealink phones can perform the specified action by receiving and handling an HTTP or HTTPS GET request or accept a SIP NOTIFY message with the “Event: ACTION-URI” header from a SIP proxy server. Supported HTTP/HTTPS GET Request...
  • Page 402 Variable Values List Variable Values List Yealink phones also support a combination of the variable values in the URI, but the order of the variable value is determined by the operation of the phone. The valid URI format is: http(s):// /servlet? <phoneIPAddress>...
  • Page 403 Administrator Guide Press the OK/√ / key. ENTER Press the Enter soft key. SPEAKER Press the Speakerphone key. F_TRANSFER Transfer a call to another party. VOLUME_UP Increase the volume. VOLUME_DOW Decrease volume. MUTE Mute a call. F_HOLD/HOLD Place an active call on hold. F_CONFERENC Press the Conf/Conference soft key.
  • Page 404 Administrator Guide Deactivate the DND feature. DNDOff  NOTE NOTE It works only if “features.dnd.allow” is set to 1 (Enabled). Place a call to xxx from SIP URI y. number=xxx&o Example: http://10.3.20.10/servlet?key=number=1234&outgoing_uri=1006@10.2.1.48 (1234 utgoing_uri=y means the number you dial out; 1006@10.2.1.48 means the SIP URL you dial from.) Pick up the handset.
  • Page 405 BusyFwdOn/N  NOTE NOTE oAnswFwdOn= For Yealink phones, it works only if “features.fwd.allow” is set to 1 (Enabled) and call xxx=n forward mode is Phone, the always/busy/no answer forward feature will apply to all the accounts on the phone. Example:...
  • Page 406 Deactivate the always/busy/no answer forward feature for the phone.  NOTE NOTE AlwaysFwdOff/ For Yealink phones, it works only if “features.fwd.allow” is set to 1 (Enabled) and call BusyFwdOff/N forward mode is Phone, the always/busy/no answer forward feature will apply to all the oAnswFwdOff accounts on the phone.
  • Page 407 Administrator Guide Configuration parameter Configuration parameter features.action_uri.enable features.show_action_uri_option features.action_uri_limit_ip Parameter Parameter Description Description Permitted Values Permitted Values Default Default features.act It enables or disables the phone to receive the action 0-Disabled ion_uri.ena URI requests. 1-Enabled It enables or disables the phone to pop up the Allow Remote Control prompt when receiving action URI requests.
  • Page 408 (which is saved as a JPG file and named with the phone model and the capture time) to the local system.  NOTE NOTE Yealink phones also support capturing the screen display using the old URI “http:// /servlet?command=screenshot”. <phoneIPAddress>...
  • Page 409  NOTE NOTE Frequent capture may affect phone performance. Yealink recommends you to capture the phone screen display within a minimum interval of 4 seconds. Example: Placing a Call via Web User Interface Example: Placing a Call via Web User Interface Procedure 1.
  • Page 410 Yealink phones support voice mail. You can configure a message waiting indicator (MWI) to inform users how many messages are waiting in their mailbox without calling the mailbox. Yealink phones support both audio and visual MWI alert when receiving new voice messages.
  • Page 411 Administrator Guide minutes. The following table lists the parameters you can use to configure MWI for voice mail. Configuration parameter Configuration parameter account.X.subscribe_mwi account.X.subscribe_mwi_expires account.X.mwi_parse_terminated account.X.sub_fail_retry_interval account.X.subscribe_mwi_to_vm voice_mail.number.X account.X.display_mwi.enable features.voice_mail_alert.enable features.voice_mail_key_lamp_field.enable features.hide_unread_vm_number.enable Parameter Parameter Description Description Permitted Values Permitted Values Default Default 0 0 -Disabled, the server automatically sends a...
  • Page 412 Administrator Guide It enables or disables the phone to subscribe to the message waiting indicator for the voicemail number.  NOTE NOTE It works only if account.X.s “account.X.subscribe_ 0 0 -Disabled, the phone will subscribe to the ubscribe_m mwi” is set to 1 message waiting indicator to a specific wi_to_vm[1 (Enabled) and...

  • Page 413: Xml Browser

    Short Message Service (SMS) Short Message Service (SMS) Yealink phones support short message service (SMS). It allows users to send and receive a text message on the support server. By default, SMS is enabled. You can use SMS at the path: Menu Menu >...
  • Page 414 To use the XML browser feature, you must configure an XML browser key in advance. For more information on XML browser, refer to Yealink IP Phones XML Browser Developer's Guide XML Browser Configuration XML Browser Configuration The following table lists the parameters you can use to configure the XML browser.
  • Page 415 Administrator Guide It configures the time (in milliseconds) to wait for the phone to send the entered keywords to push_xml.p XML phonebook server if honebook.s the user does not press Integer from 0 to 10000 1000 earch.delay OK to confirm. If it is set to 0, the phone immediately sends the entered keywords to the...
  • Page 416 Administrator Guide It configures the user name for the phone to Features > authenticate with the push_xml.u Remote push XML server. String Blank sername Control > Leave it blank if no User Name authentication is required. It configures the password for the phone Features >...

  • Page 417: Hot Desking

    Administrator Guide It deletes the specified or all custom icons for XML browser. Example: Delete all custom icons for XML browser: xmlbrowser_icon.delete xmlbrowser http://localhost/all or = http://localhost/all _icon.delet http://localhost/name. Blank Delete a custom icon for (jpg/png/bmp/jpeg/dob) XML browser (for example, customicon.jpg): xmlbrowser_icon.delete http://localhost/customi...
  • Page 418 Administrator Guide Hot desking allows the user to clear pre-registration configurations of all accounts on the phone. To use this feature, you need to assign a Hot Desking key. You can also specify which registration configurations are available to users. Hot Desking Key Configuration Hot Desking Key Configuration The following shows the configuration for a Hot Desking key.

  • Page 419: Device Management

    Device Management Device Management You can enable the device management feature to connect device and report device information to the Yealink Device Management Platform (YDMP)/Yealink Management Cloud Service (YMCS), where you can view device information, manage devices, and diagnose devices.
  • Page 420 Administrator Guide Configuration parameter Configuration parameter static.dm.enable static.dm.server.address static.dm.server.port phone_setting.qoe.enable static.remote_control.X.allow Parameter Parameter Description Description Permitted Values Permitted Values Default Default It enables or disables the static.dm.e 0 0 -Disabled device nable 1 1 -Enabled management feature. It configures static.dm.s the server erver.addre String within 512 characters...

  • Page 421: Phone Provisioning

    Administrator Guide Prerequisites Prerequisites 1. Set the Access Point to transmit Yealink AX83H preset SSID so that the phone can connect to the network automatically after reboot. The default Hotspot SSID is Axseies_deploy Axseies_deploy , and the Hotspot Password is AXseries@8! AXseries@8! 2.

  • Page 422: Boot Files, Configuration Files, And Resource Files

    You can use boot files, configuration files, and resource files to configure phone features and apply feature settings to phones. You can create or edit these files using a text editor such as Notepad++. You can ask the distributor or Yealink FAE for template files. You can also obtain the template files online: http://support.yealink.com/documentFront/forwardToDocumentFrontDisplayPage.

  • Page 423: Boot File Attributes

    Administrator Guide Common Boot File Common Boot File Common boot file, named y000000000000.boot, is effective for all phones. You can use a common boot file to apply common feature settings to all of the phones rather than a single phone. MAC-Oriented Boot File MAC-Oriented Boot File MAC-Oriented boot file, named...

  • Page 424: Configuration Files

    Static: The parameters start with a prefix “static.”, for example, static.auto_provision.custom.protect. Non-static: The parameters do not start with a prefix “static.”, for example, local_time.date_format. You can deploy and maintain a mass of Yealink phones automatically through configuration files stored in a provisioning server.

  • Page 425: Configuration File Customization

    Administrator Guide Common CFG file, named , contains parameters that affect the basic operation of the IP <y0000000000xx>.cfg phone, such as language and volume. It will be effective for all phones in the same model. The common CFG file has a fixed name for each phone model.

  • Page 426: Configuration File Attributes

    MAC-Oriented CFG file. During auto-provisioning, the phones will request the resource files and configuration files. Supported Resource Files Supported Resource Files Yealink supplies some templates of resource files for you, so you can directly edit the files as required. The following table lists the resource files Yealink supplies: Reference Reference...

  • Page 427: Provisioning Methods Priority

    Introduction Introduction Introduction Introduction Yealink provides two ways to provision your phones: Manual Provisioning: provisioning via the handset user interface or web user interface. Manual Provisioning Central Provisioning: provisioning through configuration files stored in a central provisioning server. Central Provisioning The method you use depends on how many phones need to be deployed and what features and settings to be configured.

  • Page 428: Web User Interface

    Administrator Guide There is a priority for configuration among the provisioning methods - settings you make using a higher priority provisioning method override settings made using a lower priority provisioning method. The precedence order for configuration parameter changes is as follows (highest to lowest): ...

  • Page 429: Quick Login Configuration

    Administrator Guide Quick Login Configuration Quick Login Configuration You can access the web user interface quickly using the request URI. It will locate you in the Status web page after accessing the web user interface. It is helpful to quickly log into the web user interface without entering the username and password on the login page.

  • Page 430: Web Server Type Configuration

    Web Server Type Configuration Yealink phones support HTTP and HTTPS protocols for accessing the web user interface. You can configure the web server type. The web server type determines the access protocol of the web user interface. If you disable to access the web user interface using the HTTP/HTTPS protocol, both you and the user cannot access the web user interface.

  • Page 431: Central Provisioning

    Administrator Guide 1. On the web user interface, go to Network Network > Advanced Advanced > Web Server Web Server. Auto Provisioning Auto Provisioning static.wui.https_enable static.network.port.https Permitted Permitted Parameter Parameter Default Default Description Description Values Values static.wui.https 0 0 -Disabled It enables or disables to access the web user interface of _enable[1] 1 1 -Enabled...

  • Page 432: Auto Provisioning Settings Configuration

    Administrator Guide Yealink phones can obtain the provisioning server address during startup. Then the phones first download boot files and configuration files from the provisioning server and then resolve and update the configurations written in configuration files. This entire process is called auto provisioning. For more information on auto provisioning, refer Auto Provisioning Guide.
  • Page 433 Administrator Guide 1. On the web user interface, go to Settings Settings > Auto Provision Auto Provision. Auto Provisioning Auto Provisioning static.auto_provision.attempt_expired_time static.network.attempt_expired_time static.auto_provision.attempt_before_failed static.auto_provision.retry_delay_after_file_transfer_failed static.auto_provision.reboot_force.enable static.auto_provision.power_on static.auto_provision.repeat.enable static.auto_provision.repeat.minutes static.auto_provision.weekly.enable static.auto_provision.weekly_upgrade_interval static.auto_provision.inactivity_time_expire static.auto_provision.weekly.dayofweek static.auto_provision.weekly.begin_time static.auto_provision.weekly.end_time static.auto_provision.flexible.enable static.auto_provision.flexible.interval static.auto_provision.flexible.begin_time static.auto_provision.flexible.end_time static.auto_provision.dns_resolv_nretry static.auto_provision.dns_resolv_timeout Parameter Parameter...
  • Page 434 Administrator Guide It configures the timeout (in seconds) to transfer a file via auto provisioning.  NOTE NOTE It has a higher priority static.auto_ than the value defined by provision.at Integer from 1 to 300 the parameter tempt_expi static.network.attempt_expi red_time red_time It configures the timeout (in seconds) to transfer a file for...
  • Page 435 Administrator Guide It enables or disables the phone to reboot after auto provisioning, even if there is no specific configuration requiring a reboot.  NOTE NOTE It works only for the current auto provisioning static.auto_ process. If you want the provision.re 0 0 -Disabled phone to reboot after...
  • Page 436 Administrator Guide It configures the time interval (in weeks) for the phone to perform auto provisioning. If it is set to 0, the phone performs auto provisioning at the specific day(s) configured by the parameter static.auto_provision.weekly.day every week. ofweek static.auto_ If it is set to other values (for provision.w example, 3), the phone...
  • Page 437 Administrator Guide time and ending time. static.auto_  NOTE NOTE provision.in The phone may perform Integer from 0 to 120 activity_tim auto provisioning when e_expire you are using the phone during office hour. It works only if static.auto_provision.weekly is set to 1 (On). .enable The operations on the handset will not change...
  • Page 438 Administrator Guide It configures the days of the week for the phone to perform auto provisioning weekly. Example: static.auto_provision.weekly.day ofweek = 01 static.auto_provision.weekly_upg is set to 0, it rade_interval means the phone performs auto provisioning every 0,1,2,3,4,5,6 or a combination of these digits Sunday and Monday.
  • Page 439 Administrator Guide It triggers the flexible feature to on or off. 0 0 -Off  NOTE NOTE 1 1 -On, the phone performs auto provisioning The day within the period at random between a starting time is based upon the phone's static.auto_ configured by the parameter MAC address and does not...
  • Page 440 Administrator Guide It configures the ending time of the day for the phone to perform auto provisioning at random. If it is left blank or set to a specific value equal to starting time configured by the parameter static.auto_provision.weekly.begi , the phone performs n_time auto provisioning at the starting time.

  • Page 441: Supported Provisioning Protocols

    Administrator Guide It configures the retry times when the phone fails to resolve the access URL of the provisioning server.  NOTE NOTE static.auto_ provision.d For each different DNS Integer from 1 to 10 ns_resolv_n server, it works only if retry static.auto_provision.dns_re is set to 1...

  • Page 442: Provisioning Protocols Configuration

    Administrator Guide Yealink phones support several transport protocols for provisioning: Trivial File Transfer Protocol (TFTP) File Transfer Protocol (FTP) Hyper Text Transfer Protocol ‒ Secure (HTTPS) File Transfer Protocol ‒ Secure (FTPS)  NOTE NOTE There are two types of FTP methods—active and passive. The phones are not compatible with active FTP.
  • Page 443 Administrator Guide Static: You can manually configure the server address via the handset user interface or web user interface. Static PnP Provision Configuration PnP Provision Configuration Set via the Web User Interface Set via the Web User Interface 1. On the web user interface, go to Settings Settings >...
  • Page 444 Administrator Guide 1. On the web user interface, go to Settings Settings > Auto Provision Auto Provision > DHCP Active DHCP Active / IPv4 Custom Option IPv4 Custom Option. Auto Provisioning Auto Provisioning static.auto_provision.dhcp_option.enable static.auto_provision.dhcp_option.list_user_options static.auto_provision.url_wildcard.pn Parameter Parameter Permitted Values Permitted Values Default Default...
  • Page 445 Administrator Guide It configures the characters to replace the wildcard $PN in the received URL of the provisioning server. static.auto_provis  NOTE NOTE ion.url_wildcard.p String within 32 characters Blank The configured characters must be in accordance with the actual directory name of the provisioning server.
  • Page 446 Administrator Guide 1. On the web user interface, go to Settings Settings > Auto Provision Auto Provision > Server URL Server URL / Username Username / Password Password. Auto Provisioning Auto Provisioning static.auto_provision.server.url static.auto_provision.server.username static.auto_provision.server.password Parameter Parameter Permitted Values Permitted Values Default Default Description...
  • Page 447 Administrator Guide 6. If performing static provisioning, obtain the provisioning server address.  NOTE NOTE Typically, all phones are configured with the same server account, but the server account provides a means of conveniently partitioning the configuration. Give each account a unique home directory on the server and change the configuration on a per-line basis.
  • Page 448 Administrator Guide It enables or disables the phone to keep the user’s personalized settings after auto provisioning.  NOTE NOTE The provisioning priority mechanism (handset/web user handset/web user interface > central interface central provisioning > factory provisioning factory defaults) takes effect only if defaults the value of this parameter is set to 1 (Enabled).
  • Page 449 Administrator Guide It enables or disables the phone to upload the file to <MAC>-local.cfg the server each time the file updates, and to download the file from the server <MAC>-local.cfg during auto provisioning. static.auto_ 0 0 -Disabled provision.c  NOTE NOTE 1 1 -Enabled ustom.sync...

  • Page 450: Auto Provisioning Flowchart For Keep User's Personalized Configuration Settings

    Auto Provisioning Flowchart for Keep User’s Personalized Configuration Settings Auto Provisioning Flowchart for Keep User’s Personalized Configuration Settings The following shows an auto provisioning flowchart for Yealink phones when a user wishes to keep the user’s personalized configuration settings.
  • Page 451 Administrator Guide Example: Keep User’s Personalized Settings Example: Keep User’s Personalized Settings This section shows you how to keep the personalized settings. Parameters Settings: Parameters Settings: static.auto_provision.custom.protect =1 After provisioning, if the users make changes via the phone or web user interface, the MAC-local.cfg file with non- static personal settings generates locally.
  • Page 452 Administrator Guide personalized settings locally are overridden by the file from the provisioning server. MAC-local.cfg If you set , the MAC-local.cfg file will be kept locally. The personalized settings static.auto_provision.custom.sync =0 will not be overridden after auto-provisioning. Scenario: Keep personalized user settings after factory reset Scenario: Keep personalized user settings after factory reset The IP phone requires a factory reset when it has a breakdown, but the user wishes to keep customized settings of the phone after a factory reset.
  • Page 453 Administrator Guide custom.handset.date_format custom.handset.time_format custom.handset.auto_answer.enable custom.handset.low_battery_tone.enable custom.handset.confirmation_tone.enable custom.handset.keypad_tone.enable custom.handset.keypad_light.enable custom.handset.backlight_in_charger.enable custom.handset.backlight_out_of_charger.enable custom.handset.screen_saver.enable custom.handset.language Parameter Parameter Permitted Values Permitted Values Default Default Description Description It configures the time format for all registered handsets. 0 0 -Hour 12, the time will be displayed in 12-hour custom.han ...
  • Page 454 Administrator Guide It enables or disables a user to answer incoming calls by lifting the handset from the charger cradle without having to press the off-hook key. -1 -1-Do not modify the handset configuration (Keep custom.han  NOTE NOTE the original configuration of the handset). dset.auto_a 0 0 -Disabled It works if the...
  • Page 455 Administrator Guide It enables or disables the handset to play a tone when a user saves settings or places the handset in the charger cradle.  NOTE NOTE custom.han -1 -1-Do not modify the handset configuration (Keep It will take effect on dset.confir the original configuration of the handset).
  • Page 456 Administrator Guide It enables or disables the handset to turn on the keypad light (digital key, # key, * key, TRAN key, and Mute key) when any key is pressed. custom.han  NOTE NOTE -1 -1-Do not modify the configuration. dset.keypa It will take effect on 0 0 -Disabled...
  • Page 457 Administrator Guide It enables or disables the handset backlight to be on for about 30 minutes when it is not charged.  NOTE NOTE -1 -1-Do not modify the handset configuration (Keep It will take effect on custom.han the original configuration of the handset). all handsets that are dset.backlig 0 0 -Disabled, the backlight will be turned off after...

  • Page 458: Get Started

    Introduction Introduction Yealink phones are full-featured telephones that can be plugged directly into an IP network and can be used easily without manual configuration. This guide provides instructions on how to provision Yealink phones with the minimum settings required. Yealink IP phones support FTP, TFTP, HTTP, and HTTPS protocols for auto provisioning and are configured by default to use the TFTP protocol.
  • Page 459 The configuration files referenced in the boot file are flexible: you can rearrange the configuration parameters within the Yealink-supplied template configuration files or create your own configuration files from the configuration parameters you want. You can create and name as many configuration files as you want and your own configuration files can contain any combination of configuration parameters.

  • Page 460: Obtain Phone Information

    44.83.0.10.rom Obtain Template Files Obtain Template Files You can ask the distributor or Yealink FAE for template files. You can also obtain them online: http://support.yealink.com/documentFront/forwardToDocumentFrontDisplayPage. To download template boot, configuration and resource files: To download template boot, configuration and resource files: 1.

  • Page 461: Auto Provisioning Process

    Auto Provisioning Process Old Mechanism ‒ Without Boot Files Old Mechanism ‒ Without Boot Files The following flowchart shows how Yealink phones perform auto provisioning when using configuration files only: New Mechanism ‒ With Boot Files New Mechanism ‒ With Boot Files...
  • Page 462 Administrator Guide Scenario A ‒ Do Not Support Exclude Mode Scenario A ‒ Do Not Support Exclude Mode Scenario B ‒ Support Exclude Mode Scenario B ‒ Support Exclude Mode...

  • Page 463: Major Tasks For Auto Provisioning

    Administrator Guide Major Tasks for Auto Provisioning Major Tasks for Auto Provisioning You need to complete four major tasks to provision Yealink phones. The following figure shows an overview of four major provisioning tasks:...

  • Page 464: An Instance Of Auto Provision Configuration

    Administrator Guide For more information on how to manage boot files, refer to Manage Boot Files For more information on how to manage configuration files, refer to Manage Configuration Files For more information on how to manage resource files, refer to Manage Resource Files For more information on how to configure a provisioning server, refer to Configure a Provisioning Server...
  • Page 465 Administrator Guide 2. Manage configuration files. Add/Edit the desired configuration parameters in the CFG file (for example, features.cfg) you want the phone to download. For more information on how to manage configuration files, refer to Manage Configuration Files 3. Configure the TFTP server. ①...
  • Page 466 Administrator Guide ③ Select Configure TFTP Server. Click the button to locate the TFTP root directory in your local system. For more information on how to configure a provisioning server, refer to Configure a Provisioning Server 4. Configure the provisioning server address on the phone.
  • Page 467 Administrator Guide For more information on how to obtain the provisioning server address, refer to Obtain the Provisioning Server Address 5. Trigger the phone to perform auto provisioning. For more information on how to perform auto provisioning, refer to Trigger the Phone to Perform Auto Provisioning How to use the Zero Touch method to change the password Phone Cannot Get Provisioned with Certificate Error How to clear the value of the configuration parameter...
  • Page 468 Administrator Guide Manage Boot Files Manage Boot Files Yealink phones can download CFG files referenced in the boot files. Before provisioning, you may need to edit and customize your boot files. Yealink supports the following two types of boot files: MAC-Oriented boot file (for example, 00156574b150.boot)
  • Page 469 Administrator Guide Enable or disable the overwrite mode. 1 1 -(Enabled) - If the value of a parameter in configuration files is left blank, or if a non- static parameter in configuration files is deleted or commented out, the factory default value takes effect.

  • Page 470: Manage Configuration Files

    You can also make a copy of the common boot file, rename it and then edit it. Manage Configuration Files Manage Configuration Files Auto provisioning enables Yealink phones to update themselves automatically via downloading Common CFG, MAC-Oriented CFG, custom CFG, and MAC-local CFG files. Before provisioning, you may need to edit and customize your configuration files.
  • Page 471 Administrator Guide The following table lists guidelines you need to know when editing the common CFG file: Item Item Guidelines Guidelines The line beginning with “#” is considered to be a comment. #!version:1. It must be placed in the first line. 0.0.1 Do not edit and delete.
  • Page 472 $MODEL represents the phone model.  NOTE NOTE • AX83H phone supports 16 accounts Create a New CFG File Create a New CFG File If you want to create a new CFG file for your phone, follow these steps:...

  • Page 473: Encrypt Configuration Files

    To protect against unauthorized access and tampering with sensitive information (for example, login password, registration information), you can encrypt configuration files using Yealink Configuration Encryption Tool. AES keys must be 16 characters and the supported characters contain: 0 ~ 9, A ~ Z, a ~ z and the following special characters are also supported: # $ % * + , - .

  • Page 474: Customize Resource Files

    Configure a Provisioning Server Configure a Provisioning Server Yealink phones support using FTP, TFTP, HTTP, and HTTPS protocols to download boot files and configuration files. You can use one of these protocols for provisioning. The TFTP protocol is used by default. The following section provides instructions on how to configure a TFTP server.
  • Page 475 Administrator Guide 3. (Optional.) Set security permissions for the TFTP directory folder. You need to define a user or a group name, and set the permissions: read, write or modify. Security permissions vary by organizations. An example of configuration on the Windows platform is shown as below: Configure a TFTP Server Configure a TFTP Server If you have a 3CDaemon application installed on your local system, use it directly.
  • Page 476 The server URL “tftp://IP/” (Here “IP” means the IP address of the provisioning server, for example, ”tftp://10.2.5.193/”) is where the IP phone downloads configuration files from. Obtain the Provisioning Server Address Obtain the Provisioning Server Address Yealink phones can obtain the provisioning server address in the following ways: Plug and Play (PnP) Server DHCP Options...
  • Page 477 Plug and Play Server Plug and Play Server Yealink phones support obtaining the provisioning server address from the PnP server. The IP phone broadcasts the PnP SUBSCRIBE message to obtain the provisioning server address during startup. To use Plug and Play, make sure this feature is enabled.
  • Page 478 DHCP Options DHCP Options Yealink phones can obtain the provisioning server address by detecting DHCP options during startup. If you are using the IPv4 network, the phone will automatically detect the option 66 and option 43 for obtaining the provisioning server address. DHCP option 66 is used to identify the TFTP server. DHCP option 43 is a vendor-specific option, which is used to transfer the vendor-specific information.
  • Page 479 After the IP phone obtains the provisioning server address from the DHCP server, it will connect to the provisioning server and perform auto provisioning during startup. For more information on the DHCP options, refer to the latest Administrator Guide for your phone on Yealink Technical Support.

  • Page 480: Phone Flash

    Phone Flash Phone Flash Yealink IP phones can obtain the provisioning server address from the IP phone flash. To obtain the provisioning server address by reading the IP phone flash, make sure the configuration is set properly. To configure the IP phone flash via web user interface: To configure the IP phone flash via web user interface: 1.
  • Page 481 URL for different phone models. On the provisioning server, many directories need to be configured for different phone models, each with a unique directory name. Yealink IP phones support the following wildcards in the provisioning server URL: $PN: it is used to identify the directory name of the provisioning server directory where the corresponding boot files and configuration files are located.
  • Page 482 ‘’T42G’’ for the SIP-T42G IP static.auto_provision.url_wildcard.pn phones and ‘’AX83H’’ for the AX83H phones. If the default value is different from the directory name, you need to configure the value of this parameter to be the directory name on the IP phones in advance.
  • Page 483 Administrator Guide Repeatedly Weekly Flexible Auto Provision Auto Provision Now Multi-Mode Mixed SIP NOTIFY Message Auto Provisioning via Activation Code When there is an active call on the phone during auto provisioning, the IP phone will detect the call status every 30 seconds.
  • Page 484 Administrator Guide 3. Enter the desired interval time (in minutes) in the Interval(Minutes) Interval(Minutes) field. 4. Click Confirm Confirm to accept the change. Weekly Weekly The IP phone performs auto provisioning at a random time every week/month/quarter. You can configure what time of the day and which day of the week to trigger the IP phone to perform auto provisioning.

  • Page 485: Flexible Auto Provision

    Administrator Guide 6. Check one or more checkboxes in the Day of Week Day of Week field. 7. Click Confirm Confirm to accept the change. Flexible Auto Provision Flexible Auto Provision The IP phone performs auto provisioning at a random time on a random day within a specific period of time. The random day is calculated on the basis of the phone's MAC address.

  • Page 486: Auto Provision Now

    Administrator Guide 4. Enter the desired start time and end time in the Flexible Time Flexible Time field. 5. Click Confirm Confirm to accept the change. Auto Provision Now Auto Provision Now You can use auto provision now mode to manually trigger the IP phone to perform auto provisioning immediately. To use the auto provision now mode via web user interface: To use the auto provision now mode via web user interface: 1.

  • Page 487: Auto Provisioning Via Activation Code

    For more information on the parameter , refer to the latest IP Phones Description of sip.notify_reboot_enable Configuration Parameters in CFG Files or Administrator Guide for your phone on Yealink Technical Support. This method requires server support. The following figure shows the message flow:...
  • Page 488 Administrator Guide The following lists the processes for triggering auto provisioning via activation code: 1. Create multiple directories on the provisioning server. 2. Store boot files and configuration files to each directory on the provisioning server. 3. Configure a username and password for each directory on the provisioning server. The user name and password provide a means of conveniently partitioning the boot files and configuration files for different IP phones.
  • Page 489 Administrator Guide 9. The entered user name and password must correspond to the directory where the boot files and configuration files of the IP phone are located. If you enter an invalid username or password, the LCD screen will prompt the message “Wrong username or password!”.

  • Page 490: Download And Verify Configurations

    If no common boot file is found, the IP phone will try to download the Common CFG file firstly, and then try to download the MAC-Oriented CFG file from the provisioning server ‒ that is, the old mechanism for auto provisioning. For more information about auto provisioning, refer to Provision Yealink Phones...

  • Page 491: Resolve And Update Configurations

    CFG file and the MAC-Oriented AES key to decrypt the file after downloading the configuration files. For <MAC>.cfg more information on how the IP phone decrypts configuration files, refer to Yealink Configuration Encryption Tool User Guide. Use MAC-local CFG File...

  • Page 492: Verify Configurations

    During auto provisioning, you can monitor the downloading requests and response messages by a WinPcap tool. The following shows some examples. Example 1: Yealink SIP-T23G IP phone downloads the boot file and configuration files from the TFTP server. Example 1 Example 2: Yealink SIP-T23G IP phone downloads the boot file and configuration files from the FTP server.

  • Page 493: Troubleshooting

    Administrator Guide Example 3: Yealink SIP-T23G IP phone downloads boot file and configuration files from the HTTP server. Example 3 Troubleshooting Troubleshooting This chapter provides general troubleshooting information to help you solve problems you might encounter when deploying phones. If you require additional information or assistance with the deployment, contact your system administrator.

  • Page 494: Why Does The Phone Display "Network Unavailable"

    Administrator Guide Ensure that MAC-Oriented boot file and common boot file don’t exist simultaneously on the provisioning server. If both exist, the phone only downloads MAC-Oriented boot file and the configuration files referenced in the MAC-Oriented boot file. Why does the phone fail to authenticate the provisioning server during auto provisioning? Why does the phone fail to authenticate the provisioning server during auto provisioning? Ensure that the certificate for the provisioning server has been uploaded to the phone’s trusted certificates list.
  • Page 495 >central provisioning >factory defaults. A setting you make using a lower-priority method does not apply to or override a duplicate setting made using a higher-priority method. For more information, refer to the latest Administrator Guide for your phone on Yealink Technical Support. Glossary Glossary...
  • Page 496 Administrator Guide TFTP TFTP Trivial File Transfer Protocol (TFTP) is a simple protocol to transfer files. It has been implemented on top of the User Datagram Protocol (UDP) using port number 69. Advanced Encryption Standard (AES) is a specification for the encryption of electronic data. A uniform resource locator or universal resource locator (URL) is a specific character string that constitutes a reference to an Internet resource.
  • Page 497 Administrator Guide Configure an FTP Server Configure an FTP Server To configure a wftpd server: To configure a wftpd server: 1. Download the compressed file of the wftpd application to your local directory and extract it. 2. Double click the Wftpd.exe Wftpd.exe.
  • Page 498 Administrator Guide 4. Click Security Security > Users/rights Users/rights. 5. Click New User New User. 6. Enter a user name (for example, test1) in the User Name User Name field and then click OK...
  • Page 499 Administrator Guide 7. Enter the password of the user (for example, test1) created above in the New Password New Password and Verify Password Verify Password field respectively, and then click OK 8. Click Browse Browse to locate the FTP root directory in your local system. 9.
  • Page 500 Administrator Guide 11. Click Done Done to save the settings and finish the configurations. The server URL “ftp://username:password@IP/” (Here “IP” means the IP address of the provisioning server, “username” and “password” are the authentication for FTP download. For example, “ftp://test1:123456@10.3.6.234/”) is where the IP phone downloads boot files and configuration files from. Before configuring a wftpd server, ensure that no other FTP servers exist in your local system.
  • Page 501 Administrator Guide 3. Set the security permissions for the HTTP directory folder. You need to define a user or group name and set the permissions: read, write, and modify. Security permissions vary by organizations. An example of configuration on the Windows platform is shown as below: Configure an HTTP Server Configure an HTTP Server HFS tool is an executable application, so you don’t need to install it.
  • Page 502 Administrator Guide 1. Download the application file to your local directory, double click the hfs.exe hfs.exe. The main configuration page is shown as below: 2. Click Menu Menu in the main page and select the IP address of the PC from IP address IP address.
  • Page 503 Administrator Guide The default HTTP port is 8080 8080. You can also reset the HTTP port (make sure there is no port conflict).
  • Page 504 Administrator Guide...
  • Page 505 Administrator Guide 3. Right click the icon on the left of the main page, select Add folder from disk to add the HTTP Server root directory.

  • Page 506: Phone Customization

    7. (Optional.) Enter the desired user name and password for the root directory in the corresponding fields and then click OK Yealink IP phones also support the Hypertext Transfer Protocol with SSL/TLS (HTTPS) protocol for auto provisioning. HTTPS protocol provides encrypted communication and secure identification. For more information on installing and configuring an Apache HTTPS Server, refer to the network resource.

  • Page 507: Supported Languages

    Yealink phones support multiple languages. Languages used on the phone user interface and web user interface can be specified respectively as required. You can ask the distributor or Yealink FAE for language packs. You can also refer to the following template. User interface template:...

  • Page 508: Language Display Configuration

    Administrator Guide 009.GUI.Portuguese_LA. 10.Turkish_note.xm Portuguese (Latin) Turkish 10.Turkish.js lang 11.Russian_note.xm Spanish (EU) 010.GUI.Spanish.lang Russian 11.Russian.js 011.GUI.Spanish_LA.lan 12.Czechlang_note. Spanish (Latin) Czech 12.Czechlang.js Turkish 012.GUI.Turkish.lang Arabic 13.Arabic.js 13.Arabic_note.xml Russian 013.GUI.Russian.lang Czech 014.GUI.Czechlang.lang Hebrew 015.GUI.Hebrew.lang Arabic 016.GUI.Arabic.lang Language Display Configuration Language Display Configuration The default language displayed on the phone user interface is English.

  • Page 509: Language For Phone Display Customization

    Administrator Guide Language for Phone Display Customization Language for Phone Display Customization You can customize the translation of the existing language on the phone user interface. Languages available for selection depend on language packs currently loaded to the IP phone. You can also add new languages (not included in the available language list) available for phone display by loading language packs to the IP phone.
  • Page 510 Administrator Guide Save the language pack and place it to the provisioning server. Custom Language for Phone Display Configuration Custom Language for Phone Display Configuration The following table lists the parameters you can use to configure a custom language for the phone display. configuration parameter configuration parameter gui_lang.url...

  • Page 511: Language For Web Display Customization

    You can also customize the translation of the note language pack. The note information is displayed in the question mark "?" of the web user interface. You can ask the distributor or Yealink FAE for language packs. You can also refer to the following template. Web interface template:...
  • Page 512 Administrator Guide “X.name.js” (X starts from 14, “name” is replaced with the language name). If the language name is the same as the existing one, the newly uploaded language file will override the existing one. We recommend that the file name of the new language pack should not be the same as the existing one.
  • Page 513 Administrator Guide Procedure Procedure Open the desired note language template pack (for example, 1.English_note.xml) using an XML editor. Modify the text of the note field. Do not modify the note name. The following shows a portion of the note language pack “1.English_note.xml” for the web user interface: Save the note language pack and place it to the provisioning server.

  • Page 514: Backlight Setting

    Administrator Guide URL within 511 characters For example http://localhost/X.GUI.name wui_lang.ur It configures the access URL of the custom .lang Blank language pack for the web user interface. X starts from 014, “name” is replaced with the language name URL within 511 characters For example http://localhost/X.name_no wui_lang_n...
  • Page 515 Administrator Guide Backlight and Time Configuration Backlight and Time Configuration The following table lists the parameters you can use to configure screen backlight and time. Configuration parameter Configuration parameter phone_setting.active_backlight_level phone_setting.inactive_backlight_level phone_setting.backlight_time Parameter Parameter Description Description Permitted Permitted Values Values Default Default phone_setting...

  • Page 516: Time And Date

    Time and Date Yealink phones maintain a local clock. You can choose to get the time and date from SNTP (Simple Network Time Protocol) time server to have the most accurate time and set DST (Daylight Saving Time) to make better use of daylight and to conserve energy, or you can set the time and date manually.
  • Page 517 Administrator Guide Baja California Moldova(Kishinev) Canada(Edmonton,Calgary) Pretoria Mexico(Mazatlan,Chihuahua) Jerusalem United States-Mountain Time Russia(Kaliningrad) United States-MST no DST Bulgaria(Sofia) Chihuahua,La Paz Lithuania(Vilnius) Arizona Cairo Guatemala Istanbul El Salvador E.Europe Honduras Tripoli Nicaragua Romania(Bucharest) Costa Rica Syria(Damascus) Belize Turkey(Ankara) Canada-Manitoba(Winnipeg) Ukraine(Kyiv, Odessa) Chile(Easter Islands) East Africa Time Guadalajara...
  • Page 518 Administrator Guide Manaus,Cuiaba Kazakhstan(Aqtobe) Georgetown Ekaterinburg (RTZ 4) Chile(Santiago) Karachi Paraguay(Asuncion) Tashkent United Kingdom-Bermuda(Bermuda) Pakistan(Islamabad) United Kingdom(Falkland Islands) Russia(Chelyabinsk) Trinidad&Tobago +5:30 India(Calcutta) -3:30 Canada-New Foundland(St.Johns) +5:30 Mumbai,Chennai Greenland(Nuuk) +5:30 Kolkata,New Delhi Argentina(Buenos Aires) +5:30 Sri Jayawardenepura Brazil(no DST) +5:45 Nepal(Katmandu) Brasilia Kyrgyzstan(Bishkek) Cayenne,Fortaleza...

  • Page 519: Ntp Settings

    Administrator Guide Spain-Canary Islands(Las Palmas) Japan(Tokyo) United Kingdom(London) Russia(Yakutsk,Chita) Lisbon +9:30 Australia(Adelaide) Morocco +9:30 Australia(Darwin) Albania(Tirane) Australia(Sydney,Melbourne,Canberra) Austria(Vienna) Australia(Brisbane) Belgium(Brussels) Australia(Hobart) Caicos Russia(Vladivostok) Belgrade Magadan (RTZ 9) Bratislava Guam,Port Moresby Ljubljana Solomon Islands Chad +10:30 Australia(Lord Howe Islands) Copenhagen New Caledonia(Noumea) West Central Africa Chokurdakh (RTZ 10) Russia(Srednekolymsk Time)
  • Page 520 Administrator Guide DHCP server or configured manually. NTP Configuration NTP Configuration The following table lists the parameters you can use to configure the NTP. Configuration parameter Configuration parameter local_time.manual_ntp_srv_prior local_time.dhcp_time local_time.ntp_server1 local_time.ntp_server2 local_time.interval local_time.time_zone local_time.time_zone_name Default Default Parameter Parameter Description Description Permitted Permitted Values...

  • Page 521: Dst Settings

    Administrator Guide -12 to +14 local_time.t It configures the time zone. For available time zones, refer to ime_zone Time Zone. It configures the time zone name. String within 32 characters  NOTE NOTE The available time zone names local_time.t depend on the time zone It works only if China(Beijin ime_zone_n...
  • Page 522 DST Customizing Auto DST File Customizing Auto DST File Before customizing, you need to obtain the AutoDST file. You can ask the distributor or Yealink FAE for DST template. You can also refer to the following template: <DSTData>...
  • Page 523 Administrator Guide 3. Specify the DST attribute values within double quotes. For example: Add a new time zone (+6 Paradise) with daylight saving time 30 minutes: <DST szTime="+6" szZone="Paradise" iType="1" szStart="3/5/7/2" szEnd="10/5/7/3" szOffset="30"/ > Modify the DST settings for the existing time zone “+5 Pakistan(Islamabad)” and add DST settings for the existing time zone “+5:30 India(Calcutta)”.
  • Page 524 Administrator Guide It configures the Daylight Saving Time (DST) type. local_time.  NOTE NOTE 0-DST by Date dst_time_ty It works only if 1-DST by Week “local_time.summer_ti me” is set to 1 (Enabled). Month/Day/Hour:Minute-DST by Date, use the following mapping: Month: 1=January, 2=February,…, 12=December Day: 1=the first day in a month,…, 31= the last day in a month...
  • Page 525 Administrator Guide Month/Day/Hour:Minute-DST by Date, use the following mapping: Month: 1=January, 2=February,…, 12=December Day: 1=the first day in a month,…, 31= the last day in a month Hour:Minute: 0:0=0:0am, 1:45=1:45am,…, 23:59=11:59pm It configures the end time of ----------------------------------------------------------- the Daylight Saving Time ----------------------------------------------------------- (DST).

  • Page 526: Time And Date Manually Configuration

    Administrator Guide Time and Date Manually Configuration Time and Date Manually Configuration You can set the time and date manually when the phones cannot obtain the time and date from the NTP time server. The following table lists the parameter you can use to configure time and date manually. Configuration parameter Configuration parameter local_time.manual_time_enable...
  • Page 527 Administrator Guide local_time.time_format local_time.date_format lcl.datetime.date.format Parameter Parameter Description Description Permitted Values Permitted Values Default Default 0-Hour 12, the time will be displayed in 12- hour format with AM or PM specified. local_time.t It configures the time format. 1-Hour 24, the time will be displayed in 24- ime_format hour format (for example, 2:00 PM displays as 14:00).
  • Page 528 Administrator Guide Any combination of Y, M, D, W, and the separator (for example, space, dash, slash). Use the following mapping: Y = year, M = month, D = day, W = day of week “Y”/”YY” represents a two-digit year, more than two “Y”...

  • Page 529: Date Customization Rule

    Administrator Guide Date Customization Rule Date Customization Rule You need to know the following rules when customizing date formats: Format Format Description Description Y/YY It represents a two-digit year. For example, 16, 17, 18… Y is used more than twice (for example, It represents a four-digit year.

  • Page 530: Call Display

    Administrator Guide W is used more than twice (for It represents the long format of the day of the week. For example, example, WWW, WWWW) Monday, Tuesday,…, Sunday W is used more than twice (for It represents the long format of the day of the week. For example, example, WWW, WWWW) Monday, Tuesday,…, Sunday Call Display...
  • Page 531 Administrator Guide It enables or disables the phone to display the little contact photo phone_setti when it receives an incoming call, ng.little_co 0-Disabled dials a call or is in a call. ntact_phot 1-Enabled, the phone can display the full Note: It works only if o_display.e 16-digit number.
  • Page 532 Administrator Guide 0-Name+Number 1-Number+Name It configures the remote 2-Name phone_setti information display method 3-Number ng.call_info when the phone receives an 4-Full Contact Info (display _display_m incoming call, dials an outgoing namesip:xxx@domain.com) ethod call or is during a call. 5-Null Note: Name refers to the Label; Number refers to the User Name.
  • Page 533 Administrator Guide It enables or disables the phone to display the identity contained sip.disp_inc 0-Disabled in the To field of the INVITE all_to_info 1-Enabled message when it receives an incoming call. features.nu It is used to configure whether to 0-Disabled mber_priva enable the number privacy 1-Enabled...
  • Page 534 Administrator Guide Parameter Parameter Description Description Permitted Permitted Values Values Default Default 1-Label, configured by the parameter “account.X.label”. 2-Display Name, features.call It configures the selected account information configured by the er_name_ty displayed on the pre-dialing or dialing screen. parameter pe_on_diali Note: It works only if “account.X.display_na “features.station_name.value”...
  • Page 535 The search source list can be configured using a supplied super search template file (super_search.xml). Search Source File Customization Search Source File Customization You can ask the distributor or Yealink FAE for a supper search template. You can also refer to the following template: <?xml version="1.0"?>...
  • Page 536 0: Disabled 1: Enabled. the desired directory list. The applicable phone models of the directory list. AX83H  NOTE NOTE Do not edit this field. Customizing Search Source File Customizing Search Source File 1. Open the search source file.
  • Page 537 Administrator Guide Search Source List Configuration Search Source List Configuration The following table lists the parameters you can use to configure the search source list. Configuration parameter Configuration parameter super_search.url search_in_dialing.local_directory.enable search_in_dialing.local_directory.priority search_in_dialing.history.enable search_in_dialing.history.priority search_in_dialing.remote_phone_book.enable search_in_dialing.remote_phone_book.priority search_in_dialing.ldap.enable search_in_dialing.ldap.priority Permitted Permitted Parameter Parameter Description...
  • Page 538 Administrator Guide Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Directory Directory > Settings Settings > Search Source List In Dialing Search Source List In Dialing . Recent Call Display in Dialing Recent Call Display in Dialing Recent call display allows you to view the placed calls list when the phone is on the dialing screen (lifts the handset, presses the Speakerphone key or desired line key).

  • Page 539: Screen Saver

    Administrator Guide Screen Saver Screen Saver Screen Saver Screen Saver The screen saver will automatically start when the IP phone is idle for the preset waiting time. You can stop the screen saver at any time by pressing any key or touching the screen. When your phone is idle again for a preset waiting time, the screen saver starts again.
  • Page 540 Administrator Guide YealinkIPPh oneCustom LineSpacin The vertical distance between different lines. ScreenSave InsertImage Specify which line to insert the image (configured by the Image element). LineNum Size horizontalAl Specify “show” or “hide” between <SystemTime> </SystemTime> SystemTim decide whether to display the time and date. Edit the attributes to decide how verticalAlig to display the time and date, including the size, position, and color.
  • Page 541 Note Model Model Size Size <=4.2 2MB of space should be reserved for *.jpg/*.png/*.bmp/*.j AX83H <=5MB megapixels the phone Screensaver Configuration Screensaver Configuration The following table lists the parameters you can use to configure the screensaver. Configuration parameter Configuration parameter screensaver.wait_time...
  • Page 542 Administrator Guide It enables or disables the phone to display the clock and icons when the screen saver starts. screensaver  NOTE NOTE 0-Disabled .display_clo 1-Enabled It works only if ck.enable “screensaver.type” is set to 0 (System) or 1 (Custom). 0-System, the LCD screen will display the built-in picture.
  • Page 543 Administrator Guide It deletes the specified or all custom screen saver images. Example: Delete all custom screen saver images: screensaver screensaver.delete = http://localhost/all or http://localhost/name. Blank .delete http://localhost/all (jpg/png/bmp/jpeg) Delete a custom screen saver image (for example, Screencapture.jpg): screensaver.delete = http://localhost/Screenca pture.jpg It configures the interval...

  • Page 544: Sleep Time

    Administrator Guide Deleting a Screensaver Picture Deleting a Screensaver Picture You can delete the uploaded custom pictures for a specific IP phone via the web user interface at the path: Settings Settings > Preference Preference, select Custom from the Screensaver Type field, and then select a desired custom picture from the Screensaver field, click Del (Delete).

  • Page 545: Wallpaper Settings

    Administrator Guide Set via the Web User Interface Set via the Web User Interface On the web user interface, go to Settings Settings > Preference Preference > Sleep Time Sleep Time. Configuration Parameter Configuration Parameter phone_setting.sleep_time Permitted Permitted Parameter Parameter Description Description Default...
  • Page 546 Administrator Guide Wallpaper Configuration Wallpaper Configuration You can change the wallpaper to any built-in picture or custom picture. The following table lists the parameters you can use to change the wallpaper. Configuration parameter Configuration parameter phone_setting.backgrounds Parameter Parameter Description Description Permitted Permitted Values Values...
  • Page 547 Administrator Guide <=2 2MB of space should be reserved for the *.jpg/*.png/*.bmp/*.j AX83H <=5MB megapixels phone Custom Wallpaper Configuration Custom Wallpaper Configuration The following table lists the parameter you can use to upload a custom picture. Configuration parameter Configuration parameter wallpaper_upload.url...
  • Page 548 Customization of "Com Version" and "MAC Version" Customization of "Com Version" and "MAC Version" In version V86, Yealink IP Phone devices have added the customization feature for "Com Version" and "MAC Version". This feature is solely used for modifying the display and serves no other purpose.

  • Page 549: Input Method

    Hebrew. The changes in the “Hebrew_ime.txt” file becomes effective when the language is set to Hebrew. You can ask the distributor or Yealink FAE for keypad input method file. You can also refer to the following template: [2aB] 1 = "1"...
  • Page 550 Administrator Guide [abc] 1 = "" 2 = "abc2äæåàáâãç" 3 = "def3èéêëð" 4 = "ghi4ìíîï" 5 = "jkl5£" 6 = "mno6öøòóôõñ" 7 = "pqrs7ßЅ" 8 = "tuv8ùúûü" 9 = "wxyz9ýÞ" 0 = " " * = "*.,'?!\-()@/:_;+&%=<>￡$¥¤[]{}~^¡¿§#"|" # = "#" [Abc] 1 = ""...
  • Page 551 Administrator Guide 4 = "4" 5 = "5" 6 = "6" 7 = "7" 8 = "8" 9 = "9" 0 = "0" * = "*" # = "#" [2aB_PWD] 1 = "1" 2 = "2abcABC" 3 = "3defDEF" 4 = "4ghiGHI" 5 = "5jklJKL"...
  • Page 552 Administrator Guide 8 = "8" 9 = "9" 0 = "0" * = ".*:/@[]" # = "#" Customizing the Keypad Input Method File Customizing the Keypad Input Method File When adding new characters for the existing input method, ensure that the added characters are supported by the phones.
  • Page 553 Administrator Guide  NOTE NOTE If you just want to customize the input method for a certain language, the file name must be “language name_ime.txt” (for example, German_ime.txt). The valid language names are: English, Chinese_S, Chinese_T, French_CA, French, German, Italian, Polish, Portuguese, Portuguese_LA, Spanish, Spanish_LA, Turkish and Russian Input Method Configuration Input Method Configuration...
  • Page 554 Administrator Guide It deletes the specified or all custom keypad input method files of the phone user interface. Delete all custom keypad input method files: gui_input_ http://localhost/all or gui_input_method.delete = http://localhost/all method.del http://localhost/Name.t Blank Delete a custom keypad input method file (for example, custom_ime.txt) for the phone: gui_input_method.delete = http://localhost/custom_ime.txt...

  • Page 555: Notification Popups

    Administrator Guide gui_onscreen_keyboard.url = http://192.168.10.25/keyboard_layout_2.xml After provisioning, you can use the French onscreen keyboard for entering information. Notification Notification Notification Popups Notification Popups The notification popups feature allows the IP phone to pop up the message when it misses a call, forwards an incoming call to another party, or receives a new voice mail or a new text message.
  • Page 556 Administrator Guide It enables or disables the phone to pop up the message when it receives a new voice mail. If the message disappears, it will not pop up again unless the phone receives a new voice mail or the user re-registers the account that has unread voice mail(s).

  • Page 557: Power Led Indicator

    Administrator Guide Power LED Indicator Power LED Indicator Power LED indicator indicates the power status and phone status. You can configure the power LED indicator behavior in the following scenarios: The IP phone receives an incoming call The IP phone receives a voice mail or a text message A call is muted A call is placed on hold or is held The IP phone is busy...
  • Page 558 Administrator Guide 0-Disabled (power LED indicator does not flash) It enables or disables 1-Enabled (power LED indicator fast flashes (0.3s) phone_setti the power LED indicator red) ng.ring_po to flash when the phone For T19§ E2 phones: wer_led_fla receives an incoming 0-Disabled (power LED indicator does not flash) sh_enable call.
  • Page 559 Administrator Guide Bluetooth Bluetooth Bluetooth Bluetooth You can pair and connect a Bluetooth headset with the phone. Bluetooth Configuration Bluetooth Configuration You can activate or deactivate the Bluetooth mode and personalize the Bluetooth device name for the IP phone. The pre-configured Bluetooth device name will be displayed in a scanning list of other devices. It is helpful for the other Bluetooth devices to identify and pair with your phone.
  • Page 560 It works only if “static.bluetooth.function.en able” is set to 1 (Enabled). It configures the Bluetooth device name. features.blu  NOTE NOTE Yealink- etooth_ada String within 64 characters $DEV It works only if pter_name “features.bluetooth_enable” is set to 1 (On). It enables or disables the phone to bluetooth.c...

  • Page 561: Handset/Headset/Speakerphone Mode

    Handset/Headset/Speakerphone Mode Handset/Headset/Speakerphone Mode Handset/Speakerphone Mode Handset/Speakerphone Mode Yealink phones support three ways to place/answer a call: using the handset, headset, or speakerphone. You can disable the infrequently used audio device as required. Handset/Speakerphone Mode Configuration Handset/Speakerphone Mode Configuration The following table lists the parameters you can use to configure handset/headset/speakerphone mode.
  • Page 562 Administrator Guide features.hea It enables or disables 0-Disabled dset_mode.e the phone’s headset 1-Enabled nable mode. 0-Always use (pressing the Speakerphone key and phone_settin It configures headset picking up the handset are not effective when the g.headsetkey mode during a call. headset mode is activated) _mode 1-Use as normal...

  • Page 563: Firmware Upgrade

    Downgrading will result in some configurations being cleared, so please restore the factory settings after downgrading before using the device again. Firmware Downloading Firmware Downloading You can download the latest firmware online: http://support.yealink.com/documentFront/forwardToDocumentFrontDisplayPage. Firmware Upgrading Firmware Upgrading  NOTE NOTE Do not close and refresh the browser when the device is upgrading firmware via the web user interface.

  • Page 564: Get Start

    Administrator Guide The following table lists the parameter you can use to upgrade firmware. static.firmware.url Parameter Parameter Description Description Permitted Values Permitted Values Default Default static.firmware.u It configures the access URL of the firmware URL within 511 Blank file. characters 2.
  • Page 565 Administrator Guide BIN Configuration BIN Configuration The bin file primarily stores the configuration information of the phone, which helps determine if the issue is caused by abnormal configuration parameters.  NOTE NOTE The *.bin file you export may contain some of your personal data, including contacts, history records, web-side login information, etc.
  • Page 566  NOTE NOTE To capture syslog, please ensure that the Log Level is set to 6. Export All Diagnostic Files Export All Diagnostic Files Export All Diagnostic Files Yealink phones support three types of diagnostic files (including Pcap trace, log files...

  • Page 567: Log Files

    Introduction Yealink phone can log events into two different log files: boot log and system log. You can send the log to a syslog server in real time, and use these log files to generate informational, analytic, and troubleshooting phones.

  • Page 568: Syslog Logging

    Administrator Guide < MAC >- It reports the logs with a configured severity level and the higher. sys.l < MAC >- all.tgz For example, if you have set the severity level to 4, then the logs with a sys.log severity level of 0 to 4 will all be reported. Syslog Logging Syslog Logging You can also configure the to send syslog messages to a syslog server in real time.

  • Page 569: Packets Capture

    You can analyze the packet captured for troubleshooting purpose. Capture the Packets via Web User Interface Capture the Packets via Web User Interface For Yealink phones, you can export the packets file to the local system and analyze it. Procedure Procedure...

  • Page 570: Reset To Factory Settings

    Administrator Guide 1. From the web user interface, go to Settings Settings > Configuration Configuration. 2. Click Start Start in the Pcap Feature Pcap Feature field to start capturing signal traffic. 3. Reproduce the issue to get stack traces. 4. Click Stop Stop in the Pcap Feature Pcap Feature field to stop capturing.
  • Page 571 Administrator Guide the settings defined by the user to keep some custom settings after resetting. You have to import the custom factory configuration files in advance.  NOTE NOTE The Reset local settings Reset local settings/Reset non-static settings Reset non-static settings/Reset static settings Reset static settings/Reset userdata &...
  • Page 572 We recommend that you edit the exported CFG file instead of the BIN file to change the phone’s current settings. The config.bin file is an encrypted file. For more information on config.bin file, contact your Yealink reseller. Export CFG Configuration Files from Phone Export CFG Configuration Files from Phone You can export the phone’s configuration file to local and make changes to the phone’s current feature settings.
  • Page 573 Administrator Guide contain the changes for phone features and these changes will take effect after importing. Procedure Procedure 1. Go to Settings Settings > Configuration Configuration. 2. In the Import CFG Configuration File Import CFG Configuration File field, click Browse Browse to locate a CFG configuration file in your local system.
  • Page 574 Administrator Guide 1. From the web user interface, click Settings Settings > Configuration Configuration > BIN Configuration BIN Configuration. 2. In the Export Configuration Export Configuration field, click Export Export to open the file download window, and then save the file to your local system.
  • Page 575 Introduction Introduction Yealink phones support three types of diagnostic files (including Pcap trace, log files (boot.log and sys.log), and BIN configuration files) to help analyze your problem. You can export these files at a time and troubleshoot if necessary. The file format of the exported diagnostic file is *.tar.

  • Page 576: Watch Dog

    A diagnostic file named -DiagnoseInfo.tar is successfully exported to your local system. <MAC> After exporting the diagnostic files, you can create a ticket to describe your problem at ticket.yealink.com, and Yealink support team will help you locate the root cause.  NOTE NOTE "Export All Diagnostic Files"...

  • Page 577: Watch Dog Configuration

    Its main function is to restart processes that have crashed due to unknown internal errors, often accompanied by device restarts. If you have contacted Yealink's technical support, you can, if necessary, disable this feature and capture relevant data under the guidance of technical support.

  • Page 578: Phone Reboot

    Administrator Guide Phone Reboot Phone Reboot Introduction Introduction You can reboot the phone remotely or locally. Reboot the Phone Remotely Reboot the Phone Remotely You can reboot the phones remotely using a SIP NOTIFY message with “Event: check-sync” header. Whether the phone reboots or not depends on .
  • Page 579 Administrator Guide Example of Troubleshooting Example of Troubleshooting This chapter will demonstrate troubleshooting methods through several common examples.  NOTE NOTE If the scenario involves device reboot, upgrade, or any other action that may clear the device cache, please make sure to provide both syslog and local log to avoid any loss of data and save your valuable time. Troubleshooting Sound Issues Troubleshooting Sound Issues The following section provides troubleshooting methods and examples for common audio issues and how to...
  • Page 580 4. After reproducing the issue, record the timestamp and export the Diagnostic files. ​ 5.Please compress the .dat and .tar files into a single archive and send them to Yealink technical support(https://ticket.yealink.com/index). You can either name the archive with the timestamp or mention the timestamp in the problem description.
  • Page 581 2. After encountering the issue, wait for the device to successfully boot up and then export the local log. 3. Please compress the syslog and .tar files into a single archive and send them to Yealink technical support. You can either name the archive with the timestamp or mention the timestamp in the problem description.
  • Page 582 Administrator Guide 1. Check if the server address entered in the device is correct. Incorrect addresses can result in the device sending requests to the wrong address, leading to failure. 2. Verify the network connectivity between the device and the server. You can use the device to ping the server address：...

Table of Contents

Save PDF