Yealink SIP-T2xP Auto Provisioning Manual
Yealink SIP-T2xP Auto Provisioning Manual

Yealink SIP-T2xP Auto Provisioning Manual

Sip-t2xp, sip-t3xg series ip phone family
Hide thumbs Also See for SIP-T2xP:

Advertisement

Table of Contents
i

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the SIP-T2xP and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Yealink SIP-T2xP

  • Page 1 Table of Contents...
  • Page 3: Table Of Contents

    Table of Contents Table of Contents ..............iii Summary of Changes............... v Changes for Release 71, Guide Version 71.165 ..............v Changes for Release 71, Guide Version 71.140 ..............v Changes for Release 71, Guide Version 71.125 ..............v Changes for Release 71, Guide Version 71.120 ..............v Changes for Release 71, Guide Version 71.110 ..............
  • Page 4 Yealink IP Phones Auto provisioning Guide Obtaining the Address of Provisioning Server ...... 25 Zero Touch ........................... 25 Plug and Play (PnP) Server ....................27 DHCP Options ........................28 Phone Flash ......................... 29 Update Mode ................. 31 Power On ..........................31 Repeatedly..........................
  • Page 5 Summary of Changes This section describes the changes to this guide for each release and guide version. Documentations of the newly released SIP-T19P and SIP-T21P IP phones have also been added. Major updates have occurred to the following sections: Editing Common CFG File on page ...
  • Page 6 Yealink IP Phones Auto provisioning Guide Resolving and Updating the Configurations on page  Description of Configuration Parameters in CFG Files on page  Major updates have occurred to the following sections: Customizing a Local Contact File on page ...
  • Page 7: 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 8 Yealink IP Phones Auto provisioning Guide...
  • Page 9: Getting Started

    Getting Started This section provides instructions on how to get ready for auto provisioning. The auto provisioning process discussed in this guide uses the TFTP server as the provisioning server. To begin the auto provisioning process, the following steps are required: Obtaining Configuration Information ...
  • Page 10 Yealink IP Phones Auto provisioning Guide You can ask the distributor or Yealink FAE for configuration files. The IP phones running firmware version 71 can only recognize configuration files using UTF-8 or ANSI encoding. Before beginning provisioning, you also need the phone information. For example, MAC address and the SIP account information of the phone.
  • Page 11 Getting Started The parameters commonly edited in the Common CFG file are described as follows (Take SIP-T2xP IP phones as examples): #################################################### Common CFG File #################################################### #!version:1.0.0.1 ##The file header “#!version:1.0.0.1” is not a comment and must be placed in the first line.
  • Page 12 Yealink IP Phones Auto provisioning Guide #0-Disabled, 1-Power on (default), 4-Repeatedly, 5-Weekly, 6-Power on + Repeatedly, 7-Power on + Weekly; auto_provision.mode = #Configure the interval (in minutes) for the phone to check new configuration files. It ranges from 1 to 43200, the default value is 1440.
  • Page 13 Getting Started #Set the AES key used for decrypting the Common CFG file auto_provision.aes_key_16.com = #Set the AES key used for decrypting MAC-Oriented CFG file auto_provision.aes_key_16.mac = #Set the language used on the web page #The available values are: English, Chinese_S (only applicable to SIP-T21P IP phones), Turkish, Portuguese (not applicable to SIP-T21P IP phones), Spanish (not applicable to SIP-T21P IP phones), Italian, French (not applicable to SIP-T21P IP phones) and German lang.wui =...
  • Page 14 Yealink IP Phones Auto provisioning Guide MAC-Oriented CFG file contains configuration parameters which are expected to be updated per phone, such as the registration information. The parameters commonly edited in the MAC-Oriented CFG file (Take SIP-T2xP IP phones as examples) are described as follows: ####################################################...
  • Page 15 Getting Started #Configure the user name and password for register authentication account.1.auth_name = account.1.password = #Configure the register user name account.1.user_name = #Configure the SIP server address and port (5060 by default) account.1.sip_server.1.address = account.1.sip_server.1.port = account.1.sip_server.2.address = account.1.sip_server.2.port # Account2 settings #Enable or disable the account2, 0-Disabled (Default), 1-Enabled account.2.enable = #Configure the label displayed on the LCD screen for account2...
  • Page 16 Yealink IP Phones Auto provisioning Guide account.3.password = #Configure the register user name account.3.user_name = #Configure the SIP server address and port (5060 by default) account.3.sip_server.1.address = account.3.sip_server.1.port = account.3.sip_server.2.address = account.3.sip_server.2.port # Account4 settings (For SIP-T28P IP phones only) #Enable or disable the account4, 0-Disabled (Default), 1-Enabled account.4.enable =...
  • Page 17 Getting Started #Configure the register user name account.5.user_name = #Configure the SIP server address and port (5060 by default) account.5.sip_server.1.address = account.5.sip_server.1.port = account.5.sip_server.2.address = account.5.sip_server.2.port # Account6 settings (For SIP-T28P IP phones only) #Enable or disable the account6, 0-Disabled (Default), 1-Enabled account.6.enable = #Configure the label displayed on the LCD screen for account6 account.6.label =...
  • Page 18: Customizing A Ringtone

    Yealink FAE for resource file templates. The following provides information on how to customize resource files and specify the access URL for the resource files. Yealink IP phones have built-in system ringtones. You can change the ring type, or customize a ringtone and upload it to the phone via auto provisioning.
  • Page 19 #Delete all custom languages gui_lang.delete = Available languages may vary between different firmware versions. Do not rename the language file. Yealink SIP-T2xP IP phones allow you to customize the logo displayed on the LCD screen. SIP-T20P IP phones only support a text logo.
  • Page 20 .dob <=132*64 2 gray scale Ask the distributor or Yealink FAE for the logo file, or you can customize a *.dob logo file. Upload the logo file to the provisioning server and then specify the access URL in the configuration file:...
  • Page 21 Getting Started Yealink SIP-T3xG and VP530 IP phones allow you to customize the wallpaper displayed on the LCD screen. The following table lists the wallpaper image format and resolution for each phone model: Phone Model Wallpaper Image Format Resolution SIP-T38G .jpg/.png/.bmp...
  • Page 22 During the auto provisioning process, the phone connects to the provisioning server “192.168.1.100”, and downloads the screensaver image “screensaver.jpg”. Yealink IP phones allow you to upload contact data in batch via auto provisioning. You can create multiple contacts using the supplied local contact template file. The existing local contacts on the phones will be overwritten by the downloaded local contacts.
  • Page 23 After editing the local contact template file, upload the file to the provisioning server and then specify the access URL in the configuration file. The following shows an example of a local contact file used for SIP-T2xP IP phones: <root_group>...
  • Page 24 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 25 Getting Started The following shows an example of a replace rule file used for SIP-T2xP IP phones: <DialRule> <Data Prefix="1" Replace="05928665234" LineID=""/> <Data Prefix="2(xx)" Replace="002$1" LineID="0"/> </DialRule> #################################################### Upload replace rule file #################################################### dialplan_replace_rule.url = For example, enter “tftp://192.168.1.100/DialPlan.xml” in the “dialplan_replace_rule.url =”...
  • Page 26 Yealink IP Phones Auto provisioning Guide Save the change. The following shows an example of a dial-now file used for SIP-T2xP IP phones: <DialNow> <Data DialNowRule="1234" LineID="1"/> <Data DialNowRule="52[0-6]" LineID="1"/> <Data DialNowRule="xxxxxx" LineID=""/> </DialNow> #################################################### Upload dial-now file #################################################### dialplan_dialnow.url = For example, enter “tftp://192.168.1.100/DialNow.xml”...
  • Page 27 Getting Started #################################################### Configure the access URL of the firmware file #################################################### firmware.url = For example, enter “tftp://admin:password@192.168.1.100/2.71.0.140.rom” in the “firmware.url =” field. During the auto provisioning process, the phone connects to the provisioning server “192.168.1.100” (“admin” is replaced by the authentication user name and “password”...
  • Page 28 Yealink IP Phones Auto provisioning Guide...
  • Page 29: Configuring A Tftp Server

    Configuring a TFTP Server Yealink IP Phones support to use 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 30 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 31: Obtaining The Address Of Provisioning Server

    Obtaining the Address of Provisioning Server Yealink IP phones support to obtain the provisioning server address in the following ways: Zero Touch  Plug and Play (PnP) Server  DHCP Options  Phone Flash  The priority of obtaining the provisioning server address is as follows: Zero Touch-->PnP Server-->DHCP Options (Custom option-->option 66-->option 43) -->Phone Flash.
  • Page 32 Yealink IP Phones Auto provisioning Guide Configure the wait time in the Wait Time (0~100s) field. Click Confirm to accept the change. When Zero Touch is enabled, there will be a configuration wizard during startup (Take T28P IP phone as an example): Press the OK soft key.
  • Page 33 (optional) in the Auto Provision screen. An example of screenshot is shown as below: Yealink IP phones support to obtain the provisioning server address from the PnP server. The phone broadcasts the PnP SUBCRIBE message to obtain the provisioning server address during startup.
  • Page 34 Yealink IP Phones Auto provisioning Guide can connect to the provisioning server and perform the auto provisioning process. Yealink IP phones support to obtain the provisioning server address from DHCP options. You can configure the phone to obtain the provisioning server address from a custom DHCP option, or the phone will automatically detect the Option 66 and Option 43.
  • Page 35 The default value is yealink. Click Confirm to accept the change. Yealink IP phones support to obtain the provisioning server address from the phone flash. To obtain the provisioning server address by reading the phone flash, make sure the configuration is set properly.
  • Page 36 Yealink IP Phones Auto provisioning Guide Enter the URL, user name and password of the provisioning server in the Server URL, User Name and Password fields (the user name and password are optional). Click Confirm to accept the change.
  • Page 37: Update Mode

    Update Mode The update mode is used to set the desired time for the phone to perform the auto provisioning process. This chapter introduces the following update modes in detail: Power On  Repeatedly  Weekly  Auto Provision Now ...
  • Page 38 Yealink IP Phones Auto provisioning Guide Mark the On radio box in the Power On field. Click Confirm to accept the change. The 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 39 Update Mode Enter the interval time (in minutes) in the Interval (Minutes) field. Click Confirm to accept the change. The 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 phone to perform the auto provisioning process.
  • Page 40 Yealink IP Phones Auto provisioning Guide Mark one or more radio boxes in the Day of Week field. Click Confirm to accept the change. You can use Auto Provision Now mode to manually trigger the phone to perform the auto provisioning process immediately.
  • Page 41 Update Mode Click Autoprovision Now. The 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 phone will perform the auto provisioning process when it is powered on and at a specified interval.
  • Page 42 Yealink IP Phones Auto provisioning Guide The following figure shows the message flow:...
  • Page 43: Downloading And Verifying Configurations

    If the configuration files have been AES-encrypted, the phone will decrypt the CFG files after downloading the configuration files. For more information on how to decrypt Yealink Configuration Encryption Tool User Guide configuration files, refer to The phone only reboots when there is at least a specific configuration requiring reboot during auto provisioning.
  • Page 44 Yealink IP Phones Auto provisioning Guide After auto provisioning, you can then verify the update via phone user interface, or you can verify it via web user interface of the phone. For more information, refer to Yealink phone-specific user guide.
  • Page 45: Verifying Configurations

    Downloading and Verifying Configurations Example 3: Yealink SIP-T28P IP phone downloads configuration files from the HTTP server.
  • Page 46 Yealink IP Phones Auto provisioning Guide...
  • Page 47: 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 phone fail to download configuration files? Ensure that auto provisioning feature is enabled.
  • Page 48 Yealink IP Phones Auto provisioning Guide Ensure that the size of the ringtone file is no larger than that the phone supports.  Ensure that the properties of the ringtone for the phone are correct.  Ensure that the network is available and the root directory is right for downloading.
  • Page 49: 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 50 Yealink IP Phones Auto provisioning Guide...
  • Page 51: Appendix

    Appendix This section provides instructions on how to configure an FTP server using 3CDaemon. You can download the 3CDaemon software online: http://www.oldversion.com/3Com-Daemon.html. To prepare a root directory: Create an FTP root directory on the local system. Place the configuration files to this root directory. Set the security permissions for the FTP directory folder.
  • Page 52 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 an FTP server: Double click the 3CDaemon.exe to start the application. Click the FTP Server button on the left of the main page.
  • Page 53 Appendix dialogue box. Click the OK button to save. Mark the check boxes of Login, Download and Upload to make sure the FTP user has the login, download and upload permission. Click the Save Profile button to save the settings and finish the configurations. 10.
  • Page 54 Yealink IP Phones Auto provisioning Guide 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 55 Appendix The main configuration page is shown as below: Click Menu in the main page and select the IP address of the PC from IP address.
  • Page 56 Yealink IP Phones Auto provisioning Guide The default HTTP port is 8080. You can also reset the HTTP port (make sure there is no port conflict). Right click the icon on the left of the main page, select Add folder from disk to...
  • Page 57 URL in the address bar of the web browser and then press <Enter> key to check the HTTP server before provisioning. 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.
  • Page 58 Yealink IP Phones Auto provisioning Guide Click the Login button (the login password is blank) to log in. You can then edit the existing DHCP server, or you can right click localhost and select New Server to add a new DHCP server.
  • Page 59 Appendix Right click Scopes and select New Scope. Configure the DHCP server name, the DHCP IP range and the subnet mask. 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 60 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 61 Appendix 10. Scroll down and double click the custom option 128. 11. Fill the provisioning server address in the input field. 12. Click the OK button to finish setting a custom option. 13. Click to save the change.
  • Page 62 Yealink IP Phones Auto provisioning Guide 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.
  • Page 63 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. You also can add the option 43. 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.
  • Page 64 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.
  • Page 65 Appendix 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. To customize a ringtone using Cool Edit Pro: Open the Cool Edit Pro application. Click File to open an audio file.
  • Page 66 Yealink IP Phones Auto provisioning Guide select the file format as A/mu-law wave. 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. Double click the PictureExDemo.exe.
  • Page 67 Appendix If you want to reset the configuration of a parameter, set the value of the parameter to be !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 68 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values ay = configured as IPv4 or IPv4&IPv6, and IP Address-> the Internet (WAN) port type for IPv4 is Gateway configured as Static IP Address. The default value is blank.
  • Page 69 Appendix Permitted Parameter Descriptions Web Setting Path Values IPv4&IPv6. 0-DHCP 1-Static IP Address 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 Network->Basic-> IPv4&IPv6, and the Internet (WAN) port network.ipv6_ Integer from...
  • Page 70 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values configured as Static IP Address. The default value is blank. It takes effect after a reboot. network.bridg It defines the PC (LAN) port type. e_mode = 0-Router (not Network->PC Port...
  • Page 71 Appendix Permitted Parameter Descriptions Web Setting Path Values network.dhcp. start_ip = Network->PC Port It configures the start IP address of the (not ->PC Port Config DHCP IP segment. IP address applicable to ->As Router->Start SIP-T19P and The default value is 10.0.0.10. IP Address SIP-T20P IP phones)
  • Page 72 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures VLAN ID of the Internet Network-> network.vlan.i (WAN) port. Integer from Advanced->VLAN nternet_port_v 1 to 4094 The default value is 1. ->WAN Port->VID id = (1-4094) It takes effect after a reboot.
  • Page 73 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the host name of the phone. For SIP-T2xP IP phones: The default value is SIP-T2xP Features->General network.dhcp (X=0,2,6,8). String Information-> _host_name = For SIP-T21P IP phones: DHCP Hostname The default value is SIP-T21P .
  • Page 74 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the maximum local RTP Network-> port. network.port. Integer from Advanced->Local max_rtpport = 1 to 65535 The default value is 11800. RTP Port-> Max RTP Port (1~65535) It takes effect after a reboot.
  • Page 75 Appendix Permitted Parameter Descriptions Web Setting Path Values Network-> network.802_1 It configures the access URL of the Advanced->802.1x x.client_cert_u client certificate when the 802.1x mode ->Device rl = is configured as EAP-TLS. Certificates network.vpn_ It enables or disables VPN feature. enable = 0-Disabled Network->...
  • Page 76 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values receive SNMP requests from any server. The default value is blank. It takes effect after a reboot. It enables or disables the phone to span data packets received in the WAN port to the PC port.
  • Page 77 Appendix Permitted Parameter Descriptions Web Setting Path Values 5-Weekly 6-Power on + Repeatedly 7-Power on + Weekly For SIP-T19P/T21P IP phones: It enables or disables the “Power On” mode for triggering the auto provisioning process. 0-Disabled 1-Enabled The default value is 1. It enables or disables Plug and Play feature.
  • Page 78 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values auto_provision .schedule.time _to = It configures the end time of day for the phone to check the new (only configuration weekly when the auto Settings->Auto applicable to...
  • Page 79 Appendix Permitted Parameter Descriptions Web Setting Path Values auto_provision .weekly.begin _time = It configures the begin time of the day for the phone to check the new Settings->Auto (only Time Format configuration weekly. provision->Time applicable to SIP-T19P and The default value is 00:00. SIP-T21P IP phones) auto_provision...
  • Page 80 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is blank. It configures the password for auto_provision Settings->Auto authentication during auto .server.passw String Provision-> provisioning. ord = Password The default value is blank.
  • Page 81 Appendix Permitted Parameter Descriptions Web Setting Path Values <MAC_Security>.enc files during auto provisioning. 0-Disabled 1-Enabled The default value is 0. It configures the name of the code for triggering auto provisioning. autoprovision. x.name = The maximum length of the name is String 100 characters.
  • Page 82 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values (X ranges Common CFG file. from 1 to 50.) The default value is blank. It takes effect after a reboot. It configures the AES key (16 autoprovision.
  • Page 83 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 2543 Hold 1-Enabled The default value is 0. It enables or disables the phone to keep sending the SIP messages to the Features->General sip.use_out_b outbound server in a dialog. Information->Use ound_in_dialo 0 or 1 0-Disabled Outbound Proxy In...
  • Page 84 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the access URL of the managements Settings->TR069-> ACS. erver.url = ACS URL It takes effect after a reboot. It enables or disables the phone to report its configuration to the ACS.
  • Page 85 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables the phone to complete the attended transfer transfer.on_ho Features->Transfer through on-hook. ok_trans_ena 0 or 1 ->Semi Attend 0-Disabled ble = Transfer On Hook 1-Enabled The default value is 1. It configures the DSS key behavior during an active call when user presses the DSS key and the DSS key is...
  • Page 86 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 1-Enabled The default value is 1. It enables or disables the echo canceller. Settings->Voice-> voice.echo_ca 0-Disabled Echo Cancellation 0 or 1 ncellation = 1-Enabled ->ECHO The default value is 1.
  • Page 87 Appendix Permitted Parameter Descriptions Web Setting Path Values Czech, Denmark, Finland, France, Germany, Great Britain, Greece, Hungary, Lithuania, India, Italy, Japan, Mexico, Zealand, Netherlands, Norway, Portugal, Spain, Switzerland, Sweden, Russia, United States, Chile, Czech ETSI It customizes the dial tone when the "voice.tone.country"...
  • Page 88 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values ring tone, ranges from 0 to 30000ms. You can configure at most eight different tones for one condition, and separate tones by commas. (e.g., 250/200, 0/1000, 200+300/500, 600+700+800+1000/2000).
  • Page 89 Appendix Permitted Parameter Descriptions Web Setting Path Values It customizes the call waiting tone when the "voice.tone.country" is configured as Custom. voice.tone.call The value format is F/D or !F/D. For Settings->Tones-> String waiting = more information on the value format, Call Waiting refer to the parameter “voice.tone.dial”.
  • Page 90 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values “voice.tone.dial”. The default value is blank. It customizes the auto answer tone when the "voice.tone.country" is configured as Custom. voice.tone.aut The value format is F/D or !F/D. For Settings->Tones->...
  • Page 91 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the strategy for ring-back tone. 1-Ignore: the phone plays the mix of defined tone and received RTP for ring-back tone. 2-Force: the phone discards the voice.call_pre 1, 2 or 3 view_mode = received RTP and plays the defined tone for ring-back tone.
  • Page 92 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values ert = authentication. ce Certificates 0-Default certificates 1-Custom certificates The default value is 0. It takes effect after a reboot. security.user_n It configures the user name for web String ame.user =...
  • Page 93 Appendix Permitted Parameter Descriptions Web Setting Path Values url = screen when Connecting. (not applicable to SIP-T20P IP phones) custom_softke y_dialing.url = It configures the access URL of the file Settings->Softkey (not for custom soft key layout on the LCD Layout applicable to screen when Dialing.
  • Page 94 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values applicable to SIP-T26P and SIP-T28P IP phones) memorykey.x. pickup_value (X ranges It configures the pickup code for BLF DSSKey->Memory from 1 to 10.) feature. String Key->Memory (only KeyX->Extension...
  • Page 95 Appendix Permitted Parameter Descriptions Web Setting Path Values 23-Group Pickup 24-Multicast Paging 25-Record 27-XML Browser 34-Hot Desking 35-URL Record 38-LDAP 40-Prefix 41-Zero Touch 42-ACD 45-Local Group 48-Custom Button 50-Keypad Lock 61-Directory memorykey.x. xml_phonebo ok = It specifies the desired remote (X ranges phonebook/local group for the DSSKey->Memory...
  • Page 96 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values (only applicable to SIP-T26P and SIP-T28P IP phones) linekey.x.picku p_value = (X ranges It configures the pickup code for BLF from 1 to 6.) DSSKey->Line feature. String Key->Line...
  • Page 97 Appendix Permitted Parameter Descriptions Web Setting Path Values 23-Group Pickup 24-Paging 25-Record 27-XML Browser 34-Hot Desking 35-URL Record 38-LDAP 40-Prefix 41-Zero Touch 42-ACD 45-Local Group 48-Custom Button 50-Keypad Lock 61-Directory linekey.x.xml_ phonebook = It specifies the desired remote phonebook/local group for the line key (X ranges DSSKey->Line from 1 to 6.)
  • Page 98 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values 7-Call Return 8-SMS 9-Directed Pickup 13-Spead Dial 22-XML Group 23-Group Pickup 27-XML Browser 28-History 30-Menu 31-Switch Account 32-New SMS 33-Status 38-LDAP 40-Prefix 41-Zero Touch 43-Local Directory 45-Local Group...
  • Page 99 Appendix Permitted Parameter Descriptions Web Setting Path Values programablek ey.x.history_ty DSSKey-> It configures the history type of pe = Integer Programmable programmable key. Key->Line (X ranges from 1 to 14.) programablek It configures the label displayed on the DSSKey-> ey.x.label = LCD screen for each programmable Programmable String...
  • Page 100 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values Y ranges from 1 to 39.) (only applicable to SIP-T26P and SIP-T28P IP phones) expansion_mo dule.x.key.y.pi ckup_value = (X ranges from 1 to 6. It configures the directed call pickup DSSKey->Ext...
  • Page 101 Appendix Permitted Parameter Descriptions Web Setting Path Values 1 to 39.) (only applicable to SIP-T26P and SIP-T28P IP phones) It enables or disables always forward feature. Features->Forwar forward.alwa 0-Disabled 0 or 1 d &DND->Always ys.enable = Forward->On/Off 1-Enabled The default value is 0. Features->Forwar forward.alwa It configures the target number the...
  • Page 102 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values Code It enables or disables no answer Features->Forwar forward feature. forward.no_a d &DND->No 0-Disabled nswer.enable 0 or 1 Answer 1-Enabled Forward->On/Off The default value is 0. Features->Forwar forward.no_a...
  • Page 103 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It configures the interval (in seconds) Features->ACD-> to automatically change the status of acd.auto_avai Integer from ACD Auto the ACD agent to available. lable_timer = 0 to 120 Available Timer (0~120s) The default value is 60.
  • Page 104 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends after register failed. Features->Action action_url.regi Example: URL->Register ster_failed = Failed action_url.register_failed = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when off hook.
  • Page 105 Appendix Permitted Parameter Descriptions Web Setting Path Values action_url.call_terminated = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when DND feature is enabled. action_url.dnd Features->Action Example: _on = URL->Open DND action_url.dnd_on = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when DND feature is disabled.
  • Page 106 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the action URL the phone sends when no answer forward action_url.no_ Features->Action feature is enabled. answer_fwd_o URL->Open No Example: Answer Forward action_url.no_answer_fwd_on = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when no answer forward action_url.no_...
  • Page 107 Appendix Permitted Parameter Descriptions Web Setting Path Values Example: action_url.unhold = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when muting a call. action_url.mut Features->Action Example: URL->Mute action_url.mute = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when un-muting a call. action_url.unm Features->Action Example:...
  • Page 108 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the action URL the phone sends when forwarding an incoming action_url.for Features->Action call. ward_incomin URL->Forward Example: g_call = Incoming Call action_url.forward_incoming_call = http://192.168.0.20/help.xml?IP=$ip It configures the action URL the phone sends when rejecting an incoming call.
  • Page 109 Appendix Permitted Parameter Descriptions Web Setting Path Values English, Chinese_S, It configures the language of the Chinese_T, phone user interface. German, French, Chinese_S and Chinese_T are only lang.gui = Turkish, applicable to SIP-T19P and SIP-T21P IP Italian, phones. Polish, The default value is English. Spanish or Portuguese It configures the time zone.
  • Page 110 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values For DST By Date: It configures the start time of the DST. Settings->Time & Value formats are: Date->Start Date Month/Day/Hour (for By Date)  For DST By Week: Month/ Day of Week/ Day of ...
  • Page 111 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the date format. For SIP-T19P/SIP-T21P/T22P/T26P/T28P IP phones: 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 (for 6-WWW DD MMM SIP-T19P/T21P Settings->Time &...
  • Page 112 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It enables or disables the phone to provide input field of user name on the hot desking login wizard during hotdesking.st startup.
  • Page 113 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables the phone to provide input field of user name on the hot desking login wizard when hotdesking.ds pressing the Hot Desking key. skey_usernam 0 or 1 0-Disabled e_enable = 1-Enabled The default value is 1.
  • Page 114 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values nfo.x.ringer = The value ranges from 1 to 5, the digit File stands for the appropriate ringtone. (X ranges from 1 to 10.) It enables or disables the phone to...
  • Page 115 Appendix Permitted Parameter Descriptions Web Setting Path Values 1-Enabled The default value is 0. It enables or disables the phone to use the push XML via SIP NOTIFY message. push_xml.sip_ Features->Remote 0-Disabled 0 or 1 notify = Control->SIP Notify 1-Enabled The default value is 0.
  • Page 116 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values dialplan.block Settings->Dial _out.number.X It configures the block out string. Plan->Block String Out->BlockOut The default value is blank. (X ranges NumberX from 1 to 10.) It configures lines applying the block dialplan.block...
  • Page 117 (not the LDAP phonebook. Directory->LDAP-> applicable to String Example: Base SIP-T19P and SIP-T20P IP ldap.base = dc=yealink,dc=cn phones) The default value is blank. ldap.user = It configures the user name for Directory->LDAP-> String (not accessing the LDAP server. Username...
  • Page 118 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values SIP-T19P and The default value is blank. SIP-T20P IP phones) ldap.passwor It configures the password for (not Directory->LDAP-> accessing the LDAP server. String applicable to Password SIP-T19P and The default value is blank.
  • Page 119 Appendix Permitted Parameter Descriptions Web Setting Path Values SIP-T19P and Example: SIP-T20P IP ldap.display_name =%cn phones) The default value is blank. ldap.version (not It configures the LDAP version. Directory->LDAP-> 2 or 3 applicable to Protocol The default value is 3. SIP-T19P and SIP-T20P IP phones)
  • Page 120 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the return code when refusing a call. Features->General features.norm 404-No Found 404, 480 or Information-> al_refuse_cod 480-Temporarily not available Return Code When Refuse 486-Busy here The default value is 486.
  • Page 121 Appendix Permitted Parameter Descriptions Web Setting Path Values er = Multiple numbers are separated by Numbers commas. The default value is blank. It enables or disables forward diversion feature. features.fwd_ Features->General 0- Disabled diversion_ena 0 or 1 Information->Diver ble = sion/History-Info 1-Enabled The default value is 1.
  • Page 122 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values The default value is 0. It enables or disables the phone to play a warning tone when answering an intercom call. features.interc Features->Interco 0 or 1 0-Disabled om.tone =...
  • Page 123 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables the phone to suppress the display of DTMF digits. Features->General features.dtmf. 0-Disabled 0 or 1 Information->Supp hide = ress DTMF Display 1-Enabled The default value is 0. It enables or disables the IP phone to display the DTMF digits for a short features.dtmf.
  • Page 124 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables dual headset feature. Features->General features.head 0-Disabled 0 or 1 Information->Dual- set_training = Headset 1-Enabled The default value is 0. It enables or disables the phone to play a local DTMF tone.
  • Page 125 Appendix Permitted Parameter Descriptions Web Setting Path Values 0-Disabled 1-Enabled The default value is 1. It enables or disables the phone to play key tone when pressing any key. features.key_t Features->Audio- 0-Disabled 0 or 1 one = > Key Tone 1-Enabled The default value is 1.
  • Page 126 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values numbers in the dialing interface. It enables or disables the phone with active accounts to play tones in the dialing interface differently from the features.partiti phone with no active accounts.
  • Page 127 Appendix Permitted Parameter Descriptions Web Setting Path Values The default value is 1. It enables or disables the phone to perform a blind transfer by pressing the predefined transfer DSS key. features.dsske 0 or 1 0-Disabled y_blind_tran = 1-Enabled The default value is 1. It configures the web access timeout features.relog Integer from...
  • Page 128 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values p_enable = phone is in the pre-dialing screen. Call Pickup (not 0-Disabled applicable to 1-Enabled SIP-T20 IP The default value is 0. phones) features.picku Features->Call It configures the group call pickup p.group_picku...
  • Page 129 Appendix Permitted Parameter Descriptions Web Setting Path Values applicable to For SIP-T20P/T22P/T26P/T28P IP phones: SIP-T19 IP The default value is 0. phones) For SIP-T21P IP phones: The default value is 1. It enables or disables the phone to play the warning tone when receiving features.voice a voice mail.
  • Page 130 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values _dialing_enab 0-Disabled le = 1-Enabled The default value is 0. It enables or disables the phone to automatically dial out the entered phone_setting digits in the pre-dialing interface.
  • Page 131 Appendix Permitted Parameter Descriptions Web Setting Path Values phones) Features->Phone It configures the password for phone_setting Lock->Phone unlocking the keypad. .phone_lock.u Integer Unlock PIN (0~15 nlock_pin = The default value is 123. Digit) It configures the interval (in seconds) to automatically lock the keypad. Features->Phone phone_setting Integer from...
  • Page 132 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values For SIP-T28P IP phones: 1-System logo 2-Custom logo The default value is 1. phone_setting .lcd_logo.text It configures a text logo. Features->General The maximum length of the value is 15 String Information->Text...
  • Page 133 Appendix Permitted Parameter Descriptions Web Setting Path Values It enables or disables the phone to deal with the 180 SIP message Features->General received after the 183 SIP message. phone_setting 0 or 1 Information->180 0-Disabled .is_deal180 = Ring Workaround 1-Enabled The default value is 1. Features->General It configures the delay time (in phone_setting...
  • Page 134 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values If leaving the field blank, the phone will display the value sent from the server when receiving the 403 message. The default value is blank. custom_mac_ It configures the access URL of the cfg.url =...
  • Page 135 Appendix Permitted Parameter Descriptions Web Setting Path Values The valid value is: http://localhost/all lcd_logo.url = (not It configures the access URL of logo applicable to file. SIP-T20P IP phones) lcd_logo.delet It deletes all customized logo files. (not applicable to The valid value is: http://localhost/all SIP-T20P IP phones) trusted_certific...
  • Page 136 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values configuration file. It configures the access URL of the call history list file. call_list.url = It takes effect after a reboot. It configures the access URL of the openvpn.url =...
  • Page 137 Appendix Permitted Parameter Descriptions Web Setting Path Values account.x.disp It configures the display name for lay_name = Account->Register account x. String ->Display Name (X ranges The default value is blank. from 1 to 6.) account.x.aut It configures the user name for register h_name = Account->Register authentication for account x.
  • Page 138 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values (X ranges name for account x. from 1 to 6.) 0- Not need to re-register 1-Need to re-register The default value is 0. It configures the way of SRV query when there is no result from the NAPTR account.x.nap...
  • Page 139 Appendix Permitted Parameter Descriptions Web Setting Path Values account.x.sip_ server.y.expire It configures the registration expiration Integer from Account->Register time (in seconds) to SIP server y for 30 to ->SIP Server Y-> (X ranges account x. 2147483647 Server Expires from 1 to 6. Y The default value is 3600.
  • Page 140 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values from 1 to 6. Y 1-Enabled ranges from 1 The default value is 0. to 2.) It configures whether preferentially to use the DNS cache for domain name account.x.stati...
  • Page 141 Appendix Permitted Parameter Descriptions Web Setting Path Values from 1 to 6.) account.x.dns _cache_srv.y.p Integer from It identifies the port to be used in SRV ort = 0 to 65535 record y for account x. (X ranges from 1 to 6.) account.x.dns It specifies the priority for the specific _cache_srv.y.p...
  • Page 142 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values from 1 to 6.) A-Do an A lookup next. U-No need to do a DNS query next. P-Service customized by the user account.x.dns It specifies the preferential treatment _cache_naptr.
  • Page 143 Appendix Permitted Parameter Descriptions Web Setting Path Values It specifies the way of the DNS-SRV query. 0-DNS-SRV query using UDP , TCP or TLS account.x.dns 1-DNS-SRV query using UDP only _srv_type = 0, 1, 2 or 3 2-DNS-SRV query using TCP only (X ranges from 1 to 6.) 3-DNS-SRV query using TLS only...
  • Page 144 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It enables or disables anonymous call account.x.ano feature for account x. nymous_call = Account->Basic-> 0-Disabled 0 or 1 Send Anonymous (X ranges 1-Enabled from 1 to 6.) The default value is 0.
  • Page 145 Appendix Permitted Parameter Descriptions Web Setting Path Values _offcode = account x. Code (X ranges The default value is blank. from 1 to 6.) It enables or disables DND feature for account x when the DND mode is account.x.dnd Features->Forwar configured as Custom.
  • Page 146 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values account.x.bus It configures the target number the y_fwd.target phone forwards incoming calls to Features->Forwar String when busy for account x when the call d& DND->Busy forward mode is configured as Forward->Target...
  • Page 147 Appendix Permitted Parameter Descriptions Web Setting Path Values (X ranges Code from 1 to 6.) account.x.bus Features->Forwar y_fwd.on_cod It configures the busy forward on code d& DND->Busy String for account x when the call forward Forward->On mode is configured as Custom. (X ranges Code from 1 to 6.)
  • Page 148 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values xpires = The default value is 3600. Subscription Period (Seconds) (X ranges from 1 to 6.) It configures the source caller identity for presentation when receiving an incoming call for account x.
  • Page 149 Appendix Permitted Parameter Descriptions Web Setting Path Values from 1 to 6.) 1-Enabled The default value is 0. account.x.sess It configures the interval (in seconds) Account-> ion_timer.expir for refreshing the SIP session for Integer from Advanced-> es = account x. 30 to 7200 Session Expires (X ranges...
  • Page 150 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values from 1 to 6.) account.x.dial oginfo_callpic It enables or disables the phone to kup = pick up a call according to the SIP Account-> (X ranges header of dialog-info for account x.
  • Page 151 Appendix Permitted Parameter Descriptions Web Setting Path Values _vm = message waiting indicator for account Subscribe MWI To Voice Mail (X ranges from 1 to 6.) 0-Disabled 1-Enabled The default value is 0. It enables or disables the phone to carry the MAC address in the account.x.regi Account->...
  • Page 152 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values It configures the type of the BLF account.x.blf.s subscription for account x. ubscribe_even 0-Dialog 0 or 1 (X ranges 1-Presence from 1 to 6.) The default value is 0.
  • Page 153 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures the DTMF info type when the DTMF type is configured as “SIP INFO” or “AUTO+SIP INFO” for account.x.dtm Account-> account x. f.info_type = 1, 2 or 3 Advanced->DTMF 1-DTMF-Relay (X ranges Info Type 2-DTMF from 1 to 6.)
  • Page 154 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values (X ranges (Seconds) from 1 to 6.) It enables or disables NAT Rport account.x.nat. feature for account x. rport = Account-> 0-Disabled 0 or 1 Advanced->RPort (X ranges 1-Enabled from 1 to 6.)
  • Page 155 Appendix Permitted Parameter Descriptions Web Setting Path Values It configures a ringtone for account x. Example: account.x.ring Common, account.1.ringtone.ring_type = tone.ring_type Ring1.wav, Ring3.wav means configuring Account->Basic-> Ring2.wav, Ring3.wav for account1. Ring Type …… (X ranges account.1.ringtone.ring_type = from 1 to 6.) Ring5.wav Common means account1 will use the ring tone selected for the phone.
  • Page 156 Yealink IP Phones Auto provisioning Guide Permitted Parameter Descriptions Web Setting Path Values from 1 to 6. account.1.codec.1.rtpmap = 0 Y ranges from 1 to 11.) It enables or disables the phone to account.x.unr Account-> un-register account x before reboot.
  • Page 157 Appendix Permitted Parameter Descriptions Web Setting Path Values account.x.acd It configures the user ID used to log .user_id = into the ACD system. String (X ranges The default value is blank. from 1 to 6.) account.x.acd It configures the password used to log .password = into the ACD system.
  • Page 158 Yealink IP Phones Auto provisioning Guide We are striving to improve our documentation quality and we appreciate your feedback. Email your opinions and comments to DocsFeedback@yealink.com.

Table of Contents