Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

Creating a custom phone book

Introduction

Cisco IP telephones have many practical features. One such feature is the ability to create a custom phone book which can be accessed either via a DIRECTORY button, or depending on which model you have, via the Setup Menu.

Once you complete these steps and configure the telephone via its SEPxxxxxxxxxx.cnf.xml file, there are no further changes/updates necessary to the telephone itself. In other words, as you update the respective phone book files containing the names and telephone numbers in your directory, these changes will automatically be reflected on the telephone.

The following will guide you step-by-step in order to do this.

Files Required

For this example, you will require 2 files: phonebook.xml and directory.xml. These two files need to be stored on a web server accessible by your telephones (not necessarily the public/WAN).

You can also easily generate the contents of these files using a script language which your web server can understand, for example perl, php, ruby, or python. If you choose to generate these files in this manner, the outputted files may not have the ".XML" extension (although they will still produce valid XML content), you will simply need to rename the extension accordingly.

For this purposes of this simple How-To, just follow these steps:

The phonebook.xml File

Create this file using the following format:

<?xml version="1.0" encoding="ISO-8859-1"?>
<CiscoIPPhoneDirectory>
<Title>Personal Phone Book</Title>
<Prompt>Select a number</Prompt>

<DirectoryEntry>
<Name>Surname1, Firstname1</Name>
<Telephone>0123456789</Telephone>
</DirectoryEntry>

<DirectoryEntry>
<Name>Surname2, Firstname2</Name>
<Telephone>1234567890</Telephone>
</DirectoryEntry>

</CiscoIPPhoneDirectory>

Using this format, you simply create as many entries as you wish by copying the <DirectoryEntry> tag and contents.

Note: There is a maximum of 36 <DirectoryEntries> per page on most models. To get around this limitation, you may add a couple of softkeys to walk through multiple pages. You can read the How-To on [Creating Softkeys] by clicking on the link.

The directory.xml File

Create this file using the following format (remember to change the IP address):

<?xml version="1.0" encoding="ISO-8859-1"?>
<CiscoIPPhoneMenu>
<Prompt>Select a number</Prompt>
<MenuItem>
<Name>Phonebook</Name>
<URL>http://xxx.xxx.xxx.xxx/phonebook.xml</URL>
</MenuItem>
</CiscoIPPhoneMenu>

Note: The <MenuItem> will be added to the three default entries in the Directory after: Missed Calls, Received Calls, and Placed Calls.

Updating the SEPxxxxxxxxxx.cnf.xml -or- XMLDefault.xnf.xml file

In order for the telephone to configure its menu system to use the new directory, you must make sure you update the <DirectoryURL> tag in this file. The following is an example (remember to change the IP address):

<directoryURL>http://xxx.xxx.xxx.xxx/directory.xml</directoryURL>

Finished!

That's all there is to it. At this point, you should do a [Basic Reset] or [Factory Reset] on the telephone to allow it to configure itself with the new Directory entries. You should also be able to view these files via your Internet browser if you want to make sure they are indeed accessible.

For more advanced users, you could also update your current company directory scripts to make them accessible by adding a view that creates <CiscoIpPhoneDirectory> structure. Information about this will be added later under an [Creating an advanced custom phone book].


Related

Documentation: Basic Reset
Documentation: Cisco-XML
Documentation: Factory Reset