Cisco Systems OL-20949-01 - page 31

3-13

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

Icons in the CiscoIPPhoneMenu object have a maximum width of 16 pixels and a maximum height of 10

pixels.

Figure 3-6 shows an IconMenu on a Cisco Unified IP Phone.

Figure 3-6 IconMenu on a Cisco Unified IP Phone Sample

The system presents the information as a bitmap graphic to the left of the menu item text. The user

selects menu items in the same way as a CiscoIPPhoneMenu object.

Definition

<CiscoIPPhoneIconMenu>

<Title>Title text goes here</Title>

<Prompt>Prompt text goes here</Prompt>

<MenuItem>

<IconIndex>Indicates what IconItem to display</IconIndex>

<Name>The name of each menu item</Name>

<URL>The URL associated with the menu item</URL>

</MenuItem>

<SoftKeyItem>

<Name>Name of softkey</Name>

<URL>URL or URI of softkey</URL>

<Position>Position information of the softkey</Position>

</SoftKeyItem>

<IconItem>

<Index>A unique index from 0 to 9</Index>

<Height>Size information for the icon</Height>

<Width>Size information for the icon</Width>

<Depth>Number of bits per pixel</Depth>

<Data>Packed Pixel Data</Data>

</IconItem>

</CiscoIPPhoneIconMenu>

Note 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 tags in IconMenu use the tag definitions for CiscoIPPhoneImage and CiscoIPPhoneMenu.

Although the semantics of the tags are identical, you can have only 32 MenuItem objects in a

CiscoIPPhoneIconMenu object. See “CiscoIPPhoneMenu” and “CiscoIPPhoneImage” for detailed

descriptions.

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