Cisco OL-20949-01 - Manuals

Contents vi Cisco Unified IP Phone Services Application Development Notes OL-20949-01 User Service Subscription 9-4 C H A P T E R 10 DeviceListX Report 10-1 Benefits 10-2 Restrictions 10-2 Integration Considerations and Interoperability 10-2 Performance and Scalability 10-2 Security 10-3 Related Fea...

vii Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Preface Overview Use this document with Cisco Unified Communications Manager, Release 7.1(3) to develop and deploy customized client services for the Cisco Unified IP Phones that support Cisco Unified Phone services. Becau...

viii Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Preface formalized process provides access to CDN Engineers who are an extension of the product technology engineering teams. CDN Engineers have access to the resources necessary to provide expert support in a timely mann...

ix Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Preface Obtaining Documentation and Submitting a Service Request Related Documentation For more information about Cisco Unified IP Phones or Cisco Unified Communications Manager, refer to the following publications: Cisco U...

x Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Preface Obtaining Documentation and Submitting a Service Request Cisco Product Security Overview This product contains cryptographic features and is subject to United States and local country laws governing import, export, t...

C H A P T E R 3-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 3 CiscoIPPhone XML Objects The following sections describe the general behavior and use of XML objects: • Understanding Object Behavior • XML Object Definitions • Custom Softkeys • XML Considerations • Applic...

3-3 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Object Definitions XML Object Definitions The following sections provide definitions and descriptions of each CiscoIPPhone XML object: • CiscoIPPhoneMenu • CiscoIPPhoneText • CiscoIPP...

3-4 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Object Definitions When a menu is loaded, the phone behaves the same as for built-in phone menus. The user navigates through the list of menu items and eventually chooses one by using...

3-5 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Object Definitions CiscoIPPhoneInput When a Cisco Unified IP Phone receives an XML object of type CiscoIPPhoneInput , it constructs an input form and displays it. The user then enters...

3-7 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 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 ...

3-9 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Object Definitions Example The following XML code defines a CiscoIPPhoneImage object that displays the sequence of pixels shown in Figure 3-3 as a graphic positioned at the center of ...

3-11 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Object Definitions CiscoIPPhoneGraphicMenu Graphic menus serve the same purpose as text menus: they allow a user to select a URL from a list. Use graphic menus in situations when the...

3-12 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Object Definitions Figure 3-5 shows the display of the CiscoIPPhoneGraphicFileMenu. Figure 3-5 CiscoIPPhoneGraphicFileMenu If the coordinates that are supplied in <TouchArea> t...

3-14 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Object Definitions CiscoIPPhoneIconFileMenu This icon menu is similar to CiscoIPPhoneMenu , but it uses color PNG icons rather than grayscale CIP icons. Use icon menus in situations ...

3-19 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects Custom Softkeys <ExecuteItem Priority=”1” URL=”http://server/textmessage.xml”/> </CiscoIPPhoneExecute> CiscoIPPhoneResponse The CiscoIPPhoneResponse object items provide mess...

3-20 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Considerations Note The <URLDown> tag can only contain Internal URIs—it cannot contain an HTTP URL. The “URL” in the name “URLDown” does not signify that an HTTP URL can be use...

3-21 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects XML Considerations Note All CiscoIPPhone element names and attribute names are case sensitive. Mandatory Escape Sequences By XML convention, the XML parser also requires that you provide...

3-22 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 3 CiscoIPPhone XML Objects Application Event Handlers Application Event Handlers The Application Manager API (see “Application” section on page 5-18 ) includes an Application Management Event Handler which is supp...

C H A P T E R 4-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 4 Component APIs In addition to the primary phone XSI API, two additional component APIs are available: • Application Management API, page 4-1 • RTP Streaming API, page 4-1 Application Management API To addre...

4-2 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 4 Component APIs RTP Streaming API Interaction Rules with Legacy RTP URI Streams The RTP Streaming API allows a full-duplex stream (mode=sendReceive) to be setup as a single stream request which simplifies the usag...

4-4 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 4 Component APIs RTP Streaming API </xs:element> <xs:element name="port" minOccurs="0"> <xs:simpleType> <xs:restriction base="xs:unsignedShort"> <xs:minInclusive v...

4-5 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 4 Component APIs RTP Streaming API Examples Start Media • Request HTTP POST /CGI/Execute <startMedia> <mediaStream onStopped=”Notify:http:server:80:path/page” receiveVolume=”50”> <type>audio</t...

C H A P T E R 5-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 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...

5-2 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Device Control URIs Device Control URIs These sections describe the device control URIs: • Key • Display Key The Key URI allows a programmer to send an event that a key has been pressed. The...

5-4 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Device Control URIs Unsupported Key URIs and Alternate Options This section describes the unsupported Key URIs in the phone models and provides alternative options, if any, for the unsupport...

5-5 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Device Control URIs Display The Display URI is available only on those Cisco Unified IP Phones that have a color backlight on the phone display, including the Cisco Unified IP Phone 7970G an...

5-6 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features XML Displayable Object URIs XML Displayable Object URIs These sections describe the XML displayable object URIs: • SoftKey • QueryStringParam SoftKey You can execute native softkey functiona...

5-7 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features XML Displayable Object URIs The new generation 8900 / 9900 series IP phones have the following enhancements to their display: • The positions of the sofkeys have been changed. Moving from le...

5-9 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Multimedia URIs Multimedia URIs These sections describe the multimedia URIs: • RTP Streaming • Play • Vibrate RTP Streaming You can invoke RTP streaming via URIs in services. You can instruc...

