Getting Started

Cisco BroadWorks is designed, built and operates on open standards. These include developer interfaces based on IETF, 3GPP, ETSI, and other industry RFCs as well as XML-based APIs published and supported by Cisco. This documentation is specific to the Webex Calling Xsi Inferface. Secure access to Webex Calling Xsi is controlled via the Cisco Developer Program (https://developer.webex.com/). For information on developing against the Webex Calling Xsi Interface, please refer to the Webex Calling Xsi Interface Specification.

Xsi Interface

Service providers offer a BroadWorks-based calling service normally consisting of connectivity, features, phone numbers and usage or minutes. The service provider or third-party developers can provide enhanced functionality above the basic service offering through the use of the eXtended Services Interface (Xsi).

BroadWorks Xsi application programming interfaces support the integration of BroadWorks functions to create Web Applications. By adding a public web service interface, the BroadWorks-based voice services can be integrated with Internet services - outside of BroadWorks.

The Xtended Services are a set of RESTful APIs that allows resources to be defined and addressed over HTTP with simple XML. This approach requires less client-side software to be written than other approaches and is the overwhelming choice for developers to create Web Applications.

Xsi is very scalable and designed to be used securely over multiple protocols by different types of applications. The Xsi interface informs external applications when BroadWorks subscriber activity occurs. The notifications occur when an application subscribes for one or more events from a set of available event packages.

The following parts of the Xsi interface are designed to work together to allow developers to create rich web applications:

Xsi-Actions

Xsi-Actions are a set of RESTful APIs that allow access to resources on BroadWorks. All actions are initiated by the clients on a resource and a response is returned from the server. The action may be a modification or retrieval of data. Xsi-Actions expose a broad spectrum of functionality to support a variety of web applications.

The areas exposed are:

Call Management – Exposes real-time call control primitives, such as Click To Dial, Answer, Hold, Transfer, and so on.

Call Status – Exposes the real-time abilities to retrieve the list of active calls and determine the call state of those calls.

Call Lists – Exposes the commonly accessed lists, such as placed, received, and missed call logs, as well as enterprise, group, and personal directories.

Service Management – Exposes the ability to retrieve the settings of user services managed by the BroadWorks Application Server.

Xsi-Events

Xsi-Events is a web application which allows third parties to subscribe to BroadWorks for particular event packages via HTTP. When events occur that have been subscribed to, BroadWorks sends a notification via HTTP to the address specified in the subscription. This allows web applications to receive notifications when resources change state on BroadWorks by another mechanism.

There are two main areas that are exposed:

Call Events – Allows notification of real-time call information on active calls. Notifications are sent when calls are ringing, answered, transferred, and so on.

Service Events – Allows notification when service configuration has changed.