Views

Developer Program - OpenScape Voice

The Wiki of Unify contains information on clients and devices, communications systems and unified communications. - Unify GmbH & Co. KG is a Trademark Licensee of Siemens AG.

Revision as of 12:28, 24 June 2014 by Robert Hofstetter (talk | contribs) (→‎CSTA Interface)
Jump to: navigation, search

You are here:  

Icon linkarrow.gif Home  Icon linkarrow.gif Developer Program - OpenScape Voice l-de.gif  Diese Seite auf Deutsch


OpenScape Voice OpenScape UC
Integration Connectors OpenScape 4000 OpenStage Deployment Service

On this page you will find links to information on the various open interfaces of OpenScape Voice.

Call Control related interfaces of OpenScape Voice include SIP for first party call control and CSTA for 3rd party call control. Administrative interfaces are SOAP/XML based, and allow applications to query OpenScape Voice for the content of its system, subscriber and translation database, as well as to provision users and administer features against them.

Access to all the developer resources for each interface are available below.


Please join our expert-monitored OpenScape Voice Community Forum to share thoughts, ideas and tips or ask specific questions.


QSIG Interface

This QSIG Interface Specification describes the OpenScape Voice support of QSIG including basic call, generic functions, supplementary services and PICS.

SIP Interface to Phones

Interface Specification

The goal of this document is to provide a specification for the SIP client interface, which is the interface by which clients (e.g., wired phones, wireless phones, soft clients, etc.) communicate using SIP with a Unify OpenScape Voice SIP server.



SIP Interface to Service Providers

The goal of this document is to describe the SIP interface used between an OpenScape Voice system and a Service Provider (SP). The Service Provider (SP) interface may be used only to provide PSTN access, or may also be used to provide SIP interconnection, via the SP, to subscribers in other branches of the same Enterprise or in other Enterprises.

Interface Specification


CSTA Interface

The CSTA interface provides a standard abstraction layer for telecoms applications. Below you will find the interface specifications and a SDK help you get creating CSTA apps in no time.

For more information on the CSTA please check out the CSTA overview presentation below:

Interface Manual


CSTA SDK

The OpenScape Voice Server CSTA-SDK provides a set of API’s to help simplify the development of Java based applications to control the OpenScape Voice server call control capabilities through the use of CSTA. It provides simple API's to access the most used call control features exposed in the OSV CSTA Interface. The OSV Server CSTA-SDK connects directly to the OpenScape Voice server via raw TCP.

The zip file below has been created for download to a development environment and contains the jar file as well as a self contained HTML documentation package created from Javadoc. The documentation explains also how the users can link the Javadoc documentation directly to their IDE to utilize it during coding.

zip.png  CSTA SDK 1.4.0
pdf.png  What’s new on this version


If you have any questions or comments or seek advice on CSTA related topics then feel free to post in the [CSTA Interface sub-forum].

Call Detail Recording Interface

This Document provides an overview of Call Detail Recording (CDR) for OpenScape Voice, its function and its features.

Call Detail Records (CDR) are a collection of information for each call that is processed by OpenScape Voice. More complex call scenarios such as transfer, conference, networking, and other OpenScape Voice features may produce multiple CDRs. This information is collected in order to:

  • Track bill-back accounting (for extension, department, division, or company)
  • Track and identify special common carrier services (track telephone numbers and call duration to specific locations)
  • Track client or user identification (for example, account numbers)
  • Track system traffic for analysis (call patterns and other routing information)
  • Track and identify call abuse (unauthorized calls)
  • Track calls for different states (answered, unanswered, rejected) and call scenarios (transfer, call forward, callback, and so on).

Interface Manual


SOAP/XML Subscriber Provisioning Interface

Subscriber provisioning is the management of subscriber data on the OpenScape Voice server, which is managed by a component referred to as the SOAP Server.

The SOAP (Simple Object Access Protocol) Server is an integrated component of the OpenScape Voice system whose function is to handle provisioning requests for subscriber, endpoint, and business group data, including the creation, deletion, modification, and display of these entities and their associated features, or services. The SOAP Server expects SOAP/XML requests conforming to the SOAP Server WSDL (Web Services Definition Language) file, which is included as a product deliverable and is made available to external interface partners. In particular, the OpenScape Voice Assistant uses this interface to transmit provisioning requests from the user to the OpenScape Voice system.

Web SDK Programming Overview

Interface Manual

WSDL Files

In case you would like a specific WSDL version, or if you are simply seeking advice on the use of the resources above, feel free to post in the [SOAP Provisioning Interface sub-forum].

SNMP and MIB Description

This document lists the SNMP Traps generated by the OpenScape Voice system via the OpenScape Voice Assistant. The system generates traps to alert management stations that important events have been detected. The OpenScape Voice supports the SNMP v2 trap format. Many of the faults the system generates are derived from these SNMP traps.

Interface Manual


OSV Assistant API

The administration of the OpenScape Voice system is done by the OpenScape Voice Assistant, a web based administration interface. Because there are service and customer scenarios where automatic changes of special OpenScape Voice settings are required by ’foreign’ applications, the OpenScape Voice Assistant also offers a web services interface called OpenScape Voice Assistant API.

This API provides a WSDL (Web Service Description Language) file describing all possible operations and all data structures used.

API Description


In case you miss a specific version of any document, please contact developerprogram@unify.com.
Retrieved from "http://wiki.unify.com/index.php?title=Developer_Program_-_OpenScape_Voice&oldid=42109"