Cisco Unified Communications Manager JTAPI Developers Guide
Downloads: This chapterpdf (PDF - 373.0KB) The complete bookPDF (PDF - 13.21MB) | Feedback


Table Of Contents



This chapter introduces the Cisco Unified JTAPI implementation for Cisco Unified Communications Manager (formerly Cisco Unified CallManager) Release 6.0 and later releases, describes the purpose of this book, and outlines the required software. The chapter includes the following topics:





New and Changed Information

Related Documentation

Required Software


Obtaining Documentation, Obtaining Support, and Security Guidelines

Cisco Product Security Overview


The Cisco Unified Java Telephony Application Programming Interface (JTAPI) acts as a portable, object-oriented API for computer telephony integrated call control. The package of JTAPI interfaces, located in the javax.telephony.* hierarchy, defines a programming model by which Java applications can interact with telephony resources such as PBXs and telephones. The Cisco Unified JTAPI implementation supports Java application access to the Cisco architecture for voice, video and data communication systems according to the JTAPI v 1.2 specification. Furthermore, Cisco Unified JTAPI exposes Cisco-specific events and methods for certain telephony resources such as calls and connections.


Providing an unchanging programming interface under which varied implementations may stand represents one of the primary goals of a standard Application Programming Interface (API) such as JTAPI. In implementing JTAPI for the Cisco Unified Communications Manager platform, Cisco tries to conform as closely as possible to the JTAPI specification while providing extensions that enhance JTAPI and expose the advanced features of Cisco Unified Communications Manager to applications.

As new versions of Cisco Unified Communications Manager and the Cisco Unified JTAPI implementation are released, variances in the API should be very minor and should tend in the direction of compliance. Cisco remains committed to maintaining its API extensions with the same stability and reliability, though additional extensions may be provided as new Cisco Unified Communications Manager features become available.

This document outlines some basic JTAPI concepts including transfer and conference extensions. It also describes the support of extensions to the Sun JTAPI v 1.2 specification.


The following table provides an outline of this document's organization.


Chapter 1, "Overview"

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

Chapter 2, "Backward Compatibility"

This chapter describes the features that assist you in writing applications that will remain backwards compatible with future Cisco JTAPI updates.

Chapter 3, "Cisco Unified JTAPI Installation"

This chapter describes the installation procedures.

Chapter 4, "Cisco Unified JTAPI Implementation"

This chapter describes the JTAPI interfaces and classes that are available in the implementation.

Chapter 5, "Cisco Unified JTAPI Examples"

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

Appendix A, "Message Sequence Charts"

This appendix contains message flow diagrams.

Appendix B, "Cisco Unified JTAPI Classes and Interfaces"

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

Appendix C, "Troubleshooting Cisco Unified JTAPI"

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


This document applies for telephony software developers who are developing Cisco Unified Communications applications that require JTAPI. This document assumes that the programmer is familiar with both the Java language and the Sun JTAPI v 1.2 specification.

New and Changed Information

New features or changes for Cisco Unified JTAPI are described in the Release Notes for the specified release of Cisco Unified Communications Manager.

Related Documentation

To obtain the latest version of the complete Sun Microsystems JTAPI specification files, go directly to the following web site:

Required Software

The following table lists the software requirements for JTAPI applications, JTPREFS, and sample code.


Required Software


Any JDK 1.4.2 compliant java environment

Internet Explorer 4.01 or later

Sun JDK 1.4.2 or 1.5


Any JDK 1.4.2 compliant environment.


Sample code

Microsoft Internet Explorer 4.01 or later



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.


This pointer highlights an important line of text in an example.


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:

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

Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

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: .

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