Preface

Use this document with Cisco Unified CallManager 5.0(2) to develop and deploy customized client services for the Cisco Unified IP Phones that support Cisco Unified IP Phone services.

Note Developers using this guide should join the Cisco Developer Support Program because Cisco TAC support is limited to the Cisco Unified Communications installation, configuration, and Cisco-developed applications. This program provides a consistent level of dependable support while leveraging Cisco interfaces in your development projects. For more information about the program and how to join, contact us at developer-support@cisco.com.

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


Chapter	Description
"Overview"	Provides an overview of the Cisco Unified IP Phone services for developers.
Chapter 2, "CiscoIPPhone XML Objects"	Describes the general behavior and usage of each XML object.
"Internal URI Features"	Describes how to implement embedded features on Cisco Unified IP Phones.
"Cisco IP Services Software Development Kit (SDK)"	Provides a list of the components used in the Cisco IP Services Software Development Kit (SDK) and the sample services requirements.
Chapter 5, "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 6, "IP Phone Service Administration and Subscription"	Describes how to add and administer Cisco Unified IP Phone Services through Cisco Unified CallManager Administration.
"Troubleshooting Cisco Unified IP Phone Service Applications"	Provides troubleshooting tips, XML parsing errors, and error messages.
"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.
"Cisco Unified IP Phone Services XML Schema File"	Provides the CiscoIPPhone XML Schema.

Related Documentation

•

Cisco Unified CallManager Administration Guide (also available in the online help). Refer to the chapter on configuring Cisco Unified services.

•

Cisco Unified 7960/7940 Quick Start Guide
Provides instructions for users on subscribing to phone services.

•

Cisco Unified IP Phone Administration Guide for Cisco Unified CallManager
Provides administration information for Cisco Unified IP Phones.

•

CiscoURLProxy ActiveX Component
Provided with the Cisco Unified IP Services SDK.

•

LDAP Search COM Server Programming Guide
Provided with the Cisco Unified IP Services SDK.

Obtaining Documentation

Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several ways to obtain technical assistance and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

Ordering Documentation

•

Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Ordering tool:

•

Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, USA) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).

Documentation Feedback

You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:

Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883

Obtaining Technical Assistance

For all customers, partners, resellers, and distributors who hold valid Cisco service contracts, Cisco Technical Support provides 24-hour-a-day, award-winning technical assistance. The Cisco Technical Support Website on Cisco.com features extensive online support resources. In addition, Cisco Technical Assistance Center (TAC) engineers provide telephone support. If you do not hold a valid Cisco service contract, contact your reseller.

Cisco Technical Support Website

The Cisco Technical Support Website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The website is available 24 hours a day, 365 days a year at this URL:

Access to all tools on the Cisco Technical Support Website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a user ID or password, you can register at this URL:

Submitting a Service Request

Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3 and S4 service requests are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Service Request Tool automatically provides recommended solutions. If your issue is not resolved using the recommended resources, your service request will be assigned to a Cisco TAC engineer. The TAC Service Request Tool is located at this URL:

For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone. (S1 or S2 service requests are those in which your production network is down or severely degraded.) Cisco TAC engineers are assigned immediately to S1 and S2 service requests to help keep your business operations running smoothly.

Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553 2447

Definitions of Service Request Severity

To ensure that all service requests are reported in a standard format, Cisco has established severity definitions.

Severity 1 (S1)—Your network is "down," or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.

Severity 2 (S2)—Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.

Severity 3 (S3)—Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.

