Cisco Systems OL-20949-01 manual Http Header Settings

Page 70

Chapter 6 HTTP Requests and Header Settings

HTTP Header Settings

The form that is posted should have a case-sensitive form field name called “XML” that contains the desired XML object. For any HTTP POST operation, the server must provide basic HTTP authentication information with the POST. The provided credentials must be of a user in the global directory with a device association with the target phone.

If the credentials are invalid, or the Authentication URL is not set properly in the

Cisco Unified Communications Manager Administration, the phone will return a

CiscoIPPhoneError with a value of 4 (Authentication Error) and processing will stop.

2.The phone processes the supported HTTP headers

3.The phone parses and validates the XML object

4.The phone presents data and options to the user, or in the case of a CiscoIPPhoneExecute object, begins executing the URIs.

Tip Any HTTP POST object is limited to 512 bytes in size. Larger objects (such as images) can only be delivered to the phone via HTTP GET. So, to push large objects to the phone, the server application must take an indirect approach. To do this, push an Execute object to the phone that contains an ExecuteItem pointing to the URL of the large object.

Note JTAPI also can push an XML object directly to an IP phone, with the added benefit of not requiring authentication (since the JTAPI connection itself is already authenticated). This option works particularly well for adding XML services interfaces to existing CTI applications (where the overhead of the CTI connection is already a requirement). Objects pushed via JTAPI are also limited to a maximum size of 512 bytes. See the Cisco Unified Communications Manager JTAPI Developer Guide for more information.

HTTP Header Settings

The following list provides definitions for HTTP header elements for Cisco Unified IP Phone Services:

•“Refresh”—sets the refresh time (in seconds) and URL

–If no time is set or it is zero, the refresh gets set to manual.

–If no URL is set, the current URL gets used.

See the “HTTP Refresh Setting” section on page 6-3section.

•ContentType —notifies the phone of the MIME type that was sent. See the “MIME Type and Other HTTP Headers” section on page 6-4section.

•“Expires”—sets the Date/Time in GMT when the page is to expire.

Pages that have expired before being loaded do not get added to the URL stack in the phone. The phone does not cache content. See “Content Expiration Header Setting” section on page 6-4for more information.

•“Set Cookie” - see “Set-Cookie Header Setting” section on page 6-5

•“HTTP Encoding Header Setting” section on page 6-6

Cisco Unified IP Phone Services Application Development Notes

6-2

OL-20949-01

 

 

Page 69 Page 71
Image 70
Page 69 Page 71
Contents Americas Headquarters Text Part Number OL-20949-01Copyright 2004-2009 Cisco Systems, Inc. All rights reserved N T E N T S IiiDisplay Init Benefits Revision History PrefaceOverview AudienceChapter Description OrganizationViii Cisco Unified IP Phone 7900 Series Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified Communications Manager Business EditionDocument Conventions Cisco Product Security OverviewConvention Indication Page Xii Overview 1shows a sample text menuGraphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New and Changed Information New Information for Cisco Unified Communications ManagerOL-20949-01 CiscoIPPhone XML Objects Understanding Object Behavior1shows the supported XML objects for this release XML Object Definitions CiscoIPPhoneMenuCiscoIPPhoneText DefinitionCiscoIPPhoneInput Sample User Input DisplayCiscoIPPhoneDirectory InputFlag DescriptionCiscoIPPhoneImage Custom DirectoriesPacked Pixel Translation Example Example Resolution1CiscoIPPhoneImageFile ModelMonochrome Cisco Unified IP Phone 7970G Image File DisplayCiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenuCiscoIPPhoneIconMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneIconFileMenu CiscoIPPhoneStatusDynamic Sizing of the Application Status Window CiscoIPPhoneStatusPhone Models Area Width Area Height 7940G, 7960G 7962G, 7965G 7970G/7971G-GE, 7975G, IP CommunicatorText Area Size Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile 7962G, 7965GCiscoIPPhoneExecute Behavior DescriptionCustom Softkeys CiscoIPPhoneErrorCiscoIPPhoneResponse XML Considerations SoftKeyItem NameDisplayed sofkey label/NameXML Encoding Mandatory Escape SequencesCharacter Name Escape Sequence Supported Unsupported Application Event HandlersAttributes Attribute Description Event Handler Schema Application Management API Component APIsRTP Streaming API RTP Streaming Schema Interaction Rules with Legacy RTP URI StreamsXscomplexType Xsall Error Schema Start Media Errors and ResponsesExamples Stop MediaApplicable Condition Methods Http Result Code Type Data 7942G, 7962G 7906G 7945G, 7965G 7970G 6921 Internal URI FeaturesSupported URIs by Phone Model 7905G 7911G 7921G 7940G 7971G-GE 6941Key Device Control URIsURI Format KeyDirectories Phone Unsupported Models Description and AlternativesDisplay URIXML Displayable Object URIs SoftKeySelect Exit Update Submit Search Cancel Next Dial QueryStringParamInternal URI Features XML Displayable Object URIs RTP Streaming Multimedia URIsInteraction with Call Streaming RTPRx URI FormatsRTPTx Vibrate PlayInteraction with Incoming Calls Telephony URIs DialEditDial SendDigitsError and Response Condition Status DataInit Application Management URIsNotify Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no dataAppactionpriorityidleTimerapplicationId Error and Response Http Client Requests Http GET Http Requests and Header SettingsHttp Server Requests Http Post Http Header Settings See the Http Refresh Setting section on page 6-3sectionHttp Refresh Setting Refresh Display SampleContent Expiration Header Setting Mime Type and Other Http HeadersSet-Cookie Header Setting Http Encoding Header Setting Accept-LanguageCiscoIPPhoneModelName Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneDisplay Accept Header CiscoIPPhoneSDKVersionAccessing IP Phone Information Html URL XML URLOL-20949-01 Troubleshooting Tips Troubleshooting Cisco Unified IP Phone Service ApplicationsXML Parsing Errors Error Messages Cisco IP Phone Services Software Development Kit SDK SDK ComponentsOL-20949-01 Sample Services Requirements \CiscoIpServices\ToolsOL-20949-01 IP Phone Service Administration Subscription Accessing Phone Service AdministrationAdding a Phone Service Field DescriptionDefining IP Phone Service Parameters Field Description Service Parameter InformationUser Service Subscription DeviceListX Report 10-1Integration Considerations and Interoperability BenefitsRestrictions Performance and ScalabilitySupported Platforms Related Features and TechnologiesSecurity PrerequisitesField Name Description Troubleshooting DeviceListX ReportsError Codes 10-4Procedure Determining Problems With the Interface10-5 10-6 CiscoIPPhone XML Object Quick Reference Object DefinitionAppendix 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 EnforcementCiscoIPPhone.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-1Html URL IN-2IN-3 XML URL IN-4
Top Page Image Contents