Specifications

3-29

Cisco Unified IP Phone Services Application Development Notes

OL-22505-01

Chapter 3 CiscoIPPhone XML Objects

Custom Softkeys

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.

Note The <URLDown> tag can only contain Internal URIs—it cannot contain an HTTP URL. The “URL” in

the name “URLDown” does not signify that an HTTP URL can be used.

Definition

<Name>Displayed sofkey label</Name>

<URL>URL or URI action for softkey RELEASE event</URL>

<URLDown>URL or URI action for softkey PRESS event</URLDown>

<Position>position of softkey</Position>

</SoftKeyItem>

Example

In this example, a CiscoIPPhoneText object has a single custom softkey defined:

<Text>This object has one softkey named "Custom"</Text>

<Name>Custom</Name>

<URL>http://someserver/somepage</URL>

</SoftKeyItem>

</CiscoIPPhoneText>