This chapter describes how to configure and upload customized phone ring
types for your Cisco Unified IP Phones.
Custom Phone Rings
Custom Phone Rings
allows you to create customized phone rings and upload the customized files to
the Cisco Unified Communications Manager TFTP server where they can be accessed
by Cisco Unified IP Phones.
Cisco Unified IP Phones ship with default ring types that are implemented in hardware: Chirp1 and Chirp2. In addition, Cisco Unified Communications Manager provides the capability of uploading the following files to phones:
- PCM Files
Cisco Unified Communications Manager provides a default set of phone ring sounds that are implemented in software as pulse code modulation (PCM) audio files. Each PCM file specifies a single ring type.
- Ringlist.xml File
The Ringlist.xml file describes the list of ring options that are available for phones.
You can upload customized PCM audio files, such as custom ring tones and call back tones, as well as the modified Ringlist.xml file to the TFTP directory in Cisco Unified Communications Manager.
Custom Phone Rings Prerequisites
The following prerequisites apply to Custom Phone Rings:
In order to upload your custom phone rings, the Cisco TFTP service must be running.
Any PCM files that you want to upload must meet a set of file requirements in order to be compatible with Cisco Unified IP Phones. For details, review the topic PCM File Format Requirements.
The Ringlist.xml file must meet a set of formatting guidelines. For details, review the topic Ringlist.xml File Format Requirements.
Rings Configuration Task Flow
Prepare Custom Phone Rings for Upload
||Use the file get tftp <tftp path> CLI command to download the existing Ringlist.xml file, in addition to any PCM files that you want to modify.|
||Create a PCM file for each ring type that you want to upload. For guidelines on PCM file compatibility with Cisco Unified Communications Manager, see PCM File Format Requirements.|
||Use an ASCII editor to update the Ringlist.xml file with your new phone rings. For details on Ringlist.xml file formatting requirements, see Ringlist.xml File Format Requirements.|
What to Do Next
Upload Custom Phone Rings to TFTP Server
Upload Custom Phone Rings to
Unified OS Administration, choose
Browse and select the Ringlist.xml file, as well as any PCM files that you want to upload.
What to Do Next
Restart TFTP Service
||Log in to
Cisco Unified Serviceability and choose
Server drop-down list box, choose the server on
which the Cisco TFTP service is running.
radio button that corresponds to the
PCM File Format
PCM files for phone
rings must meet a set of requirements for proper playback on Cisco Unified
IP Phones. When creating or modifying your PCM files, you can use any standard audio editing packages that support the following file format requirements:
- Raw PCM
- 8000 samples per second
- 8 bits per sample
- mu-law compression
- Maximum ring size: 16080
- Number of samples in the
ring must be evenly divisible by 240
- Ring starts and ends at the
The Ringlist.xml file defines an XML object that contains a list of phone ring types. Each ring type contains a pointer to the PCM file that is used for that ring type and the text that will display on the Ring Type menu on a Cisco Unified IP Phone for that ring.
The CiscoIPPhoneRinglist XML object uses the following simple tag set to describe the information:
The following characteristics apply to the definition names:
DisplayName defines the name of the custom ring for the associated PCM file that will display on the Ring Type menu of the Cisco Unified IP Phone.
FileName specifies the name of the PCM file for the custom ring to associate with DisplayName.
The DisplayName and FileName fields must not exceed 25 characters.
The following example shows a Ringlist.xml file that defines two phone ring types:
<DisplayName>Analog Synth 1</DisplayName>
<DisplayName>Analog Synth 2</DisplayName>
You must include the required DisplayName and FileName for each phone ring type. The Ringlist.xml file can include up to 50 ring types.