Severity 4 (S4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.

Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online and printed sources.

•

Cisco Marketplace provides a variety of Cisco books, reference guides, and logo merchandise. Visit Cisco Marketplace, the company store, at this URL:

•

The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:

•

Cisco Press publishes a wide range of general networking, training and certification titles. Both new and experienced users will benefit from these publications. For current Cisco Press titles and other information, go to Cisco Press at this URL:

•

Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Each quarter, Packet delivers coverage of the latest industry trends, technology breakthroughs, and Cisco products and solutions, as well as network deployment and troubleshooting tips, configuration examples, customer case studies, certification and training information, and links to scores of in-depth online resources. You can access Packet magazine at this URL:

•

iQ Magazine is the quarterly publication from Cisco Systems designed to help growing companies learn how they can use technology to increase revenue, streamline their business, and expand services. The publication identifies the challenges facing these companies and the technologies to help solve them, using real-world case studies and business strategies to help readers make sound technology investment decisions. You can access iQ Magazine at this URL:

•

Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL:

•

World-class networking training is available from Cisco. You can view current offerings at this URL:

Document 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.
boldface screen font	Information you must enter is in boldface screen 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.


Warning	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
Waarschuwing	BELANGRIJKE VEILIGHEIDSINSTRUCTIES Dit waarschuwingssymbool betekent gevaar. U verkeert in een situatie die lichamelijk letsel kan veroorzaken. Voordat u aan enige apparatuur gaat werken, dient u zich bewust te zijn van de bij elektrische schakelingen betrokken risico's en dient u op de hoogte te zijn van de standaard praktijken om ongelukken te voorkomen. Gebruik het nummer van de verklaring onderaan de waarschuwing als u een vertaling van de waarschuwing die bij het apparaat wordt geleverd, wilt raadplegen. BEWAAR DEZE INSTRUCTIES
Varoitus	T�RKEIT� TURVALLISUUSOHJEITA T�m� varoitusmerkki merkitsee vaaraa. Tilanne voi aiheuttaa ruumiillisia vammoja. Ennen kuin k�sittelet laitteistoa, huomioi s�hk�piirien k�sittelemiseen liittyv�t riskit ja tutustu onnettomuuksien yleisiin ehk�isytapoihin. Turvallisuusvaroitusten k��nn�kset l�ytyv�t laitteen mukana toimitettujen k��nnettyjen turvallisuusvaroitusten joukosta varoitusten lopussa n�kyvien lausuntonumeroiden avulla. S�ILYT� N�M� OHJEET
Attention	IMPORTANTES INFORMATIONS DE S�CURIT� Ce symbole d'avertissement indique un danger. Vous vous trouvez dans une situation pouvant entra�ner des blessures ou des dommages corporels. Avant de travailler sur un �quipement, soyez conscient des dangers li�s aux circuits �lectriques et familiarisez-vous avec les proc�dures couramment utilis�es pour �viter les accidents. Pour prendre connaissance des traductions des avertissements figurant dans les consignes de s�curit� traduites qui accompagnent cet appareil, r�f�rez-vous au num�ro de l'instruction situ� � la fin de chaque avertissement. CONSERVEZ CES INFORMATIONS
Warnung	WICHTIGE SICHERHEITSHINWEISE Dieses Warnsymbol bedeutet Gefahr. Sie befinden sich in einer Situation, die zu Verletzungen f�hren kann. Machen Sie sich vor der Arbeit mit Ger�ten mit den Gefahren elektrischer Schaltungen und den �blichen Verfahren zur Vorbeugung vor Unf�llen vertraut. Suchen Sie mit der am Ende jeder Warnung angegebenen Anweisungsnummer nach der jeweiligen �bersetzung in den �bersetzten Sicherheitshinweisen, die zusammen mit diesem Ger�t ausgeliefert wurden. BEWAHREN SIE DIESE HINWEISE GUT AUF.
Avvertenza	IMPORTANTI ISTRUZIONI SULLA SICUREZZA Questo simbolo di avvertenza indica un pericolo. La situazione potrebbe causare infortuni alle persone. Prima di intervenire su qualsiasi apparecchiatura, occorre essere al corrente dei pericoli relativi ai circuiti elettrici e conoscere le procedure standard per la prevenzione di incidenti. Utilizzare il numero di istruzione presente alla fine di ciascuna avvertenza per individuare le traduzioni delle avvertenze riportate in questo documento. CONSERVARE QUESTE ISTRUZIONI
Advarsel	VIKTIGE SIKKERHETSINSTRUKSJONER Dette advarselssymbolet betyr fare. Du er i en situasjon som kan f�re til skade p� person. F�r du begynner � arbeide med noe av utstyret, m� du v�re oppmerksom p� farene forbundet med elektriske kretser, og kjenne til standardprosedyrer for � forhindre ulykker. Bruk nummeret i slutten av hver advarsel for � finne oversettelsen i de oversatte sikkerhetsadvarslene som fulgte med denne enheten. TA VARE P� DISSE INSTRUKSJONENE
Aviso	INSTRU��ES IMPORTANTES DE SEGURAN�A Este s�mbolo de aviso significa perigo. Voc� est� em uma situa��o que poder� ser causadora de les�es corporais. Antes de iniciar a utiliza��o de qualquer equipamento, tenha conhecimento dos perigos envolvidos no manuseio de circuitos el�tricos e familiarize-se com as pr�ticas habituais de preven��o de acidentes. Utilize o n�mero da instru��o fornecido ao final de cada aviso para localizar sua tradu��o nos avisos de seguran�a traduzidos que acompanham este dispositivo. GUARDE ESTAS INSTRU��ES
�Advertencia!	INSTRUCCIONES IMPORTANTES DE SEGURIDAD Este s�mbolo de aviso indica peligro. Existe riesgo para su integridad f�sica. Antes de manipular cualquier equipo, considere los riesgos de la corriente el�ctrica y familiar�cese con los procedimientos est�ndar de prevenci�n de accidentes. Al final de cada advertencia encontrar� el n�mero que le ayudar� a encontrar el texto traducido en el apartado de traducciones que acompa�a a este dispositivo. GUARDE ESTAS INSTRUCCIONES
Varning!	VIKTIGA S�KERHETSANVISNINGAR Denna varningssignal signalerar fara. Du befinner dig i en situation som kan leda till personskada. Innan du utf�r arbete p� n�gon utrustning m�ste du vara medveten om farorna med elkretsar och k�nna till vanliga f�rfaranden f�r att f�rebygga olyckor. Anv�nd det nummer som finns i slutet av varje varning f�r att hitta dess �vers�ttning i de �versatta s�kerhetsvarningar som medf�ljer denna anordning. SPARA DESSA ANVISNINGAR