Cisco Systems OL-20949-01 - page 56

5-8

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 5 Internal URI Features

XML Displayable Object URIs

<Name>Delete</Name>

<URL>http://server/delete.asp</URL>

</SoftKeyItem>

</CiscoIPPhoneMenu>

Example 5-1 shows how to use the QueryStringParam URI in a CiscoIPPhoneMenu object. The

CiscoIPPhoneMenu object includes two MenuItems with QueryStringParam URIs. If the user chooses the

MenuItem(s) with the numeric keypad, the cursor moves to that entry, but nothing executes because the

values are QueryStringParam URIs.

If the user presses either custom softkey, the currently highlighted MenuItem URI value gets appended

to the softkey URL that was pressed and requested from the web server.

If you highlight the first MenuItem and press the Read softkey, the phone generates the following URL:

http://server//read.asp?message=1

Example 5-2 Selecting an Item with Numeric Keypad Calls the URL

<CiscoIPPhoneMenu>

<Title>Message List</Title>

<Prompt>Two Messages</Prompt>

<MenuItem>

<Name>Messae One</Name>

<URL>http://server/messages.asp?message=1</URL>

</MenuItem>

<MenuItem>

<Name>Messae Two</Name>

<URL>http://server/messages.asp?message=2</URL>

</MenuItem>

<SoftKeyItem>

<Name>Read</Name>

<Position>1</Position><URL>QueryStringParam:action=read</URL>

</SoftKeyItem>

<SoftKeyItem>

<Name>Delete</Name>

<Position>2</Position><URL>QueryStringParam:action=delete</URL>

</SoftKeyItem>

</CiscoIPPhoneMenu>

The Cisco Unified IP Phones allow you to implement the QueryStringParam URI in either manner

although Example 5-2 is not as efficient as Example 5-1. Choose the best way to perform the action

based on your applications needs.

Example 5-2 does have a slight advantage in that if the user chooses an item with the numeric keypad,

the URL gets called. This would allow you to invoke some default behavior such as to read the message

in the example. By highlighting the first message and pressing the Read softkey, the phone creates the

following URL: http://server/messages.asp?message=1&action=read

Using the QueryStringParam URI reduces the size of the XML objects that yo u ge nera te by not having

to repeat redundant portions of a URL in every MenuItem.

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