How to add a custom background image in CUCM
Posted by Josh on Thu 26 Aug 2010Categories: Cisco , Cisco VOIP , Voice LAB - [6] Comments
Adding a custom background image to a Cisco IP Phone can be tricky. You can use Cisco Phone Designer or you can use the following instructions to upload backgrounds to the dedicated servers so the users can choose a background from the phone.
References
The original source of this article is based on a Cisco support forum response from from Martin Streule .
Important Notes
- The List.xml file must start with a capitol ‘L’
- You must have a thumbnail image as well as a background image.
- There can be up to 50 entries in a List file
- The List.xml must be done per phonetype…
- The tn-xxxx.png file referenced in the xml file below is the thumbnail image.
- This can be used for CUCM or CUCME.
- CUCME will require you to use a separate tftp server or create directories in the router’s flash
Create backgroung image files
Create two .png images one for the thumbnail and one for the real image.
- For best results, reduce the colour palette of an image to 12-bit (4096 colors) when you create a PNG file.
- “tn-xxxx.png” is the thumbnail image
- “xxxx.png” is the “real” image
- Thumbnail and real image sizes must be exact to specs below
Create a “List.xml” file
Here is the format of the List.xml file for two separate example backgrounds … logo and mountain.
<CiscoIPPhoneImageList>
<ImageItem Image=”TFTP:Desktops/320x212x12/tn-logo.png” URL=”TFTP:Desktops/320x212x12/logo.png”/>
<ImageItem Image=”TFTP:Desktops/320x212x12/tn-mountain.png” URL=”TFTP:Desktops/320x212x12/mountain.png”/>
</CiscoIPPhoneImageList>
Phone image specifics
The following image sizes and tftp directories should be used for each specific phone type.
7941 / 7961
Full size image— 320 pixels (width) X 196 pixels (height).
Thumbnail image— 80 pixels (width) X 49 pixels (height).
Directory “Desktops/320x196x4″
7942 / 7962
Full size image—320 pixels (width) X 196 pixels (height).
Thumbnail image—80 pixels (width) X 49 pixels (height).
Directory “/Desktops/320x196x4″
7945 / 7965
Full size image—320 pixels (width) X 212 pixels (height).
Thumbnail image—80 pixels (width) X 53 pixels (height).
Directory “/Desktops/320x212x16″
7970 / 7971
Full size image—320 pixels (width) X 212 pixels (height).
Thumbnail image—80 pixels (width) X 53 pixels (height).
Directory “Desktops/320x212x12″
7975
Full size image—320 pixels (width) X 216 pixels (height).
Thumbnail image—80 pixels (width) X 53 pixels (height).
Directory “/Desktops/320x216x16″
Upload the files to the TFTP Server
- Upload the file “List.xml” to the tftp folder matching the phone directory above
- Upload the tn-xxxx.png to the folder matching the phone directory above
- Upload the xxxx.png to the folder matching the phone directory above
- For example, if the phone were a 7971, the directory would be “Desktops/320x212x12″.
TFTP Upload Instructions
- Navigate to the ‘Operating System Administration’ window
- Go to ‘Software Upgrades > TFTP File Management’
- Click ‘Upload File’
- Click ‘Browse’ and then choose the file to upload
- Enter the subdirectory in the ‘Directory’ field e.g. “Desktops/320x212x12″
- Click ‘Upload File’
Restart tftp service
- Go to ‘Cisco Serviceability’ in the upper right corner drop down box.
- Go to Tools > Control Center ‘Feature Services’
- Select ‘Cisco TFTP’ and Click the Restart Icon at the top of the page.
Restart the phone
- Press the settings button
- Press ** # **
Change the background image on the phone
- Choose Settings > User Preferences > Background Images.
- Scroll through available images and press Select to choose an image.
- Press Preview to see a larger view of the background image.
- Press Exit to return to the selection menu.
- Press Save to accept the new image, or press Cancel.
Troubleshooting
- (You can sniff on the network to see what directory a certain phonetype is looking for).
- If a background image just does not want to show up, it’s a good idea to browse to the phone web site and check the Console Log for failures (xml parsing, …)

August 27th, 2010 at 2:14 pm
Very nice,I wonder if the IP Communicator is part of this,I will read it more carefully and see how to implement it.
August 27th, 2010 at 2:31 pm
chips,
IP Communicator is part of this. Use the specs for a 7970 phone.
Josh
August 28th, 2010 at 4:15 pm
Hello Josh,
This is excellent post.
My question is how to down load the files in CME router.The restriction in this case is we are not allowed to use directory e.g “Desktops/320x212x12″
If we are not using phone specific directory then where the file is going to save.In cucm root directory.What is the path for this directory.
Also I can use this command to download into the cme flash
tftp-server flash:
what path I have to define after this command tftp-server flash:
Or is there any other way around to install back ground images in CME router.
February 4th, 2011 at 8:01 am
Azhar,
I think if you are faced with such a restriction, you can use mkdir to create the required directory in flash, otherwise, you have to backup & format the flash to enable directory creation.
Check below:
http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_tech_note09186a008062495a.shtml
August 11th, 2011 at 7:47 am
Hi,
I am trying to upload a custom background pic to the Cisco IP Phone 7965.
I created a List.xml and 2 .png pic(Big & Thumbnail) and uploaded to the Cisco Unified OS Administration link- TFTP File Management and restart the tftp server & IP phone accordingly.
It has successfully uploaded to the tftp server but when I browse into the background images on the phone, it display a default thumbnnail and a new blank thumbnail. When i select the new blank thumbnail, it could not retrieved it at all.
This is what i have done:
List.xml
Name of 2 png: Small_Main.png, Big_Main.png
Uploadfile directory: /Desktops/320x212x16
The strange part is when I search for List.xml using the TFTP File Management, it listed out 2 file as shown below.
File Name Directory
List.xml Desktops/320x212x16
List.xml Desktops/640x480x24
Supposed to be like this?
August 11th, 2011 at 8:48 am
when i run the command it show all the file is there.
admin:file list tftp /Desktops/320x212x16
Big_Main.png List.xml
Small_Main.png
dir count = 0, file count = 3
this is the List.xml format