Yealink Remote Directory

Yealink phones can pull FreePBX directory information by using a remote phone book. To set up a remote phone book, the following PHP file will need to be added to /var/www/html on the FreePBX server. Code from Sorvani's work at



ylab.php (short for yealink address book) was taken directly from yl.php and modified.

The purpose of this file is to read all the extensions in the system and then output them in a

Yealink Remote Address Book formatted XML syntax.

Updated December 24, 2019 to use FreePBX bootstrap


header("Content-Type: text/xml");

// Load FreePBX bootstrap environment


// Initialize a database connection

global $db;

// This pulls every extension in the systm. Including virtual mailboxes and is a recommended default

$sql = "SELECT `id`,`description` FROM `devices`;";

// You can restrict the output with standard SQL syntax

// This example only shows extensions prior to 200 and not virtual mailboxes

// $sql = "SELECT `id`,`description` FROM `devices` WHERE `id` < 200 AND `tech` <> 'custom';";

// This example will pull all extensions from 1000 to 1999

// $sql = "SELECT `id`,`description` FROM `devices` WHERE `id` BETWEEN 1000 and 1999;";

// Execute the SQL statement

$res = $db->prepare($sql);


// Check that something is returned

if (DB::IsError($res)) {

// Potentially clean this up so that it outputs pretty if not valid

error_log( "There was an error attempting to query the extensions<br>($sql)<br>\n" . $res->getMessage() . "\n<br>\n");

} else {

$extensions = $res->fetchAll(PDO::FETCH_ASSOC);

// output the XML header info

echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";

// Output the XML root. This tag must be in the format XXXIPPhoneDirectory

// You may change the word Company below, but no other part of the root tag.

echo "<CompanyIPPhoneDirectory clearlight=\"true\">\n";

// Loop through the results and output them correctly.

// Spacing is setup below in case you wish to look at the result in a browser.

foreach ($extensions as $extension) {

echo " <DirectoryEntry>\n";

echo " <Name>" . $extension['description'] . "</Name>\n";

echo " <Telephone>" . $extension['id'] . "</Telephone>\n";

echo " </DirectoryEntry>\n";


// Output the closing tag of the root. If you changed it above, make sure you change it here.

echo "</CompanyIPPhoneDirectory>\n";



With the PHP file in place, go Directory > Remote Phone Book in the web ui of the Yealink phone and enter the Remote URL of the PHP file and give it a name.

Finally, set a programmable key to access the remote directory. In the Dsskey tab select any key and set the Type to XML Group. Provide an appropriate name in the Label field and in the Line field, select the name of the remote phone book that was created in the previous step.