Cisco Systems OL-20949-01 Troubleshooting

CHAPTE 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 apply to troubleshooting Cisco Unified IP Phone service applications:

• Microsoft Internet Explorer 5 or higher can display the XML source with its default style sheet.

• Understand that standard IP troubleshooting techniques are important for HTTP errors.

• Externally verify name resolution (Phone has DNS set).

• If DNS is suspected, use IP addresses in URLs.

• Browse the URL in question with Microsoft Internet Explorer or download and verify with another

web browser

• Use a logged telnet session to verify that the desired HTTP headers are returned (Telnet to the server

on port 80; then, enter get /path/page).

XML Parsing Errors

The following tips apply to troubleshooting XML parsing errors in Cisc o Unified IP Phone services

applications:

• Verify the object tags (the object tags are case sensitive).

• Verify that “&” and the other four special characters are used per the restrictions while inside the

XML objects. See Chapter 3, “CiscoIPPhone XML Objects” for more information.

• Validate XML applications developed prior to Cisco Unified IP Phone firmware release 8.3(2)

against the more recent XML parser (see the “Updated XML Parser and Schema Enforcement”

section on page B-1 for details). Some of examples of the types of errors you might encounter

include:

Contents

Main Page CONTENTS Page Page Page Preface Overview Revision History Audience Cisco Developer Support Program Organization Related Documentation Obtaining Documentation and Submitting a Service Request Cisco Product Security Overview Document Conventions Page Page Overview Page Page Page New and Changed Information New Information for Cisco Unified Communications Manager 7.1(3) Page CiscoIPPhone XML Objects Understanding Object Behavior Page XML Object Definitions CiscoIPPhoneMenu CiscoIPPhoneText CiscoIPPhoneInput CiscoIPPhoneDirectory Custom Directories CiscoIPPhoneImage Page CiscoIPPhoneImageFile Page CiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu Page CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Page Page CiscoIPPhoneStatusFile CiscoIPPhoneExecute CiscoIPPhoneResponse CiscoIPPhoneError Custom Softkeys XML Considerations Mandatory Escape Sequences XML Encoding Application Event Handlers Page 3-24 Event Handler Schema Example Component APIs Application Management API RTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema 4-3 4-4 Error Schema Examples Errors and Responses Page Internal URI Features Supported URIs by Phone Model Device Control URIs Key Key:Directories Key:Settings Unsupported Key URIs and Alternate Options Display XML Displayable Object URIs SoftKey QueryStringParam Page Multimedia URIs RTP Streaming RTPRx RTPTx RTPMRx RTPMTx Play Vibrate Telephony URIs Dial EditDial SendDigits Page Application Management URIs Init Notify Page Application Page Page HTTP Requests and Header Settings HTTP Client Requests (HTTP GET) HTTP Server Requests (HTTP POST) HTTP Header Settings HTTP Refresh Setting MIME Type and Other HTTP Headers Audio Clips Content Expiration Header Setting Set-Cookie Header Setting HTTP Encoding Header Setting Accept-Language Accept-Charset HTTP Response Headers: Content-Type Identifying the Capabilities of IP Phone Clients x-CiscoIPPhoneModelName x-CiscoIPPhoneDisplay x-CiscoIPPhoneSDKVersion Accept Header Accessing IP Phone Information Page Troubleshooting Service Applications Troubleshooting Tips XML Parsing Errors Error Messages Cisco IP Phone Services Software Development Kit (SDK) SDK Components Page Sample Services Requirements Page IP Phone Service Administration and Subscription Accessing Phone Service Administration Adding a Phone Service Defining IP Phone Service Parameters User Service Subscription DeviceListX Report Benefits Restrictions Integration Considerations and Interoperability Performance and Scalability Security Related Features and Technologies Supported Platforms Prerequisites Message and Interface Definitions Troubleshooting DeviceListX Reports Error Codes Determining Problems With the Interface Page A-1 APPENDIX A CiscoIPPhone XML Object Quick Reference Tab l e A-1 CiscoIPPhone XML Object Quick Reference A-2 Table A-1 CiscoIPPhone XML Object Quick Reference (continued) A-3 Table A-1 CiscoIPPhone XML Object Quick Reference (continued) Page APPENDIX B Cisco Unified IP Phone Services XML Schema File Updated XML Parser and Schema Enforcement B-2 CiscoIPPhone.xsd B-3 B-4 B-5 B-6 B-7 B-8 B-9 B-10 B-11 B-12 B-13 B-14 INDEX Symbols Numerics A D E F G I M N P U X