QueryStringParam | Cisco Systems OL-20949-01 manual

Chapter 5 Internal URI Features

XML Displayable Object URIs

Table 5-4	Valid Softkey Actions for CiscoIPPhoneObject Types (continued)

IPPhoneObject1											Edit
IPPhoneObject1		Select	Exit	Update	Submit	Search	<<	Cancel	Next	Dial	Dial
CiscoIPPhoneImage			X	X

CiscoIPPhoneGraphicMenu			X	X

CiscoIPPhoneInput					X	X2	X	X
CiscoIPPhoneDirectory								X	X	X3	X3

1.The SoftKey URI is not allowed in an Execute object.

2.Only when used under the Directories button.

3.The SoftKey:Dial and SoftKey:EditDial URIs can be used only for Directory objects, but the Dial:xxx and EditDial:xxx URIs can be used as the URL of any SoftKeyItem or MenuItem. For more details, see the “Telephony URIs” section on page 5-13.

The new generation 8900 / 9900 series IP phones have the following enhancements to their display:

•The positions of the sofkeys have been changed. Moving from left to right, the Exit is the first softkey followed by the Submit/Select/Update/Next softkey, and finally the Delete softkey.

• In the submenu screens, the back arrow icon (	) replaces the << or Exit softkeys, and it is placed
in the first (extreme left) position.

•The phone displays error messages, like XML Parse error or HTTP failures, in a new window.

QueryStringParam

The QueryStringParam URI allows an application developer to collect more information from the user with less interaction. When the user performs an action with a softkey, you can either append a query string parameter to the URL of the highlighted MenuItem or append the query string parameter from the MenuItem to the URL of the softkey.

URI Format

QueryStringParam:d

Where

d = the data to be appended to a corresponding URL.

Example 5-1 QueryStringParam URI in a CiscoIPPhoneMenu object

<CiscoIPPhoneMenu> <Title>Message List</Title> <Prompt>Two Messages</Prompt> <MenuItem>

<Name>Message One</Name> <URL>QueryStringParam:message=1</URL>

</MenuItem>

<MenuItem>

<Name>Message Two</Name> <URL>QueryStringParam:message=2</URL>

</MenuItem>

<SoftKeyItem>

<Name>Read</Name>

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

</SoftKeyItem>

<SoftKeyItem>

Cisco Unified IP Phone Services Application Development Notes

	OL-20949-01	5-7

Image 55

Cisco Systems OL-20949-01 manual QueryStringParam, Select Exit Update Submit Search Cancel Next Dial

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 Audience PrefaceOverview Revision History Chapter Description OrganizationViii Cisco Unified Communications Manager Business Edition Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified IP Phone 7900 Series Document Conventions Cisco Product Security OverviewConvention 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 Model Resolution1CiscoIPPhoneImageFile Example 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 7962G, 7965G Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile Text Area Size Behavior Description CiscoIPPhoneExecute Custom Softkeys CiscoIPPhoneErrorCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML Considerations XML Encoding Mandatory Escape SequencesCharacter Name Escape Sequence Supported Unsupported Application Event HandlersAttributes Attribute Description Event Handler Schema Application Management API Component APIsRTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema XscomplexType Xsall Error Schema Stop Media Errors and ResponsesExamples Start Media Applicable Condition Methods Http Result Code Type Data 7905G 7911G 7921G 7940G 7971G-GE 6941 Internal URI FeaturesSupported URIs by Phone Model 7942G, 7962G 7906G 7945G, 7965G 7970G 6921 Key Device Control URIsURI 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 RTP Streaming Multimedia URIsInteraction with Call Streaming URI Formats RTPRx RTPTx Vibrate PlayInteraction with Incoming Calls Dial Telephony URIs SendDigits EditDial Condition Status Data Error and Response Init Application Management URIsNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data Application AppactionpriorityidleTimerapplicationId Error and Response Http Client Requests Http GET Http Requests and Header SettingsHttp 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 CiscoIPPhoneModelName Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept Header Html URL XML URL Accessing IP Phone Information OL-20949-01 Troubleshooting Tips Troubleshooting Cisco Unified IP Phone Service ApplicationsXML 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 Performance and Scalability BenefitsRestrictions Integration Considerations and Interoperability Prerequisites Related Features and TechnologiesSecurity Supported Platforms 10-4 Troubleshooting DeviceListX ReportsError Codes Field Name Description Procedure Determining Problems With the Interface10-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