Cisco Unified IP Phone Services Application Development Notes, Release 7.1(3)
Downloads: This chapterpdf (PDF - 378.0 KB) The complete bookPDF (PDF - 2.95 MB) | Feedback


Table Of Contents



Revision History


Cisco Developer Support Program


Related Documentation

Obtaining Documentation and Submitting a Service Request

Cisco Product Security Overview

Document Conventions



Use this document with Cisco Unified Communications Manager, Release 7.1(3) to develop and deploy customized client services for the Cisco Unified IP Phones that support Cisco Unified Phone services.

Because of the complexity of a Unified Communications network, this guide does not provide complete and detailed information for procedures that you need to perform in Cisco Unified Communications Manager or other network devices. See the "Related Documentation" section for a list of related documentation.

Revision History


September 29, 2009

Initial release.

November 23, 2009

Updated the document with information on the Cisco Unified IP Phones 9971, 9951, and 8961 models. See, New Information for Cisco Unified Communications Manager 7.1(3), page 1.


This document provides the information needed for eXtensible Markup Language (XML) and X/Open System Interface (XSI) programmers and system administrators to develop and deploy new services.

Cisco Developer Support Program

The Cisco Developer Network (CDN) portal provides access to multiple Cisco technology developer interfaces and collaborative support communities. CDN also provides formalized support services for these interfaces to enable developers, customers, and partners to accelerate their development. The formalized process provides access to CDN Engineers who are an extension of the product technology engineering teams. CDN Engineers have access to the resources necessary to provide expert support in a timely manner.

The Cisco Developer Network Program is designed for businesses (IHV's and ISV's) interested in going to market with Cisco. The CDN Program enables members to develop compelling solutions that unify data, voice, video, and mobile communications on Cisco's powerful communications platform. The program also allows members to take advantage of Cisco's brand, market leadership position, and installed base to help drive positive business results for themselves and their customers.

For additional information about the CDN Program and CDN support services go to

Note The Cisco TAC does NOT provide support for this API/interface under standard hardware or software support agreements. All technical support for this API/interface, from initial development assistance through API troubleshooting/bugs in final production apps, is provided by Cisco Developer Support and requires a separate Developer Support contract. When opening cases, a Developer Support contract number must be provided to receive support.


This document comprises the following sections:


Chapter 1, "Overview"

Provides an overview of the Cisco Unified IP Phone services for developers.

Chapter 2, "New and Changed Information"

Provides details on the new and changed information in the XML service interface for the latest release of Cisco Unified Communication Manager.

Chapter 3, "CiscoIPPhone XML Objects"

Describes the general behavior and usage of each XML object.

Chapter 4, "Component APIs"

Describes additional APIs available to the Cisco Unified IP Phones.

Chapter 5, "Internal URI Features"

Describes how to implement embedded features on Cisco Unified IP Phones.

Chapter 6, "HTTP Requests and Header Settings"

Provides a procedure on handling HTTP client requests, definitions for HTTP header elements, identifies the capabilities of the requesting IP phone client, and defines the Accept header.

Chapter 7, "Troubleshooting Cisco Unified IP Phone Service Applications"

Provides troubleshooting tips, XML parsing errors, and error messages.

Chapter 8, "Cisco IP Phone Services Software Development Kit (SDK)"

Provides a list of the components used in the Cisco Unified IP Services Software Development Kit (SDK) and the sample services requirements.

Chapter 9, "IP Phone Service Administration and Subscription"

Describes how to add and administer Cisco Unified IP Phone Services through Cisco Unified Communications Manager Administration.

Chapter 10, "DeviceListX Report"

Describes how the report provides a list of the services-capable devices along with basic information about the device to identify or classify the devices based on specific criteria.

Appendix A, "CiscoIPPhone XML Object Quick Reference"

Provides a quick reference of the CiscoIPPhone XML objects and the definitions that are associated with each.

Appendix B, "Cisco Unified IP Phone Services XML Schema File"

Provides the CiscoIPPhone XML Schema.

Related Documentation

For more information about Cisco Unified IP Phones or Cisco Unified Communications Manager, refer to the following publications:

Cisco Unified IP Phone 7900 Series

These publications are available at the following URL:

Cisco Unified Communications Manager Administration

Related publications are available at the following URL:

Cisco Unified Communications Manager Business Edition

Related publications are available at the following URL:

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.

Cisco Product Security Overview

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.

Further information regarding U.S. export regulations may be found at

Document Conventions

This document uses the following conventions:


bold font

Commands and keywords and user-entered text appear in bold font.

italic font

Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.

[ ]

Elements in square brackets are optional.

{x | y | z }

Required alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ]

Optional alternative keywords are grouped in brackets and separated by vertical bars.


A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

courier font

Terminal sessions and information the system displays appear in courier font.

< >

Nonprinting characters such as passwords are in angle brackets.

[ ]

Default responses to system prompts are in square brackets.

!, #

An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.

Note Means reader take note.

Tip Means the following information will help you solve a problem.

Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.

Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury.