Cisco Unified TAPI Developers Guide for Cisco Unified Communications Manager Release 7.0(1)
Downloads: This chapterpdf (PDF - 132.0 KB) The complete bookPDF (PDF - 8.21 MB) | Feedback


Table Of Contents



This chapter describes the purpose, intended audience, and organization of this document and describes the conventions that convey instructions and other information. It contains the following topics:




Related Documentation

Developer Support


Obtaining Documentation, Obtaining Support, and Security Guidelines

Cisco Product Security Overview

OpenSSL/Open SSL Project


This document describes the Cisco Unified TAPI implementation by detailing the functions that comprise the implementation software and illustrating how to use these functions to create applications that support the Cisco Unified Communications hardware, software, and processes. You should use this document with the Cisco Unified Communications Manager manuals to develop applications.


Cisco intends this document to be for use by telephony software engineers who are developing Cisco telephony applications that require TAPI. This document assumes that the engineer is familiar with both the C or C++ languages and the Microsoft TAPI specification.

This document assumes that you have knowledge of C or C++ languages and the Microsoft TAPI specification.You must also have knowledge or experience in the following areas:

Extensible Markup Language (XML)

Hypertext Markup Language (HTML)

Hypertext Transport Protocol (HTTP)

Socket programming

TCP/IP Protocol

Web Service Definition Language (WSDL) 1.1

Secure Sockets Layer (SSL)

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

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



Chapter 1, "Overview"

Outlines key concepts for Cisco Unified TAPI and lists all functions that are available in the implementation.

Chapter 2, "New and Changed Information"

Provides a list new and changed features release-by-release of Cisco Unified Communications Manager.

Chapter 4, "Cisco Unified TAPI Installation"

Provides installation procedures for Cisco Unified TAPI and Cisco Unified TSP.

Chapter 5, "Basic TAPI Implementation"

Describes the supported functions in the Cisco implementation of standard Microsoft TAPI v2.1.

Chapter 6, "Cisco Device-Specific Extensions"

Describes the functions that comprise the Cisco hardware-specific implementation classes.

Chapter 7, "Cisco Unified TAPI Examples"

Provides examples that illustrate the use of the Cisco Unified TAPI implementation.

Appendix A, "Message Sequence Charts"

Lists possible call scenarios and use cases.

Appendix B, "Cisco Unified TAPI Interfaces"

Lists APIs that are supported or not supported.

Appendix C, "Troubleshooting Cisco Unified TAPI"

Describes troubleshooting techniques.

Appendix D, "Cisco Unified TAPI Matrices"

Lists features, line functions, messages, and structures; phone functions, messages, and structures that have been added or modified by Cisco Unified Communications Manager release.

Appendix E, "CTI Supported Devices"

Lists CTI supported devices.

Related Documentation

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

Cisco Unified Communications Manager Release 7.0(1)—A suite of documents that relate to the installation and configuration of Cisco Unified Communications Manager. Refer to the Cisco Unified Communications Manager Documentation Guide for Release 7.0(1)for a list of documents on installing and configuring Cisco Unified Communications Manager 7.0(1), including:

Cisco Unified Communications Manager Administration Guide, Release 7.0(1).

Cisco Unified Communications Manager System Guide, Release 7.0(1).

Cisco Unified Communications Manager Features and Services Guide, Release 7.0(1).

Cisco Unified Communications Manager Release Notes, Release 7.0(1).

Cisco Unified IP Phones and Services—A suite of documents that relate to the installation and configuration of Cisco Unified IP Phones.

Cisco Distributed Director—A suite of documents that relate to the installation and configuration of Cisco Distributed Director.

For more information about TAPI specifications, creating an application to use TAPI, or TAPI administration, see the following documents:

Microsoft TAPI 2.1 Features:

Getting Started with Windows Telephony

Windows Telephony API (TAPI)

Creating Next Generation Telephony Applications:

The Microsoft Telephony Application Programming Interface (TAPI) Programmer's Reference

"For the Telephony API, Press 1; For Unimodem, Press 2; or Stay on the Line" —A paper on TAPI by Hiroo Umeno, a COMM and TAPI specialist at Microsoft.

"TAPI 2.1 Microsoft TAPI Client Management"

"TAPI 2.1 Administration Tool"

Developer Support

The Developer Support Program provides formalized support for Cisco Systems interfaces to enable developers, customers, and partners in the Cisco Service Provider solutions Ecosystem and Cisco AVVID Partner programs to accelerate their delivery of compatible solutions.

The Developer Support Engineers are an extension of the product technology engineering teams. They have direct access to the resources necessary to provide expert support in a timely manner.

For additional information on this program, refer to the Developer Support Program web site at


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.


An unquoted 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 that 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.

Tip Means the following information might help you solve a problem.

Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.

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

OpenSSL/Open SSL Project

The following link provides information about the OpenSSL notice: