Summary of the content on the page No. 1
Cisco Unified IP Phone Services
Application Development Notes
Supporting XML Applications
Release 7.1(3)
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-20949-01
Summary of the content on the page No. 2
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE IN
Summary of the content on the page No. 3
CONTENTS Preface vii Overview vii Revision History vii Audience vii Cisco Developer Support Program vii Organization viii Related Documentation ix Obtaining Documentation and Submitting a Service Request i-ix Cisco Product Security Overview x Document Conventions x CHAPTER 1 Overview 1-1 CHAPTER 2 New and Changed Information 2-1 New Information for Cisco Unified Communications Manager 7.1(3) 2-1 CHAPTER 3 CiscoIPPhone XML Objects 3-1 Unders
Summary of the content on the page No. 4
Contents CiscoIPPhoneResponse 3-19 CiscoIPPhoneError 3-19 Custom Softkeys 3-19 XML Considerations 3-20 Mandatory Escape Sequences 3-21 XML Encoding 3-21 Application Event Handlers 3-22 CHAPTER 4 Component APIs 4-1 Application Management API 4-1 RTP Streaming API 4-1 Interaction Rules with Legacy RTP URI Streams 4-2 RTP Streaming Schema 4-2 Error Schema 4-4 Examples 4-5 Errors and Responses 4-5 CHAPTER 5 Internal URI Features 5-1 S
Summary of the content on the page No. 5
Contents Application Management URIs 5-16 Init 5-16 Notify 5-16 Application 5-18 CHAPTER 6 HTTP Requests and Header Settings 6-1 HTTP Client Requests (HTTP GET) 6-1 HTTP Server Requests (HTTP POST) 6-1 HTTP Header Settings 6-2 HTTP Refresh Setting 6-3 MIME Type and Other HTTP Headers 6-4 Audio Clips 6-4 Content Expiration Header Setting 6-4 Set-Cookie Header Setting 6-5 HTTP Encoding Header Setting 6-6 HTTP Response Headers: Content-Type
Summary of the content on the page No. 6
Contents User Service Subscription 9-4 CHAPTER 10 DeviceListX Report 10-1 Benefits 10-2 Restrictions 10-2 Integration Considerations and Interoperability 10-2 Performance and Scalability 10-2 Security 10-3 Related Features and Technologies 10-3 Supported Platforms 10-3 Prerequisites 10-3 Message and Interface Definitions 10-3 DeviceList XML Object 10-3 Troubleshooting DeviceListX Reports 10-4 Error Codes 10-4 Determining Problems With the
Summary of the content on the page No. 7
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 perform in Cisco Unified Communications Manager or other network devices. See the “Related Documentation” section on page
Summary of the content on the page No. 8
Preface 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 commu
Summary of the content on the page No. 9
Preface Obtaining Documentation and Submitting a Service Request Chapter Description Chapter 9, “IP Phone Service Administration Describes how to add and administer and Subscription” 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.
Summary of the content on the page No. 10
Preface Obtaining Documentation and Submitting a Service Request 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 pr
Summary of the content on the page No. 11
Preface Obtaining Documentation and Submitting a Service Request 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. Cisco Unified IP Phone Services Application Development Notes OL-20949-01 xi
Summary of the content on the page No. 12
Preface Obtaining Documentation and Submitting a Service Request Cisco Unified IP Phone Services Application Development Notes xii OL-20949-01
Summary of the content on the page No. 13
CH A P T E R 1 Overview You can use Cisco Unified IP Phones to deploy customized client services with which users can interact via the keypad and display. Services deploy using the HTTP protocol from standard web servers. Users access these features using the services and directories buttons or menu options (availability varies by phone model). When a user presses the services button (or chooses the services menu item), a menu of configured services displays. The user then chooses a servic
Summary of the content on the page No. 14
Chapter 1 Overview Figure 1-2 Graphic Menu on a Cisco Unified IP Phone Sample Phone users can navigate a text menu by using the Navigation button followed by the Select softkey, or by using the numeric keypad to enter a selection directly. Graphic menus currently do not support cursor-based navigation; users simply enter a number using the DTMF keypad. When a menu selection is made, the Cisco Unified IP Phone acts on it by using its HTTP client to load a specific URL. The return type f
Summary of the content on the page No. 15
Chapter 1 Overview Note HTML Disclaimer: Phone service developers must take into consideration that the phone is not a web browser and cannot parse HTML. Although content is delivered to the phone through HTTP messages by using a web server, keep in mind that the content is not HTML. All content comes either as plain text or packaged in proprietary XML wrappers. Cisco Unified IP Phone Services Application Development Notes OL-20949-01 1-3
Summary of the content on the page No. 16
Chapter 1 Overview Cisco Unified IP Phone Services Application Development Notes 1-4 OL-20949-01
Summary of the content on the page No. 17
CH A P T E R 2 New and Changed Information This chapter gives details on the new and changed information in the XML service interface for the latest releases of Cisco Unified Communication Manager. New Information for Cisco Unified Communications Manager 7.1(3) The following are the updates made in the XML service interface for Cisco Unified Communication manager 7.1(3): � Support for the latest 9971, 9951, and 8961 series Cisco IP phones. For more information see Table 3-1 on page 3-2
Summary of the content on the page No. 18
Chapter 2 New and Changed Information New Information for Cisco Unified Communications Manager 7.1(3) Cisco Unified IP Phone Services Application Development Notes 2-2 OL-20949-01
Summary of the content on the page No. 19
CH A P T E R 3 CiscoIPPhone XML Objects The following sections describe the general behavior and use of XML objects: � Understanding Object Behavior � XML Object Definitions � Custom Softkeys � XML Considerations � Application Event Handlers Understanding Object Behavior Creating interactive service applications is relatively easy when you understand the XML objects that are defined for Cisco Unified IP Phones and the behavior that each object generates. Regarding services, the phone do
Summary of the content on the page No. 20
Chapter 3 CiscoIPPhone XML Objects Understanding Object Behavior Table 3-1 shows the supported XML objects for this release. Table 3-1 XML Objects Supported for Release 7.1(3) Cisco Unified IP Phone Services SDK 7905G 7941G/7941G-GE, 7942G, 7906G 7945G, 7961G/7961G-GE, 7911G 7962G, 7965G, 7970G/ 7912G 7921G 7940G 7971G-GE, 7975G, IP 6921, 6941, 9971, 9951, Phone Model XML Object 7931G 7920G 7925G 7960G Communicator 6961 8961 CiscoIPPhoneMenu X X X X X X X CiscoIPPhoneText X X X X X
