Specifications

3-24
Cisco Unified IP Phone Services Application Development Notes
OL-22505-01
Chapter 3 CiscoIPPhone XML Objects
XML Object Definitions
• AnimatedIcon.Ringin
• AnimatedIcon.Hold
• AnimatedIcon.MessageWaiting
• AnimatedIcon.StreamingRx
• AnimatedIcon.StreamingTx
• AnimatedIcon.StreamRxTx
• AnimatedIcon.Throbber
Troubleshooting
The following errors and conditions may occur in this feature:
• If the CiscoIPPhoneIconFileMenu object is invalid, a parsing error is generated and a
CiscoIPPhoneError object (with Number="1") is returned as the response.
• If the Resource URI does not specify a recognized Icon resource, then a default unknown-icon image
is displayed.
Error Handling
Standard XML services debugging techniques are applied to this feature. The root cause for any parsing
errors is displayed in the phone console logs. For HTTP requests/responses, sniffer traces and web server
debug can be used to examine the CiscoIPPhoneIconFileMenu object to ensure that it conforms to the
schema.
CiscoIPPhoneStatus
The CiscoIPPhoneStatus object is also a displayable object, but differs from the preceding objects in that
it displays on the Call plane of the phone rather than the Services plane. The CiscoIPPhoneStatus object
“hovers” above the Call plane and is typically used in conjunction with CTI applications to present
application status to the user.
The Status object cannot be closed or cleared by the user (for example, by pressing Services) because
the Status object is only present on the Call plane. In order to clear the object, the phone must execute
the Init:AppStatus URI. This would typically occur as the result of an application server pushing an
Execute object to the phone that contains the Init:AppStatus URI.
Note The CiscoIPPhoneStatus object can only be pushed (HTTP POST) to the phone but it cannot be pulled
(HTTP GET).
The CiscoIPPhoneStatus object can be refreshed or replaced at any time. It is not necessary to clear an
existing Status object before sending a new Status object. The new object simply replaces the old object.
Figure 3-17 shows the CiscoIPPhoneStatus object that contains the following visual elements:
• 106 x 21 graphics area for displaying CIP images (same image format as CiscoIPPhoneImage)
• Seedable, free-running timer (optional)
• Single-line text area (optional)