Cisco Unified Communications Manager XML Developers Guide Release 7.1(2)
Overview
Downloads: This chapterpdf (PDF - 107.0KB) The complete bookPDF (PDF - 7.76MB) | Feedback

Overview

Table Of Contents

Overview

Cisco Unifed Communications Manager Interfaces

Provisioning Interfaces

Administrative XML

Cisco Extension Mobility

Device Monitoring and Call Control Interfaces

Cisco TAPI and Wave Driver

Cisco JTAPI

Cisco Web Dialer

Serviceability Interfaces

Serviceability XML

SNMP/MIBs

What is New in Unified CM 7.1(2) API

Adminstrative XML

Extension Mobility

Cisco WebDialer

Serviceability XML


Overview


Cisco Unified Communications Manager (Unified CM) is the powerful call-processing component of the Cisco Unified Communications Solution. It is a scalable, distributable, and highly available enterprise IP telephony call-processing solution. Unified CM acts as the platform for collaborative communication and as such supports a wide array of features. In order to provision, invoke the features, monitor, and control such a powerful system, Unified CM supports different interface types.

This chapter gives an introduction to the different interfaces of Unified CM and includes the following sections:

Cisco Unifed Communications Manager Interfaces

What is New in Unified CM 7.1(2) API

Cisco Unifed Communications Manager Interfaces

The interface types supported by Unified CM are divided into the following types:

Provisioning interfaces

Device monitoring and call control interfaces

Serviceability interfaces

Provisioning Interfaces

The following are the provisioning interfaces of Unified CM:

Administration XML

Cisco Extension Mobility service

Administrative XML

The Administration XML (AXL) API provides a mechanism for inserting, retrieving, updating and removing data from the Unified CM configuration database using an eXtensible Markup Language (XML) Simple Object Access Protocol (SOAP) interface. This allows a programmer to access Unified CM provisioning services using XML and exchange data in XML form, instead of using a binary library or DLL. The AXL methods, referred to as requests, are performed using a combination of HTTP and SOAP. SOAP is an XML remote procedure call protocol. Users perform requests by sending XML data to the Unified CM Publisher server. The publisher then returns the AXL response, which is also a SOAP message.

This guide gives detailed information on the AXL API see Part 1, Administrative XML.

Cisco Extension Mobility

The Cisco Extension Mobility (Extension Mobility) service, a feature of Unified CM, allows a device, usually a Cisco Unified IP Phone, to temporarily embody a new device profile, including lines, speed dials, and services. It enables users to temporarily access their individual Cisco Unified IP Phone configuration, such as their line appearances, services, and speed dials, from other Cisco Unified IP Phones. The Extension Mobility service works by downloading a new configuration file to the phone. Unified CM dynamically generates this new configuration file based on information about the user who is logging in. You can use the XML-based Extension Mobility service API with your applications, so they can take advantage of Extension Mobility service functionality.

This guide gives detailed information on the Extension Mobility APIs, see Part 3, Cisco Extension Mobility API.

Device Monitoring and Call Control Interfaces

The following are the device monitoring and call control interfaces of Unified CM:

Cisco TAPI and Wave Driver

Cisco JTAPI

Cisco Web Dialer

Cisco TAPI and Wave Driver

Unified CM exposes sophisticated call control of IP telephony devices and soft-clients via the Computer Telephony TAPI interface. Cisco's Telephone Service Provider (TSP) and Wave Driver interface enables custom applications to monitor telephony-enabled devices and call events, establish first- and third-party call control, and interact with the media layer to terminate media, play announcements, record calls.

Information on Cisco TAPI and Wave Driver is beyond the scope of this guide. For information of Cisco TAPI and Wave Driver, see Cisco Unified TAPI Developers Guide for Cisco Unified Communications Manager for relevant release of Unifed CM at the following location:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/products_programming_reference_guides_list.html

Cisco JTAPI

Unified CM exposes sophisticated call control of IP telephony devices and soft-clients via the Computer Telephony JTAPI interface. Cisco's JTAPI enables custom applications to monitor telephony-enabled devices and call events, as well as establish first- and third-party call control.

