Professional Documents
Culture Documents
Alcatel-Lucent Application Partner Program API Definitions
Alcatel-Lucent Application Partner Program API Definitions
Alcatel-Lucent Application Partner Program API Definitions
=
I.
OVERVIEW ........................................................................................ 4
1.1
Definitions .................................................................................. 4
1.4
1.5
=
29 OHL Interface [OXO] {Reserved} ........................................................... 38
30 XML IP Touch Service [OXE, OXO, ICS] {Open} .......................................... 39
31 My IC Phone SDK [OXE, OXO, ICS] {Open}................................................ 40
32 CDR Interface [OXO] {Reserved} ........................................................... 41
33 Call Accounting Web Service [OXO] {Reserved} ......................................... 42
34 PIMphony SDK [OXO] {Reserved} ........................................................... 43
35 Glossary ......................................................................................... 44
I. OVERVIEW
The Alcatel-Lucent Application Parter Program (AAPP) is designed to support companies
that develop communications applications for Alcatel-Lucent's enterprise solutions,
including IP infrastructure products, IP telephony products and communications
applications.
To support the Program and developers, Alcatel-Lucent offers an array of application
programming interfaces (APIs) including protocols and software development kits
(SDKs) that enable customers and partners to build integrated communications
solutions for enterprises. These solutions drive effective communications for the
enterprise, accelerating business innovation and enhancing customer satisfaction.
Alcatel-Lucent makes it easy to integrate third-party applications with its network
infrastructure products, communications platforms and software suites. The company
offers a large range of documented APIs, supported by Alcatel-Lucent experts. These APIs
enable your application to interoperate with Alcatel-Lucent solutions, while offering your
customers a rich set of features.
1.1 Definitions
In this document, an API designates a means for interworking with Alcatel-Lucent
platforms (such as OmniPCX Enterprise, OmniPCX Office, etc.), in order to access specific
resources. Two sorts of APIs are provided:
A protocol description, i.e., a document that describes the protocol in detail. The
protocol may be based on either a:
-
A full SDK, which includes guidelines, a library, tools and examples, and is based
on either a:
-
Access
Available to all developers, free of charge
Reserved for Program participants
Restricted to Program participants and subject to a
specific contractual agreement
Restricted to Program participants and available only in
collaboration with Alcatel-Lucent R&D
=
1.2.3 Restricted and Unpublished APIs
Restricted APIs are not available to all participants: they require specific agreement from
Alcatel-Lucent and a contractual commitment from the participant. The following APIs
are in this class:
Unpublished APIs require collaboration with Alcatel-Lucent R&D. They are not described
in this document.
Alcatel-Lucent OmniPCX Enterprise Communication Server (OXE): The AlcatelLucent OmniPCX Enterprise is a highly scalable solution based on a pure software
communications server platform that provides multimedia call processing for both
Alcatel-Lucent and third-party clients/phones including TDM, IP and SIP. See
related APIs
Alcatel-Lucent OmniPCX Office Communication Server (OXO): The AlcatelLucent OmniPCX Office is an integrated communications system for small and
medium-sized businesses (SMBs), providing a personal communications manager
(Alcatel-Lucent PIMphony Softphone), an advanced call center solution, secure
high-speed Internet access, advanced TDM and IP telephony and LAN switching.
The Alcatel-Lucent solution consists of a pre-configured server that provides every
employee with voice, Internet, e-mail and data capabilities. See related APIs
=
the office, away on business, in a meeting, at home), using any device and any
interface. See related APIs
Alcatel-Lucent OmniTouch 8460 Advanced Communications Server (ACS): A SIPand software-based platform within the award-winning Alcatel-Lucent OmniTouch
8400 Instant Communications Suite, the OmniTouch 8460 ACS is now being
released as a development tool for enablement of business applications and
process communications. Carriers, OEMs, systems integrators and businesses are
already using it as a communications and presence engine to enable the rapid
deployment of a wide range of real-time applications and services for hosted and
premises-based environments across wireless and wireline networks. See related
APIs
Special case:
=
1.4 API Categories
APIs are grouped by category:
Management
This category includes all APIs designed to collect billing and statistics tickets;
monitor traps and alarms; and access the PBX database. Examples of Management
APIs:
- 4760 Ticket Collector
- 4760 VoIP Performance Ticket Collector
- VoIP Ticket-on-the-Fly
- Call Accounting, CDR
- SNMP
- Management Web Service
- SIP Device Management [Restricted]
Hospitality/Healthcare
These APIs enable Hospitality or Healthcare applications to benefit from the full
range of features of OmniPCX platforms. Examples of Hospitality/Healthcare APIs:
- AHL/OHL
- SIP
Recording
Includes APIs that enable voice-recording applications. Passive recording
connectivity is provided by Reserved APIs, while active recording is provided by
Restricted APIs (see below). Examples of Recording APIs:
- Passive recording APIs (Extension, Trunk)
- Active recording APIs (TDM DR-Link, IP DR-Link) [Restricted]
End point
Includes interfaces that integrate third-party SIP terminals. Example of End-Point
API: SIP
Contact Center
Includes interfaces that enable contact center CTI integration at the server or
client level, as well as call center monitoring and management. Examples of
Contact Center APIs:
- Telephony Server API (TSAPI) Premium Server
- Computer Supported Telephony Application (CSTA)
- Real-Time Interface (RTI)
- Workforce Management Interface (WMI)
- Call Center Agent (CCA)
Notification
Includes interfaces that enable an alarm server application based on text or voice
notification. Examples of Notification APIs:
- Paging
- CSTA
- Telephony Web Services
=
Collaboration/Conferencing
Includes APIs enabling third-party applications to provide conferencing and
collaboration services. Examples of Collaboration/Conferencing APIs:
- OmniTouch My Teamwork 8660 (ACS)
- Teamwork Web Service
Contact Management
Includes APIs that enable operator applications using advanced user data. Example
of a Contact Management API:
- InfoCenter
Business Integration
Includes interfaces that enable desktop or server integration of business
applications. Examples of Business Integration APIs:
- TSAPI Premium Server
- TAPI Premium Server, TAPI Server
- CSTA
- Telephony Web Service
- One-Number Web Service
- XML IP Touch Services
- QSIG
- PIMphony SDK
Voice Mail
Includes interfaces that enable interaction with integrated or third-party voice
mail. Examples of Voice Mail APIs:
- Messaging Web Service
- VPS
- SIP [Restricted]
=
1.5 APIs by class, product and category
The table below lists all available APIs by class, product and category.
Notification
Contact Center
End Point
Recording
Hospitality
Management
ICS
ACS
IC Phone
IP Touch
NMS
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X X X X
X X X
X X X X
X X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
OTCCPE
X
X
X
X
OTCCSE
Category
X X X X X X X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
OXE
RESTRICTED
Platform/Product
OXO
RESERVED
Class
OPEN
API
Key to Platforms/Products
OXO
Alcatel-Lucent OmniPCX Office Communication Server
OXE
Alcatel-Lucent OmniPCX Enterprise Communication Server
OTCCSE Alcatel-Lucent OmniTouch Contact Center Standard Edition
OTCCPE Alcatel-Lucent OmniTouch Contact Center Premium Edition
NMS
Alcatel-Lucent OmniVista 4760 Network Management System
IP Touch Alcatel-Lucent IP Touch Phones
IC Phone Alcatel-Lucent OmniTouch 8082 My IC Phone
ACS
Alcatel-Lucent OmniTouch 8460 Advanced Communication Server
ICS
Alcatel-Lucent OmniTouch 8400 Instant Communications Suite for Enterprise
BENEFITS
FEATURES
TAPI client/server TSP
Compatible with applications that
interwork with TAPI Releases 2.1 and
3.0
Adds telephone service capabilities
to standard Windows applications
Development and integration basis
for CTI applications
SDK available, providing access to
unique OmniPCX Enterprise
telephony features
Designed for OmniPCX Enterprise
system with Alcatel-Lucent IP
Touch phones and Alcatel-Lucent
digital phones
Direct Computer Supported
Telecommunications Applications
(CSTA) mapping
RESOURCES
Software
Installation Manual
Administration Guide
Developers' Guide
Feature List
Assisted Telephony
TAPI/CSTA Comparison
Data Sheet
Product Presentation
Release Notes
FEATURES
BENEFITS
Communications solutions in
Windows or Linux environment
RESOURCES
Runtime Software
Installation Manual (Windows/Linux)
Developers' Guide
SDK
Product Overview
Release Notes
Passive Recording
The Alcatel-Lucent OmniPCX platforms provide several methods for capturing voice by
reusing existing interfaces. These passive methods do not require any action by the voice
recording system:
Extension-side recording: taps the extension lines connecting the phones to the
audio boards
Trunk-side recording: taps the trunk lines connecting the trunk boards to the
PSTN
IP sniffing: sniffs (or mirrors) the IP networks
FEATURES
BENEFITS
Extension-side recording is
appropriate for recording a small
number of digital or analog extensions
Trunk-side recording is appropriate
for large systems, for all types of
telephone sets that make incoming or
outgoing calls over PSTN trunks
RESOURCES
Recording Overview
Trunk-Side Recording Guidelines
Active Recording
Active Recording interfaces were designed and developed on OmniPCX Enterprise
to overcome the limitations of the Passive Recording interfaces. A call copy is
provided to the voice recording system on its request, using one of two methods:
Dedicated Recording Link (TDM DR-Link), where the TDM recorder is
connected to PCM boards
IP Dedicated Recording Link (IP DR-Link), where a direct RTP flow is
established between IP phones and the VoIP recorder
FEATURES
BENEFITS
RESOURCES (Restricted)
Recording Overview
IP DR-Link Guidelines
FEATURES
BENEFITS
RESOURCES
Introduction and Profiling
Developers' Guide
Questionnaire
FEATURES
BENEFITS
RESOURCES
ACS Software
Release Notes
Developers' Guide
FEATURES
BENEFITS
Multi-line capability
Support for all types of phones:
analog, digital, IP, DECT, WiFi,
softphone
RESOURCES
Framework Software [Reserved]
Installation Guide [Reserved]
Basic Tutorials [Open]
License Guide [Reserved]
FEATURES
BENEFITS
Simplified mechanism to connect
applications easily, whatever the
technology or device used
RESOURCES
Framework Software [Reserved]
Installation Guide [Reserved]
Basic Tutorials [Open]
[Reserved]
License Guide [Reserved]
BENEFITS
FEATURES
RESOURCES
Framework Software [Reserved]
Installation Guide [Reserved]
Basic Tutorials [Open]
[Reserved]
License Guide [Reserved]
FEATURES
BENEFITS
RESOURCES
Framework Software [Reserved]
Installation Guide [Reserved]
Basic Tutorials [Open]
[Reserved]
License Guide [Reserved]
FEATURES
BENEFITS
RESOURCES
Framework Software [Reserved]
Installation Guide [Reserved]
License Guide [Reserved]
FEATURES
BENEFITS
RESOURCES
Paging Overview
FEATURES
BENEFITS
RESOURCES
AHL Developers' Guide
Product Description
OmniPCX Configuration
FEATURES
BENEFITS
RESOURCES
CDR Developers' Guide
FEATURES
BENEFITS
Incident filtering
RESOURCES
SNMP Developers' Guide
The OmniVista 4760 Ticket Collector is a powerful interface for collecting AlcatelLucent OmniPCX Call Detailed Records (CDR) for provision to third-party applications.
The interface can:
Periodically connect to OmniPCX systems
Retrieve the accounting tickets via FTP transfer
Save the files on external platforms
Maintain those files for a fixed period of time
FEATURES
BENEFITS
RESOURCES
Overview
Guidelines
FEATURES
BENEFITS
RESOURCES
Developers' Guide
Tools
FEATURES
BENEFITS
RESOURCES
Developers' Guide
FEATURES
BENEFITS
RESOURCES
Developers' Guide
FEATURES
BENEFITS
RESOURCES
QSIG Executive Brief
OXE
FEATURES
BENEFITS
RESOURCES
ECMA Standard
Set
Country Trunk Support
CSTA v2 Documentation
Features List
FEATURES
BENEFITS
RESOURCES
Overview
Description
Guidelines
Attendant Product
Test Plan
FEATURES
BENEFITS
RESOURCES
SDK
CCS Configuration
Developers' Guide
RTI within DCOM
FEATURES
BENEFITS
RESOURCES
Developers' Guide
OLE Server - CCA features an OLE server that allows other applications to
use CCA information or execute telephony functions
DDE Interface A Dynamic Data Exchange interface allows applications to
receive notification of any telephony event and to control telephony
functions
Support of Visual Basic scripting - enables users to write scripts controlling
events, properties and methods of OLE objects
FEATURES
BENEFITS
RESOURCES
CCA Software
Samples
CCA Trouble Shooting Guide
Development Requirement Specifications
FEATURES
BENEFITS
RESOURCES
TAPI Conformance Guide
TAPI drivers
Developers' Guide
TAPI samples
FEATURES
BENEFITS
RESOURCES
Conformance Guide
Users' Guide
CSTA drivers
Reference Guide
Developers' Guide
FEATURES
BENEFITS
RESOURCES
OHL Presentation
Installation & Configuration
FAQ
OHL driver
Developers' Guide
Release Notes
Test Plan
FEATURES
BENEFITS
RESOURCES
Framework Software [Reserved]
Installation Guide [Reserved]
Basic Tutorials [Open]
License Guide [Reserved]
FEATURES
BENEFITS
RESOURCES
AAPP Factory [Open]
FEATURES
BENEFITS
RESOURCES
CDR Developers' Guide
FEATURES
BENEFITS
RESOURCES
Developers' Guide
Ticket Samples
Ticket Description
FEATURES
BENEFITS
RESOURCES
Developers' Guide
Samples
35 Glossary
Acronym
AAPP
ACD
ACS
AHL
AMDS
API
CC
CCA
CCS
CCTI
CDR
CSTA
CTI
DCOM
DDE
DECT
DR-Link
DTMF
FTP
GUI
HTTP
HTTPS
IC
ICS
IP
IT
IVR
NMS
OEM
OHL
OLD
OLE
OTCCPE
OTCCSE
OXE
OXO
PBX
PMS
PSTN
QoS
QSIG
REST
Definition
Alcatel-Lucent Application Partner Program
Automatic Call Distribution
Alcatel-Lucent OmniTouch 8460 Advanced Communications Server
Alcatel-Lucent Hotel/Hospitality Link Interface
Automated Message Delivery System
Application Programming Interface
Contact Center
Call Center Agent
Contact Center Supervisor
Contact Center Telephony Integration
Call Detail Record
Computer Supported Telephony Application
Computer Telephone Integration
Distributed Component Object Model
Dynamic Data Exchange
Digital Enhanced Cordless Telecommunications
Dedicated Recording Link
Dual-Tone Multi-Frequency
File Transfer Protocol
Graphical User Interface
Hypertext Transfer Protocol
Hypertext Transport Protocol Secure
Instant Communications
Alcatel-Lucent OmniTouch 8400 Instant Communications Suite for
Enterprise
Internet Protocol
Information Technology
Interactive Voice Response
Alcatel-Lucent OmniVista 4760 Network Management System
Original Equipment Manufacturer
Alcatel-Lucent Office Hotel/Hospitality Link Interface
Office Link Driver
Object Linking and Embedding
Alcatel-Lucent OmniTouch Contact Center Premium Edition
Alcatel-Lucent OmniTouch Contact Center Standard Edition
Alcatel-Lucent OmniPCX Enterprise Communication Server
Alcatel-Lucent OmniPCX Office Communication Server
Private Branch Exchange
PBX Management Service
Public Switched Telephone Network
Quality of Service
ISDN-based signaling protocol using connection-level Q.931 protocol
Representational State Transfer
=
RFC
RPM
RTI
SDK
SIP
SNMP
SOAP
TAPI
TDM
TSAPI
UC
VAD
VCS
VoIP
VPS
WiFi
WMI
WSDL
XML
XSD
applicationpartner.alcatel-lucent.com