Chapter 3 CiscoIPPhone XML Objects

Custom Softkeys

<ExecuteItem Priority=”1” URL=”http://server/textmessage.xml”/>

</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

<CiscoIPPhoneResponse>

<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>

CiscoIPPhoneError

The following list gives possible CiscoIPPhoneError codes:

Error 1 = Error parsing CiscoIPPhoneExecute object

Error 2 = Error framing CiscoIPPhoneResponse object

Error 3 = Internal file error

Error 4 = Authentication error

Definition

<CiscoIPPhoneError Number=”x”/> optional error message <CiscoIPPhoneError>

The text value of the CiscoIPPhoneError object may contain an optional error message to further describe the nature of the error condition.

Custom Softkeys

Cisco Unified IP Phones can use custom softkeys with any of the displayable CiscoIPPhone XML objects, excluding the CiscoIPPhoneStatus object which cannot control softkeys and the CiscoIPPhoneExecute object which is not displayable.

Softkeys can have either URL or URI “actions” associated with them. The SoftkeyItem can define separate actions to be taken when the softkey is pressed and released. The standard UI behavior is to execute an action when a key is released, and this action is defined by the <URL> tag. An action can also be taken when the softkey is initially pressed by including the optional <URLDown> tag. For example, you might use <URLDown> for a press-to-talk application in which pressing the button starts audio streaming and releasing the button stops it.

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

 

 

OL-20949-01

 

 

3-19

 

 

 

 

 

Page 37
Image 37
Cisco Systems OL-20949-01 manual Custom Softkeys, CiscoIPPhoneResponse, CiscoIPPhoneError