Information on Cisco JTAPI is beyond the scope of this guide. For information on Cisco JTAPI, see Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager for relevant release of Unifed CM at the following location:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/products_programming_reference_guides_list.html

Cisco Web Dialer

The Web Dialer, which is installed on a Unifed CM server, allows Cisco Unified IP Phone users to make calls from web and desktop applications. For example, the Web Dialer uses hyperlinked telephone numbers in a company directory to allow users to make calls from a web page by clicking the telephone number of the person that they are trying to call. The two main components of Web Dialer comprise the Web Dialer Servlet and the Redirector Servlet.

This guide gives detailed information on the Web Dialer API, see Part 4, Cisco Web Dialer API.

Serviceability Interfaces

The following are the serviceability interfaces of Unified CM:

Serviceability XML

SNMP/MIBs

Serviceability XML

A collection of services and tools designed to monitor, diagnose, and address issues specific to Unified CM. serviceabiltiy XML interface:

Provides platform, service and application performance counters to monitor the health of Unified CM hardware and software

Provides real-time device and CTI connection status to monitor the health of phones, devices, and applications connected to Unified CM.

Enables remote control (Start/Stop/Restart) of Unified CM services.

Collects and packages Unified CM trace files and logs for troubleshooting and analysis.

Provides applications with Call Detail Record files based on search criteria.

Provides management consoles with SNMP data specific to Unified CM hardware and software.

This guide gives detailed information on the Serviceability XML APIs, see Part 2, Serviceability API.

SNMP/MIBs

SNMP interface allows external applications to query and report various UCMgr entities. It provides information on the connectivity of the Unified Communication Manager to other devices in the network, including syslog information.

The MIBs supported by Unified CM includes:

Cisco-CCM-MIB, CISCO-CDP-MIB, Cisco-syslog-MIB

Standard Mibs like MIB II, SYSAPPL-MIB, HOST RESOURCES-MIB

Vendor MIBs

What is New in Unified CM 7.1(2) API

This section gives information about the chnages in the following APIs for the Unified CM release 7.1.2:

Administrative XML

Extension Mobility

Cisco WebDialer

Serviceability XML


Note Information on the Cisco JTAPI andthe Cisco TAPI and Wave Driver API changes are beyond the scope of this guide.
For information of Cisco TAPI and Wave Driver, see Cisco Unified TAPI Developers Guide for Cisco Unified Communications Manager and for information on Cisco JTAPI, see Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager for relevant release of Unifed CM at the following location:
http://www.cisco.com/en/US/products/sw/voicesw/ps556/products_programming_reference_guides_list.html


Adminstrative XML

For Unified CM release 7.1.2, the following changes are made in the Administarive XML APIs:

The following new APIs are added:

GeoLocation (add, get, remove, and update operations)

GeoLocationPolicy (add, get, remove, and update operations)

GeoLocationFilter (add, get, remove, and update operations)

CommonPhoneConfig (add, get, remove, and update operations)

The following APIs are updated:

Line (add, get, and update operations)

HuntPilot (add, get, and update operations)

H323Gateway (add, get, and update operations)

H323Gateway

updateH323Gateway

getH323Gateway

H323Trunk

CommonDeviceConfig

SIPProfile

ProcessNode

SIPRoutePattern

Phone

H323Phone

GatewayEndpoint

MGCP

MGCPEndpoint

SIPTrunk

VG224

DevicePool

DeviceProfile

For the detailed description of the changes for Administartive XML APIs, see New Information for Cisco Unified Communications Manager 7.1(2), page 2-4.

Extension Mobility

There are no changes in Cisco Extension Mobility APIs for Unified CM 7.1(2).

Cisco WebDialer

There are no changes in Cisco Web Dialer APIs for Unified CM 7.1(2).

Serviceability XML

For Unified CM release 7.1.2, the following changes are made in the Administarive XML APIs:

New service URL added

The following new APIs are added:

SelectCmDevice

SelectCtiDevice

New perfmon counters added

Introduced new phone seamless upgrade information

For the detailed description of the changes for Serviceability XML APIs, see New Information for Cisco Unified Communications Manager 7.1(2), page 4-2.