Views

Difference between revisions of "OpenScape Office LX/MX V3 Open Interfaces"

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
(Application Interfaces)
(Proprietary protocol for CDR-Transmission)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div class="breadcrumb">
+
{{Breadcrumb|0|0|Unified Communications|OpenScape Office}}
{{up}} [[OpenScape Office LX/MX]] | {{up}} [[Open interfaces of OpenScape Office LX/MX/HX and HiPath 3000 | OpenScape Office and HiPath 3000 open interfaces]] | {{de}} [[OpenScape Office LX/MX V3 offenen Schnittstellen]]
 
</div>
 
  
OpenScape Office LX/MX offers different types of '''open interfaces''' which can be used for integration of OpenScape Office LX/MX features into applications and IT landscapes.
+
 
 +
[[OpenScape Office LX/MX]] offers different types of '''Open Interfaces''' which can be used for integration of OpenScape Office LX/MX features into applications and IT landscapes.
  
 
== Physical interfaces ==
 
== Physical interfaces ==
Line 11: Line 10:
 
* S0 / S2m (OpenScape Office MX only)
 
* S0 / S2m (OpenScape Office MX only)
 
* a/b (OpenScape Office MX only)
 
* a/b (OpenScape Office MX only)
 +
 +
== Protocols ==
 +
 +
=== Web Services Interface (HTTP / HTTPS) ===
 +
 +
The realization of the HTTP(S) protocol is done by the WebServices. From OpenScape Office MX/LX V3 on the WebServices replaces the G-Server. The function set comprises nearly all function of the G-Server except EVM support but offers also additioninal feature like access to user presence status.
 +
 +
