Yealink XML Phonebook.xml auto-generation

gbaughma · August 15, 2018, 5:06pm

So, I wrote a script that generates the XML Phonebook for Yealink phones.

Enjoy!

Note: username and password need to have select access to the database

<?php
$mysql_conn = mysql_connect('localhost','username','password');
mysql_select_db('asterisk', $mysql_conn);
$query = 'SELECT description AS Name, user AS Telephone FROM devices WHERE 
tech="sip"';

$result = mysql_query($query, $mysql_conn);
if (! $result){
echo mysql_error();
}

$Output = "<YealinkIPPhoneDirectory>\n";
while($data = mysql_fetch_assoc($result)){
    $results[] = $data;
    $Output .= " <DirectoryEntry>\n";
    foreach($data as $key => $value){
            $Output .= "  <$key>$value</$key>\n";
    }
    $Output .= " </DirectoryEntry>\n";
}
$Output .= "</YealinkIPPhoneDirectory>\n";
// echo $Output;

file_put_contents('Phone.xml',$Output);

?>

arielgrin · August 15, 2018, 5:18pm

Great script! I have a similar one that generates phonebook simultaneously for yealink, grandstream and snom.

sorvani · August 30, 2018, 2:30pm

Here is one I wrote.

This one is designed to be called live from the phone button.

github.com

sorvani/freepbx-helper-scripts/blob/master/ylab.php

<?php
/* 
ylab.php (short for yealink address book) was taken directly from yl.php and modified.
https://github.com/sorvani/freepbx-helper-scripts/blob/master/yl.php

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.
*/

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

// get the MySQL/MariaDB login information from the amportal configuration file.
define("AMP_CONF", "/etc/amportal.conf");

$file = file(AMP_CONF);
if (is_array($file)) {
    foreach ($file as $line) {
        if (preg_match("/^\s*([a-zA-Z0-9_]+)=([a-zA-Z0-9 .&-@=_!<>\"\']+)\s*$/",$line,$matches)) {
            $amp_conf[ $matches[1] ] = $matches[2];
        }

This file has been truncated. show original

sorvani · January 16, 2019, 1:33am

Apparently, I cannot edit the post any more, but I cleaned up the repository, the address changed a bit.

github.com

sorvani/freepbx-helper-scripts/blob/master/Extensions_to_Yealink_AddressBook/ylab.php

<?php
/* 
ylab.php (short for yealink address book) was taken directly from yl.php and modified.
https://github.com/sorvani/freepbx-helper-scripts/blob/master/yl.php

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.
*/

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

// get the MySQL/MariaDB login information from the amportal configuration file.
define("AMP_CONF", "/etc/amportal.conf");

$file = file(AMP_CONF);
if (is_array($file)) {
    foreach ($file as $line) {
        if (preg_match("/^\s*([a-zA-Z0-9_]+)=([a-zA-Z0-9 .&-@=_!<>\"\']+)\s*$/",$line,$matches)) {
            $amp_conf[ $matches[1] ] = $matches[2];
        }

This file has been truncated. show original

BlazeStudios · February 8, 2019, 1:26pm

So I have a question about these scripts. Is there a reason they only look for local extensions on the PBX vs the actual contact lists? I mean the scripts are basically kicking out an internal directory but what if people what other contacts in their phonebook directory?

sorvani · February 10, 2019, 5:18pm

@BlazeStudios I have another one that in there that looks at the Contact Manager.

comdif · February 17, 2019, 10:49pm

To use freepbx phone book I have make this very simple code working like a charm
Use this page as remote phone book, name is as you like and put it in /var/www/html dir.

<?php
################################################
#    COMDIF INNOVATION Christian-Zeler@2019    #
# Dynamic XML from Free-PBX Asterisk Phonebook #
################################################
header("Content-Type: text/xml");
// Connect Asterisk Sqlite database
$db = new SQLite3('/var/lib/asterisk/astdb.sqlite3');
// Search cidname datas
$results=$db->query('SELECT * FROM astdb WHERE key like "/cidname/%";');
// make header for XML format
echo'<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n';
// XML doc start
echo'<contactIPPhoneDirectory>\n';
$index = 0;
// Loop to print Directory 
while ($row = $results->fetchArray())
	{
    $num = explode('/',$row[0]);
	$index= $index + 1;
	echo "    <DirectoryEntry>\n";
	echo "        <Name>" . $row[1] . "</Name>\n";
	echo "        <Telephone>" . $num[2] . "</Telephone>\n";
	echo "    </DirectoryEntry>\n";
	}
// End XML doc
echo "</contactIPPhoneDirectory>\n";
// That's all folks :-)
?>

Enjoy

gbaughma · February 26, 2019, 4:45pm

I’m not a php expert (although I have 40+ years programming in other languages…) what is the purpose of the $index variable in that script? Seems to not do anything…

sorvani · February 26, 2019, 4:51pm

Not true it increments every loop. So that is something… He’s not using it to do anything, but it does increment.

clopez2019 · July 16, 2019, 9:58pm

Buenas tardes.

En donde se pone el script

sorvani · July 16, 2019, 10:12pm

I place the script in the default location on the FreePBX server.

Google Translate: Coloco el script en la ubicación predeterminada en el servidor FreePBX.

/var/www/html

clopez2019 · July 16, 2019, 10:31pm

Gracias, y como se llama en vivo desde el teléfono, se corre el script primero para que genere algún archivo

sorvani · July 16, 2019, 10:42pm

That is correct, but the phone only refreshes every 26400 seconds

Google Translate: Eso es correcto, pero el teléfono solo se actualiza cada 26400 segundos

1A2 · July 19, 2019, 5:29pm

I grabbed the latest version of cm_to_yl_ab.php from github. Had a little hiccup though, but I tracked it down - if the actual group name in $contact_manager_group has a single quote in it, it’s not escaped properly and breaks the script. ie $contact_manager_group = “Joe’s Contacts”

sorvani · July 19, 2019, 7:01pm

never even thought about that as this wasn’t designed for open input.

1A2 · July 19, 2019, 8:07pm

Well, no telling WHAT a contact group is going to be named… I added a $_GET[‘ext’] so I could pass the extension number ( remote_phonebook.data.1.url = http://pbx.xxxx.com:81/ExtensionPB.php?ext=__line1Ext__ ). That way it pulls the private contacts for a user that they can maintain via UCP. Just name the group whatever the extension number is.

sorvani · July 20, 2019, 5:15am

That concept is better served with the local contact function in the phone IMO. Users can save that without a web browser via the desk phone itself, or via the phone gui with the user account.

That contact list can be auto uploaded to the PBX every time it is modified.

But I see your point.

1A2 · July 24, 2019, 4:55pm

I have to disagree with you wrt the local contact function in the phone. Maintaining numbers on the phone itself is annoying at best. Let’s face it, touch screens are horrible, whether on a T48S or an iPhone X. And older users with dry skin find it particularly vexing (search on ‘zombie finger’). Giving users web access to the phone? Why do that when you already have given them UCP and taught them how to use it?

mst · October 11, 2019, 7:52pm

This page contains the following errors:

error on line 1 at column 15: String not started expecting ’ or "

Below is a rendering of the page up to the first error.

any thoughts?

sorvani · October 11, 2019, 10:04pm

random guess? Single quote in user name