Accessing IP Phone Information | Cisco Systems OL-20949-01 specification

Chapter 6 HTTP Requests and Header Settings

Accessing IP Phone Information

Accessing IP Phone Information

Cisco Unified IP Phones have an embedded web server to provide a programming interface for external applications and a debugging and management interface for system administrators.

You can access the administrative pages using a standard web browser and pointing to the IP address of the phone with: /http://<phoneIP>/, where phoneIP is the IP address of the specific phone.

These device information pages are available in either HTML format, for manual debugging purposes, or in XML format for automation purposes. Table 6-1lists the available URLs and their purpose.

Table 6-1	Device Information URLs

HTML URL		XML URL	Description

/DeviceInformation		/DeviceInformationX	General device information

/NetworkConfiguration		/NetworkConfigurationX	Network configuration information

/EthernetInformation		/EthernetInformationX	Ethernet counters

/PortInformation?n		/PortInformationX?n	Detailed port information, where n is
			a model-specific ethernet port
			identifier, typically in the range 1- 3.

/DeviceLog?n		/DeviceLogX?n	Device logging, debug, and error
			messages, where n is a
			model-specific log number, typically
			in the range 0 - 2.

/StreamingStatistics?n		/StreamingStatisticsX?n	Current RTP streaming stats, where
			'n' is model-specific RTP stream
			identifier, typically in the range 1-3.

/CGI/Execute1			The target URL of a phone push
			(HTTP POST) request.

/CGI/Screenshot1			Returns an exact snapshot of the
			current phone display. The size and
			format of the image returned is
			model-specific.

1. Password-protected CGI script

Cisco Unified IP Phone Services Application Development Notes

	OL-20949-01	6-9

Image 77

Cisco Systems OL-20949-01 manual Accessing IP Phone Information, Html URL XML URL

Contents

Text Part Number OL-20949-01 Americas Headquarters Copyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T S Display Init Benefits Overview PrefaceRevision History Audience Viii OrganizationChapter Description Related Documentation Cisco Unified Communications Manager AdministrationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business Edition Convention Indication Cisco Product Security OverviewDocument Conventions Page Xii 1shows a sample text menu Overview Graphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed Information OL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects 1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object Definitions Definition CiscoIPPhoneText Sample User Input Display CiscoIPPhoneInput InputFlag Description CiscoIPPhoneDirectory Custom Directories CiscoIPPhoneImage Packed Pixel Translation Example CiscoIPPhoneImageFile Resolution1Example Model Cisco Unified IP Phone 7970G Image File Display Monochrome CiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu 6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Dynamic Sizing of the Application Status Window 7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960G CiscoIPPhoneStatusFile Phone Models WxH No Timer WxH 7940G, 7960GText Area Size 7962G, 7965G Behavior Description CiscoIPPhoneExecute CiscoIPPhoneResponse CiscoIPPhoneErrorCustom Softkeys SoftKeyItem NameDisplayed sofkey label/Name XML Considerations Character Name Escape Sequence Mandatory Escape SequencesXML Encoding Attributes Application Event HandlersSupported Unsupported Attribute Description Event Handler Schema RTP Streaming API Component APIsApplication Management API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema XscomplexType Xsall Error Schema Examples Errors and ResponsesStart Media Stop Media Applicable 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 6941 URI Format Device Control URIsKey KeyDirectories Description and Alternatives Phone Unsupported Models URI Display SoftKey XML Displayable Object URIs QueryStringParam Select Exit Update Submit Search Cancel Next Dial Internal URI Features XML Displayable Object URIs Interaction with Call Streaming Multimedia URIsRTP Streaming URI Formats RTPRx RTPTx Interaction with Incoming Calls PlayVibrate Dial Telephony URIs SendDigits EditDial Condition Status Data Error and Response Notify Application Management URIsInit Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data Application AppactionpriorityidleTimerapplicationId Error and Response Http Server Requests Http Post Http Requests and Header SettingsHttp Client Requests Http GET See the Http Refresh Setting section on page 6-3section Http Header Settings Refresh Display Sample Http Refresh Setting Mime Type and Other Http Headers Content Expiration Header Setting Set-Cookie Header Setting Accept-Language Http Encoding Header Setting CiscoIPPhoneDisplay Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneModelName CiscoIPPhoneSDKVersion Accept Header Html URL XML URL Accessing IP Phone Information OL-20949-01 XML Parsing Errors Troubleshooting Cisco Unified IP Phone Service ApplicationsTroubleshooting Tips Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDK OL-20949-01 \CiscoIpServices\Tools Sample Services Requirements OL-20949-01 Accessing Phone Service Administration IP Phone Service Administration Subscription Field Description Adding a Phone Service Field Description Service Parameter Information Defining IP Phone Service Parameters User Service Subscription 10-1 DeviceListX Report Restrictions BenefitsIntegration Considerations and Interoperability Performance and Scalability Security Related Features and TechnologiesSupported Platforms Prerequisites Error Codes Troubleshooting DeviceListX ReportsField Name Description 10-4 10-5 Determining Problems With the InterfaceProcedure 10-6 Object Definition CiscoIPPhone XML Object Quick Reference Appendix 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 File CiscoIPPhone.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 Numerics IN-2 Html URL IN-3 IN-4 XML URL