Cisco Systems OL-20949-01 Benefits, Restrictions, Integration Considerations and Interoperability

Page 90

Chapter 10 DeviceListX Report

Benefits

•Device Pool

•IP Address

•Real-Time Information

The completed list of data gets formatted into a simple XML object and gets returned in the HTTP Response to the developer.

Benefits

DeviceListX provides access to critical real-time data that was previously unavailable to third-party developers. In particular, the ability to list currently registered devices along with their IP address allows developers to easily build push, broadcast, and CTI-type applications.

Restrictions

Only users with administrative privileges to the Cisco Unified Communications Manager

Administration can access the report.

Note To minimize processing overhead on the Cisco Unified Communications Manager server, access to the DeviceListX report gets rate-limited to once per minute. Any attempt to pull the report more frequently will fail. In practice, the developer application should pull and cache the DeviceListX report, refreshing only as often as required, typically every few hours or daily.

Integration Considerations and Interoperability

The interface allows HTTP 1.1 or HTTP 1.0 GET requests for the report. The report returns data that is encapsulated by using XML version 1.0.

Performance and Scalability

You can run this report on the largest supported Cisco Unified Communications Manager cluster size for the targeted release without impacting core features, such as delaying dial tone. On multiserver Cisco Unified Communications Manager clusters, the report can access only from the publisher server. In large clusters where the publisher is not a Cisco Unified Communications Manager server, no possibility exists of impacting the system performance as perceived by a user.

This report is not intended for use during real time, so this interface should provide a mechanism for developers to poll for the data on a daily or hourly basis. Give consideration to the frequency of polling and the time of day to prevent unnecessary burden on the system during peak usage times.

	Cisco Unified IP Phone Services Application Development Notes
10-2	OL-20949-01

Image 90

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 AudienceOrganization Chapter DescriptionViii Cisco Unified IP Phone 7900 Series Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified Communications Manager Business EditionCisco Product Security Overview Document ConventionsConvention 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 DescriptionCiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse XML Considerations SoftKeyItem NameDisplayed sofkey label/NameMandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP 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 6941Device Control URIs KeyURI 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 Multimedia URIs RTP StreamingInteraction with Call Streaming RTPRx URI FormatsRTPTx Play VibrateInteraction with Incoming Calls Telephony URIs DialEditDial SendDigitsError and Response Condition Status DataApplication Management URIs InitNotify Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no dataAppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp 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-LanguageIdentifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay Accept Header CiscoIPPhoneSDKVersionAccessing IP Phone Information Html URL XML URLOL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML 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-4Determining Problems With the Interface Procedure10-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