Views

Difference between revisions of "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.

Jump to: navigation, search
(Changed e-mail addess)
(CSTA SDK)
 
(14 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
__NOTOC__
 
__NOTOC__
 
<p style="text-align:right"> [[Entwicklerprogramm_-_OpenScape_Voice |OpenScape Voice]] | [[Entwicklerprogramm_-_OpenScape_SBC|OpenScape SBC]] | [[Entwicklerprogramm_-_OpenScape_Branch|OpenScape Branch]] | [[Entwicklerprogramm_-_OpenScape_4000|OpenScape 4000]] <br/>
 
<p style="text-align:right"> [[Entwicklerprogramm_-_OpenScape_Voice |OpenScape Voice]] | [[Entwicklerprogramm_-_OpenScape_SBC|OpenScape SBC]] | [[Entwicklerprogramm_-_OpenScape_Branch|OpenScape Branch]] | [[Entwicklerprogramm_-_OpenScape_4000|OpenScape 4000]] <br/>
[[Entwicklerprogramm_-_OpenScape_UC|OpenScape UC]] | [[Entwicklerprogramm_-_Integration_Connectors|OSCC-E Integration Connectors]] |  [[Entwicklerprogramm_-_OpenStage|OpenStage]] | [[Entwicklerprogramm_-_DLS|Deployment Service]] </p>
+
[[Entwicklerprogramm_-_OpenScape_UC|OpenScape UC]] | [[Entwicklerprogramm_-_Integration_Connectors|OSCC-E Integration Connectors]] |  [[Entwicklerprogramm_-_OpenStage|OpenStage]] | [[Developer_Program_-_OSCC|OpenScape Contact Center]] </p>
  
 
On this page you will find links to information on the various open interfaces of OpenScape Voice.
 
On this page you will find links to information on the various open interfaces of OpenScape Voice.
Line 19: Line 19:
 
This QSIG Interface Specification describes the OpenScape Voice support of QSIG including basic call, generic functions, supplementary services and PICS.
 
This QSIG Interface Specification describes the OpenScape Voice support of QSIG including basic call, generic functions, supplementary services and PICS.
  
 +
* {{File-DL|OpenScape Voice V10, QSIG Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, QSIG Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, QSIG Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, QSIG Interface Manual|pdf}}  
 
* {{File-DL|OpenScape Voice V8, QSIG Interface Manual|pdf}}  
Line 32: Line 33:
 
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.
 
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.
  
 
+
* {{File-DL|OpenScape Voice V10, SIP to Phones Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, SIP to Phones Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, SIP to Phones Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, SIP to Phones Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, SIP to Phones Interface Manual|pdf}}
Line 46: Line 47:
 
=== Interface Specification ===
 
=== Interface Specification ===
  
 +
* {{File-DL|OpenScape Voice V10, SIP to SP Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, SIP to SP Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, SIP to SP Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, SIP to SP Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, SIP to SP Interface Manual|pdf}}
Line 62: Line 64:
 
=== Interface Manual ===
 
=== Interface Manual ===
  
 +
* {{File-DL|OpenScape Voice V10, CSTA Interface Manual|zip}}
 
* {{File-DL|OpenScape Voice V9, CSTA Interface Manual|zip}}
 
* {{File-DL|OpenScape Voice V9, CSTA Interface Manual|zip}}
 
* {{File-DL|OpenScape Voice V8, CSTA Interface Manual|zip}}
 
* {{File-DL|OpenScape Voice V8, CSTA Interface Manual|zip}}
Line 74: Line 77:
 
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.
 
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.
  
{{File-DL|openscape-csta-sdk-1.6.0|zip||CSTA SDK 1.6.0}}
+
{{File-DL|openscape-csta-sdk-1.6.1|zip||CSTA SDK 1.6.1}}
<br/>{{File-DL|openscape-csta-sdk-1.6.0|pdf ||What’s new on this version}}
+
<br/>{{File-DL|openscape-csta-sdk-1.6.1|pdf ||What’s new on this version}}
  
 
=== ECMA-348 (WSDL) for CSTA Phase III ===
 
=== ECMA-348 (WSDL) for CSTA Phase III ===
Line 98: Line 101:
 
=== Interface Manual ===
 
=== Interface Manual ===
  
 +
* {{File-DL|OpenScape Voice V10, CDR Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, CDR Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, CDR Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, CDR Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, CDR Interface Manual|pdf}}
Line 114: Line 118:
 
=== Web SDK Programming Overview ===
 
=== Web SDK Programming Overview ===
  
 +
 +
* {{File-DL|OpenScape Voice v10 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v10 SOAP/XML Application Developers Manual}}
 +
* {{File-DL|OpenScape Voice v9 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v9 SOAP/XML Application Developers Manual}}
 +
* {{File-DL|OpenScape Voice v8 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v8 SOAP/XML Application Developers Manual}}
 
* {{File-DL|OpenScape Voice v7 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v7 SOAP/XML Application Developers Manual}}
 
* {{File-DL|OpenScape Voice v7 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v7 SOAP/XML Application Developers Manual}}
* {{File-DL|OpenScape Voice v8 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v8 SOAP/XML Application Developers Manual}}
 
* {{File-DL|OpenScape Voice v9 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v9 SOAP/XML Application Developers Manual}}
 
* {{File-DL|OpenScape Voice v10 SOAP-XML Application Developers Manual|pdf||OpenScape Voice v10 SOAP/XML Application Developers Manual}}
 
  
 
=== Interface Manual ===
 
=== Interface Manual ===
Line 142: Line 147:
 
=== Interface Manual ===
 
=== Interface Manual ===
  
 +
* {{File-DL|OpenScape Voice V10, SNMP and MIB Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, SNMP and MIB Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V9, SNMP and MIB Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, SNMP and MIB Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, SNMP and MIB Interface Manual|pdf}}
Line 157: Line 163:
 
* {{File-DL|OpenScape Voice V9R0 MIB files|zip}}
 
* {{File-DL|OpenScape Voice V9R0 MIB files|zip}}
 
* {{File-DL|OpenScape Voice V9R1 MIB files|zip}}
 
* {{File-DL|OpenScape Voice V9R1 MIB files|zip}}
 +
* {{File-DL|OpenScape Voice V10R0 MIB files|zip}}
 +
* {{File-DL|OpenScape Voice V10R1 MIB files|zip}}
 +
* {{File-DL|OpenScape Voice V10R2 MIB files|zip}}
  
 
== OSV Assistant API ==
 
== OSV Assistant API ==
Line 166: Line 175:
 
=== API Description ===
 
=== API Description ===
  
 +
* {{File-DL|OpenScape Voice V10, Assistant API Interface Manual|pdf}}
 +
* {{File-DL|OpenScape Voice V9, Assistant API Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, Assistant API Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V8, Assistant API Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V7, Assistant API Interface Manual|pdf}}
 
* {{File-DL|OpenScape Voice V7, Assistant API Interface Manual|pdf}}

Latest revision as of 14:59, 15 March 2022


OpenScape Voice | OpenScape SBC | OpenScape Branch | OpenScape 4000
OpenScape UC | OSCC-E Integration Connectors | OpenStage | OpenScape Contact Center

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.


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 to help you with 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.6.1
pdf.png  What’s new on this version

ECMA-348 (WSDL) for CSTA Phase III

The OpenScape Voice Server provides also support for CSTA over HTTP/SOAP based on ECMA-348 edition 3 and ECMA-323 edition 4.

The current ECMA-348 edition 5 WSDLs may be downloaded from here and the namespace SOAP bindings should be modified to reflect ECMA-348 edition 3 and ECMA-323 edition 4 in order to work with OpenScape Voice. An archived copy of ECMA-348 edition 3 is available for reference here.

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

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

MIB Files

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@atos.net.