XML Services Interface (XSI) is a protocol that allows communication between applications and the phone system. You can add your own XSI services to your phone using the supported XML objects and URIs.

After subscribing the phone to the services, users can access all the configured services on the phone.

  • Cisco Desk Phone 9800 Series

    • Directory and message services can be provisioned to the Contacts and Favorite hard keys respectively.

    • For services that are provisioned as Standard IP Phone Service, users can access them through the feature buttons on the phone screen.
    • Other services can be accessed in Settings > Network and service > Custom services.
  • Cisco Video Phone 8875

    • Directory and message services can be provisioned to the Contacts and Messages hard keys respectively.

    • For services that are provisioned as Standard IP Phone Service, users can access them through the feature buttons on the phone screen.
    • Other services can be accessed in Settings > Custom services.

The supported features are:

  • Directories
  • Extension Mobility
  • Messages (images and text)

For more details about the XSI service configuration, see Cisco Unified IP Phone Services Application Development Notes.

Supported XML objects and URIs

See the following lists for the XML objects and URIs that Cisco Video Phone 8875 and Cisco Desk Phone 9800 Series support.

For more information about how to use the XML objects and URIs, see Cisco Unified IP Phone Services Application Development Notes.

Supported XML objects

  • CiscoIPPhoneMenu

  • CiscoIPPhoneText

  • CiscoIPPhoneInput

  • CiscoIPPhoneDirectory

  • CiscoIPPhoneImage

  • CiscoIPPhoneImageFile

  • CiscoIPPhoneIconMenu

  • CiscoIPPhoneIconFileMenu

  • CiscoIPPhoneExecute

  • CiscoIPPhoneResponse

  • CiscoIPPhoneError

Supported URIs

  • RTP

  • Dial

  • EditDail

  • Play

  • SendDigits

  • Init

  • Notify

  • Application

  • Display

  • QueryStringParam

  • Key

  • Softkey

Add an XSI service in Unified CM

Before you can subscribe your phones to a service, configure the feature as an XML service first.

1

From Cisco Unified CM Administration, choose Device > Device Settings > Phone Services.

2

Click Add New.

3

In the Service Name field, enter a name for the service.

4

In the Service URL field, enter the service URL.

Here are the example URLs for Extension Mobility and directory services:

  • Extension Mobility (EM):

    http://<CUCM IP Address>:8080/emapp/EMAppServlet?device=#DEVICENAME#

    For more setups for EM, see the Extension Mobility chapter in Feature Configuration Guide for Cisco Unified Communications Manager, Release 12.5 or later.

  • Directories:

    Corporate directory: http://<CUCM IP Address>:8080/ccmip/xmldirectoryinput.jsp

    Personal address book: http://<CUCM IP Address>/ccmpd/pdCheckLogin.do?name=#DEVICENAME#

    Fast dial: http://<CUCM IP Address>/ccmpd/pfdGetList.do?name=#DEVICENAME#

CUCM IP Address is the IP address of the Cisco Unified Communications Manager where the XML service is activated and running. It can either be an IPv4 or an IPv6 address.

5

In the Service Category field, choose XML Service.

6

In the Service Type field, choose whether the service is provisioned to a soft button or a hard key.

  • Standard IP Phone Service: The service will be provisioned to a feature button or softkey on the screen.
  • Directories: Choose this option for directory services. Users can use the Contacts key the Contacts key to access the directories.
  • Messages: Choose this option if you are provisioning messages service to the Messages key the Messages key or the Favorite key the favorite key, depending on phone models.
7

Check the Enable check box.

8

Click Save.

If you change the service URL, remove an IP Phone service parameter, or change the name of a phone service parameter for a phone service to which users are subscribed, you must click Update Subscriptions to update all currently subscribed users with the changes; otherwise, users must resubscribe to the service to rebuild the correct URL.

Subscribe to an XSI service

Before users can access the XSI services, you must subscribe their phones to the services.

Before you begin

The XSI services have been added to your phone system through Cisco Unified CM Administration.

1

Do one of the following actions from Cisco Unified CM Administration:

  • To subscribe service for a specific phone:

    Choose Device > Phone, specify search criteria, click Find, and choose the phone which users will use.

  • To subscribe service for a group of phones:

    Choose Device > Device Settings > Device Profile, specify search criteria, click Find, and choose the desired device profile.

2

From the Related Links drop-down list, choose Subscribe/Unsubscribe Services, and then click Go.

3

From the Select a Service drop-down list, choose the desired service.

4

Click Next, and then Subscribe.

5

Click Save and close the popup window.

Add an XSI service as a shortcut

You can add XSI services as shortcuts on the phone for your users to access them easily by pressing the associated line key or by tapping the shortcut button.

Before you begin

Add and activate the XSI service and subscribe your phones to the service.

1

From Cisco Unified CM Administration, choose Device > Phone, specify search criteria, click Find, and choose the desired phone.

2

In the Association list on the left, click Add a new SURL.

If you don't see the option Add a new SURL available in the display module, click Modify Button Items and add the option to the display module before you proceed.

3

In the Configure Service URL Buttons window, select the desired service in the list and specify a label name for it.

4

Click Save and then close the window.