Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 10.0(1)
Downloads: This chapterpdf (PDF - 1.22 MB) The complete bookPDF (PDF - 24.46 MB) | The complete bookePub (ePub - 5.02 MB) | Feedback


This chapter describes the objectives, intended audience, and organization of this document and describes the conventions that convey instructions and other information.


This document describes the Cisco Unified Communications Manager (formerly Cisco Unified CallManager) Java Telephony Application Programming Interface (JTAPI). Cisco Unified JTAPI enables programming interfaces to support different implementations. This document outlines basic Cisco Unified JTAPI concepts including extensions, classes and interfaces.

To implement JTAPI for Cisco Unified Communications Manager, Cisco conforms to the JTAPI Specification v1.2 while providing extensions that enhance JTAPI with the advanced features of Cisco Unified Communications Manager.

As new versions of Cisco Unified Communications Manager and the Cisco Unified JTAPI implementation are released, Cisco maintains stable and reliable API extensions, and as new Cisco Unified Communication Manager features become available, additional extensions are provided.


This document is for developers who write applications that extend the functionality of the APIs that are described in this document.

This document assumes that you have knowledge of the Java language and the Sun JTAPI v 1.2 specification.You must also have knowledge or experience in the following areas:

In addition, as a user of the Cisco Unified Communications Manager APIs, you must have a firm understanding of XML Schema. For more information about XML Schema, refer to http:/​/​​TR/​xmlschema-0/​.

You must have an understanding of Cisco Unified Communications Manager and its applications. See the Related documentation for Cisco Unified Communications Manager documents and other related technologies.


The following table provides an outline of the chapters in this document.




This chapter introduces the major concepts with which you need to be familiar before creating JTAPI applications for Cisco IP Telephony Solutions.

New and changed information

This chapter describes the new and changed features in Cisco Unified Communications Manager releases that are supported by Cisco Unified JTAPI.

Features supported by Cisco Unified JTAPI

This chapter describes additional features that are supported by Cisco Unified JTAPI.

Cisco Unified JTAPI Installation

This chapter describes the Cisco Unified JTAPI installation process.

Hierarchy for all Cisco Unified JTAPI packages

This chapter provides the Hierarchy for All Cisco Unified JTAPI Packages.

Cisco Unified JTAPI extensions

This chapter describes the extensions (interfaces and classes) that are available for implementation in a Cisco Unified Communications Manager.

Cisco Unified JTAPI alarms and services

This chapter describes the alarms and services that are available for implementation in a Cisco Unified Communications Manager.

Cisco Unified JTAPI Examples

This chapter provides the examples of source code for makecall, the Cisco Unified JTAPI program that is used to test the JTAPI installation.

Message sequence charts

This appendix contains message flow diagrams.

Cisco Unified JTAPI classes and interfaces

This appendix contains a listing of all the classes and interfaces that are available in Cisco Unified JTAPI.

Troubleshooting Cisco Unified JTAPI

This appendix contains CTI Error Codes, CiscoEvent IDs, and other troubleshooting information.

Cisco Unified JTAPI Operations by Release

This appendix contains a list of supported, unsupported, changed, and "under consideration or review" by Cisco Unified Communications Manager release.

CTI supported devices

This appendix contains a list of CTI supported devices.

Constant field values

This appendix lists the static final fields and their values.


This appendix provides details of the JTAPI caveats that are common across releases and those that are release-specific.

Deprecated API

This appendix lists deprecated APIs, fields, and methods.

Related documentation

This section lists documents and URLs that provide information on Cisco Unified Communications Manager, Cisco Unified IP Phones, and the technologies that are required to develop applications.

Related information

To obtain the latest version of the complete Sun Microsystems JTAPI specification files, go directly to http:/​/​​products/​jtapi.

Cisco Developer Network

The Cisco Developer Network (CDN) portal provides access to multiple Cisco technology developer interfaces and collaborative support communities. CDN also provides formalized support services for these interfaces to enable developers, customers, and partners to accelerate their development. The formalized process provides access to CDN Engineers who are an extension of the product technology engineering teams. CDN Engineers have access to the resources necessary to provide expert support in a timely manner.

The Cisco Developer Network Program is designed for businesses (IHV's and ISV's) interested in going to market with Cisco. The CDN Program enables members to develop compelling solutions that unify data, voice, video, and mobile communications on Cisco's powerful communications platform. The program also allows members to take advantage of Cisco's brand, market leadership position, and installed base to help drive positive business results for themselves and their customers.

For additional information about the CDN Program and CDN support services go to http:/​/​​web/​devservices.


This document uses the following conventions:



boldface font

Commands and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

[   ]

Elements in square brackets are optional.

{ x | y | z }

Alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ]

Optional alternative keywords are grouped in brackets and separated by vertical bars.


A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

screen font

Terminal sessions and information the system displays are in screen font.

boldface screen font

Information you must enter is in boldface screen font.

italic screen font

Arguments for which you supply values are in italic screen font.


The symbol ^ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.

<   >

Nonprinting characters, such as passwords are in angle brackets.

Notes use the following conventions:


Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.

Tips use the following conventions:


Means the following are useful tips.

Obtaining documentation and submitting a service request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:


Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.

Cisco product security overview

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.

A summary of U.S. laws governing Cisco cryptographic products may be found at: http:/​/​​wwl/​export/​crypto/​tool/​stqrg.html.

If you require further assistance please contact us by sending email to