XML Object Definitions | Cisco Systems OL-20949-01 instruction

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

XML Object Definitions

The following sections provide definitions and descriptions of each CiscoIPPhone XML object:

•CiscoIPPhoneMenu

•CiscoIPPhoneText

•CiscoIPPhoneInput

•CiscoIPPhoneDirectory

•CiscoIPPhoneImage

•CiscoIPPhoneImageFile

•CiscoIPPhoneGraphicMenu

•CiscoIPPhoneGraphicFileMenu

•CiscoIPPhoneIconMenu

•CiscoIPPhoneIconFileMenu

•CiscoIPPhoneStatus

•CiscoIPPhoneStatusFile

•CiscoIPPhoneExecute

•CiscoIPPhoneResponse

•CiscoIPPhoneError

CiscoIPPhoneMenu

A menu on the phone comprises a list of text items, one per line. Users choose individual menu items by using the same mechanisms that are used for built-in menus in the phone as described in Chapter 1, “Overview”.

Definition <CiscoIPPhoneMenu>

		<Title>Title text goes here</Title>
		<Prompt>Prompt text goes here</Prompt>
		<MenuItem>
		<Name>The name of each menu item</Name>
		<URL>The URL associated with the menu item</URL>
		</MenuItem>
		</CiscoIPPhoneMenu>

Note		• The Name field under the <MenuItem> supports a maximum of 64 characters. This field can also
		accept two carriage returns to allow the MenuItem name to span three lines on the display.
		• The 6900 series IP phones does not display the Title and Prompt menu fields at the same time. If
		both Title and Prompt fields are defined at the same time, then these phones display only the Prompt
		field.

		The XML format allows you to specify a title and prompt that are used for the entire menu, followed by
		a sequence of MenuItem objects. Cisco Unified IP Phones allow a maximum of 100 MenuItems. Each
		MenuItem includes a Name and an associated URL.

Cisco Unified IP Phone Services Application Development Notes

	OL-20949-01	3-3

Image 21

Cisco Systems OL-20949-01 manual XML Object Definitions, CiscoIPPhoneMenu

Contents

Text Part Number OL-20949-01 Americas Headquarters Copyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T S Display Init Benefits Overview PrefaceRevision History Audience Organization Chapter DescriptionViii Related Documentation Cisco Unified Communications Manager AdministrationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business Edition Cisco Product Security Overview Document ConventionsConvention Indication Page Xii 1shows a sample text menu Overview Graphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed Information OL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects 1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object Definitions Definition CiscoIPPhoneText Sample User Input Display CiscoIPPhoneInput InputFlag Description CiscoIPPhoneDirectory Custom Directories CiscoIPPhoneImage Packed Pixel Translation Example CiscoIPPhoneImageFile Resolution1Example Model Cisco Unified IP Phone 7970G Image File Display Monochrome CiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu 6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Dynamic Sizing of the Application Status Window 7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960G CiscoIPPhoneStatusFile Phone Models WxH No Timer WxH 7940G, 7960GText Area Size 7962G, 7965G Behavior Description CiscoIPPhoneExecute CiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML Considerations Mandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema XscomplexType Xsall Error Schema Examples Errors and ResponsesStart Media Stop Media Applicable Condition Methods Http Result Code Type Data Supported URIs by Phone Model Internal URI Features7942G, 7962G 7906G 7945G, 7965G 7970G 6921 7905G 7911G 7921G 7940G 7971G-GE 6941 Device Control URIs KeyURI Format KeyDirectories Description and Alternatives Phone Unsupported Models URI Display SoftKey XML Displayable Object URIs QueryStringParam Select Exit Update Submit Search Cancel Next Dial Internal URI Features XML Displayable Object URIs Multimedia URIs RTP StreamingInteraction with Call Streaming URI Formats RTPRx RTPTx Play VibrateInteraction with Incoming Calls Dial Telephony URIs SendDigits EditDial Condition Status Data Error and Response Application Management URIs InitNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data Application AppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post See the Http Refresh Setting section on page 6-3section Http Header Settings Refresh Display Sample Http Refresh Setting Mime Type and Other Http Headers Content Expiration Header Setting Set-Cookie Header Setting Accept-Language Http Encoding Header Setting Identifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept Header Html URL XML URL Accessing IP Phone Information OL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDK OL-20949-01 \CiscoIpServices\Tools Sample Services Requirements OL-20949-01 Accessing Phone Service Administration IP Phone Service Administration Subscription Field Description Adding a Phone Service Field Description Service Parameter Information Defining IP Phone Service Parameters User Service Subscription 10-1 DeviceListX Report Restrictions BenefitsIntegration Considerations and Interoperability Performance and Scalability Security Related Features and TechnologiesSupported Platforms Prerequisites Error Codes Troubleshooting DeviceListX ReportsField Name Description 10-4 Determining Problems With the Interface Procedure10-5 10-6 Object Definition CiscoIPPhone XML Object Quick Reference Appendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Updated XML Parser and Schema Enforcement Cisco Unified IP Phone Services XML Schema File 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 IN-1 Numerics IN-2 Html URL IN-3 IN-4 XML URL