The WebServices are fully integrated into HiPath OpenScape Office LX/MX V3 software.  No SW download and no external PC are required for use of the WebServices. Administration is done by Web Based Administration (WBM) of OpenScape Office LX/MX V3
 +
 +
{| {{DefaultTable}}
 +
! width="25%" | Documentation
 +
! width="20%" | Version / Date
 +
! width="10%" | File
 +
! width="45%" | Disclaimer
 +
|-
 +
|
 +
OpenScape Office V3
 +
 +
Web Services Interface Manual
 +
|
 +
V1.0 / 07.10.2011
 +
|
 +
{{File-DL|OSOV3_WSI|pdf}}
 +
<!-- Placeholder -->
 +
 +
|
 +
You may download and use this file only if you agree to the [[About This Wiki#Disclaimer|DISCLAIMER]]. If You disagree, your are not allowed to download the file.
 +
 +
Any support regarding the WebServices interface implemtation is only be given to registered partners within the  [http://www.unify.com/main/Partners/Technology-Partners.aspx HiPath Technologie Partner Program]
 +
|-
 +
|}
  
  
== Protocols ==
 
  
=== HTTP / HTTPS ===
 
  
The realisation of the HTTP(S) protocol is done by the WebServices. From OpenScape Office MX/LX V3 on the WebServices replaces the G-Server. The function set comprises nearly all function of the G-Server except EVM support and offers additioninal feature lie access to user presence status.
 
  
WebServices are integrated part of HiPath OpenScape Office LX/MX V3 software.  No SW download and no external PC are required for use of the WebServices. Administration is fully integrated within the Web Based Administration (WBM) of OpenScape Office LX/MX V3
 
  
[[Image:LASOSOLXMXV3.png|400px|OpenScape Office LX/MX V3 HTTP(S) - logical links]] <br />
 
'''OpenScape Office LX/MX - HTTP(S) link'''
 
  
 
=== CSTA protocol ===
 
=== CSTA protocol ===
Line 49: Line 73:
 
|-
 
|-
 
|
 
|
OpenScape Office MX
+
OpenScape Office V3
  
 
CSTA Interface Manual
 
CSTA Interface Manual
 
|
 
|
V1.0 / 31.01.2008
+
V1.0 / 04.04.2011
 
|
 
|
{{File-DL|HooMECSTA|zip}}
+
{{File-DL|OSOV3_CSTA|zip}}
 
<!-- Placeholder -->
 
<!-- Placeholder -->
  
Line 79: Line 103:
 
|-
 
|-
 
|
 
|
OpenScape Office MX
+
OpenScape Office V3
  
Ecosystem Open Interfaces
+
CDR Transmission
 
|
 
|
A31003P1010-T101-1-18
 
  
05/2008
+
 
 +
2012-24-07
 
|
 
|
{{File-DL|HooMEINT|pdf}}
+
{{File-DL|OSOV3CDR|pdf}}
 
|  
 
|  
This document is currently only available in German language
+
 
|-
 
|-
 
|}
 
|}
Line 128: Line 152:
  
 
* [[HiPath TAPI 170 TSP]] (3rd party)
 
* [[HiPath TAPI 170 TSP]] (3rd party)
* [[HiPath TAPI 170 TSP]] (1st party)
+
* [[HiPath TAPI 120 TSP]] (1st party)
 
* [[CallBridge Collection]] (1st party for openStage Phones)
 
* [[CallBridge Collection]] (1st party for openStage Phones)
  

Latest revision as of 11:42, 10 June 2014


OpenScape Office LX/MX offers different types of Open Interfaces which can be used for integration of OpenScape Office LX/MX features into applications and IT landscapes.

Physical interfaces

  • LAN Ethernet 10/100 base T
  • USB (OpenScape Office MX only)
  • S0 / S2m (OpenScape Office MX only)
  • a/b (OpenScape Office MX only)

Protocols

Web Services Interface (HTTP / HTTPS)

The realization of the HTTP(S) protocol is done by the WebServices. From OpenScape Office MX/LX V3 on the WebServices replaces the G-Server. The function set comprises nearly all function of the G-Server except EVM support but offers also additioninal feature like access to user presence status.

The WebServices are fully integrated into HiPath OpenScape Office LX/MX V3 software. No SW download and no external PC are required for use of the WebServices. Administration is done by Web Based Administration (WBM) of OpenScape Office LX/MX V3

Documentation Version / Date File Disclaimer

OpenScape Office V3

Web Services Interface Manual

V1.0 / 07.10.2011

pdf.png  OSOV3_WSI

You may download and use this file only if you agree to the DISCLAIMER. If You disagree, your are not allowed to download the file.

Any support regarding the WebServices interface implemtation is only be given to registered partners within the HiPath Technologie Partner Program




CSTA protocol

CSTA protocol implementation is based on following ECMA recommendations:

  • ECMA-269 Services for Computer Supported Telecommunications Applications (CSTA) Phase III
  • ECMA-285 Protocol for Computer Supported Telecommunications Applications (CSTA) Phase III


The CSTA interface of Open Scape Office LX/MX is licensed per CSTA link.

Physically it is available on Ethernet LAN 10/100 base T interface with TCP/IP.

Default IP address is 192.168.1.2 (OpenScape Office MX only). Default port number is 8800.

OpenScape Office LX/MX specific CSTA implemtation is described within:


Documentation Version / Date File Disclaimer

OpenScape Office V3

CSTA Interface Manual

V1.0 / 04.04.2011

zip.png  OSOV3_CSTA

You may download and use this file only if you agree to the DISCLAIMER. If You disagree, your are not allowed to download the file.

Any support regarding the CSTA implemtation is only be given to registered partners within the HiPath Technologie Partner Program

Proprietary protocol for CDR-Transmission

OpenScape Office LX/MX collects data about outbound (incoming and outgoing) calls within an internal file.

This file can be transmitted via Ethernet LAN to external computers. To avoid inconsistencies by multiple transmission of the same file, the file should be deleted after transmission. More information about the handling, link establishing and the call data record content is given within the following document. An asynchonous transfer of single data records, as HiPath 3000 does, is not supported by OpenScape Office LX/MX.


Documentation Version / Date File Remark

OpenScape Office V3

CDR Transmission


2012-24-07

pdf.png  OSOV3CDR

SIP (Session Initiation Protokoll)

SIP is physically available at the Ethernet LAN-Interface. Implementations is done according to the following RFC:

  • VoIP über SIP
    • RFC 2198 RTP Payload for Redundant Audio Data
    • RFC 2327 SDP Session Description Protocol
    • RFC 2617 HTTP Authentication: Basic and Digest Access Authentication
    • RFC 2782 DNS RR for specifying the location of services (DNS SRV)
    • RFC 2833 RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals
    • RFC 3261 SIP Session Initiation Protocol
    • RFC 3262 Provisional Response Acknowledgement (PRACK) Early Media
    • RFC 3263 SIP Locating Servers
    • RFC 3264 An Offer/Answer Model with the Session Description Protocol
    • RFC 3310 HTTP Digest Authentication
    • RFC 3311 Session Initiation Protocol (SIP)UPDATE Method
    • RFC 3323 A Privacy Mechanism for the Session Initiation Protocol (SIP)
    • RFC 3325 Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks
    • RFC 3326 The Reason Header Field for the Session Initiation Protocol (SIP)
    • RFC 3489 STUN - Simple Traversal of User Datagram Protocol (UDP)Through Network Address Translators (NATs)
    • RFC 3515 The Session Initiation Protocol (SIP) Refer Method
    • RFC 3550 RTP: Transport Protocol for Real-Time Applications
    • RFC 3551 RTP Profile for Audio and Video Conferences with Minimal Control
    • RFC 3581 An Extension to the Session Initiation Protocol (SIP) for Symmetric Response Routing
    • RFC 3891 The Session Initiation Protocol (SIP) Replaces Header

SIP protocol is available at subscriber lines and at trunk lines. For interoperability with VoIP Providers (SIP trunking) see Collaboration with VoIP Providers.

Application Interfaces

Microsoft TAPI

OpenScape Office LX/MX provides three TAPI service providers (TSP) for implementation in Microsoft TAPI based applications:

TAPI 120 and 170 is connected to OpenScape Office LX/MX via LAN interface . Callbridge Collection is connected directly to OpenStage phones using USB or LAN interface.

Manufacturer specific implementations are described within these documents.


Documentation Version / Date File Disclaimer

TAPI Application Developer´s Guide

HiPath TAPI 170 V2.0

V1.3 / 28.11.2007

pdf.png  TAPI170 Developers Guide

You may download and use this file only if you agree to the DISCLAIMER. If You disagree, your are not allowed to download the file.

Any support regarding the TAPI implentation is only be given to registered partners within the HiPath Technologie Partner Program

CallBridge Collection

CorNet TS TAPI Service Provider

Supplement to the Microsoft Windows Telephony Application Programmer's Guide Version 2.0

V2.0 / November 2004

zip.png  CBV2_PG

You may download and use this file only if you agree to the DISCLAIMER. If You disagree, your are not allowed to download the file.

Any support regarding the TAPI implentation is only be given to registered partners within the HiPath Technologie Partner Program