Cisco CallManager 3.0 JTAPI Developer Guide
Preface
Downloads: This chapterpdf (PDF - 159.0KB) The complete bookPDF (PDF - 2.06MB) | Feedback

Preface

Table Of Contents

Preface

Introduction

Purpose

Audience

Organization

Related Documentation

Required Software

Conventions

Obtaining Documentation

World Wide Web

Documentation CD-ROM

Ordering Documentation

Obtaining Technical Assistance

Cisco Connection Online

Technical Assistance Center

Documentation Feedback


Preface


This chapter introduces Cisco JTAPI implementation, describes the purpose of this document, and outlines the required software. The following topics are included:

Introduction

Purpose

Audience

Organization

Related Documentation

Required Software

Conventions

Obtaining Documentation

Obtaining Technical Assistance

Introduction

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

Purpose

One of the primary goals of a standard Application Programming Interface (API) such as JTAPI is to provide an unchanging programming interface under which varied implementations may stand. Cisco's goal in implementing JTAPI for the CallManager platform is to conform as closely as possible to the JTAPI specification, while providing extensions that enhance JTAPI and expose the advanced features of Cisco CallManager to applications.

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

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

Audience

This document is intended for telephony software developers who are developing Cisco IP Telephony 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.

Organization

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

Chapter
Description

Chapter 1, "JTAPI Concepts"

Important concepts to understand before starting to write JTAPI applications for Cisco IP Telephony.

Chapter 2, "Cisco JTAPI Extensions"

Cisco extension classes and interfaces. Includes a list of the classes and interfaces in a hierarchical format and a detailed description of each class or interface.

Chapter 3, "Cisco JTAPI Trace Logging"

Exception tracing API reference information for each class.

Chapter 4, "Cisco JTAPI Examples"

Source code for makecall, the Cisco JTAPI program that tests the JTAPI installation.

Appendix A, "Cisco JTAPI Classes and Interfaces"

Lists of all the classes and interfaces available in the Cisco JTAPI implementation for Cisco CallManager.

Appendix B, "CTI Error Codes"

Lists and describes CTI error codes.


Related Documentation

The companion document Cisco JTAPI Developer Reference (JTAPI v 1.2 Specification) contains the Sun JTAPI specification for the supported interfaces and classes and their respective methods. The specification was downloaded from the Sun JTAPI web site and included in this document set as a convenience to Cisco  JTAPI programmers. Note that the writing style in that book conforms to the Sun specification, it does not conform to the Cisco writing style.

To obtain the very latest version of the JTAPI specification files, go directly to the web site at:

The Sun Microsystems Inc. JTAPI v 1.2 specification
http://java.sun.com/products/jtapi/jtapi-1.2/packages.html

Required Software

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

.

Application
Required Software
Examples

JTAPI applications

Any JDK 1.1 compliant java environment

Microsoft Internet Explorer 4.01 or later

Sun JDK 1.1, 1.2, or 1.3

JTPREFS

Microsoft Internet Explorer 4.01 or later

 

Sample code

Microsoft Internet Explorer 4.01 or later

 

Conventions

This document uses the following conventions:

Convention
Description

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.

string

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

World Wide Web

You can access the most current Cisco documentation on the World Wide Web at http://www.cisco.com, http://www-china.cisco.com, or http://www-europe.cisco.com.

Documentation CD-ROM

Cisco documentation and additional literature are available in a CD-ROM package, which ships with your product. The Documentation CD-ROM is updated monthly. Therefore, it is probably more current than printed documentation. The CD-ROM package is available as a single unit or as an annual subscription.

Ordering Documentation

Registered CCO users can order the Documentation CD-ROM and other Cisco Product documentation through our online Subscription Services at http://www.cisco.com/cgi-bin/subcat/kaojump.cgi.

Nonregistered CCO users can order documentation through a local account representative by calling Cisco's corporate headquarters (California, USA) at 408 526-4000 or, in North America, call 800 553-NETS (6387).

Obtaining Technical Assistance

Cisco provides Cisco Connection Online (CCO) as a starting point for all technical assistance. Warranty or maintenance contract customers can use the Technical Assistance Center. All customers can submit technical feedback on Cisco documentation using the web, e-mail, a self-addressed stamped response card included in many printed docs, or by sending mail to Cisco.

Cisco Connection Online

Cisco continues to revolutionize how business is done on the Internet. Cisco Connection Online is the foundation of a suite of interactive, networked services that provides immediate, open access to Cisco information and resources at anytime, from anywhere in the world. This highly integrated Internet application is a powerful, easy-to-use tool for doing business with Cisco.

CCO's broad range of features and services helps customers and partners to streamline business processes and improve productivity. Through CCO, you will find information about Cisco and our networking solutions, services, and programs. In addition, you can resolve technical issues with online support services, download and test software packages, and order Cisco learning materials and merchandise. Valuable online skill assessment, training, and certification programs are also available.

Customers and partners can self-register on CCO to obtain additional personalized information and services. Registered users may order products, check on the status of an order and view benefits specific to their relationships with Cisco.

You can access CCO in the following ways:

WWW: www.cisco.com

Telnet: cco.cisco.com

Modem using standard connection rates and the following terminal settings: VT100 emulation; 8 data bits; no parity; and 1 stop bit.

From North America, call 408 526-8070

From Europe, call 33 1 64 46 40 82

You can e-mail questions about using CCO to cco-team@cisco.com.

Technical Assistance Center

The Cisco Technical Assistance Center (TAC) is available to warranty or maintenance contract customers who need technical assistance with a Cisco product that is under warranty or covered by a maintenance contract.

To display the TAC web site that includes links to technical support information and software upgrades and for requesting TAC support, use www.cisco.com/techsupport.

To contact by e-mail, use one of the following:

Language
E-mail Address

English

tac@cisco.com

Hanzi (Chinese)

chinese-tac@cisco.com

Kanji (Japanese)

japan-tac@cisco.com

Hangul (Korean)

korea-tac@cisco.com

Spanish

tac@cisco.com

Thai

thai-tac@cisco.com


In North America, TAC can be reached at 800 553-2447 or 408 526-7209. For other telephone numbers and TAC e-mail addresses worldwide, consult the following web site: http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml.

Documentation Feedback

If you are reading Cisco product documentation on the World Wide Web, you can submit technical comments electronically. Click Feedback in the toolbar and select Documentation. After you complete the form, click Submit to send it to Cisco.

You can e-mail your comments to bug-doc@cisco.com.

To submit your comments by mail, for your convenience many documents contain a response card behind the front cover. Otherwise, you can mail your comments to the following address:

Cisco Systems, Inc.
Document Resource Connection
170 West Tasman Drive
San Jose, CA 95134-9883

We appreciate and value your comments.