Specifications

3-28

Cisco Unified IP Phone Services Application Development Notes

OL-22505-01

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

The <ExecuteItem> tag of the CiscoIPPhoneExecute object includes an optional attribute called

Priority. The Priority attribute is used to inform the phone of the urgency of the execute request and to

indicate whether the phone should be interrupted to perform the request. The Priority levels determine

whether the phone must be idle to perform the requested action. The Idle Timer (along with an optional

Idle URL) is defined globally in the Cisco

Unified Communications Manager Administration Enterprise

Parameters and can be overridden on a per phone basis in the Cisco

Unified Communications Manager

Device configuration.

The following table lists the Priority levels and their behavior.

Note The Priority attribute is only used for HTTP URLs. Internal URIs always execute immediately.

Example

The following CiscoIPPhoneExecute object results in the phone playing an alert “chime,” regardless of

the state of the phone, but waits until the phone goes idle before displaying the specified XML page:

</CiscoIPPhoneExecute>

CiscoIPPhoneResponse

The CiscoIPPhoneResponse object items provide messages and information resulting from

CiscoIPPhoneExecute. As a result, a ResponseItem exists for each ExecuteItems that you send. The

order differs based on completion time, and the execution order is not guaranteed.

The URL attribute specifies the URL or URI that was sent with the request. The Data attribute contains

any special data for the item. The Status attribute specifies a status code. Zero indicates that no error

occurred during processing of the ExecuteItem. If an error occurred, the phone returns a

CiscoIPPhoneError object.

Definition

<ResponseItem Status=”the success or failure of the action”

Data=”the information returned with the response”

URL=”the URL or URI specified in the Execute object”/>

</CiscoIPPhoneResponse>

Behavior Description

0 = Execute Immediately The URL executes regardless of the state of the phone. If the Priority

attribute does not get specified in the

<ExecuteItem>, the default

priority gets set to zero for backward compatibility.

1 = Execute When Idle The URL gets delayed until the phone goes idle, then it executes.

2 = Execute If Idle The URL executes on an idle phone; otherwise, it does not get

executed (it does not get delayed).