Ciscoipphoneresponse - Cisco OL-18696-01 Development Manual

Chapter 2 CiscoIPPhone XML Objects
Like the other XML objects, the CiscoIPPhoneExecute can be either pushed (HTTP POST) or pulled
(HTTP GET). Upon receiving a CiscoIPPhoneExecute object, the phone will begin executing the
specified ExecuteItems. Order of execution is not guaranteed, so ExecuteItems will likely not execute in
the order in which they are listed in the CiscoIPPhoneExecute object.
Limit the requests to three ExecuteItems: only one can be a URL and two URIs per
Note
CiscoIPPhoneExecute
Definition
<CiscoIPPhoneExecute>
</CiscoIPPhoneExecute>
The
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.
Behavior
0 = Execute Immediately
1 = Execute When Idle
2 = Execute If Idle
The Priority attribute is only used for HTTP URLs. Internal URIs always execute immediately.
Note
Example
The following
the state of the phone, but waits until the phone goes idle before displaying the specified XML page:
<CiscoIPPhoneExecute>
</CiscoIPPhoneExecute>

CiscoIPPhoneResponse

The
CiscoIPPhoneExecute
order differs based on completion time, and the execution order is not guaranteed.
OL-18696-01
object, or you can send three URIs with no URL.
<ExecuteItem URL="the URL or URI to be executed"/>
tag of the
<ExecuteItem>
Description
The URL executes regardless of the state of the phone. If the Priority
attribute does not get specified in the
priority gets set to zero for backward compatibility.
The URL gets delayed until the phone goes idle, then it executes.
The URL executes on an idle phone; otherwise, it does not get
executed (it does not get delayed).
CiscoIPPhoneExecute
<ExecuteItem Priority="0" URL="Play:chime.raw"/>
<ExecuteItem Priority="1" URL="http://server/textmessage.xml"/>
object items provide messages and information resulting from
CiscoIPPhoneResponse
. As a result, a
object includes an optional attribute called
CiscoIPPhoneExecute
<ExecuteItem>
object results in the phone playing an alert "chime," regardless of
exists for each
ResponseItem
Cisco Unified IP Phone Services Application Development Notes
XML Object Definitions
, the default
that you send. The
ExecuteItems
2-17