Cisco Unified CallManager Developers Guide
Preface
Downloads: This chapterpdf (PDF - 239.0KB) The complete bookPDF (PDF - 3.65MB) | Feedback

Preface

Table Of Contents

Preface

Purpose

Audience

Organization

New and Changed Information

Related Documentation

Conventions

Obtaining Documentation

Cisco.com

Documentation

Documentation Feedback

Cisco Product Security Overview

Reporting Security Problems in Cisco Products

Obtaining Technical Assistance

Cisco Technical Support Website

Developer Support

Submitting a Service Request

Definitions of Service Request Severity

Obtaining Additional Publications and Information


Preface


This section explains the objectives, intended audience, and organization of this publication and describes the conventions that convey instructions and other information.

This preface includes the following sections:

Purpose

Audience

Organization

New and Changed Information

Related Documentation

Conventions

Obtaining Documentation

Documentation Feedback

Cisco Product Security Overview

Obtaining Technical Assistance

Obtaining Additional Publications and Information

Purpose

The purpose of this document is to describe the following Cisco Unified CallManager APIs:

The Cisco Unified CallManager AXL implementation allows applications to modify the Cisco Unified CallManager system database. AXL is not intended as a real-time API, but as a provisioning and configuration API.

Cisco Unified CallManager Real-Time information, Performance Counters, and Database information exposure occurs through the AXL Serviceability API.

The Cisco Unified CallManager Extension Mobility Service provides a rich API, which enables extension mobility on IP phones and allows application control over authentication, scheduling, and availability. It allows a device, usually a Cisco Unified IP Phone, to temporarily embody a new device profile, including lines, speed dials, and services. An application that uses the CiscoUnified CallManager Extension Mobility Service represents an IP phone service that allows a user to log in by entering a userID and PIN. The architecture and implementation of the CiscoUnified CallManager Extension Mobility Service make many other applications possible.

Some examples are:

An application that automatically activates phones for employees when they reserve a particular desk for a particular time (the scheduling application).

A lobby phone does not have a line appearance until a user logs in.

The Cisco Unified CallManager WebDialer application is installed on a Cisco Unified CallManager server. It enables click-to-dial functionality by creating hyperlinked telephone numbers in a company directory. This functionality allows users to make calls from a web page by clicking on the telephone number of the person they are trying to call.

Audience

The Cisco Unified CallManager Developers Guide provides information for developers who write applications that extend the functionality of the APIs described in this document.

This guide assumes the developer has knowledge of a high-level programming language such as C++, Java, or an equivalent language. You must also have knowledge or experience in the following areas:

Extensible Markup Language (XML)

Hypertext Markup Language (HTML)

Hypertext Transport Protocol (HTTP)

Simple Object Access Protocol (SOAP) 1.1

Socket programming

TCP/IP Protocol

Web Service Definition Language (WSDL) 1.1

In addition, users of the Cisco Unified CallManager APIs must have a firm grasp of XML Schema. For more information on XML Schema, refer to http://www.w3.org/TR/xmlschema-0/.

The developer must also have an understanding of Cisco Unified CallManager and its applications. Documents on Cisco Unified CallManager and other related technologies are listed in the Related Documentation section.

Organization

The following organization applies for this guide.

Table 1 Organization 

Chapter
Description

Chapter 1 "AXL Programming"

This chapter describes the Administrative XML Layer (AXL) API, which provides a mechanism for inserting, retrieving, updating, and removing data from the database using an XML SOAP interface. This allows you to access Cisco Unified CallManager data using XML and receive the data in XML form.

Chapter 2 "AXL Serviceability API Programming"

This chapter describes the AXL Serviceability APIs, which are based on the SOAPISAPI.dll. Cisco Unified CallManager Real-Time information, Performance Counters, and Database information exposure occurs through the AXL Serviceability APIs.

Chapter 3 "Extension Mobility Service API Programming"

This chapter includes high-level concepts that are important in understanding the Cisco Unified CallManager Extension Mobility Service as well as an overview of configuring EM services, messages, message DTDs, and error codes.

Chapter 4 "WebDialer API Programming"

This chapter describes the Simple Object Access Protocol (SOAP) and HTML over HTTP (and HTTPS) interfaces that are used to develop customized directory search applications for Cisco Unified CallManager WebDialer.


New and Changed Information

New features and or changes that are pertinent to release 5.0 of the Cisco Unified CallManager are described in each chapter,

Related Documentation

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

Cisco Unified CallManager Release 5.0—A suite of documents related to the installation and configuration of Cisco Unified CallManager. Refer to the Cisco Unified CallManager Documentation Guide for Release 5.0 for a list of documents on installing and configuring Cisco Unified CallManager 5.0, including:

Cisco Unified CallManager Administration Guide, Release 5.0.

Cisco Unified CallManager System Guide, Release 5.0.

Cisco Unified CallManager Features and Services Guide, Release 5.0.

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

Cisco DistributedDirector—A suite of documents that are related to the installation and configuration of Cisco DistributedDirector.

Related Information

Simple Object Access Protocol (SOAP) 1.1

Web Service Definition Language (WSDL) 1.1

SOAP Tutorial

WSDL Tutorial—Web Service Definition Language tutorial.

http://www.soapagent.com/—Open SOAP directory with links to articles, tutorials, and white papers.

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 non-quoted 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.

< >

Non-printing 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.


Timesavers use the following conventions:


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


Tips use the following conventions:


Tip Means the following are useful tips.


