Internal URI Features | Cisco Systems OL-20949-01 guide

C H A P T E R 5

Internal URI Features

Internal uniform resource identifiers (URIs) provide access to embedded phone features such as placing calls, playing audio files, and invoking built-in object features.

These sections provide details about the available internal URIs:

•Supported URIs by Phone Model

•Device Control URIs

•XML Displayable Object URIs

•Multimedia URIs

•Telephony URIs

•Application Management URIs

Supported URIs by Phone Model

Table 5-1lists the URIs that are supported for Release 7.1(3).

Table 5-1

URIs Supported for Release Cisco Unified IP Phone Services SDK

7941G/7941G-GE,

7961G/7961G-GE,

7942G, 7962G,

7906G

7945G, 7965G,

7970G

6921,

9971,

7905G

7911G

7921G

7940G

IP

7971G-GE

6941,

9951,

URI

7912G

7931G

7920G

7925G

7960G

Communicator

7975G

6961

8961

Key

X

X

X

X

X

X

X

X

X1

Softkey

X

X

X

X

X

X

X

X

X

Init

X

X

X

X

X

X

X

X

X

Dial, EditDial

X

X

X

X

X

X

X

X

X

Play

X

X

X

X

X

X

X

X

X

QueryStringParam

X

X

X

X

X

X

X

X

X

Unicast RTP

X

X

X2

X

X

X

X

X

X

Multicast RTP

X

X

X

X

X

X

X

X

X

Display

—

—

—

—

—

—

X

—

X

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

5-1

Image 49

Cisco Systems OL-20949-01 Internal URI Features, Supported URIs by Phone Model, 7942G, 7962G 7906G 7945G, 7965G 7970G 6921

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 Chapter Description OrganizationViii Related Documentation Cisco Unified Communications Manager AdministrationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business Edition Document Conventions Cisco Product Security OverviewConvention Indication 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 Custom Softkeys CiscoIPPhoneErrorCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML Considerations XML 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 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 Key Device Control URIsURI Format 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 RTP Streaming Multimedia URIsInteraction with Call Streaming URI Formats RTPRx RTPTx Vibrate PlayInteraction with Incoming Calls Dial Telephony URIs SendDigits EditDial Condition Status Data Error and Response Init Application Management URIsNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data Application AppactionpriorityidleTimerapplicationId 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 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 CiscoIPPhoneModelName Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept Header Html URL XML URL Accessing IP Phone Information OL-20949-01 Troubleshooting Tips Troubleshooting Cisco Unified IP Phone Service ApplicationsXML Parsing Errors 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 Procedure Determining Problems With the Interface10-5 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