Cisco Systems OL-20949-01 Preface

vii

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Preface

Overview

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 pe rform in Ci sco Un ified Communications

Manager or other network devices. See the “Related Documentati on” se c tio n on pa ge ix for a list of

related documentation.

Revision History

Audience

This document provides the information needed for e Xte nsib le Ma rk up La ng uag e (X M L) a nd X/ Op en

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

Date Updates

September 29, 2009 Initial release.

November 23, 2009 Updated the document with information o n the Cisc o Uni fied I P Pho nes 99 71,

9951, and 8961 models. See, New Information for Cisco Unified

Communications Manager 7.1(3), page 1.

December 10, 2009 Corrected the Cisco Unified IP Phone 7925G r esolution from 176 x 220 to 176

x 140. See, Tabl e 3-2 on page 9

Contents

Main Page CONTENTS Page Page Page Preface Overview Revision History Audience Cisco Developer Support Program Organization Related Documentation Obtaining Documentation and Submitting a Service Request Cisco Product Security Overview Document Conventions Page Page Overview Page Page Page New and Changed Information New Information for Cisco Unified Communications Manager 7.1(3) Page CiscoIPPhone XML Objects Understanding Object Behavior Page XML Object Definitions CiscoIPPhoneMenu CiscoIPPhoneText CiscoIPPhoneInput CiscoIPPhoneDirectory Custom Directories CiscoIPPhoneImage Page CiscoIPPhoneImageFile Page CiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu Page CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Page Page CiscoIPPhoneStatusFile CiscoIPPhoneExecute CiscoIPPhoneResponse CiscoIPPhoneError Custom Softkeys XML Considerations Mandatory Escape Sequences XML Encoding Application Event Handlers Page 3-24 Event Handler Schema Example Component APIs Application Management API RTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema 4-3 4-4 Error Schema Examples Errors and Responses Page Internal URI Features Supported URIs by Phone Model Device Control URIs Key Key:Directories Key:Settings Unsupported Key URIs and Alternate Options Display XML Displayable Object URIs SoftKey QueryStringParam Page Multimedia URIs RTP Streaming RTPRx RTPTx RTPMRx RTPMTx Play Vibrate Telephony URIs Dial EditDial SendDigits Page Application Management URIs Init Notify Page Application Page Page HTTP Requests and Header Settings HTTP Client Requests (HTTP GET) HTTP Server Requests (HTTP POST) HTTP Header Settings HTTP Refresh Setting MIME Type and Other HTTP Headers Audio Clips Content Expiration Header Setting Set-Cookie Header Setting HTTP Encoding Header Setting Accept-Language Accept-Charset HTTP Response Headers: Content-Type Identifying the Capabilities of IP Phone Clients x-CiscoIPPhoneModelName x-CiscoIPPhoneDisplay x-CiscoIPPhoneSDKVersion Accept Header Accessing IP Phone Information Page Troubleshooting Service Applications Troubleshooting Tips XML Parsing Errors Error Messages Cisco IP Phone Services Software Development Kit (SDK) SDK Components Page Sample Services Requirements Page IP Phone Service Administration and Subscription Accessing Phone Service Administration Adding a Phone Service Defining IP Phone Service Parameters User Service Subscription DeviceListX Report Benefits Restrictions Integration Considerations and Interoperability Performance and Scalability Security Related Features and Technologies Supported Platforms Prerequisites Message and Interface Definitions Troubleshooting DeviceListX Reports Error Codes Determining Problems With the Interface Page A-1 APPENDIX A CiscoIPPhone XML Object Quick Reference Tab l e A-1 CiscoIPPhone XML Object Quick Reference A-2 Table A-1 CiscoIPPhone XML Object Quick Reference (continued) A-3 Table A-1 CiscoIPPhone XML Object Quick Reference (continued) Page APPENDIX B Cisco Unified IP Phone Services XML Schema File Updated XML Parser and Schema Enforcement B-2 CiscoIPPhone.xsd B-3 B-4 B-5 B-6 B-7 B-8 B-9 B-10 B-11 B-12 B-13 B-14 INDEX Symbols Numerics A D E F G I M N P U X