Cautions use the following conventions:


Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Warnings use the following conventions:


Warning This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents.

Obtaining Documentation

Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several ways to obtain technical assistance and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

You can access the most current Cisco documentation at this URL:

http://www.cisco.com/cisco/web/support/index.html

You can access the Cisco website at this URL:

http://www.cisco.com

You can access international Cisco websites at this URL:

http://www.cisco.com/public/countries_languages.shtml

Documentation

You can order Cisco documentation in these ways:

Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Ordering tool:

http://www.cisco.com/en/US/partner/ordering/index.shtml

Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, USA) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).

Documentation Feedback

You can send comments about technical documentation to bug-doc@cisco.com.

You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:

Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883

We appreciate your comments.

Cisco Product Security Overview

Cisco provides a free online Security Vulnerability Policy portal at this URL:

http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html

From this site, you can perform these tasks:

Report security vulnerabilities in Cisco products.

Obtain assistance with security incidents that involve Cisco products.

Register to receive security information from Cisco.

A current list of security advisories and notices for Cisco products is available at this URL:

http://www.cisco.com/go/psirt

If you prefer to see advisories and notices as they are updated in real time, you can access a Product Security Incident Response Team Really Simple Syndication (PSIRT RSS) feed from this URL:

http://www.cisco.com/en/US/products/products_psirt_rss_feed.html

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://www.cisco.com/wwl/export/crypto/tool/stqrg.html.

If you require further assistance please contact us by sending email to export@cisco.com.

Reporting Security Problems in Cisco Products

Cisco is committed to delivering secure products. We test our products internally before we release them, and we strive to correct all vulnerabilities quickly. If you think that you might have identified a vulnerability in a Cisco product, contact PSIRT:

Emergencies — security-alert@cisco.com

Nonemergencies — psirt@cisco.com


Tip We encourage you to use Pretty Good Privacy (PGP) or a compatible product to encrypt any sensitive information that you send to Cisco. PSIRT can work from encrypted information that is compatible with PGP versions 2.x through 8.x.

Never use a revoked or an expired encryption key. The correct public key to use in your correspondence with PSIRT is the one that has the most recent creation date in this public key server list:

http://pgp.mit.edu:11371/pks/lookup?search=psirt%40cisco.com&op=index&exact=on


In an emergency, you can also reach PSIRT by telephone:

1 877 228-7302

1 408 525-6532

Obtaining Technical Assistance

For all customers, partners, resellers, and distributors who hold valid Cisco service contracts, Cisco Technical Support provides 24-hour-a-day, award-winning technical assistance. The Cisco Technical Support Website on Cisco.com features extensive online support resources. In addition, Cisco Technical Assistance Center (TAC) engineers provide telephone support. If you do not hold a valid Cisco service contract, contact your reseller.

Cisco Technical Support Website

The Cisco Technical Support Website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The website is available 24 hours a day, 365 days a year at this URL:

http://www.cisco.com/techsupport

Access to all tools on the Cisco Technical Support Website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a user ID or password, you can register at this URL:

http://tools.cisco.com/RPF/register/register.do

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 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 http://www.cisco.com/go/developersupport/.

Developers using the Cisco Unified CallManager Developers Guide are encouraged to join the Cisco Developer Support Program. This program provides a consistent level of support while leveraging Cisco interfaces in development projects.


Note Cisco Technical Assistance Center (TAC) support does not include Extension Mobility API developer support and is limited to Cisco Unified Communications installation/configuration and Cisco-developed applications. For more information about the Developer Support Program, please contact Cisco at developer-support@cisco.com.


Submitting a Service Request

Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3 and S4 service requests are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Service Request Tool automatically provides recommended solutions. If your issue is not resolved using the recommended resources, your service request will be assigned to a Cisco TAC engineer. The TAC Service Request Tool is located at this URL:

http://www.cisco.com/techsupport/servicerequest

For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone. (S1 or S2 service requests are those in which your production network is down or severely degraded.) Cisco TAC engineers are assigned immediately to S1 and S2 service requests to help keep your business operations running smoothly.

To open a service request by telephone, use one of the following numbers:

Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553 2447

For a complete list of Cisco TAC contacts, go to this URL:

http://www.cisco.com/techsupport/contacts

Definitions of Service Request Severity

To ensure that all service requests are reported in a standard format, Cisco has established severity definitions.

Severity 1 (S1)—Your network is "down," or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.

Severity 2 (S2)—Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.

Severity 3 (S3)—Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.

Severity 4 (S4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.

Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online and printed sources.

Cisco Marketplace provides a variety of Cisco books, reference guides, and logo merchandise. Visit Cisco Marketplace, the company store, at this URL:

http://www.cisco.com/go/marketplace/

The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:

http://cisco.com/univercd/cc/td/doc/pcat/

Cisco Press publishes a wide range of general networking, training and certification titles. Both new and experienced users will benefit from these publications. For current Cisco Press titles and other information, go to Cisco Press at this URL:

http://www.ciscopress.com

Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Each quarter, Packet delivers coverage of the latest industry trends, technology breakthroughs, and Cisco products and solutions, as well as network deployment and troubleshooting tips, configuration examples, customer case studies, certification and training information, and links to scores of in-depth online resources. You can access Packet magazine at this URL:

http://www.cisco.com/packet

Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL:

http://www.cisco.com/ipj

World-class networking training is available from Cisco. You can view current offerings at this URL:

http://www.cisco.com/en/US/learning/index.html