Cisco Systems OL-20949-01 manual

Chapter 3 CiscoIPPhone XML Objects

Understanding Object Behavior

Table 3-1shows 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	X	X

CiscoIPPhoneInput		X	X	X	X	X	X	X

CiscoIPPhoneDirectory		X	X	X	X	X	X	X

CiscoIPPhoneImage		—	X1	X	X	X	—2	X
CiscoIPPhoneImageFile		—	—	X	—	X	—2	X
CiscoIPPhoneGraphicMenu		—	X1	X	X	X	—2	X
CiscoIPPhoneGraphicFileMenu		—	—	X	—	X	—2	X
CiscoIPPhoneIconMenu		X3	X	X	X	X	X4	X
CiscoIPPhoneIconFileMenu		—	—	X	—	X5	X4	X
CiscoIPPhoneStatus		—	—	—	X	X	—	—

CiscoIPPhoneStatusFile		—	—	—	—	X5	—	—
CiscoIPPhoneExecute		X	X6	X	X	X	X	X
CiscoIPPhoneResponse		X	X	X	X	X	X	X

CiscoIPPhoneError		X	X	X	X	X	X	X

1.The Cisco Unified IP Phone 7920G has only a 128-by-59 display with 2 grayscale images clipping the graphic equally on both sides and providing vertical scrolling. When an image with 4 grayscale settings occurs (<Depth>2</Depth>), the phone equally splits them into 2 grayscale settings (0-1 get treated as 0 and 2-3 get treated as 1).

2.The Cisco Unified IP Phones 6921, 6941, and 6961 do not support CiscoIPPhoneGraphicFileMenu, CiscoIPPhoneGraphicMenu, CiscoIPPhoneImageFile, and CiscoIPPhoneImage because these phones use monochrome LCD.

3.The Cisco Unified IP Phones 7905G and 7912G do not support CIP images; therefore, all icons get ignored and does not display.

4.The Cisco Unified IP Phones 6921, 6941, and 6961 do not support icons; therefore, all icons are ignored and does not display.

5.The Cisco Unified IP Phones 7970G and 7971G-GE require firmware version 7.1(2) or higher to support this object, and Cisco IP Communicator requires software version 2.01 or higher.

6.The Cisco Unified IP Phone 7920G does not support Priority 1 when on a call.

Cisco Unified IP Phone Services Application Development Notes

3-2	OL-20949-01

Image 20

Cisco Systems OL-20949-01 manual 1shows the supported XML objects for this release

Contents

Americas Headquarters Text Part Number OL-20949-01 Copyright 2004-2009 Cisco Systems, Inc. All rights reserved N T E N T S Iii Display Init Benefits Preface OverviewRevision History Audience Viii OrganizationChapter Description Cisco Unified Communications Manager Administration Related DocumentationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business Edition Convention Indication Cisco Product Security OverviewDocument Conventions Page Xii Overview 1shows a sample text menu Graphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New and Changed Information New Information for Cisco Unified Communications Manager OL-20949-01 CiscoIPPhone XML Objects Understanding Object Behavior 1shows the supported XML objects for this release XML Object Definitions CiscoIPPhoneMenu CiscoIPPhoneText Definition CiscoIPPhoneInput Sample User Input Display CiscoIPPhoneDirectory InputFlag Description CiscoIPPhoneImage Custom Directories Packed Pixel Translation Example Resolution1 CiscoIPPhoneImageFileExample Model Monochrome Cisco Unified IP Phone 7970G Image File Display CiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu 6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Dynamic Sizing of the Application Status Window CiscoIPPhoneStatus Phone Models Area Width Area Height 7940G, 7960G 7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models WxH No Timer WxH 7940G, 7960G CiscoIPPhoneStatusFileText Area Size 7962G, 7965G CiscoIPPhoneExecute Behavior Description CiscoIPPhoneResponse CiscoIPPhoneErrorCustom Softkeys XML Considerations SoftKeyItem NameDisplayed sofkey label/Name Character Name Escape Sequence Mandatory Escape SequencesXML Encoding Attributes Application Event HandlersSupported Unsupported Attribute Description Event Handler Schema RTP Streaming API Component APIsApplication Management API RTP Streaming Schema Interaction Rules with Legacy RTP URI Streams XscomplexType Xsall Error Schema Errors and Responses ExamplesStart Media Stop Media Applicable Condition Methods Http Result Code Type Data Internal URI Features Supported URIs by Phone Model7942G, 7962G 7906G 7945G, 7965G 7970G 6921 7905G 7911G 7921G 7940G 7971G-GE 6941 URI Format Device Control URIsKey KeyDirectories Phone Unsupported Models Description and Alternatives Display URI XML Displayable Object URIs SoftKey Select Exit Update Submit Search Cancel Next Dial QueryStringParam Internal URI Features XML Displayable Object URIs Interaction with Call Streaming Multimedia URIsRTP Streaming RTPRx URI Formats RTPTx Interaction with Incoming Calls PlayVibrate Telephony URIs Dial EditDial SendDigits Error and Response Condition Status Data Notify Application Management URIsInit Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no data AppactionpriorityidleTimerapplicationId Error and Response Http Server Requests Http Post Http Requests and Header SettingsHttp Client Requests Http GET Http Header Settings See the Http Refresh Setting section on page 6-3section Http Refresh Setting Refresh Display Sample Content Expiration Header Setting Mime Type and Other Http Headers Set-Cookie Header Setting Http Encoding Header Setting Accept-Language CiscoIPPhoneDisplay Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneModelName Accept Header CiscoIPPhoneSDKVersion Accessing IP Phone Information Html URL XML URL OL-20949-01 XML Parsing Errors Troubleshooting Cisco Unified IP Phone Service ApplicationsTroubleshooting Tips Error Messages Cisco IP Phone Services Software Development Kit SDK SDK Components OL-20949-01 Sample Services Requirements \CiscoIpServices\Tools OL-20949-01 IP Phone Service Administration Subscription Accessing Phone Service Administration Adding a Phone Service Field Description Defining IP Phone Service Parameters Field Description Service Parameter Information User Service Subscription DeviceListX Report 10-1 Benefits RestrictionsIntegration Considerations and Interoperability Performance and Scalability Related Features and Technologies SecuritySupported Platforms Prerequisites Troubleshooting DeviceListX Reports Error CodesField Name Description 10-4 10-5 Determining Problems With the InterfaceProcedure 10-6 CiscoIPPhone XML Object Quick Reference Object Definition Appendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Cisco Unified IP Phone Services XML Schema File Updated XML Parser and Schema Enforcement CiscoIPPhone.xsd Xsdelement name=Name minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType XsdsimpleType xsdrestriction base=xsdstring XsdcomplexType name=CiscoIPPhoneSoftKeyType xsdsequence Xsdelement name=Title minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType Xsdattribute XsdcomplexType Xsdelement name=CiscoIPPhoneDirectory xsdcomplexType Xsdelement name=CiscoIPPhoneImageFile xsdcomplexType Xsdelement name=CiscoIPPhoneIconMenu xsdcomplexType Xsdelement name=CiscoIPPhoneGraphicFileMenu xsdcomplexType Xsdsequence Xsdelement name=Text minOccurs=0 xsdsimpleType Xsdsequence XsdcomplexType Xsdelement Numerics IN-1 Html URL IN-2 IN-3 XML URL IN-4