Cisco Systems OL-20949-01 instruction

Chapter 5 Internal URI Features

XML Displayable Object URIs

<Name>Delete</Name>

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

</SoftKeyItem>

</CiscoIPPhoneMenu>

Example 5-1shows 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-2is not as efficient as Example 5-1. Choose the best way to perform the action based on your applications needs.

Example 5-2does 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 you generate by not having to repeat redundant portions of a URL in every MenuItem.

Cisco Unified IP Phone Services Application Development Notes

5-8	OL-20949-01

Image 56

Cisco Systems OL-20949-01 manual Internal URI Features XML Displayable Object URIs

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