Cisco Systems OL-20949-01 manual CiscoIPPhoneImage, Custom Directories

Page 25

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

</DirectoryEntry>

</CiscoIPPhoneDirectory>

Note For the directory listing, the Cisco Unified IP Phone displays the appropriate softkeys that are needed to dial the numbers that are listed on the display. The softkeys include the Edit Dial softkey, which allows users to insert access codes or other necessary items before dialing.

The Title and Prompt tags in the XML object have the usual semantics. A single CiscoIPPhoneDirectory object can contain a maximum of 32 DirectoryEntry objects. If more than 32 entries must be returned, use multiple CiscoIPPhoneDirectory objects in subsequent HTTP requests.

Note The 6900 series IP phones does not display the Title and Prompt menu fields at the same time. If both Title and Prompt fields are defined at the same time, then these phones display only the Prompt field.

Custom Directories

You can use the Cisco Unified Communications Manager enterprise parameter, “URL Directories” and CiscoIPPhone XML objects to display custom directories. The “URL Directories” points to a URL that returns a CiscoIPPhoneMenu object that extends the directories menu. The request for “URL Directories” must return a valid CiscoIPPhoneMenu object, even if has no DirectoryEntry objects.

To create a custom directory, use the following optional objects in the order in which they are listed:

1.Use the CiscoIPPhoneInput XML object to collect search criteria.

2.Use the CiscoIPPhoneText XML object to display status messages or errors.

3.Use the CiscoIPPhoneDirectory XML object to return a list of directory entries that can be dialed.

You can omit the CiscoIPPhoneInput or CiscoIPPhoneText objects. You can display multiple CiscoIPPhoneDirectory objects by specifying an HTTP refresh header that points to the URL of the next individual directory object, which the user accesses by pressing the Next softkey on the phone.

CiscoIPPhoneImage

The CiscoIPPhoneImage provides a bitmap display with a 133 x 65 pixel pane that is available to access services. Each pixel includes four grayscale settings. A value of three (3) displays as black, and a value of zero (0) displays as white.

Note The phone uses an LCD display, which inverts the palette.

The CiscoIPPhoneImage XML type lets you use the Cisco Unified IP Phone display to present graphics to the user.

Definition

<CiscoIPPhoneImage>

<Title>Image title goes here</Title> <Prompt>Prompt text goes here</Prompt> <LocationX>Position information of graphic</LocationX> <LocationY>Position information of graphic</LocationY> <Width>Size information for the graphic</Width> <Height>Size information for the graphic</Height>

Cisco Unified IP Phone Services Application Development Notes

 

OL-20949-01

3-7

 

 

 

Page 24 Page 26
Image 25
Page 24 Page 26
Contents Text Part Number OL-20949-01 Americas HeadquartersCopyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T SDisplay Init Benefits Overview PrefaceRevision History AudienceChapter Description OrganizationViii Related Documentation Cisco Unified Communications Manager AdministrationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business EditionDocument Conventions Cisco Product Security OverviewConvention Indication Page Xii 1shows a sample text menu OverviewGraphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed InformationOL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object DefinitionsDefinition CiscoIPPhoneTextSample User Input Display CiscoIPPhoneInputInputFlag Description CiscoIPPhoneDirectoryCustom Directories CiscoIPPhoneImagePacked Pixel Translation Example CiscoIPPhoneImageFile Resolution1Example ModelCisco Unified IP Phone 7970G Image File Display MonochromeCiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenuCiscoIPPhoneStatus Dynamic Sizing of the Application Status Window7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960GCiscoIPPhoneStatusFile Phone Models WxH No Timer WxH 7940G, 7960GText Area Size 7962G, 7965GBehavior Description CiscoIPPhoneExecuteCustom Softkeys CiscoIPPhoneErrorCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML ConsiderationsXML 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 SchemaXscomplexType Xsall Error Schema Examples Errors and ResponsesStart Media Stop MediaApplicable Condition Methods Http Result Code Type Data Supported URIs by Phone Model Internal URI Features7942G, 7962G 7906G 7945G, 7965G 7970G 6921 7905G 7911G 7921G 7940G 7971G-GE 6941Key Device Control URIsURI Format KeyDirectories Description and Alternatives Phone Unsupported ModelsURI DisplaySoftKey XML Displayable Object URIsQueryStringParam Select Exit Update Submit Search Cancel Next DialInternal URI Features XML Displayable Object URIs RTP Streaming Multimedia URIsInteraction with Call Streaming URI Formats RTPRxRTPTx Vibrate PlayInteraction with Incoming Calls Dial Telephony URIsSendDigits EditDialCondition Status Data Error and ResponseInit Application Management URIsNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data ApplicationAppactionpriorityidleTimerapplicationId 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 SettingsRefresh Display Sample Http Refresh SettingMime Type and Other Http Headers Content Expiration Header SettingSet-Cookie Header Setting Accept-Language Http Encoding Header SettingCiscoIPPhoneModelName Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept HeaderHtml URL XML URL Accessing IP Phone InformationOL-20949-01 Troubleshooting Tips Troubleshooting Cisco Unified IP Phone Service ApplicationsXML Parsing Errors Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDKOL-20949-01 \CiscoIpServices\Tools Sample Services RequirementsOL-20949-01 Accessing Phone Service Administration IP Phone Service Administration SubscriptionField Description Adding a Phone ServiceField Description Service Parameter Information Defining IP Phone Service ParametersUser Service Subscription 10-1 DeviceListX ReportRestrictions BenefitsIntegration Considerations and Interoperability Performance and ScalabilitySecurity Related Features and TechnologiesSupported Platforms PrerequisitesError Codes Troubleshooting DeviceListX ReportsField Name Description 10-4Procedure Determining Problems With the Interface10-5 10-6 Object Definition CiscoIPPhone XML Object Quick ReferenceAppendix 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 FileCiscoIPPhone.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 NumericsIN-2 Html URLIN-3 IN-4 XML URL
Top Page Image Contents