Cisco Systems OL-20949-01 IP Phone User Manual


 
3-3
Cisco Unified IP Phone Services Application Development Notes
OL-20949-01
Chapter 3 CiscoIPPhone XML Objects
XML Object Definitions
XML Object Definitions
The following sections provide definitions and descriptions of each CiscoIPPhone XML object:
CiscoIPPhoneMenu
CiscoIPPhoneText
CiscoIPPhoneInput
CiscoIPPhoneDirectory
CiscoIPPhoneImage
CiscoIPPhoneImageFile
CiscoIPPhoneGraphicMenu
CiscoIPPhoneGraphicFileMenu
CiscoIPPhoneIconMenu
CiscoIPPhoneIconFileMenu
CiscoIPPhoneStatus
CiscoIPPhoneStatusFile
CiscoIPPhoneExecute
CiscoIPPhoneResponse
CiscoIPPhoneError
CiscoIPPhoneMenu
A menu on the phone comprises a list of text items, one per line. Users choose individual menu items by
using the same mechanisms that are used for built-in menus in the phone as described in Chapter 1,
“Overview”.
Definition
<CiscoIPPhoneMenu>
<Title>Title text goes here</Title>
<Prompt>Prompt text goes here</Prompt>
<MenuItem>
<Name>The name of each menu item</Name>
<URL>The URL associated with the menu item</URL>
</MenuItem>
</CiscoIPPhoneMenu>
Note The Name field under the <MenuItem> supports a maximum of 64 characters. This field can also
accept two carriage returns to allow the MenuItem name to span three lines on the display.
The 6900 series IP phones does not display the Title and Prompt menu fields at the same time. If
both Title and Prompt fields are defined at the same time, then these phones display only the Prompt
field.
The XML format allows you to specify a title and prompt that are used for the entire menu, followed by
a sequence of
MenuItem objects. Cisco Unified IP Phones allow a maximum of 100 MenuItems. Each
MenuItem includes a Name and an associated URL.