Cisco Systems OL-20949-01 Accept Header

6-8

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 6 HTTP Requests and Header Settings

Accept Header

x-CiscoIPPhoneSDKVersion

This Cisco-proprietary header contains the version of the IP Phone Services SDK that the requesting

phone supports. The HTTP header does not specify which URI s a re supp orte d. T he refor e, y ou mu st

check the “Supported URIs” matrix in the IP Phone Services SDK to determine which URIs are

supported based on the Phone Model Name and supported SDK version.

See Tabl e 5-1 table to find which IP phone models support the URIs documented in this SDK.

Note Beginning with the IP Phone Services SDK 3.3(3), the SDK version numb er m atc hes the minimu m

Cisco Unified Communications Manager software that is required to support it. For exa mple , SD K

version 3.3(4) gets supported only on Cisco Communications Manager version 3.3(4) or later.

Accept Header

The Accept header represents a standard HTTP header that is used to inform web servers about the

content-handling capabilities of the client.

Cisco Unified IP Phones include proprietary content-types to indicate which XML obj ect s are

supported. These proprietary content-types all begin with x-CiscoIPPhone, to indicate

Cisco Unified IP Phone XML objects, followed by a slash “/”, foll ow ed b y either a spec if ic XML ob ject

or a “*” to indicate all objects.

For example, x-CiscoIPPhone/* indicates that all XML objects defined in the specified version of the

SDK are supported, and x-CiscoIPPhone/Menu specifies th at th e <C iscoIPPhoneMenu> object gets

supported.

As the example illustrates, the name of the XML object can be derived dire ctly from the conte nt-typ e by

appending the sub-type (the part after the slash) onto “CiscoIPPhone .” The content-type can also include

an optional version to indicate support for a particular SDK ver sio n of t hat obje ct. If a version is n ot

specified, then the x-CiscoIPPhoneSDKVersion is implied. T he synta x of th e version number may vary,

but, in general, will be as follows:

<major version>.<minor version>.<maintenance version>

Here are some examples of typical content-types:

x-CiscoIPPhone/*;version=3.3.3

x-CiscoIPPhone/Text

x-CiscoIPPhone/Menu;version=3.3.4

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