Yealink SIP-T23 Provisioning Manual

Yealink SIP-T23 Provisioning Manual

Sip-t2 series
Hide thumbs Also See for SIP-T23:

Advertisement

Table of Contents
i

Advertisement

Table of Contents
loading

Summary of Contents for Yealink SIP-T23

  • Page 1 Table of Contents...
  • Page 2 Yealink IP Phones Auto Provisioning Guide...
  • Page 3: Table Of Contents

    Table of Contents Table of Contents ..............iii Introduction ................1 Getting Started ................. 3 Obtaining Configuration Information ................3 Obtaining Configuration Files ..................3 Obtaining Phone Information ..................4 Managing Configuration Files .................... 4 Editing Common CFG File ....................4 Editing MAC-Oriented CFG File ..................
  • Page 4 Yealink IP Phones Auto Provisioning Guide Downloading and Verifying Configurations ......45 Downloading Configuration Files ..................45 Resolving and Updating Configurations ................. 45 Downloading and Updating <MAC>-local.cfg File ............46 Verifying Configurations ....................46 Specific Scenarios ......................48 Configuration Parameters ....................48 Scenario A Protect personalized configuration settings ..........
  • Page 5: Introduction

    This guide provides instructions on how to provision Yealink IP 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 6 Yealink IP Phones Auto Provisioning Guide...
  • Page 7: Getting Started

    <MAC>-local.cfg file, refer to Scenario D Import or export the local configuration file on page 55. You can ask the distributor or Yealink FAE for Common CFG and MAC-Oriented files. You can also obtain the Common CFG file and MAC-Oriented file online:...
  • Page 8 IP address of the SIP server. Ask your system administrator for SIP account information. Auto provisioning enables Yealink IP phones to update themselves automatically via downloading Common CFG and MAC-Oriented CFG files. Before beginning provisioning, you may need to edit and customize your configuration files. Open each configuration file with a text editor such as UltraEdit.
  • Page 9 Getting Started The following figure shows a portion of the common CFG file: The line beginning with “#” is considered to be a comment. The file header “#!version:1.0.0.1” is not a comment and must be placed in the first line. It cannot be edited or deleted. The partial parameters in the Common CFG file are described as follows: #################################################### Common CFG File...
  • Page 10 ##1-Full duplex 10Mbps ##2-Full duplex 100Mbps ##3-Half duplex 10Mbps ##4-Half duplex 100Mbps ##5-Full duplex 1000Mbps (only applicable to SIP-T23 (P/G), SIP-T42G and SIP-T46G IP phones) ##The default value is 0.It takes effect after a reboot. network.internet_port.speed_duplex = MAC-Oriented CFG file contains configuration parameters which are expected to be updated per phone, such as the registration information.
  • Page 11 ##The default value is 0. account.1.sip_server.1.transport_type = account.1.sip_server.2.transport_type = SIP-T23/T23P/T23G IP phones support 3 accounts. MAC-local CFG file is automatically filled with configurations modified via web user interface or phone user interface. The file is stored locally on the IP phone and can also be uploaded to the provisioning server.
  • Page 12 Yealink IP Phones Auto Provisioning Guide Updating the <MAC>-local.cfg file You can configure whether the IP phone updates configurations in the <MAC>-local.cfg file during auto provisioning. This process is controlled by the value of the parameter “auto_provision.custom.protect”. When the value of the parameter “auto_provision.custom.protect”...
  • Page 13 Getting Started forward.busy.off_code = #Configure no answer forward feature. forward.no_answer.enable = forward.no_answer.target = forward.no_answer.timeout = forward.no_answer.on_code = forward.no_answer.off_code = #Configure DND feature. features.dnd.enable = features.dnd.on_code = features.dnd.off_code = #Configure always forward feature for account X. account.X.always_fwd.enable = account.X.always_fwd.target = account.X.always_fwd.on_code = account.X.always_fwd.off_code = #Configure busy forward feature for account X.
  • Page 14: Editing Mac-Oriented Cfg File

    When configuring some particular features, you may need to upload resource files to IP phones, such as personalized ring tone file, language package file and logo file. Yealink supplies some resource file templates for the particular features. Ask the distributor or Yealink FAE for resource file templates.
  • Page 15 Getting Started Yealink IP phones have built-in system ring tones. You can change the ring type, or customize a ring tone and upload it to the IP phone via auto provisioning. The ring tone file must meet the following: File Format...
  • Page 16 Yealink IP Phones Auto Provisioning Guide The following table lists available languages and the associated language files for phone user interface: Available Language Associated Language File English 000.GUI.English.lang Simplified Chinese 001.GUI.Chinese_S.lang Traditional Chinese 002.GUI.Chinese_T.lang German 003.GUI.German.lang French 004.GUI.French.lang Italian 005.GUI.Italian.lang Polish 006.GUI.Polish.lang...
  • Page 17 Getting Started The following figure shows a portion of a lang formatted English language file: #################################################### Configure the custom LCD language file #################################################### #Specify the access URL of the custom LCD language file. gui_lang.url = If you want to modify the existing language translation for the IP phone user interface, edit the language translation and then configure the parameter “gui_lang.url =”...
  • Page 18 Yealink IP Phones Auto Provisioning Guide If you want to add a new language “wuilan” to SIP-T23G IP phones, prepare the language file named as 011.GUI.wuilan.lang for downloading and configure the parameter “gui_lang.url =” in the configuration file, for example: gui_lang.url = tftp://192.168.1.100/011.GUI.wuilan.lang...
  • Page 19 Getting Started Associated Note Language Associated Language Available Language Pack Pack Polish 7.Polish.js 7.Polish_note.xml Portuguese 8.Portuguese.js 8.Portuguese_note.xml Spanish 9.Spanish.js 9.Spanish_note.xml Turkish 10.Turkish.js 10.Turkish_note.xml Russian 11.Russian.js 11.Russian_note.xml The following figure shows a portion of a js formatted English language file:...
  • Page 20 Yealink IP Phones Auto Provisioning Guide The following figure shows a portion of an xml formatted English note language file: #################################################### Configure the custom web and note language files #################################################### #Specify the access URL of the custom web language file.
  • Page 21 12 “Y” means the language name. To modify translation of an existing language, do not rename the language file. Yealink IP phones allow you to customize the logo displayed on the LCD screen. These two IP phone models use the wallpaper instead.
  • Page 22 When editing the local contact template file, learn the following: Add groups between <root_group> and </root_group>.  At most 48 groups (including the default groups) can be stored on SIP-T23 (P/G) IP  phones. Add local contacts between <root_contact> and </root_contact>.
  • Page 23 Getting Started display_name=”” specifies the name of the group. ring=”” specifies the ring tone for this group. For each contact that you wish to add, add the following string to the file. Each starts on a separate line: <contact display_name=”” office_number=”” mobile_number=”” other_number=”” line=””...
  • Page 24 Yealink IP Phones Auto Provisioning Guide The following shows an example of a local contact file used for SIP-T23 (P/G) IP phones: <root_group> <group display_name="All Contacts" ring=""/> <group display_name="Family" ring="Resource:Ring1.wav"/> <group display_name="Friend" ring="Auto"/> </root_group> <root_contact> <contact display_name="Mary" office_number="123" mobile_number="456" other_number="2201" line="0" ring="Auto" group_id_name="Family"/>...
  • Page 25 ID. The digit 0 stands for all lines. Multiple line IDs are separated by commas. At most 100 replace rules can be added to the IP phone.  For the basic expression syntax of the replace rule, refer to Yealink phone-specific  user guide. To customize a replace rule file: Open the template file using an ASCII editor.
  • Page 26 ID. The digit 0 stands for all lines. Multiple line IDs are separated by commas. At most 100 dial-now rules can be added to the IP phone.  For the basic expression syntax of the dial-now rule, refer to Yealink phone-specific  user guide.
  • Page 27 Getting Started When editing a directory template, learn the following: Do not rename the directory template.  <root_favorite_set> indicates the start of a template and </root_favorite_set>  indicates the end of a template. The default display names of directory lists are Local Directory, History, Remote ...
  • Page 28 Yealink IP Phones Auto Provisioning Guide The following shows an example of a directory template: <root_favorite_set> <item id_name="localdirectory" display_name="Local Directory" priority="1" enable="1" /> <item id_name="history" display_name="History" priority="2" enable="0" /> <item id_name="remotedirectory" display_name="Remote Phone Book" priority="3" enable="0" /> <item id_name="ldap" display_name="LDAP" priority="4" enable="0" />...
  • Page 29 Getting Started To customize a super search template: Open the template file using an ASCII editor. For each directory list that you want to configure, edit the corresponding string in the file. For example, you want to configure the local directory list, edit the following strings: <item id_name="local_directory_search"...
  • Page 30 Yealink IP Phones Auto Provisioning Guide Yealink IP phones allow you to upgrade firmware manually via web user interface, or upgrade firmware in batch via auto provisioning. The following table lists the firmware name for the phone model (X is replaced by the...
  • Page 31: Configuring A Tftp Server

    Configuring a TFTP Server Yealink IP phones support using FTP , TFTP , HTTP and HTTPS protocols to download 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 32 Yealink IP Phones Auto Provisioning Guide If you have a 3CDaemon application installed on your local system, use it directly. Otherwise, download and install it. To configure a TFTP server: Double click 3CDaemon.exe to start the application. A configuration page is shown as below: Select Configure TFTP Server.
  • Page 33: Obtaining The Provisioning Server Address

    Obtaining the Address of Provisioning Server Yealink IP phones support obtaining the provisioning server address in the following ways: Zero Touch  Plug and Play (PnP) Server  DHCP Options  Phone Flash  Configuring Wildcard of the Provisioning Server URL ...
  • Page 34 Yealink IP Phones Auto Provisioning Guide Configure the wait time in the Wait Time (0~100s) field. The default value is 5. Click Confirm to accept the change. When Zero Touch is enabled, there will be a configuration wizard during startup: Press the OK soft key.
  • Page 35 Obtaining the Address of Provisioning Server An example of screenshot is shown as below: Yealink IP 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.
  • Page 36 Then the IP phone can connect to the provisioning server and perform the auto provisioning process. Yealink IP phones support obtaining the provisioning server address by detecting DHCP options.
  • Page 37 Obtaining the Address of Provisioning Server The default value is yealink. Click Confirm to accept the change. The phone will broadcast DHCP request with DHCP options for obtaining the provisioning server address. The provisioning server address will be found in the...
  • Page 38 Copy->Bytes->Printable Text Only. Paste the copied text in your favorite text editor to check the address, for example, tftp://192.168.1.100/. Yealink IP phones support obtaining 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.
  • Page 39 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 ...
  • Page 40 Yealink IP Phones Auto Provisioning Guide from the identified directory on the provisioning server. The value of the parameter “auto_provision.url_wildcard.pn” must be configured in accordance with the directory name of the provisioning server directory where the configuration files of the IP phones are located.
  • Page 41: Configuring The Update Mode

    Configuring the Update Mode The update mode is used to set the desired time to trigger the IP phone to perform the auto provisioning process. This chapter introduces the following update modes in detail: Power On  Repeatedly  Weekly ...
  • Page 42 Yealink IP Phones Auto Provisioning Guide Mark the On radio box in the Power On field. Click Confirm to accept the change. The IP phone performs the auto provisioning process at regular intervals. You can configure the interval for the Repeatedly mode. The default interval is 1440 minutes.
  • Page 43 Configuring the Update Mode Enter the interval time (in minutes) in the Interval (Minutes) field. Click Confirm to accept the change. The IP phone performs the auto provisioning process at the fixed time every week. You can configure what time of the day and which day of the week to trigger the IP phone to perform the auto provisioning process.
  • Page 44 Yealink IP Phones Auto Provisioning Guide Mark one or more checkboxes in the Day of Week field. Click Confirm to accept the change. You can use Auto Provision Now mode to manually trigger the IP phone to perform the auto provisioning process immediately.
  • Page 45 Configuring the Update Mode Click Autoprovision Now. The IP phone will perform the auto provisioning process immediately. You can activate more than one update mode for auto provisioning. For example, you can activate the “Power On” and “Repeatedly” modes simultaneously. The IP phone will perform the auto provisioning process when it is powered on and at a specified interval.
  • Page 46 Yealink IP Phones Auto Provisioning Guide The following figure shows the message flow: In addition to the updating modes introduced above, users can trigger IP phones to perform auto provisioning by dialing an activation code. To use this method, the activation code and the provisioning server address need to be pre-configured on the IP phones.
  • Page 47 Configuring the Update Mode configuration files for different IP phones. To access the specified directory, you need to provide the correct user name and password configured for the directory. Configure unique activation codes and the provisioning server URLs on IP phones. The activation code can be numeric string and special characters “* #”...
  • Page 48 Yealink IP Phones Auto Provisioning Guide The following parameters are used to configure the auto provisioning via activation code method (X ranges from 1 to 50): #Configure the auto provisioning name. autoprovision.X.name #Configure the activation code. autoprovision.X.code #Configure the URL of the provisioning server.
  • Page 49: Downloading And Verifying Configurations

    Common CFG file and the MAC-Oriented AES key to decrypt the <MAC>.cfg file after downloading the configuration files. For more information on how Yealink Configuration Encryption Tool the IP phone decrypts configuration files, refer to User Guide...
  • Page 50 50. After auto provisioning, you can then verify the update via phone user interface or web user interface of the phone. For more information, refer to Yealink phone-specific user guide. During the auto provisioning process, you can monitor the downloading requests and response messages by a WinPcap tool.
  • Page 51 Downloading and Verifying Configurations Example 2: Yealink SIP-T23G IP phone downloads configuration files from the FTP server. Example 3: Yealink SIP-T23G IP phone downloads configuration files from the HTTP server.
  • Page 52: Specific Scenarios

    X.80.0.5 or later. The following demonstrated specific scenarios are taking SIP-T23G IP phones as example for reference. Yealink IP phones support FTP , TFTP , HTTP and HTTPS protocols for uploading the MAC-local CFG file. This section takes the TFTP protocol as an example. Before performing the following, make sure the provisioning server supports uploading.
  • Page 53 Downloading and Verifying Configurations Parameters Permitted Values Default the provisioning server to back up this file. During auto provisioning, the IP phone will download the <MAC>-local.cfg file from the provisioning server to override the one stored on the phone. If it is set to 0 (Disabled), the IP phone will not upload the <MAC>-local.cfg file to the provisioning server.
  • Page 54: Scenario Protect Personalized Configuration Settings

    Yealink IP Phones Auto Provisioning Guide The administrator wishes to upgrade firmware from the old version to the latest version. Meanwhile, protect personalized settings after auto provisioning and upgrade. Scenario Conditions: SIP-T23G IP phone current firmware version: 44.80.0.1. This firmware supports ...
  • Page 55 Downloading and Verifying Configurations phone will save the personalized configuration settings to the 00156574b150-local.cfg file on the IP phone, and then periodically (every 5 minutes) upload this file to the provisioning server. If a configuration item is both in the downloaded MAC-local.cfg file and Common CFG file/ MAC-Oriented CFG file, setting of the configuration item in the MAC-local CFG file will be written and saved to the IP phone system.
  • Page 56 Yealink IP Phones Auto Provisioning Guide matter what the value of the parameter “auto_provision.custom.sync” is. If a configuration is modified via both web user interface and phone user interface, the later modification will prevail. For more information on the flowchart of protect personalized configuration settings,...
  • Page 57 Downloading and Verifying Configurations To clear personalized configuration settings via web user interface: Click on Settings->Upgrade. Click Reset Local Config. The web user interface prompts “Are you sure to reset the local configuration?”. Click OK. Configurations in the 00156574b150-local.cfg file saved on the phone will be cleared. If the IP phone is triggered to perform auto provisioning after resetting local configuration file, it will download the configuration files from the provisioning server and update the configurations to the phone system.
  • Page 58 Yealink IP Phones Auto Provisioning Guide Scenario Operations: You can protect the personalized settings of the phone after factory reset via phone or web user interface. To reset the phone to factory via phone user interface: Press Menu->Settings->Advanced Settings (password: admin).
  • Page 59 Downloading and Verifying Configurations To retrieve personalized settings of the phone after factory reset: Set the values of the parameters “auto_provision.custom.sync” and “auto_provision.custom.protect” to be 1 in the configuration file (y000000000044.cfg or 00156574b150.cfg). Trigger the phone to perform the auto provisioning process. The IP phone will download the 00156574b150-local.cfg file from the provisioning server, and then update configurations in it during auto provisioning.
  • Page 60 Yealink IP Phones Auto Provisioning Guide Select Local_Configuration from the pull down list of Export CFG Configuration File field, and then click Export to open file download window, and then save the 00156574b150-local.cfg file to the local system. The administrator or user can edit the 00156574b150-local.cfg file after exporting.
  • Page 61 Downloading and Verifying Configurations The existing local configuration file will be overridden by the imported one after importing. The configurations in the importing 00156574b150-local.cfg file will be saved to the phone flash and take effect. If the administrator or user deletes the configurations in the 00156574b150-local.cfg file and then import the file to the phone, the IP phone will remain the original configurations.
  • Page 62 Yealink IP Phones Auto Provisioning Guide...
  • Page 63: 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. Why does the IP phone fail to download configuration files? Ensure that auto provisioning feature is configured properly.
  • Page 64 Yealink IP Phones Auto Provisioning Guide Why doesn’t the IP phone download the ring tone? Ensure that the file format of the ring tone is *.wav.  Ensure that the size of the ring tone file is no larger than that the IP phone supports.
  • Page 65: Glossary

    Glossary MAC Address: A Media Access Control address (MAC address) is a unique identifier assigned to network interfaces for communications on the physical network segment. MD5: The MD5 Message-Digest Algorithm is a widely used cryptographic hash function that produces a 128-bit (16-byte) hash value. DHCP: Dynamic Host Configuration Protocol (DHCP) is a network configuration protocol for hosts on Internet Protocol (IP) networks.
  • Page 66 Yealink IP Phones Auto Provisioning Guide...
  • Page 67: Appendix

    Appendix Wftpd and FileZilla are free FTP application softwares for Windows. This section mainly provides instructions on how to configure an FTP server using wftpd for Windows. You can download wftpd online: http://www.wftpd.com/products/products.html or FileZilla online: https://filezilla-project.org. We recommend that you use vsftpd as a FTP server for Linux platform if required.
  • Page 68 Yealink IP Phones Auto Provisioning Guide To configure a wftpd server: Download the compressed file of the wftpd application to your local directory and extract it. Double click the WFTPD.EXE. The dialogue box of how to register is shown as below: Check the check box and click OK in the pop-up dialogue box.
  • Page 69 Appendix Click Security->Users/rights. Click New User. Enter a user name (e.g., test1) in the User Name field and then click OK.
  • Page 70 Yealink IP Phones Auto Provisioning Guide Enter the password of the user (e.g., test1) created above in the New Password and Verify Password fields respectively, and then click OK. Click Browse to locate the FTP root directory from your local system.
  • Page 71 Appendix downloads configuration files from. Before configuring a wftpd server, ensure that no other FTP servers exist in your local system. This section provides instructions on how to configure an HTTP server using HFS tool. You can download the HFS software online: http://www.snapfiles.com/get/hfs.html. To prepare a root directory: Create an HTTP root directory on the local system.
  • Page 72 Yealink IP Phones Auto Provisioning Guide HFS tool is an executable application, so you don’t need to install it. To configure an HTTP server: Download the application file to your local directory, double click the hfs.exe. The main configuration page is shown as below:...
  • Page 73 Appendix Click Menu in the main page and select the IP address of the PC from IP address. The default HTTP port is 8080. You can also reset the HTTP port (make sure there is no port conflict).
  • Page 74 Check the server URL (e.g., http:// 10.2.11.101:8088/ProvisioningDir) by clicking “Open in browser”. Yealink IP phones also support the Hypertext Transfer Protocol with SSL/TLS (HTTPS) protocol for auto provisioning. HTTPS protocol provides the encrypted communication and secure identification. For more information on installing and configuring an Apache HTTPS...
  • Page 75 Appendix This section provides instructions on how to configure a DHCP server for Windows using DHCP Turbo. You can download this software online: http://www.tucows.com/preview/265297 and install it following the setup wizard. Before configuring the DHCP Turbo, make sure: The firewall on the PC is disabled. ...
  • Page 76 Yealink IP Phones Auto Provisioning Guide Click OK to accept the change. You can add a custom option via DHCP Turbo. Select Option Types, right click one of the options on the right of the main page, and then select New Option Type.
  • Page 77 Set the custom DHCP option (custom DHCP option tag number ranges from 128 to 254) and select the option type (Yealink supports String and IP Address option types only). Click the OK button to finish setting the option properties. Click save the change.
  • Page 78 Yealink IP Phones Auto Provisioning Guide Scroll down and double click the custom option 128. 10. Fill the provisioning server address in the input field. 11. Click the OK button to finish setting a custom option. 12. Click to save the change.
  • Page 79 Appendix You can add the option 66 via DHCP Turbo. The following shows the detailed processes. Click Named Policies-->Global, right click the blank area on the right of the main page and then select New Option. Select TFTP Options from the pull-down list of Filter. Scroll down and double click MS option 66.
  • Page 80 Yealink IP Phones Auto Provisioning Guide Fill the provisioning server address in the input field. Click the OK button to finish setting a custom option. Click to save the change. You can also add the option 43. The following shows the detailed processes.
  • Page 81 Appendix Fill the provisioning server address in the input field. Click the OK button to finish setting a custom option. Click to save the change. If you have installed the Cool Edit application, double click to open it. Otherwise, you can download the installation package online: http://www.toggle.com/lv/group/view/kl36218/Cool_Edit_Pro.htm and install it.
  • Page 82 Yealink IP Phones Auto Provisioning Guide A sample audio file loaded is shown as below: Select and copy the audio waveform. Select File->New to create a new file, set the channels as Mono, the sample rate as 8000 and the resolution as 16-bit.
  • Page 83 The original picture format must be *.bmp or *.gif. We recommend placing all files and the PictureExDemo application to the root directory of the PC. You can ask the distributor or Yealink FAE for the PictureExDemo application. Double click the PictureExDemo.exe.
  • Page 84 Yealink IP Phones Auto Provisioning Guide The following shows auto provisioning flowchart for Yealink IP phones when a user wishes to protect personalized configuration settings.
  • Page 85: Configuration Parameters In Cfg Files

    Appendix If you want to reset the configuration of a parameter, set the value of the parameter to !NULL! or %NULL%. For example, local_time.ntp_server1 = %NULL%. After the auto provisioning process is completed, the NTP server 1 will be reset to “cn.pool.ntp.org”. Permitted Parameter Descriptions...
  • Page 86 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to use manually configured static IPv4 DNS when the Internet (WAN) port type for IPv4 is configured as DHCP .
  • Page 87 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the IPv4 default gateway when the IP address mode is configured as IPv4 or IPv4&IPv6, and the Internet (WAN) port type Network->Basic->IPv4 Config->Static network.internet_port.gateway IPv4 address for IPv4 is configured as Static IP Address. IP Address->Gateway The default value is blank.
  • Page 88 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the user name for PPPoE connection when the IP address mode is configured as IPv4 or IPv4&IPv6, and the String within Network->Basic->IPv4 Config-> network.pppoe.user Internet port type is configured as PPPoE.
  • Page 89 Appendix Permitted Parameter Descriptions Web Setting Path Values Internet (WAN) port type for IPv6 is configured Static DNS as DHCP . 0-Disabled (use the IPv6 DNS obtained by DHCP) 1-Enabled The default value is 0. It takes effect after a reboot. It configures the IPv6 prefix when the IP address mode is configured as IPv6 or IPv4&IPv6, and the Internet (WAN) port type...
  • Page 90 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values IPv4&IPv6, and the Internet (WAN) port type for IPv6 is configured as Static IP Address. The default value is blank. It takes effect after a reboot. It configures the primary IPv6 DNS server when the IP address mode is configured as IPv6 or IPv4&IPv6, and the Internet (WAN) port...
  • Page 91 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It takes effect after a reboot. It configures the transmission method and speed of the Internet (WAN) port. 0-Auto negotiate 1-Full duplex 10Mbps 2-Full duplex 100Mbps 3-Half duplex 10Mbps 0, 1, 2, 3, 4 or Network->Advanced->Port Link->...
  • Page 92 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 3-Half duplex 10Mbps 4-Half duplex 100Mbps 5-Full duplex 1000Mbps The default value is 0. It takes effect after a reboot. Note: It cannot be configured via web user interface and 1000Mbps is only applicable to SIP-T23G IP phones.
  • Page 93 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It takes effect after a reboot. It enables or disables VLAN for the PC (LAN) port. 0-Disabled Network->Advanced->VLAN->PC network.vlan.pc_port_enable 0 or 1 1-Enabled Port->Active The default value is 0. It takes effect after a reboot.
  • Page 94 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It takes effect after a reboot. It configures the DHCP option from which the IP phone will obtain the VLAN settings. You Network->Advanced->VLAN->DHCP...
  • Page 95 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables the phone to use TTL in the A record. 0-Disabled network.dns.ttl_enable 0 or 1 1-Enabled The default value is 1. It takes effect after a reboot. It configures the MTU of network card. Integer from network.mtu_value The default value is 1500.
  • Page 96 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1-Enabled The default value is 1. It takes effect after a reboot. It configures the HTTP port for the user to access web user interface of the IP phone Integer from 1 Network->Advanced->Web...
  • Page 97 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the minimum local RTP port. Integer from Network->Advanced->Local RTP The default value is 11780. network.port.min_rtpport 1024 to 65535 Port->Min RTP Port (1024~65535) It takes effect after a reboot. It configures the DSCP for voice packets. Integer from 0 The default value is 46 (Expedited Network->Advanced->Voice QoS...
  • Page 98 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the 802.1x authentication method. 0-Disabled 1-EAP-MD5 2-EAP-TLS 3-EAP-PEAP/MSCHAPv2 0, 1, 2, 3, 4, 5, 6 Network->Advanced->802.1x->802.1 network.802_1x.mode or 7 4-EAP-TTLS/EAP-MSCHAPv2 x Mode 5-EAP-PEAP/GTC 6-EAP-TTLS/EAP-GTC 7-EAP-FAST The default value is 0.
  • Page 99 Appendix Permitted Parameter Descriptions Web Setting Path Values Note: It is required for all 802.1x authentication methods except EAP-TLS. It configures the access URL of the CA certificate when the 802.1x authentication method is configured as EAP-TLS, EAP-PEAP/MSCHAPV2, EAP-TTLS/EAP-MSCHAPV2, EAP-PEAP/GTC EAP-TTLS/EAP-GTC or EAP-FAST.
  • Page 100 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values *.pem or *.cer. It enables or disables 802.1x-logoff feature for the PC port. 0-Disabled network.802_1x.proxy_eap_logoff.enable 0 or 1 1-Enabled The default value is 0. It takes effect after a reboot.
  • Page 101 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It takes effect after a reboot. It configures the interval (in seconds) for the IP phone to send the LLDP request. The default value is 60. Integer from 1 Network->Advanced->LLDP->Packet network.lldp.packet_interval It takes effect after a reboot.
  • Page 102 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values parameter “network.cdp.enable” is set to 1 (Enabled). It enables or disables the IP phone to span data packets received from the WAN (Internet) port to the PC (LAN) port. If it is enabled, all packets from WAN port can be Network->Advanced->Span to...
  • Page 103 Appendix Permitted Parameter Descriptions Web Setting Path Values message The default value is 1. It takes effect after a reboot. It configures the IP phone behavior when receiving a SIP NOTIFY message which contains the header “Event: check-sync”. 0-The IP phone will reboot only if the SIP NOTIFY message contains an additional sip.notify_reboot_enable 0, 1or 2...
  • Page 104 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 256 characters in the SIP server address. The default value is blank. It configures the string returned as the reason of the register failure due to misconfiguration...
  • Page 105 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the constitution of the refer-bye header. 0-URI in the registration message sip.refer_by_header_auto_build 0 or 1 1-From header in the refer message The default value is 0. It takes effect after a reboot. It configures the special characters reserved -_.!~*#'()&=+ in the user name.
  • Page 106 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the local SIP port. Integer from sip.listen_port Settings->SIP->Local SIP Port 1024 to 65535 The default value is 5060. It configures the local TLS listen port.
  • Page 107 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the SIP session timer T1 (in seconds). Float from 0.5 T1 is an estimate of the Round Trip Time (RTT) Settings->SIP->SIP Session Timer T1 sip.timer_t1 to 10s of transactions between a SIP client and SIP (0.5~10s) server.
  • Page 108 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1-Server The default value is 0. It takes effect after a reboot. It configures the IP address or domain name of the syslog server when exporting log to the syslog server.
  • Page 109 Note: The configured characters must be in auto_provision.url_wildcard.pn 32 characters accordance with the actual directory name of the provisioning server. For SIP-T23 (P/G) IP phones, the default value is T23. It enables or disables the IP phone to protect personalized settings after auto provisioning. 0-Disabled 1-Enabled auto_provision.custom.protect...
  • Page 110 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values <MAC>-local.cfg file to the provisioning server, and download the <MAC>-local.cfg file from the provisioning server during auto provisioning. 0-Disabled 1-Enabled If it is set to 1 (Enabled), the IP phone will periodically upload the <MAC>-local.cfg file...
  • Page 111 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Put 1-Post The default value is 0. Note: It works only if the value of the parameter “auto_provision.custom.sync” is set to 1 (Enabled). It enables or disables the IP phone to reboot after auto provisioning when there is no specific configuration requiring a reboot.
  • Page 112 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 1. Note: The old parameter “auto_provision.mode” is also applicable to IP phones. It enables or disables Plug and Play (PnP) feature. If it is enabled, the IP phone will...
  • Page 113 Appendix Permitted Parameter Descriptions Web Setting Path Values digits 1-Monday 2-Tuesday 3-Wednesday 4-Thursday 5-Friday 6-Saturday Example: auto_provision.weekly.dayofweek = 01 means the IP phone will perform an auto provisioning process every Sunday and Monday. The default value is 0123456. Note: It works only if the value of the parameter “auto_provision.weekly.enable”...
  • Page 114 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values set to 1 (Enabled). The old parameter “auto_provision.schedule.time_from” is also applicable to IP phones. It configures the end time of the day for the IP phone to perform an auto provisioning process weekly.
  • Page 115 Appendix Permitted Parameter Descriptions Web Setting Path Values Note: It works only if the value of the parameter “auto_provision.weekly.enable” is set to 1 (Enabled).The old parameter “auto_provision.schedule.periodic_minute” is also applicable to IP phones. It enables or disables the IP phone to request the provisioning server address by detecting DHCP options.
  • Page 116 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the password for provisioning String within server access. auto_provision.server.password Settings->Auto Provision->Password 32 characters The default value is blank. It configures the value (vendor name of the String within Settings->Auto Provision->DHCP...
  • Page 117 Descriptions Web Setting Path Values For more information, refer to Yealink Configuration Encryption Tool User Guide It configures the plaintext AES key for decrypting the Common CFG file. The valid characters contain: 0 ~ 9, A ~ Z, a ~ z and the following special characters are also supported: # $ % * +, - .
  • Page 118 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values Note: It works only if the value of the parameter “auto_provision.aes_key_in_file” is set to 0 (Disabled). Yealink For more information, refer to Configuration Encryption Tool User Guide It configures the code name for triggering auto provisioning.
  • Page 119 Appendix Permitted Parameter Descriptions Web Setting Path Values by activation code. The default value is blank. It takes effect after a reboot. For more information, refer to Auto Provisioning via Activation Code on page 42. It configures the authentication user name for provisioning server access for auto provisioning which is triggered by activation code.
  • Page 120 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the plaintext AES key for decrypting the Common CFG file. If it is configured, it has a higher priority than the value configured in the parameter autoprovision.X.com_aes...
  • Page 121 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It enables or disables the IP phone to use RFC 2543 (c=0.0.0.0) outgoing hold signaling. 0-Disabled 1-Enabled If it is set to 0 (Disabled), SDP media direction Features->General Information->RFC sip.rfc2543_hold 0 or 1...
  • Page 122 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values dialog. The default value is 1. It takes effect after a reboot. It enables or disables the phone to close BLF monitoring feature for call park key.
  • Page 123 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the user name for the IP phone to authenticate with the ACS (Auto String within Configuration Servers). This string is set to the managementserver.username Settings->TR069->ACS Username 128 characters empty string if no authentication is required. The default value is blank.
  • Page 124 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the interval (in seconds) for the IP phone to report its configurations to the ACS Integer from 5 Settings->TR069->Periodic Inform managementserver.periodic_inform_interval (Auto Configuration Servers). to 4294967295 Interval (seconds) The default value is 60.
  • Page 125 Appendix Permitted Parameter Descriptions Web Setting Path Values besides pressing the Transfer/Tran soft key or Hook TRAN/TRANSFER key. 0-Disabled 1-Enabled The default value is 1. It enables or disables the IP phone to complete the semi-attended/attended transfer through on-hook besides pressing the Features->Transfer->Attend Transfer Transfer/Tran soft key or TRAN/TRANSFER key.
  • Page 126 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values dial, transfer or BLF/BLF list key. 0-New Call 1-Attended Transfer 2-Blind Transfer The default value is 2. It enables or disables the IP phone to select transferee’s call (a new call or another...
  • Page 127 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It enables or disables the IP phone to transfer the local conference call to the other two parties after the conference initiator drops the local conference call. 0-Disabled 1-Enabled Features->Transfer->Transfer on...
  • Page 128 Parameter Descriptions Web Setting Path Values 0-Disbaled 1-Enabled The default value is 0. For more information on VAD, refer to Yealink IP Phones Administrator Guide. It enables or disables CNG (Comfortable Noise Generator) feature. 0-Disabled Settings->Voice->Echo Cancellation voice.cng 0 or 1 1-Enabled ->CNG...
  • Page 129 0 or 1 Type The default value is 1. For more information on jitter buffer, refer to Yealink IP Phones Administrator Guide. It configures the minimum delay time (in milliseconds) of jitter buffer. Integer from 0 The default value is 60.
  • Page 130 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 120. Note: It works only if the value of the parameter “voice.jib.adaptive” is set to 0 (Fixed). Custom, Australia, Austria, Brazil, Belgium, China, Czech,...
  • Page 131 Appendix Permitted Parameter Descriptions Web Setting Path Values Portugal, Spain, Switzerland, Sweden, Russia, United States, Chile, Czech ETSI It customizes the dial tone. tonelist = element[,element] [,element]… Where element = [!]Freq1[+Freq2][+Freq3][+Freq4] /Duration Freq: the frequency of the tone (ranges from 200 to 7000 Hz).
  • Page 132 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values If you want the IP phone to play tones once, add an exclamation mark “!” before tones (e.g., !250/200, 0/1000, 200+300/500, 600+700+800+1000/2000). The default value is blank.
  • Page 133 Appendix Permitted Parameter Descriptions Web Setting Path Values Note: It works only if the value of the parameter “voice.tone.country” is set to Custom. It customizes the tone when the network is congested. The value format is Freq/Duration. For more information on the value format, refer to the parameter “voice.tone.dial”.
  • Page 134 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It customizes the call back tone. The value format is Freq/Duration. For more information on the value format, refer to the parameter “voice.tone.dial”. voice.tone.dialrecall String Settings->Tones->Dial Recall The default value is blank.
  • Page 135 Appendix Permitted Parameter Descriptions Web Setting Path Values Note: It works only if the value of the parameter “voice.tone.country” is set to Custom. It customizes the tone when the IP phone receives a voice mail. The value format is Freq/Duration. For more information on the value format, refer to the parameter “voice.tone.dial”.
  • Page 136 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It customizes the warning tone for auto answer. The value format is Freq/Duration. For more information on the value format, refer to the parameter “voice.tone.dial”. voice.tone.autoanswer String Settings->Tones->Auto Answer...
  • Page 137 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the receiving volume of the Integer from 1 handset during a call. voice.handset.spk_vol to 15 The default value is 8. It configures the dial tone or ringback tone Integer from 1 volume of the handset.
  • Page 138 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the sending volume of the headset. Integer from 1 Features->Audio->Headset Send voice.headset_send to 53 The default value is 30. Volume (1~53) It takes effect after a reboot.
  • Page 139 Appendix Permitted Parameter Descriptions Web Setting Path Values authenticate for TLS connection. 0-Default certificates 1-Custom certificates 2-All certificates The default value is 2. It takes effect after a reboot. It enables or disables the IP phone to mandatorily validate the CommonName or SubjectAltName of the certificate sent by the Security->Trusted server.
  • Page 140 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It takes effect after a reboot. It configures the user name of the user for String within phone’s web user interface access. security.user_name.user 32 characters The default value is user.
  • Page 141 0 or 1 The default value is 0. It takes effect after a reboot. For more information, refer to Yealink IP phones Configuration Guide for User Access Level It configures the access URL of the file, which defines 3-level access permissions.
  • Page 142 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables custom soft keys layout feature. Settings->Softkey Layout->Custom 0-Disabled phone_setting.custom_softkey_enable 0 or 1 Softkey 1-Enabled The default value is 0. It configures the access URL of the custom file for the soft key presented on the LCD screen when in the Call Failed state.
  • Page 143 Appendix Permitted Parameter Descriptions Web Setting Path Values download the CallIn state file from the “XMLfiles” directory on provisioning server 10.2.8.16 using 8080 port. custom_softkey_call_in.url = http://10.2.8.16:8080/XMLfiles/CallIn.xml The default value is blank. It configures the access URL of the custom file for the soft key presented on the LCD screen when in the Connecting state.
  • Page 144 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The following example uses HTTP to download the Dialing state file from the “XMLfiles” directory on provisioning server 10.2.8.16 using 8080 port. custom_softkey_dialing.url = http://10.2.8.16:8080/XMLfiles/Dialing.xml The default value is blank.
  • Page 145 Appendix Permitted Parameter Descriptions Web Setting Path Values Example: The following example uses HTTP to download the Talking state file from the “XMLfiles” directory on provisioning server 10.2.8.16 using 8080 port. custom_softkey_talking.url = http://10.2.8.16:8080/XMLfiles/Talking.xml The default value is blank. It configures the key feature for the line key X. Valid values are: 0-N/A 1-Conference...
  • Page 146 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 11-DTMF 12-Voice Mail 13-Speed Dial 14-Intercom 15-Line 16-BLF 17-URL 18-Group Listening 20-Private Hold 22-XML Group 23-Group Pickup 24-Multicast Paging 25-Record 27-XML Browser 34-Hot Desking 35-URL Record 38-LDAP...
  • Page 147 Appendix Permitted Parameter Descriptions Web Setting Path Values 42-ACD 45-Local Group 46-Network Group 50-Keypad Lock 55-Meet-Me Conference 56-Retrieve Park 57-Hoteling 58-ACD Trace 59-Disp Code 60-Emergency 61-Directory The default value is 15. It configures the desired line to apply the key feature.
  • Page 148 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the value of the line key feature. For example, when the key feature is linekey.X.value String within DSSKey->Line Key->Line configured as BLF , it configures the phone 99 characters KeyX->Value...
  • Page 149 Appendix Permitted Parameter Descriptions Web Setting Path Values 3-Third local group 4-Fourth local group 5-Fifth local group When the key feature is configured as XML Group (remote phone book), valid values are: 0-First XML group 1-Second XML group 2-Third XML group 3-Fourth XML group 4-Fifth XML group When the key feature is configured as...
  • Page 150: Programmable Keys

    Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the label displayed on the LCD linekey.X.label String within DSSKey->Line Key->Line screen for each line key. 99 characters KeyX->Label (X ranges from 1 to 3) The default value is blank.
  • Page 151 Appendix Permitted Parameter Descriptions Web Setting Path Values 33-Status 38-LDAP 40-Prefix 41-Zero Touch 43-Local Directory 44-Network Directory 45-Local Group 46-Network Group 47-XML Directory 50-Keypad Lock 51-Switch Account Up 52-Switch Account Down 55-Meet-Me Conference 61-Directory It configures the desired line to apply the programmable key feature.
  • Page 152 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the value of the programmable programablekey.X.value key feature. (X=1-10, 14.) String within For example, when the key feature is DSSKey->Programmable Key->Value 99 characters configured as Speed Dial, it configures the...
  • Page 153 Appendix Permitted Parameter Descriptions Web Setting Path Values are: 0-First XML group 1-Second XML group 2-Third XML group 3-Fourth XML group 4-Fifth XML group When the key feature is configured as Network Group, valid values are: 0-All contacts 1-Group 2-Enterprise 3-GroupCommon 4-EnterpriseCommon 5-Personal...
  • Page 154 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values programablekey.X.label It configures the label displayed on the LCD (X=1-4.) String within screen for each soft key. DSSKey->Programmable Key->Label 99 characters For more information, refer to Programmable Keys The default value is blank.
  • Page 155 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the always forward on code to activate the server-side always forward feature. The IP phone will send the always forward on code and the pre-configured String within Features->Forward &DND->Always forward.always.on_code destination number to the server when you 32 characters Forward->On Code...
  • Page 156 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It configures the destination number the IP String within Features->Forward &DND->Busy phone forwards incoming calls to when busy. forward.busy.target 32 characters Forward->Target The default value is blank.
  • Page 157 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled If it is set to 1 (Enabled), incoming calls are forwarded to the destination number after a period of ring time. The default value is 0. It configures the destination number the IP phone forwards incoming calls to after a String within Features->Forward &DND->No...
  • Page 158 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values phone. The default value is blank. It configures the no answer forward off code to deactivate the server-side no answer forward feature. The IP phone will send the no String within Features->Forward &DND->No...
  • Page 159 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the length of time (in seconds) before the status of the ACD agent is automatically changed to available. Integer from 0 Features->ACD->ACD Auto Available acd.auto_available_timer The default value is 60. to 120 Timer (0~120s) Note: It works only if the value of the...
  • Page 160 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values $local  $remote  $display_local  $display_remote  $call_id  Example: action_url. setup_completed = http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends after an account is registered.
  • Page 161 Appendix Permitted Parameter Descriptions Web Setting Path Values action_url.unregistered = http://192.168.0.20/help.xml?IP=$ip The default value is blank. Note: The old parameter “action_url.log_off” is also applicable to IP phones. It configures the action URL the IP phone sends after a register failed. Example: URL within 511 Features->Action URL->Register...
  • Page 162 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values action_url.on_hook = http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends when receiving an incoming call. Example: URL within 511 action_url.incoming_call Features->Action URL->Incoming Call...
  • Page 163 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is blank. It configures the action URL the IP phone sends when terminating a call. Example: URL within 511 action_url.call_terminated Features->Action URL->Terminated characters action_url.call_terminated = http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends when DND feature is enabled.
  • Page 164 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the action URL the IP phone sends when always forward feature is enabled. URL within 511 Features->Action URL->Open Always Example: action_url.always_fwd_on characters Forward action_url.always_fwd_on = http://192.168.0.20/help.xml?IP=$ip...
  • Page 165 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the action URL the IP phone sends when busy forward feature is disabled. Example: URL within 511 Features->Action URL->Close Busy action_url.busy_fwd_off characters Forward action_url.busy_fwd_off = http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends when no answer forward feature is enabled.
  • Page 166 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the action URL the IP phone sends when performing a transfer. Example: URL within 511 action_url.transfer_call Features->Action URL->Transfer Call characters action_url.transfer_call = http://192.168.0.20/help.xml?IP=$ip The default value is blank.
  • Page 167 Appendix Permitted Parameter Descriptions Web Setting Path Values characters sends when placing a call on hold. Example: action_url.hold = http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends when resuming a held call. Example: URL within 511 action_url.unhold Features->Action URL->UnHold...
  • Page 168 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values action_url.outgoing_call = http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends when muting a call. Example: URL within 511 action_url.mute Features->Action URL->Mute characters action_url.mute =...
  • Page 169 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is blank. It configures the action URL the IP phone sends when changing the state of the IP phone from busy to idle. URL within 511 Example: action_url.busy_to_idle Features->Action URL->Busy To Idle characters action_url.busy_to_idle = http://192.168.0.20/help.xml?IP=$ip...
  • Page 170 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends when forwarding an incoming call. Example: URL within 511 Features->Action URL->Forward action_url.forward_incoming_call...
  • Page 171 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the action URL the IP phone sends when completing a call transfer. Example: URL within 511 Features->Action URL->Transfer action_url.transfer_finished characters Finished action_url.transfer_finished = http://192.168.0.20/help.xml?IP=$ip The default value is blank. It configures the action URL the IP phone sends when failing to transfer a call.
  • Page 172: Time Zones

    Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values English, Chinese_S, Chinese_T, German, It configures the language used on the IP French, phone user interface. lang.gui Turkish, Italian, The default value is English. Polish, Spanish, Russian or Portuguese It configures the time zone.
  • Page 173 Appendix Permitted Parameter Descriptions Web Setting Path Values parameter “local_time.summer_time” is set to 2 (Automatic). It configures the IP phone to obtain time from NTP server or manual settings. 0-NTP local_time.manual_time_enable 0 or 1 Settings->Time & Date->Manual Time 1-Manual The default value is 0. It enables or disables the IP phone to use manually configured NTP server preferentially.
  • Page 174 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values phone will request the time and date from the NTP server 2. The default value is cn.pool.ntp.org. It configures the interval (in seconds) to Integer from Settings->Time & Date->Synchronism update time and date from the NTP server.
  • Page 175 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the start time of the DST. Value formats are: Month/Day/Hour (for By Date)  Month/ Day of Week/ Day of Week Last  in Month/ Hour of Day (for By Week) If “local_time.dst_time_type”...
  • Page 176 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1 (Enabled). It configures the end time of the DST. Value formats are: Month/Day/Hour (for By Date)  Month/ Day of Week/ Day of Week Last ...
  • Page 177 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 12/31/23. Note: It works only if the value of the parameter “local_time.summer_time” is set to 1 (Enabled). It configures the offset time (in minutes) of DST. Integer from The default value is blank.
  • Page 178 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the date format. 0-WWW MMM DD 1-DD-MMM-YY 2-YYYY-MM-DD 3-DD/MM/YYYY 4-MM/DD/YY 0, 1, 2, 3, 4, 5 5-DD MMM YYYY or 6 local_time.date_format Settings->Time & Date->Date Format 6-WWW DD MMM The default value is 0.
  • Page 179 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It enables or disables the IP phone to provide input field of register name on the hot desking login wizard during startup. hotdesking.startup_register_name_enable 0 or 1 0-Disabled 1-Enabled The default value is 0.
  • Page 180 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to provide input field of SIP server on the hot desking login wizard during startup. hotdesking.startup_sip_server_enable 0 or 1 0-Disabled 1-Enabled The default value is 0.
  • Page 181 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to provide input field of user name on the hot desking login wizard when pressing the Hot Desking key. hotdesking.dsskey_username_enable 0 or 1 0-Disabled 1-Enabled The default value is 1.
  • Page 182 (X ranges from 1 to 10) Family The default value is blank. For more information, refer to Yealink IP phones Administrator Guide. It configures the desired ring tone for each text. The value ranges from 1 to 7, the digit distinctive_ring_tones.alert_info.X.ringer...
  • Page 183 Appendix Permitted Parameter Descriptions Web Setting Path Values phones Administrator Guide. It enables or disables the IP phone to automatically redial the dialed number when the callee is temporarily unavailable. 0-Disabled 1-Enabled Features->General auto_redial.enable 0 or 1 Information->Auto Redial If it is set to 1 (Enabled), the IP phone will dial the previous dialed out number automatically when the dialed number is temporarily unavailable.
  • Page 184 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values call. The default value is 10. It enables or disables zero touch for the IP phone to configure the network parameters and provisioning server address via phone user interface during startup.
  • Page 185 Features->Remote Control->Push push_xml.server IP address The default value is blank. XML Server IP Address Yealink IP For more information, refer to Phones XML Browser Developer's Guide It enables or disables the IP phone to block XML applications during a call.
  • Page 186 If it is left blank, the IP phone will reject action URI requests. The default value is blank. For more information, refer to Yealink IP Phones Administrator Guide. It enables or disables the phone to pop up the Allow Remote Control prompt when it receives the action URI requests.
  • Page 187 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It enables or disables the phone to pop up the Allow Remote Control prompt using remote control. action_url.show_msgbox 0 or 1 0-Disabled 1-Enabled The default value is 0. It enables or disables the IP phone to remain at the hot desking logon wizard even though timeout.
  • Page 188 16 characters Code->Code “dialplan.area_code.min_len” and the maximum length configured by the parameter “dialplan.area_code. max_len”. For more information, refer to Yealink IP Phones Administrator Guide. It configures the minimum length of the entered numbers. Integer from 1 Settings->Dial Plan->Area dialplan.area_code.min_len...
  • Page 189 The default value is 15. Note: The value must be larger than the minimum length. For more information, refer to Yealink IP Phones Administrator Guide. It configures the desired line to apply the area code rule. The digit 0 stands for all lines.
  • Page 190 Descriptions Web Setting Path Values The default value is blank. For more information, refer to Yealink IP Phones Administrator Guide. It configures the desired line to apply the block out rule. The digit 0 stands for all lines. If it is left blank, the block out rule will apply to all lines on the IP phone.
  • Page 191 The digit 0 stands for all lines. If it is left blank, the dial-now rule will apply to all lines on the IP phone. dialplan.dialnow.line_id.X Settings->Dial 0 to 3 (for SIP-T23 (P/G)) Integer Plan->Dial-now->Account (X ranges from 1 to 100) Multiple line IDs are separated by commas.
  • Page 192 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the entered number to be replaced. Example: dialplan.replace.prefix.1 =1 and dialplan.replace.prefix.X String within Settings->Dial Plan->Replace dialplan.replace.replace.1 = 254245 32 characters Rule->Prefix (X ranges from 1 to 100) When you enter the number ”1”...
  • Page 193 Parameter Descriptions Web Setting Path Values lines on the IP phone. 0 to 3 (for SIP-T23 (P/G)) Multiple line IDs are separated by commas. The default value is blank. It configures the access URL of the replace rule template file.
  • Page 194 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values Menu->Directory. The default value is blank. It enables or disables the IP phone to perform a remote phone book search for an incoming or outgoing call and display the matched call Directory->Remote Phone Book->...
  • Page 195 Appendix Permitted Parameter Descriptions Web Setting Path Values book. 0-Disabled 1-Enabled The default value is 0. It enables or disables LDAP feature on the IP phone. 0-Disabled ldap.enable 0 or 1 Directory->LDAP->Enable LDAP 1-Enabled The default value is 0. It configures the criteria for searching the LDAP contact name attributes.
  • Page 196 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values For more information on LDAP feature, refer to LDAP Phonebook on Yealink IP Phones It configures the criteria for searching the LDAP contact number attributes. The “*” symbol in the filter stands for any character.
  • Page 197 IP phone (an alternative port is necessary). The default value is 0. For more information on LDAP feature, refer to LDAP Phonebook on Yealink IP Phones It configures the IP address or domain name of the LDAP server. IP address or ldap.host...
  • Page 198 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the LDAP search base which corresponds to the location of the LDAP phonebook from which the LDAP search request begins. The search base narrows the search scope and decreases directory search time.
  • Page 199 Appendix Permitted Parameter Descriptions Web Setting Path Values LDAP Phonebook on Yealink IP Phones It configures the password to login the LDAP server. String within ldap.password The default value is blank. Directory->LDAP->Password 99 characters For more information on LDAP feature, refer to...
  • Page 200 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values by spaces. Example: ldap.name_attr = cn sn This requires the “cn” and “sn” attributes set for each contact record on the LDAP server. The default value is blank.
  • Page 201 LCD screen. The default value is blank. For more information on LDAP feature, refer to LDAP Phonebook on Yealink IP Phones It configures the LDAP protocol version supported by the IP phone. Make sure the protocol value corresponds with the version assigned on the LDAP server.
  • Page 202 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 0. For more information on LDAP feature, refer to LDAP Phonebook on Yealink IP Phones It enables or disables the IP phone to perform an LDAP search when dialing an outgoing a call.
  • Page 203 Appendix Permitted Parameter Descriptions Web Setting Path Values LDAP Phonebook on Yealink IP Phones It enables or disables the phone to search for special numbers. 0-Disabled ldap.incoming_call_special_search.enable 0 or 1 1-Enabled The default value is 0. It configures the input method type when performing an LDAP search.
  • Page 204 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures a return code and reason of SIP response messages when the IP phone rejects an incoming call by DND. A specific reason is displayed on the caller’s phone LCD screen.
  • Page 205 Appendix Permitted Parameter Descriptions Web Setting Path Values here” when the callee rejects the incoming call. The default value is 486. It enables or disables call completion feature. If a user places a call and the callee is temporarily not available to answer the call, call completion feature allows notifying the user when the callee becomes available to receive a call.
  • Page 206 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values If it is set to 1 (Custom), you can configure call forward feature for each account. The default value is 0. It configures the DND mode for the IP phone.
  • Page 207 Appendix Permitted Parameter Descriptions Web Setting Path Values is configured as Phone. The IP phone will send the DND on code to the server when you activate DND feature on the IP phone. The default value is Blank. It configures the DND off code to deactivate the server-side DND feature when the DND mode is configured as Phone.
  • Page 208 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to present the diversion information when an incoming call is forwarded to your IP phone. Features->General Information-> features.fwd_diversion_enable 0 or 1...
  • Page 209 Appendix Permitted Parameter Descriptions Web Setting Path Values 1-Enabled If it is set to 1 (Enabled), the IP phone will perform an audible indicator when receiving a new incoming call during a call. The default value is 1. Note: It works only if the value of the parameter “call_waiting.enable”...
  • Page 210 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to automatically answer an incoming intercom call. 0-Disabled 1-Enabled Features->Intercom->Accept If it is set to 0 (Disabled), the IP phone will features.intercom.allow...
  • Page 211 Appendix Permitted Parameter Descriptions Web Setting Path Values Note: It works only if the value of the parameter “features.intercom.allow” is set to 1 (Enabled). It enables or disables the IP phone to play a warning tone when automatically answering an intercom call. 0-Disabled features.intercom.tone 0 or 1...
  • Page 212 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values call on the IP phone. If it is set to 1 (Enabled), the IP phone will automatically answer the intercom call while there is already an active call on the IP phone and place the active call on hold.
  • Page 213 Appendix Permitted Parameter Descriptions Web Setting Path Values key. If it is set to a value greater than 0, the IP phone will wait the designated seconds before dialing out the predefined hotline number when you lift the handset, press the speakerphone key or press the line key.
  • Page 214 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values dial out a pre-configured number (configured by the parameter “account.X.auto_dial_num”) when a user dials out a call using account X. The default value is 0. Note: The server may prompt the user to enter an activation code to use this account for call service.
  • Page 215 Appendix Permitted Parameter Descriptions Web Setting Path Values If it is set to 1 (Enabled), the DTMF digits are displayed as asterisks. The default value is 0. It enables or disables the IP phone to display the DTMF digits for a short period before displaying asterisks during an active call.
  • Page 216 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values If it is set to 0 (Disabled), the IP phone will perform the transfer as normal when pressing the transfer key during a call. If it is set to 1 (Enabled), the IP phone will...
  • Page 217 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables headset prior feature. 0-Disabled 1-Enabled If it is set to 1 (enabled), the headset mode Features->General Information-> features.headset_prior 0 or 1 will not be deactivated until you press the Headset Prior HEADSET key again.
  • Page 218 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to play a local DTMF tone. Features->General Information->Play 0-Disabled features.play_local_dtmf_tone_enable 0 or 1 Local DTMF Tone 1-Enabled The default value is 1.
  • Page 219 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Send one pound key by pressing double # 1-Do not send any pound key when pressing double The default value is 0. It configures the "#" or "*" key as a send key. 0-Disabled 1-# key 2-* key...
  • Page 220 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled If it is set to 1 (Enabled), the IP phone will play a key tone when a user presses a send key. The default value is 1.
  • Page 221 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It configures the interval (in seconds) at which the IP phone plays a hold tone. If it is set to 30 (30s), the IP phone will play a hold warning tone every 30 seconds when Integer from 3 Features->General Information->Play...
  • Page 222 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values pre-dialing screen. The default value is blank. It enables or disables the IP phone with active accounts to play tones in the dialing screen differently from the IP phone with no active accounts.
  • Page 223 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is blank. It configures the number of digits to be hidden. Integer from 0 Features->General Information-> features.password_dial.length The hidden digits are displayed as asterisks to 99 PswLength on the LCD screen. The default value is blank.
  • Page 224 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the power indicator LED to flash when the IP phone receives an incoming call. 0-Disabled (power indicator LED does not flash) 1-Enabled (power indicator LED fast flashes Features->Power LED->Ring Power...
  • Page 225 Appendix Permitted Parameter Descriptions Web Setting Path Values If it is set to 0, the status of the power indicator LED is determined by the value of the parameter “phone_setting.common_power_led_enable” It enables or disables the power indicator LED to flash when a call is mute. 0-Disabled (power indicator LED does not flash) 1-Enabled (power indicator LED fast flashes...
  • Page 226 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1-Enabled ( power indicator LED fast flashes (500ms) red) The default value is 0. If it is set to 0, the status of the power indicator LED is determined by the value of the parameter “phone_setting.common_power_led_enable”...
  • Page 227 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 1. It enables or disables the IP phone to play a warning tone when it receives a new voice mail. features.voice_mail_tone.enable 0 or 1 0-Disabled 1-Enabled The default value is 1.
  • Page 228 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It enables or disables the IP phone to display the pop-up message when the phone Features->Notification receives a new text message. features.text_message_popup.enable 0 or 1 Popups->Display Text Message...
  • Page 229 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 1. It enables or disables the IP phone to mute an active call. Features->General 0-Disabled features.allow_mute 0 or 1 Information->Allow Mute 1-Enabled The default value is 1. It enables or disables the IP phone to enter into the group listening mode by pressing the speakerphone key when it is in talking using...
  • Page 230 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values If the ringer device is set to Headset or Headset&Speaker, the headset should be connected with the IP phone and the headset mode also should be activated in advance.
  • Page 231 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 0. It configures the group call pickup code on a phone basis. String within The default value is blank. Features->Call Pickup->Group Call features.pickup.group_pickup_code 32 characters Pickup Code Note: The group call pickup code configured on a per-line basis takes precedence over that configured on a phone basis.
  • Page 232: Blf Led Mode

    Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values basis. It enables or disables the IP phone to display a visual alert when the monitored user receives an incoming call. Features->Call Pickup->Visual Alert features.pickup.blf_visual_enable 0 or 1...
  • Page 233 Appendix Permitted Parameter Descriptions Web Setting Path Values For more information, refer to BLF LED Mode on page 315. It enables or disables the IP phone to deal with the Version header in the BLF NOTIFY message sent by the server. 0-Disabled features.blf_list_version 0 or 1...
  • Page 234 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It enables or disables feature key synchronization. Features->General Information-> 0-Disabled bw.feature_key_sync 0 or 1 Feature Key Synchronization 1-Enabled The default value is 0.
  • Page 235 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the feature access code for account.X.blf_list_code directed call pickup (default: *97) for account String within Account->Advanced->BLF List Code 32 characters (X ranges from 1 to 3.) The default value is blank. It configures the feature access code for account.X.blf_list_barge_in_code directed call pickup with barge-in (default:...
  • Page 236 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 0. It enables or disables Broadsoft SCA feature for account X. account.X.shared_line 0-Disabled 0 or 1 Account->Advanced->Shared Line (X ranges from 1 to 3) 1-Broadsoft SCA The default value is 0.
  • Page 237 1-Function Keys Features->Phone Lock->Keypad Lock phone_setting.phone_lock.lock_key_type 0, 1 or 2 2-Menu Key Type The default value is 0. Yealink IP Phone For more information, refer to Family Administrator Guide It configures the password for unlocking the characters Features->Phone Lock->Phone keypad.
  • Page 238 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values Ring3.wav, phone_setting.ring_type = Ring1.wav Ring4.wav, The default value is Ring1.wav. Ring5.wav Silent.wav Splash.wav It configures the contrast of the LCD screen. Integer from 1 Note: We recommend that you set the phone_setting.contrast...
  • Page 239 Appendix Permitted Parameter Descriptions Web Setting Path Values 2-Name 3-Number 4-Full Contact Info (display name<sip:xxx@domain.com>) The default value is 0. It configures the logo mode of the LCD screen. 0-Disabled Features->General Information->Use phone_setting.lcd_logo.mode 0, 1 or 2 1-System logo Logo 2-Custom logo The default value is 0.
  • Page 240 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the delay time (in seconds) to turn off the backlight when the IP phone is inactive. If it is set to 60 (60s), the LCD backlight is turned off when the IP phone is inactive for 60 seconds.
  • Page 241 Appendix Permitted Parameter Descriptions Web Setting Path Values Silent.wav Splash.wav It enables or disables the IP phone to provide the logon wizard during startup. Features->General Information-> 0-Disabled phone_setting.logon_wizard 0 or 1 Logon Wizard 1-Enabled The default value is 0. It enables or disables the IP phone to automatically quit the logon wizard after timeout.
  • Page 242 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values upon a subsequent 180 message received. The default value is 1. It configures headset mode precedence during a call. 0-Always use (pressing the Speakerphone key and picking up the handset are not phone_setting.headsetkey_mode...
  • Page 243 Appendix Permitted Parameter Descriptions Web Setting Path Values It takes effect after a reboot. It enables or disables recent call in dialing feature. If it is enabled, you can see the placed calls list when the IP phone is in the Directory->Setting->Recent Call In pre-dialing screen.
  • Page 244 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values http://192.168.1.20/super_search.xml The default value is blank. For more information on the super search template file, refer to Customizing a Super Search Template on page 24. It configures the access URL of the firmware file.
  • Page 245 Appendix Permitted Parameter Descriptions Web Setting Path Values It deletes all custom ring tone files. The valid value is: http://localhost/all URL within 511 ringtone.delete The default value is blank. characters For more information, refer to Customizing a Ring Tone on page 11. It configures the access URL of the custom LCD language file for phone user interface.
  • Page 246 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values characters language file for web user interface. Example: wui_lang.url = tftp://192.168.1.100/1.English.js. The default value is blank. For more information, refer to Customizing a Language on page 11.
  • Page 247 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the access URL of the custom URL within 511 input method file for phone user interface. gui_input_method.url characters The default value is blank. It deletes all custom input method file for phone user interface.
  • Page 248 The default value is blank. Note: The certificate you want to upload must be in *.pem, *.crt, *.cer or *.der format. For more information, refer to Yealink IP Phones Administrator Guide. It deletes all uploaded trusted certificates. The valid value is: http://localhost/all URL within 511 trusted_certificates.delete...
  • Page 249 The default value is blank. Note: The certificate you want to upload must be in *.pem or *.cer format. For more information, refer to Yealink IP Phones Administrator Guide. It deletes all uploaded server certificates. The valid value is: http://localhost/all URL within 511 server_certificates.delete...
  • Page 250 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the access URL of the local contact file. Example: URL within 511 Directory->Local Directory->Import local_contact.data.url characters Local Directory File local_contact.data.url = http://192.168.10.25/contact.xml The default value is blank.
  • Page 251 Appendix Permitted Parameter Descriptions Web Setting Path Values Configuration item will be displayed on the IP phone's web user interface at the path Settings->Configuration. You can import a custom factory configuration file or delete the user-defined factory configuration via web user interface.
  • Page 252 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the account X. 0-Disabled account.X.enable 0 or 1 Account->Register->Line Active (X ranges from 1 to 3) 1-Enabled The default value is 0. It configures the label to be displayed on the account.X.label...
  • Page 253 1-SRV query using UDP, TCP and TLS. (X ranges from 1 to 3) The default value is 0. For more information, refer to Server Redundancy on Yealink IP Phones It configures the registration mode for account X in fallback mode. account.X.fallback.redundancy_type 0-Concurrent registration...
  • Page 254 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values Redundancy on Yealink IP Phones It configures the time interval (in seconds) for the IP phone to detect whether the working server is available by sending the registration...
  • Page 255 (X ranges from 1 to 3, Y ranges from 1 to 2.) The default value is 3. Server For more information, refer to Redundancy on Yealink IP Phones It configures the mode for the IP phone to retry the primary server in failover mode for account.X.sip_server.Y.failback_mode account X.
  • Page 256 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1-DNSTTL: the IP phone retries to send requests to the primary server after the timeout of the DNSTTL configured for the server that the IP phone is registered to.
  • Page 257 60 seconds. The default value is 3600. Server For more information, refer to Redundancy on Yealink IP Phones It enables or disables the IP phone to send registration requests to the secondary server for account X when encountering a failover.
  • Page 258 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 0. Server For more information, refer to Redundancy on Yealink IP Phones It configures the content that the DNS cache records for account X.
  • Page 259 It takes effect after a reboot. Server For more information, refer to Redundancy on Yealink IP Phones It configures the time interval (in seconds) that A record Y may be cached before the record should be consulted again for account Integer from account.X.dns_cache_a.Y.ttl...
  • Page 260 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It takes effect after a reboot. Server For more information, refer to Redundancy on Yealink IP Phones It configures the priority for the target host in SRV record Y for account X.
  • Page 261 It takes effect after a reboot. Server For more information, refer to Redundancy on Yealink IP Phones It configures the time interval (in seconds) that SRV record Y may be cached before the record should be consulted again for account Integer from account.X.dns_cache_srv.Y.ttl...
  • Page 262 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the flag of NAPTR record Y for account X. (Always “s” for SIP, which means to do an SRV lookup on whatever is in the replacement field) S-Do an SRV lookup next.
  • Page 263 The default value is 0. It takes effect after a reboot. Server For more information, refer to Redundancy on Yealink IP Phones It configures a domain name to be used for the next SRV query in NAPTR record Y for account X.
  • Page 264 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 2147483647 the record should be consulted again for account X. The default value is 300. It takes effect after a reboot. Server For more information, refer to...
  • Page 265 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It configures the IP address or domain name account.X.outbound_host IP address or Account->Register->Outbound Proxy of the outbound proxy server for account X. domain name Server (X ranges from 1 to 3) The default value is blank.
  • Page 266 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values account.X.proxy_require It configures the proxy server for account X. String within Account->Basic->Proxy Require 256 characters (X ranges from 1 to 3) The default value is blank. It enables or disables anonymous call feature for account X.
  • Page 267 Appendix Permitted Parameter Descriptions Web Setting Path Values If it is set to 1 (On Code), the IP phone will send anonymous on code to activate the server-side anonymous call feature. The default value is 0. It configures the anonymous call on code to activate the server-side anonymous call feature for account X.
  • Page 268 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values (X ranges from 1 to 3) rejection feature for account X. Rejection 0-Disabled 1-Enabled If it is set to 1 (Enabled), the IP phone will automatically reject incoming calls from users enabled anonymous call feature.
  • Page 269 Appendix Permitted Parameter Descriptions Web Setting Path Values activate the server-side anonymous call rejection feature. The default value is 0. It configures the anonymous call rejection on code to activate the server-side anonymous call rejection feature for account X. The IP account.X.anonymous_reject_oncode phone will send the anonymous call rejection String within...
  • Page 270 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled If it is set to 1 (Enabled), the IP phone will reject incoming calls on account X. The default value is 0. It configures the DND on code to activate the server-side DND feature for account X when the DND mode is configured as Custom.
  • Page 271 Appendix Permitted Parameter Descriptions Web Setting Path Values configured as Custom. 0-Disabled 1-Enabled If it is set to 1 (Enabled), incoming calls to the account X are forwarded to the destination number immediately. The default value is 0. It configures the destination number of the account.X.always_fwd.target always forward for account X when the call String within...
  • Page 272 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the always forward off code to deactivate the server-side always forward feature for account X when the call forward account.X.always_fwd.off_code mode is configured as Custom. The IP phone String within Features->Forward&...
  • Page 273 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the busy forward on code to activate the server-side busy forward feature for account X when the call forward mode is configured as Custom. The IP phone will send account.X.busy_fwd.on_code String within Features->Forward&...
  • Page 274 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values If it is set to 1 (Enabled), incoming calls to the account X are forwarded to the destination number after a period of ring time. The default value is 0.
  • Page 275 Appendix Permitted Parameter Descriptions Web Setting Path Values feature for account X on the IP phone. The default value is blank. It configures the no answer forward off code to deactivate the server-side no answer forward feature for account X when the call forward mode is configured as Custom.
  • Page 276 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values If it is set to 1 (Enabled), the IP phone will send a SUBSCRIBE message to the server for message-summary updates. The default value is 0. It configures MWI subscribe expiry time (in seconds) for account X.
  • Page 277 Appendix Permitted Parameter Descriptions Web Setting Path Values account X. 0-FROM (Derives the name and number of the caller from the “From” header). 1-PAI (Derives the name and number of the caller from the “PAI” header. If the server does not send the “PAI” header, it will display “anonymity”...
  • Page 278 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It enables or disables the IP phone to process the P-Preferred-Identity header for caller identity presentation when receiving an account.X.cid_source_ppi incoming call for account X.
  • Page 279 Appendix Permitted Parameter Descriptions Web Setting Path Values When the RFC 4916 is enabled on the IP phone, the caller sends the SIP request message which contains the from-change tag in the Supported header. The caller then receives an UPDATE message from the callee, and displays the identity in the From header.
  • Page 280 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 1800. It configures the refresher of the session timer for account X. 0-Uac (Refreshing the session is performed by account.X.session_timer.refresher Account->Advanced->Session the IP phone).
  • Page 281 Appendix Permitted Parameter Descriptions Web Setting Path Values of encryption to utilize for the session. If it is set to 2 (Compulsory), the IP phone is forced to use SRTP during a call. The default value is 0. It configures the ptime (in milliseconds) for the 0 (Disabled), account.X.ptime codec for account X.
  • Page 282 (X ranges from 1 to 3) If it is set to 1 (Enabled), call pickup is implemented through SIP signals. The default value is 0. For more information, refer to Yealink IP Phones Administrator Guide. It configures the group pickup code for account X.
  • Page 283 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the directed call pickup code for account X. The default value is blank. account.X.direct_pickup_code String within Account->Advanced->Directed Call Note: The directed call pickup code 32 characters Pickup Code (X ranges from 1 to 3) configured on a per-line basis takes precedence over that configured on a phone basis.
  • Page 284 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1-Enabled The default value is 1. It configures the delay time (in seconds) before the IP phone automatically answers an Integer from 1 features.auto_answer_delay incoming call. to 4 The default value is 1.
  • Page 285 Appendix Permitted Parameter Descriptions Web Setting Path Values the voice mail number for account X. 0-Disabled 1-Enabled Note: It works only if the value of the parameters “account.X.subscribe_mwi” is set to 1 (Enabled) and “voice_mail.number.X” is configured. The default value is 0. It configures the interval (in seconds) for the IP account.X.reg_fail_retry_interval phone to retry to register account X when...
  • Page 286 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values (X ranges from 1 to 3) The default value is blank. Note: It works only if the value of the parameter “account.X.conf_type” is set to 2 (Network Conference).
  • Page 287 256 characters Hold server for account X. Examples for valid values: <10.1.3.165>, 10.1.3.165, sip:moh@sip.com, <sip:moh@sip.com>, <yealink.com> or yealink.com. The default value is blank. Note: The DNS query in this parameter only supports A query. It configures the DTMF type for account X.
  • Page 288 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 101. It configures the DTMF info type when the DTMF type is configured as “SIP INFO”, “AUTO or SIP INFO” for account X.
  • Page 289 Appendix Permitted Parameter Descriptions Web Setting Path Values NAT can continue to function for account X. 0-Dsiabled 1-Default (the IP phone sends UDP packets to the server). 2-Option (the IP phone sends SIP OPTION packets to the server). 3-Notify (the IP phone sends SIP NOTIFY packets to the server).
  • Page 290 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 0. It enables and disables the IP phone to map the keywords in the Alert-Info header to the specified Bellcore ring tones.
  • Page 291 Appendix Permitted Parameter Descriptions Web Setting Path Values (X ranges from 1 to 3) Ring1.wav, Example: Ring2.wav, account.1.ringtone.ring_type = Ring3.wav Ring3.wav means configuring Ring3.wav for account1. Ring4.wav account.1.ringtone.ring_type = Common Ring5.wav means account1 will use the ring tone selected for the IP phone. Silent.wav The default value is Common.
  • Page 292 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1-Enabled Example: account.1.codec.1.enable = 1 This means that the codec PCMU is enabled on the IP phone. When Y=1, the default value is 1; When Y=2, the default value is 1;...
  • Page 293 Appendix Permitted Parameter Descriptions Web Setting Path Values When Y=3, the default value is 3; When Y=4, the default value is 4; When Y=5, the default value is 0; When Y=6, the default value is 0; When Y=7, the default value is 0; When Y=8, the default value is 0;...
  • Page 294 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to un-register account X before a reboot. account.X.unregister_on_reboot Account->Advanced->Unregister 0-Disabled 0 or 1 When Reboot (X ranges from 1 to 3) 1-Enabled The default value is 0.
  • Page 295 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It enables or disables the IP phone to display the available and unavailable soft keys for account X after the IP phone logs into the ACD account.X.acd.available system.
  • Page 296 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the duration time (in seconds) in the ringback state. account.X.ringback_duration_time Integer from If it is set to 180, the phone will cancel the 64 to +∞...
  • Page 297 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is -1. It takes effect after a reboot. The following table lists configuration parameters that are integrated with BroadSoft platform. For more information on BroadSoft features, refer to Yealink_IP_Phones_Deployment_Guide_for_BroadSoft_UC-One_Environment Permitted Parameter Descriptions...
  • Page 298 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the phone to hide caller ID when it receives an incoming call. 0-Disabled features.hide_caller_id.enable 0 or 1 1-Enabled The default value is 0.
  • Page 299 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables 5 seconds delay for the LED flashing of the URL DSS key. 0-Disabled features.flash_url_dsskey_led.enable 0 or 1 1-Enabled The default value is 1. It configures the server address which the DssKey.cfg file is uploaded to when the phone features.upload_server IP address...
  • Page 300 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values the user name and password of the SIP account for XSI authentication. The default value is 0. It configures the IP address or domain name of the Xtended Services Platform server for account account.X.xsi.host...
  • Page 301 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the user name for XSI authentication for account X. account.X.xsi.user Example: String within Directory-> Network Directory->User 99 characters (X ranges from 1 to 3.) account.1.xsi.user = 3502@as.iop1.broadworks.net The default value is blank. It configures the password for XSI authentication for account X.
  • Page 302 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is Group. Note: It works only if XSI is configured for account It enables or disables the IP phone to display the enterprise directory.
  • Page 303 Appendix Permitted Parameter Descriptions Web Setting Path Values Note: It works only if XSI is configured for account It configures the display name on the LCD screen for the group common directory. String within Directory-> Network Directory->Group bw_phonebook.group_common_displayname The default value is GroupCommon. 99 characters Common Note: It works only if XSI is configured for account...
  • Page 304 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to display the personal directory. 0-Disabled Directory-> Network bw_phonebook.personal_enable 0 or 1 1-Enabled Directory->Personal The default value is 1. Note: It works only if XSI is configured for account It configures the display name on the LCD screen for the personal directory.
  • Page 305 Appendix Permitted Parameter Descriptions Web Setting Path Values directory from the BroadSoft server. The default value is 60. It enables or disables BroadSoft call log feature. 0-Disabled 1-Enabled bw_phonebook.call_log_enable 0 or 1 The default value is 0. Note: It works only if XSI is configured for account It enables or disables the IP phone to show the caller’s phone number in the call history list.
  • Page 306 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables the IP phone to display the Park soft key during a call. 0-Disabled call_park.enable 0 or 1 Features->Call Pickup->Call Park 1-Enabled The default value is 0.
  • Page 307 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the park retrieve code when call park mode is configured as FAC. String within Features->Call Pickup->Park Retrieve features.call_park.park_retrive_code The default value is blank. 32 characters Code Note: It works only if the value of the parameter “features.call_park.park_mode”...
  • Page 308 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 1. It enables or disables call park subscription for account X. account.X.callpark_enable 0-Disabled 0 or 1 (X ranges from 1 to 3.) 1-Enabled The default value is 0.
  • Page 309 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is *11. Note: It works only if the value of the parameter “account.X.shared_line” is set to 1 (Shared line). The default value is 1. It configures the initial agent state for account X. account.X.acd.initial_state 1-Avaliable 1 or 2...
  • Page 310 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values BroadWorks for account X. The value Y must be continuous. The default value is blank. It enables or disables call center call information feature for account X.
  • Page 311 Appendix Permitted Parameter Descriptions Web Setting Path Values The value Y must be continuous. The default value is blank. It configures the disposition code name which must match one of the names configured on account.X.bw_disp_code_name.Y String within BroadWorks for account X. 99 characters (X ranges from 1 to 3.) The value Y must be continuous.
  • Page 312 Yealink IP Phones Auto Provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the supervisor name for account X. account.X.supervisor_info_code_name.Y String within The value Y must be continuous. 99 characters (X ranges from 1 to 3, Y ranges from 1 to 100) The default value is blank.
  • Page 313 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 0. It takes effect after a reboot. It enables or disables the IP phone to save login credentials automatically when logging into the guest profile for account X. account.X.hoteling.auto_login_enable 0 or 1 0-Disabled...
  • Page 314 Yealink IP Phones Auto Provisioning Guide The following tables list relationship between the values of X in the following parameters and programmable keys for each phone model. # X ranges from 1 to10, 14. programablekey.X.type = programablekey.X.line = programablekey.X.value = programablekey.X.xml_phonebook =...
  • Page 315 Appendix Phone Model SIP-T23 (P/G) Left Right Cancel TRAN...
  • Page 316: Time Zones

    Yealink IP Phones Auto Provisioning Guide Time Zone Time Zone Name −11:00 Samoa −10:00 United States-Hawaii-Aleutian −10:00 United States-Alaska-Aleutian −09:00 United States-Alaska Time −09:30 French Polynesia −08:00 Canada(Vancouver, Whitehorse) −08:00 Mexico(Tijuana, Mexicali) −08:00 United States-Pacific Time −07:00 Canada(Edmonton, Calgary) −07:00 Mexico(Mazatlan, Chihuahua) −07:00...
  • Page 317 Appendix Time Zone Time Zone Name Portugal(Lisboa, Porto, Funchal) Spain-Canary Islands(Las Palmas) United Kingdom(London) Morocco +01:00 Albania(Tirane) +01:00 Austria(Vienna) +01:00 Belgium(Brussels) +01:00 Caicos +01:00 Chad +01:00 Spain(Madrid) +01:00 Croatia(Zagreb) +01:00 Czech Republic(Prague) +01:00 Denmark(Kopenhagen) +01:00 France(Paris) +01:00 Germany(Berlin) +01:00 Hungary(Budapest) +01:00 Italy(Rome) +01:00...
  • Page 318 Yealink IP Phones Auto Provisioning Guide Time Zone Time Zone Name +04:00 Kazakhstan(Aktau) +04:00 Russia(Samara) +04:30 Afghanistan(Kabul) +05:00 Kazakhstan(Aqtobe) +05:00 Kyrgyzstan(Bishkek) +05:00 Pakistan(Islamabad) +05:00 Russia(Chelyabinsk) +05:30 India(Calcutta) +05:45 Nepal(Katmandu) +06:00 Kazakhstan(Astana, Almaty) +06:00 Russia(Novosibirsk, Omsk) +06:30 Myanmar(Naypyitaw) +07:00 Russia(Krasnoyarsk) +07:00...
  • Page 319 Appendix BLF LED Mode provides four kinds of definition for the BLF/BLF list key LED status. The following tables list the LED statuses of the BLF/BLF list key when BLF LED Mode is set to 0, 1, 2 or 3 respectively. The default value of the BLF LED Mode is 0. Line key LED (configured as a BLF/BLF list key and BLF LED Mode is set to 0) LED Status Description...
  • Page 320 Yealink IP Phones Auto Provisioning Guide LED Status Description The monitored user does not exist. Line key LED (configured as a BLF/BLF list key and BLF LED Mode is set to 3) LED Status Description Fast flashing green The monitored user receives an incoming call.
  • Page 321 Appendix We are striving to improve our documentation quality and we appreciate your feedback. Email your opinions and comments to DocsFeedback@yealink.com.

This manual is also suitable for:

Sip-t23pSip-t23g

Table of Contents