Cisco Systems OL-20949-01 QueryStringParam

5-7

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 5 Internal URI Features

XML Displayable Object URIs

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 strin g 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>

CiscoIPPhoneImage X X

CiscoIPPhoneGraphicMenu X X

CiscoIPPhoneInput X X2X X

CiscoIPPhoneDirectory X X X3X3

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 Dir ectory object s, but the Di al: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 pag e 5-13.

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

IPPhoneObject1Select Exit Update Submit Search << Cancel Next Dial

Edit

Dial

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