How to Configure Yealink Remote Phonebook


Yealink remote phonebook feature allows you to access your corporate directory straight from your phone. You can simply dial a contact number from the corporate directory.

In this guide, we introduce how to configure the remote phonebook on S-Series IPPBX.


Preparing XML Phonebook

XML phonebook enables the Yealink phone to access to an XML-formatted phone book which is located in an HTTP/TFTP/HTTPs server.























The XML file can be edit by UltraEdit or Windows Notepad. Please note that the Yealink xml phone book supports only ASCII and UTF-8 encoding. You can change the words marked with red font, and do not change the words with black fonts which are the fixed format for the xml phonebook.

Pay attention to the following points:

  • <xxxIPPhoneDirectory>

You can change xxx to your company name, for example, <YeastarIPPhoneDirectory>

  • <Telephone>number</Telephone> supports three formats:
    1. Telephone number, for example, <Telephone>1234567890</Telephone>
    2. user@host, for example, <Telephone>302@ </Telephone>
    3. SIP URL, for example, <Telephone>sip:301@</Telephone>

When you finish the configuration, save the file as an XML file. Here we save it as “Yeastar.xml”.



 Configuring Remote Phonebook on S-Series IPPBX

Follow the steps below to configure remote phonebook on Yeastar S-Series IPPBX. 

STEP 1. Upload the XML phonebook file to S-Series IPPBX.

  • Log in Yeastar S-Series IPPBX, navigate to “Settings > System > Security > Service”, enable TFTP service, the PBX will be a TFTP server.

  • Go to “Auto Provisioning > Phonebook > Phonebook”, click “Upload Phonebook”, and choose the prepared XML phone book file to upload.

Now, the XML file is uploaded to the S-Series IPPBX TFTP server. The access URL is tftp://IP of S-series PBX/upload/phonebook/phonebook name.

In this example, the access URL is:


STEP 2. Enter the phonebook access URL for the Yealink phones.

  • Go to “Auto Provisioning > Device List”, select the desired Yealink phone(s), click  to edit the phone(s).
  • Click “Feature” tab, enter the phonebook URL, and phonebook name.

  • Click “Save” and click “Yes” to confirm rebooting the phone(s).
  • The phone(s) will apply the changes and download the phonebook.


Using Yealink Remote Phonebook

After the Yealink phone boots up, you can access your corporate directory via phone user interface.

  • Press “Menu > Directory > Remote phonebook”.

If Remote phonebook is added to the directory, press Directory->Remote phonebook to enter remote phonebook.

  • Select the desired remote group.


  • Press the “Enter” soft key to load the corporate directory.


  • Press the “Back” soft key to return to the previous interface.

Note: different IP phone firmware versions may have different phone user interfaces.

Have more questions? Submit a request


  • 1
    Edited by Jan Dedek Alfamik
  • 0

    Is there any way to specify the ring type using the phone book? I noticed this XML format is different than the Yealink format, can we just upload that XML file?

Please sign in to leave a comment.