Cisco Unified IP Phone Services Application Development Notes Release 9.1(1) and Later
Preface
Downloads: This chapterpdf (PDF - 1.24MB) The complete bookPDF (PDF - 3.56MB) | The complete bookePub (ePub - 834.0KB) | The complete bookMobi (Mobi - 1.53MB) | Feedback

Preface

Preface

Overview

Use this document with Cisco Unified Communications Manager 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.

Related References

Audience

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.

Organization

This document contains the following sections:

Chapter

Description

Custom Client Services Overview

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

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.

CiscoIPPhone XML Objects

Describes the general behavior and usage of each XML object.

Component APIs

Describes additional application programming interfaces (API) available to the Cisco Unified IP Phones.

Internal URI Features

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

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.

Troubleshooting Cisco Unified IP Phone Service Applications

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

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.

IP Phone Service Administration and Subscription

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

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.

CiscoIPPhone XML Object Quick Reference

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

Cisco Unified IP Phone Services XML Schema File

Provides the CiscoIPPhone XML Schema.

Device Capability Query via CTI Feature

Provides information on the Device Capability Query via CTI feature.

Related Documentation

Use the following sections to obtain related information.

Cisco Unified IP Phone 6900 Series Documentation

Refer to publications that are specific to your language, phone model and Cisco Unified Communications Manager release. Navigate from the following documentation URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​collaboration-endpoints/​unified-ip-phone-6900-series/​tsd-products-support-series-home.html

Cisco IP Phone 7800 Series Documentation

Refer to publications that are specific to your language, phone model and Cisco Unified Communications Manager release. Navigate from the following documentation URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​collaboration-endpoints/​unified-ip-phone-7800-series/​tsd-products-support-general-information.html

Cisco Unified IP Phone 7900 Series Documentation

See the publications that are specific to your language, phone model, and Cisco Unified Communications Manager release. Navigate from the following documentation URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​collaboration-endpoints/​unified-ip-phone-7900-series/​tsd-products-support-general-information.html

Cisco IP Phone 8800 Series Documentation

Refer to publications that are specific to your language, phone model, and Cisco Unified Communications Manager release. Navigate from the following documentation URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​collaboration-endpoints/​unified-ip-phone-8800-series/​tsd-products-support-series-home.html

Cisco Unified IP Phone 8900 Series Documentation

Refer to publications that are specific to your language, phone model, and Cisco Unified Communications Manager release. Navigate from the following documentation URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​collaboration-endpoints/​unified-ip-phone-8900-series/​tsd-products-support-series-home.html

Cisco Unified IP Phone 9900 Series Documentation

Refer to publications that are specific to your language, phone model, and Cisco Unified Communications Manager release. Navigate from the following documentation URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​collaboration-endpoints/​unified-ip-phones-9900-series/​tsd-products-support-series-home.html

Cisco Unified Communications Manager Documentation

See the Cisco Unified Communications Manager Documentation Guide and other publications that are specific to your Cisco Unified Communications Manager release. Navigate from the following documentation URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​unified-communications/​unified-communications-manager-callmanager/​tsd-products-support-series-home.html

Cisco Business Edition 5000 Documentation

See the Cisco Business Edition 5000 Documentation Guide and other publications that are specific to your Cisco Business Edition 5000 release. Navigate from the following URL:

http:/​/​www.cisco.com/​c/​en/​us/​support/​unified-communications/​business-edition-5000/​tsd-products-support-series-home.html

Guide Conventions

This document uses the following conventions:

Convention

Description

boldface font

Commands and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

[   ]

Elements in square brackets are optional.

{ x | y | z }

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.

string

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

screen font

Terminal sessions and information the system displays are in screen font.

input font

Information you must enter is in input font.

italic screen font

Arguments for which you supply values are in italic screen font.

^

The symbol ^ represents the key labeled Control - for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.

<   >

Nonprinting characters such as passwords are in angle brackets.


Note


Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.



Caution


Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.


Warnings use the following convention:

Attention:

IMPORTANT SAFETY INSTRUCTIONS

This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device. Statement 1071

SAVE THESE INSTRUCTIONS

Cisco Developer Network

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 (IHVs and ISVs) 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 http:/​/​developer.cisco.com/​web/​devservices.

Documentation, Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, reviewing security guidelines, and also recommended aliases and general Cisco documents, see the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http:/​/​www.cisco.com/​c/​en/​us/​td/​docs/​general/​whatsnew/​whatsnew.html

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 http:/​/​www.bis.doc.gov/​index.php/​regulations/​export-administration-regulations-ear.