5-10 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Multimedia URIs The user has no explicit mechanism for terminating the Rx URI stream independent of the call. Thus, if the Rx stream is not terminated automatically, it would continue to pl...

5-11 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Multimedia URIs RTPTx Use the RTPTx URI to instruct the phone to transmit a Unicast RTP stream or to stop transmitting Unicast or Multicast RTP streams. URI Formats RTPTx:i:p RTPTx:Stop Whe...

5-12 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Multimedia URIs Play The Play URI downloads an audio file from the TFTP server and plays through the phone speaker. This same mechanism also plays ring files, and the format of the files is...

5-13 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Telephony URIs URI Format Vibrate:vibrateDuration:silenceDuration:count Where vibrateDuration = duration (in milliseconds) in which the vibrate state remains on. Value must be an integer ra...

5-14 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Telephony URIs useAppUI = Specifies whether or not this application will be used as the user interface for this call. A value of true will cause the application to keep UI focus when the ca...

5-16 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Application Management URIs Application Management URIs These sections describe the application management URIs: • Init • Notify • Application Init The Init URI allows an application to ini...

5-18 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 5 Internal URI Features Application Management URIs HTTP POST /path/streamhandler?event=stopped HTTP/1.1 Accept: */* Authorization: Basic 8fh4hf7s7dhf Content-Type: application/x-www-form-urlencoded; charset=”UTF-...

6-2 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 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 serv...

6-3 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 6 HTTP Requests and Header Settings HTTP Header Settings HTTP Refresh Setting The HTTP headers that are sent with any page from an HTTP server can include a Refresh setting. This setting comprises two parameters: a...

6-4 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 6 HTTP Requests and Header Settings HTTP Header Settings MIME Type and Other HTTP Headers Although delivering pages with the proper MIME type and other formatting items is not difficult, it requires moderately in d...

6-5 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 6 HTTP Requests and Header Settings HTTP Header Settings This functionality allows you to make the content of any page that is sent to the phone expire. When a user presses the Exit softkey, the user goes back to t...

6-6 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 6 HTTP Requests and Header Settings HTTP Header Settings HTTP Encoding Header Setting The encoding header controls language and character settings related to localization. Accept-Language Cisco Unified IP Phones po...

6-7 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 6 HTTP Requests and Header Settings Identifying the Capabilities of IP Phone Clients If 'charset' is not specified, the phones will use the default encoding for the currently configured user locale. So to avoid pos...

6-8 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 6 HTTP Requests and Header Settings Accept Header x-CiscoIPPhoneSDKVersion This Cisco-proprietary header contains the version of the IP Phone Services SDK that the requesting phone supports. The HTTP header does no...

6-9 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 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...

C H A P T E R 7-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 7 Troubleshooting Cisco Unified IP Phone Service Applications This chapter contains the following sections: • Troubleshooting Tips • XML Parsing Errors • Error Messages Troubleshooting Tips The following tips...

7-2 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 7 Troubleshooting Cisco Unified IP Phone Service Applications Error Messages – CiscoIPPhoneMenu Object—If the field <Name> is missing for a <MenuItem> , the original parser would stop rendering from tha...

C H A P T E R 8-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 8 Cisco IP Phone Services Software Development Kit (SDK) The Cisco IP Phone Services Software Development Kit (SDK) contains everything that you require to create XML applications, including necessary documen...

8-3 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 8 Cisco IP Phone Services Software Development Kit (SDK) Sample Services Requirements – Speed Dials (JSP) – Group MWI (JSP) – AutoDialer (JSP) – PhotoDirectory (JSP) – CallerInfo (JSP) – PushAuthenticate (ASP) – Sc...

C H A P T E R 9-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 9 IP Phone Service Administration and Subscription Cisco Unified Communications Manager administrators maintain the list of services to which users can subscribe. Administrators must use Cisco Unified Communi...

9-2 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 9 IP Phone Service Administration and Subscription Adding a Phone Service Example http:// <servername> /ccmuser/sample/sample.asp Where <servername> designates a fully qualified domain name or an IP add...

9-3 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 9 IP Phone Service Administration and Subscription Defining IP Phone Service Parameters Defining IP Phone Service Parameters Each service can have a list of parameters. You can use these parameters, which are appen...

9-4 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 9 IP Phone Service Administration and Subscription User Service Subscription Tip If you change the service URL, remove a Cisco Unified IP Phone service parameter, or change the Parameter Name of a phone service par...

10-2 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 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. Benefit...

10-4 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 10 DeviceListX Report Troubleshooting DeviceListX Reports <?xml version="1.0" encoding="iso-8859-1"?> <DeviceList> <Device t="" n="" d="" c="" p="...

10-5 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 Chapter 10 DeviceListX Report Troubleshooting DeviceListX Reports Error Message 1001 Too many simultaneous requests for Device List. Please wait at least 60 seconds and try again. Explanation When two or more clients atte...

B-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 A P P E N D I X B Cisco Unified IP Phone Services XML Schema File These sections provide details about the XML schema supported on Cisco Unified IP Phones: • Updated XML Parser and Schema Enforcement • CiscoIPPhone.xsd Upd...

IN-1 Cisco Unified IP Phone Services Application Development Notes OL-20949-01 I N D E X Symbols << softkey 5-6 Numerics 8961 Color depth 3-10 Resolution 3-10 URIs supported 5-1, 5-3 XML Objects supported 2-1, 3-2 9951 Color depth 3-10 Reolution 3-10 URIs supported 5-1, 5-3 XML Objects support...