Cisco Systems OL-20949-01 XML Considerations

3-20

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 3 CiscoIPPhone XML Objects

XML Considerations

Note The <URLDown> tag can only contain Internal URIs—it cannot contain an HTT P URL. The “URL” in

the name “URLDown” does not signify that an HTTP URL can b e use d.

Definition

<SoftKeyItem>

<Name>Displayed sofkey label</Name>

<URL>URL or URI action for softkey RELEASE event</URL>

<URLDown>URL or URI action for softkey PRESS event</URLDown>

<Position>position of softkey</Position>

</SoftKeyItem>

Example

In this example, a CiscoIPPhoneText object has a single custom softkey defined:

<CiscoIPPhoneText>

<Text>This object has one softkey named "Custom"</Text>

<SoftKeyItem>

<Name>Custom</Name>

<URL>http://someserver/somepage</URL>

<Position>4</Position>

</SoftKeyItem>

</CiscoIPPhoneText>

If any custom softkeys are defined in the XML object, then all default s oftkeys ar e removed fr om tha t

object. To retain default softkey behavior, then you must explicitly define it in the XML object using a

<SoftKeyItem> tag. The internal Softkey URIs can be used in the <URL> tag of <SoftKeyItem> to invoke

default softkey actions from custom softkeys. See Chapter 5, “Internal URI Features” for more

information on invoking internal softkey features.

Note If there are no custom softkeys and there is no default softkey placed in position 1, either a Next or

Update softkey is assigned automatically. If the URL is a Refresh URL, the softkey will be “Next.” If

not, the Update softkey is assigned.

Example

The following softkey definitions would provide the custom softkey, witho ut losing the defaul t “Select”

behavior:

<SoftKeyItem>

<Name>Select</Name>

<URL>SoftKey:Select</URL>

<Position>1</Position>

</SoftKeyItem>

<SoftKeyItem>

<Name>Custom</Name>

<URL>http://someserver/somepage</URL>

<Position>4</Position>

</SoftKeyItem>

XML Considerations

The XML parser in Cisco Unified IP Phones does not function as a fully capable XML parser. Do not

include any tags other than those defined in your XML display definitions.

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