Alcatel-Lucent Application Partner Program API Definitions

8/10/2019 Alcatel-Lucent Application Partner Program API Definitions

1/45

All Rights Reserved Alcatel-Lucent 2010

Alcatel-LucentApplication Partner Program

API Definitions


2/45

=

I. OVERVIEW........................................................................................ 4

1.1 Definitions .................................................................................. 4

1.2 API Classes.................................................................................. 51.2.1 Open APIs ..................................................................................51.2.2 Reserved APIs .............................................................................5

1.2.3 Restricted and Unpublished APIs .......................................................6

1.3 Alcatel-Lucent Products Supported ................................................... 6

1.4 API Categories ............................................................................. 8

1.5 APIs by class, product and category ..................................................10

2 TAPI Premium Server [OXE] {Reserved} ..................................................11

3 TSAPI Premium Server [OXE, OTCCSE, OTCCPE] {Reserved} .........................12

4 Passive Recording Interface [OXE, OXO, OTCCSE, OTCCPE] {Reserved}............13

5 Active Recording Interface [OXE, OTCCSE, OTCCPE] {Restricted}...................14

6 SIP [OXE] {Reserved} .........................................................................157 My Teamwork 8660 [ACS] {Reserved}.....................................................16

8 Telephony Web Services [OXE, OXO, ICS] {Open}......................................17

9 Messaging Web Services [OXE, ICS] {Open}..............................................18

10 Management Web Services [OXE, ICS] {Open} ..........................................19

11 One-Number Web Services [OXE, ICS] {Open} ..........................................20

12 Teamwork Web Services [OXE, ICS] {Open} .............................................21

13 Paging Interface [OXE] {Restricted} .......................................................22

14 AHL Interface [OXE] {Reserved}............................................................2315 CDR Interface [OXE] {Reserved}............................................................24

16 SNMP Interface [OXE] {Reserved} ..........................................................25

17 4760 Ticket Collector [OXE, OXO, NMS] {Reserved}....................................26

18 4760 VoIP Performance [OXE, NMS] {Reserved} ........................................27

19 VoIP Tickets-on-the-Fly [OXE] {Reserved}................................................28

20 VPS [OXE] {Reserved} ........................................................................29

21 QSIG [OXE] {Reserved} .......................................................................30

22 CSTA for OXE [OXE, OTCCSE, OTCCPE] {Reserved} .....................................3123 InfoCenter [OXE] {Reserved}................................................................32

24 RTI [OTCCSE] {Reserved} ....................................................................33

25 WMI [OTCCSE] {Reserved} ...................................................................34

26 CCTI or CCA SDK [OTCCSE] {Reserved}....................................................35

27 TAPI Server [OXO] {Reserved} ..............................................................36

28 CSTA for OXO [OXO] {Reserved}............................................................37


3/45

=

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}.........................................4234 PIMphony SDK [OXO] {Reserved} ...........................................................43

35 Glossary .........................................................................................44


4/45

=

I. OVERVIEW

The Alcatel-Lucent Application Parter Program (AAPP) is designed to support companiesthat develop communications applications for Alcatel-Lucent's enterprise solutions,including IP infrastructure products, IP telephony products and communicationsapplications.

To support the Program and developers, Alcatel-Lucent offers an array of applicationprogramming interfaces (APIs) including protocols and software development kits(SDKs) that enable customers and partners to build integrated communicationssolutions for enterprises. These solutions drive effective communications for theenterprise, accelerating business innovation and enhancing customer satisfaction.

Alcatel-Lucent makes it easy to integrate third-party applications with its networkinfrastructure products, communications platforms and software suites. The company

offers a large range of documented APIs, supported by Alcatel-Lucent experts. These APIsenable your application to interoperate with Alcatel-Lucent solutions, while offering yourcustomers a rich set of features.

1.1

Definitions

In this document, an API designates a means for interworking with Alcatel-Lucentplatforms (such as OmniPCX Enterprise, OmniPCX Office, etc.), in order to access specificresources. Two sorts of APIs are provided:

A protocoldescription, i.e., a document that describes the protocol in detail. Theprotocol may be based on either a:

- Proprietary definition (e.g., Alcatel-Lucent Hotel/Hospitality Link Interface(AHL), Call Detail Record (CDR), etc.); or

- Standard definition (e.g., CSTA, SIP, QSIG, etc.: see Glossary)

A full SDK, which includes guidelines, a library, tools and examples, and is basedon either a:

- Proprietary definition (XML Phone Web Service, TSAPI Premium Server,etc.); or

- Standard definition (TAPI Premium Server)


5/45

=

1.2API Classes

There are four classes of APIs, associated with increasingly restricted levels of access:

API class AccessOpen Available to all developers, free of charge

Reserved Reserved for Program participants

Restricted Restricted to Program participants and subject to aspecific contractual agreement

Unpublished Restricted to Program participants and available only incollaboration with Alcatel-Lucent R&D

1.2.1Open APIs

Open APIs give developers access to Alcatel-Lucent's next-generation development tools.These APIs enable you to develop innovative applications for the Alcatel-LucentApplication Phone, empower your business applications with IP communication features,or provide users with the global benefits of unified communications. Whatever the goal,you'll find powerful tools for developing valuable applications.

Alcatel-Lucent Open APIs are available to all developers free of charge. There are twolarge families of Open APIs:

Alcatel-Lucent 8082 My IC Phone SDK

The IC Phone Software Development Kit simplifies development on the My IC Phonedevice. For more information, see www.developer-enterprise.alcatel-lucent.com

Alcatel-Lucent XML Web Services, XML IP Touch Services, etc.

Alcatel-Lucent XML Web Services provide key functions for the entire range ofenterprise solutions.

1.2.2Reserved APIs

Alcatel-Lucent has documented a set of reserved APIs that are supported by itscommunication platforms. The associated SDKs include technical documentation, driversand documented examples.

These APIs are reserved for participants in the Program. They may be downloaded fromthe private area of the Application Partner web site.


6/45

=

1.2.3Restricted and Unpublished APIs

Restricted APIs are not available to all participants: they require specific agreement fromAlcatel-Lucent and a contractual commitment from the participant. The following APIsare in this class:

Active Recording interfaces (TDM DR-Link and IP DR-Link) Paging SIP Device Management SIP for voice mail

Unpublished APIs require collaboration with Alcatel-Lucent R&D. They are not describedin this document.

1.3Alcatel-Lucent Products Supported

Products currently supported are as follows:

Alcatel-Lucent OmniTouch 8082 My IC Phone (IC Phone)offers an openplatform and an entirely new user interface based on a large multi-touch display.Powered by pioneering new software and an open interface, it has a 7-inch widecapacitive touch screen that is LED-backlit and includes context-aware sensoryfeedback, as well as connectivity to Bluetooth and USB devices. See related APIs

Alcatel-Lucent IP Touch Phones (IP Touch):Full-featured IP Touch phones fromthe Alcatel-Lucent 8 Series offer integrated IP connectivity and telephony. Inaddition to the converged power of data and VoIP, these terminals support a rangeof features and functions, including Web-based XML business applications. See

related APIs

Alcatel-Lucent OmniPCX Enterprise Communication Server (OXE):The Alcatel-Lucent OmniPCX Enterprise is a highly scalable solution based on a pure softwarecommunications server platform that provides multimedia call processing for bothAlcatel-Lucent and third-party clients/phones including TDM, IP and SIP. Seerelated APIs

Alcatel-Lucent OmniPCX Office Communication Server (OXO):The Alcatel-Lucent OmniPCX Office is an integrated communications system for small andmedium-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 everyemployee with voice, Internet, e-mail and data capabilities. See related APIs

Alcatel-Lucent OmniTouch 8400 Instant Communications Suite for Enterprise(ICS): The Alcatel-Lucent OmniTouch 8400 Instant Communications Suite is acutting-edge software suite providing a full set of IP-based unified communicationservices. These services allow subscribers to tailor, control and manage calls,messages, directories, collaboration tools and information wherever they are (at


7/45

=

the office, away on business, in a meeting, at home), using any device and anyinterface. See related APIs

Alcatel-Lucent OmniTouch 8460 Advanced Communications Server (ACS): A SIP-and software-based platform within the award-winning Alcatel-Lucent OmniTouch8400 Instant Communications Suite, the OmniTouch 8460 ACS is now being

released as a development tool for enablement of business applications andprocess communications. Carriers, OEMs, systems integrators and businesses arealready using it as a communications and presence engine to enable the rapiddeployment of a wide range of real-time applications and services for hosted andpremises-based environments across wireless and wireline networks. See relatedAPIs

Alcatel-Lucent OmniVista 4760 Network Management System (NMS):TheAlcatel-Lucent OmniVista 4760 NMS is a comprehensive set of networkmanagement applications that are designed for IP telephony and IP networking andthat simplify the management of Alcatel-Lucent networking devices. OmniVistasolutions allow managers to monitor network activity, configure and troubleshoot

each device, and manage an entire network from a single platform. See relatedAPIs

Alcatel-Lucent OmniTouch Contact Center Standard Edition (OTCCSE): TheAlcatel-Lucent OmniTouch Contact Center Standard Edition is designed forcustomers with small- to medium-capacity contact centers (10 to 30 agents) and isthe ideal solution for voice communications needs. This modular suite includes:CCDistribution, CCSupervision, CCagent, CCivr, CCoutbound and WallboardManager. See related APIs

Special case:

Alcatel-Lucent OmniTouch Contact Center Premium Edition (OTCCPE): Designedfor customers with medium-capacity contact centers (20-150 agents), the Alcatel-Lucent OmniTouch Contact Center - Premium Edition is a converged multimediasolution for voice and e-mail, built on Genesys technology. It provides a unique,easy-to-use graphical user interface (called Visual CC), from which all operationscan be managed and monitored.

NOTE:This platform is currently not part of the Program, as its SDKs (called OpennessPacks) are based on Genesys SDKs and require specific licensing agreements, as detailed inthe Alcatel-Lucent OmniTouch Contact Center Premium Edition Openness Packs ProductDescription.


8/45

=

1.4

API Categories

APIs are grouped by category:

ManagementThis category includes all APIs designed to collect billing and statistics tickets;

monitor traps and alarms; and access the PBX database. Examples of ManagementAPIs:

- 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 fullrange of features of OmniPCX platforms. Examples of Hospitality/Healthcare APIs:- AHL/OHL- SIP

RecordingIncludes APIs that enable voice-recording applications. Passive recordingconnectivity is provided by Reserved APIs, while active recording is provided byRestricted APIs (see below). Examples of Recording APIs:

- Passive recording APIs (Extension, Trunk)- Active recording APIs (TDM DR-Link, IP DR-Link) [Restricted]

End pointIncludes interfaces that integrate third-party SIP terminals. Example of End-PointAPI: SIP

Contact CenterIncludes interfaces that enable contact center CTI integration at the server orclient level, as well as call center monitoring and management. Examples ofContact 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)

NotificationIncludes interfaces that enable an alarm server application based on text or voicenotification. Examples of Notification APIs:

- Paging- CSTA- Telephony Web Services


9/45

=

Collaboration/ConferencingIncludes APIs enabling third-party applications to provide conferencing andcollaboration services. Examples of Collaboration/Conferencing APIs:

- OmniTouch My Teamwork 8660 (ACS)- Teamwork Web Service

Contact ManagementIncludes APIs that enable operator applications using advanced user data. Exampleof a Contact Management API:

- InfoCenter

Business IntegrationIncludes interfaces that enable desktop or server integration of businessapplications. 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 MailIncludes interfaces that enable interaction with integrated or third-party voicemail. Examples of Voice Mail APIs:

- Messaging Web Service- VPS

- SIP [Restricted]


10/45

=

1.5APIs by class, product and category

The table below lists all available APIs by class, product and category.

API

OPEN

RESERVED

RESTRICTED

OXO

OXE

OTCCSE

OTCCPE

NMS

IPTouch

ICPhone

ACS

ICS

Management

Hospitality

Recording

EndPoint

ContactCenter

Notification

4760 Ticket Collector X X X X X4760 VoIP Performance Ticket Collector X X X XVoIP Tickets-on-theFly X X XCDR for OXE X X XCDR for OXO X X XCall Accounting Web Service X X XSNMP X X XSIP End Point X X XACS X X

AHL X X XOHL/OLD X X XCCA / CCTI X X X

CSTA for OXE X X X X X X XRTI X X XWMI X X XCSTA for OXO X X X XPassive Recording X X X X X X XActive Recording X X X X X XTSAPI Premium Server X X X X X XInfoCenter X X

Paging X X XPIMphony SDK X X

QSIG X X

TAPI Premium Server X X

TAPI Server for OXO X X

VPS/analog X X

XML IP Touch X X X X X X

One-Number Web Service X X X X X X

Messaging Web Service X X X

Management Web Service X X X X

Telephony Web Service X X X X XTeamwork Web Service X X X X

My IC Phone SDK X X X X X X

CategoryPlatform/ProductClass

Key to Platforms/Products

OXO Alcatel-Lucent OmniPCX Office Communication ServerOXE Alcatel-Lucent OmniPCX Enterprise Communication ServerOTCCSE Alcatel-Lucent OmniTouch Contact Center Standard EditionOTCCPE Alcatel-Lucent OmniTouch Contact Center Premium EditionNMS Alcatel-Lucent OmniVista 4760 Network Management SystemIP Touch Alcatel-Lucent IP Touch PhonesIC Phone Alcatel-Lucent OmniTouch 8082 My IC PhoneACS Alcatel-Lucent OmniTouch 8460 AdvancedCommunication ServerICS Alcatel-Lucent OmniTouch 8400 Instant Communications Suite for Enterprise


11/45

=

2 TAPI Premium Server [OXE] {Reserved}

TAPI Premium Server

The Alcatel-Lucent Telephone Application Programming Interface (TAPI) Premium Serveris a TAPI Telephony Service Provider (TSP) that enables TAPI applications to access thetelephony services of the Alcatel-Lucent OmniPCX Enterprise system. Its client/serverarchitecture, ability to support a wide range of telephone sets and compatibility with allnetwork architectures fulfill all Computer Telephony Integration (CTI) needs at lowcost.

An SDK is available for building or adapting applications that take full advantage ofOmniPCX Enterprise telephony features.

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 Enterprisetelephony features

Designed for OmniPCX Enterprise

system with Alcatel-Lucent IPTouch phones and Alcatel-Lucentdigital phones

Direct Computer SupportedTelecommunications Applications(CSTA) mapping

BENEFITS

Compatible with TAPI applications

Client/server architecture reducessupport, maintenance and hardwarecosts

Simplified installation, administrationand integration for any networktopology

Toolkit for developing CTI applications

Compatible with non-TAPI standardWindows applications, using theassisted telephony function

RESOURCES

Software Assisted TelephonyInstallation Manual TAPI/CSTA ComparisonAdministration Guide Data SheetDevelopers' Guide Product PresentationFeature List Release Notes


12/45

=

3 TSAPI Premium Server [OXE, OTCCSE, OTCCPE]{Reserved}

TSAPI Premium ServerThe Alcatel-Lucent Telephony Server Application Programming Interface (TSAPI) is basedon the Novell TSAPI architecture and programming interface and integrates server-basedtelephony control with desktop (client) or server applications on enterprise-wide networks.TSAPI incorporates Computer Supported Telecommunications Applications (CSTA)telephony call control services, device monitoring services and query services.

FEATURES

Communications solutions in

Windows or Linux environment

Compatible with all versions ofOmniPCX Enterprise

Network support: one server perOmniPCX node

Multi-protocol support: ECMA/V1,ECMA/V2, CCA, IVR, etc.

Support for active recording features

Central administration by GUI

Support for all CSTA services andevents

BENEFITS

Real network-enabled application with

centralized management and backup ofservers distributed throughout thenetwork

Designed for business and contactcenter environments

Transparent support for spatialredundancy for all clients

Includes a GUI-enabled client thatsimulates all services and displays allevents/messages.

Optimizes licenses by multiplexingCSTA requests

Rich feature set for developers: log,debug, client source code, etc.

RESOURCES

Runtime Software SDKInstallation Manual (Windows/Linux) Product OverviewDevelopers' Guide Release Notes


13/45

=

4 Passive Recording Interface [OXE, OXO, OTCCSE,OTCCPE] {Reserved}

Passive RecordingThe Alcatel-Lucent OmniPCX platforms provide several methods for capturing voice byreusing existing interfaces. These passive methods do not require any action by the voicerecording system:

Extension-side recording: taps the extension lines connecting the phones to theaudio boards

Trunk-side recording: taps the trunk lines connecting the trunk boards to thePSTN

IP sniffing: sniffs (or mirrors) the IP networks

FEATURES

Extension-side recordingisappropriate for recording a smallnumber of digital or analog extensions

Trunk-side recordingis appropriatefor large systems, for all types oftelephone sets that make incoming oroutgoing calls over PSTN trunks

IP sniffing is appropriate for theoperator console

BENEFITS

Available for both the OmniPCXOffice and Enterprise platforms

Several CTI links can be used (TSAPIPremium Server, Genesys T-Server,CDR), but are not mandatory

RESOURCES

Recording Overview Trunk-Side Recording Test PlanTrunk-Side Recording Guidelines Related information:seeTSAPI


14/45

=

5 Active Recording Interface [OXE, OTCCSE, OTCCPE]{Restricted}

Active Recording

Active Recording interfaces were designed and developed on OmniPCX Enterpriseto overcome the limitations of the Passive Recording interfaces. A call copy isprovided to the voice recording system on its request, using one of two methods:

Dedicated Recording Link (TDM DR-Link), where the TDM recorder isconnected to PCM boards

IP Dedicated Recording Link (IP DR-Link), where a direct RTP flow isestablished between IP phones and the VoIP recorder

FEATURES

The Omni PCX administratorcanconfigure the system to prevent therecording of users

One or more optional beeps can beissued to notify the external partywhen recording

Full compatibility with OmniPCXnetwork and branch survivabilitymode

Full support for recording ofencrypted calls (IP DR-Link)

Can mix both recording methods onthe same OmniPCX

BENEFITS

Dedicated license control based onsimultaneous recording channels(independent of declared/monitoredextension to be recorded)

Less cabling needed and resourcesoptimized compared to passiverecording interfaces

Strong security and confidentiality

No restriction of telephony servicesdue to recording

When using the TSAPI PremiumServer, benefis include TSAPIreliability, with its transparentsupport for spatial redundancy forOXE, and CTI server backup

RESOURCES (Restricted)

Recording Overview IP DR-Link Guidelines

TDM DR-Link Guidelines Related information:see TSAPI


15/45

=

6 SIP [OXE] {Reserved}

SIP for End Point

The Session Initiation Protocol (SIP) is a simple, open protocol that enables newmultimedia applications for voice, data and video. The OmniPCX Enterprise handlesSIP phones the same way as any other proprietary sets, providing powerful featuresincluding telephony services (multi-line, supervision, tandem, boss/secretary, hotel,group calls, etc.); use of prefix (forward, substitution, wake-up, etc.); CSTA

monitoring, etc.

FEATURES

Access to OmniPCX Enterprisefeatures and application support,including hospitality services,twinset and hunting groups via SIP,dual-tone multi-frequency (DTMF)codes and voice guides

Use of policy enforcement for SIPdevices, such as call barring, calldetail records, high availability andadmission control

BENEFITS

Take advantage of Omni PCXEnterprise benefits as regardsscalability, reliability, and highavailability

Tight integration in the overall IPtelephony solution, including all TDMand IP phones, fax, H. 323 and TDMtrunks

Can be deployed through OmniVista4760 SIP Device Management

Full compatibility with active recordingmethods (DR-Link)

RESOURCES

Introduction and Profiling Developers' Guide

Supported RFC Lists Questionnaire


16/45

=

7 My Teamwork 8660 [ACS] {Reserved}

My Teamwork

The My Teamwork API is used for integrating conference call scheduling andadministration into external applications.

The interface can interact with Alcatel-Lucent's OmniTouch 8460 Advanced

Communication Server (ACS) through SIP, VCS XML, SIP-CC or CDR.

RESOURCESACS Software Developers' GuideRelease Notes

FEATURES

Provides a SIP server for complexconference session control andpresence event management

Provide an HTTP/XML interface(VCS XML) to scheduleconferences, create recordings andmanage AMDS voice mailbroadcasts and access other user-based features available in ACS

BENEFITS

Adds value to enterprise applicationsvia conferencing, collaboration andpresence capabilities

Easy incorporation of (XML- andHTTP-based) REST Web service APIs,for a rapid time to market


17/45

=

8 Telephony Web Services [OXE, OXO, ICS] {Open}

Telephony Web Services

XML Web Services are fundamental building blocks for distributed computing on theInternet. Alcatel-Lucent OmniTouch 8410 Instant Communications Web Servicesare open interfaces that link the world of telephony to that of the Web, connectingAlcatel-Lucent's communication services to customer business applications. They aredesigned for use on the Alcatel-Lucent OmniPCX Office and Alcatel-Lucent OmniPCXEnterprise communication platforms.

Telephony Web Servicesprovide detailed information about the current incomingcall; personal phonebook management; phone set management; unified directory

access; nomad mode; and call log.

FEATURES

Support for basic and advancedcall-control services:

o Make, take, clear a callo Transfer/conference callo DTMF dialingo Recordingo Call management: forward,

lock/unlock, do not disturb,overflow, camp-on, etc.

o Phonebook accesso Nomad modeo Call log

Multi-line capability

Support for all types of phones:analog, digital, IP, DECT, WiFi,softphone

BENEFITS

Simplified mechanism to connectapplications easily, whatever thetechnology or device used

Applications run anywhere, on anytechnology or device

Based on universally supported,industry-standard protocols

Authentication within a user IDframework

RESOURCES

Framework Software [Reserved] Developers' Guide [Open]Installation Guide [Reserved] Release Notes [Reserved]Basic Tutorials [Open] Advanced Tutorials [Reserved]License Guide [Reserved] Technical Overview [Reserved]


18/45

=

9 Messaging Web Services [OXE, ICS] {Open}

Messaging Web Services

XML Web Services are fundamental building blocks for distributed computing on theInternet. Alcatel-Lucent OmniTouch 8410 Instant Communications Web Servicesare open interfaces that link the world of telephony to that of the Web, connectingAlcatel-Lucent's communication services to customer business applications. They aredesigned for use on the Alcatel-Lucent OmniPCX Enterprise communication platform.

Messaging Web Servicesare used to interact with a voice from a third-partyapplication. The voice media, located on a voice mail server, can be played on and

recorded from any device (e.g., business phone, external PSTN phone, etc.).

FEATURES

Interacts with various types ofAlcatel-Lucent voice mail:

o 4635o 4645o OmniTouch Unified

Communication

Supports basic and advanced

services:o Play, pause, resume, stop a

voice mailo Forward, sendo Deleteo Recordo Call back sender

BENEFITS





RESOURCES

Framework Software [Reserved] Developers' Guide [Open]Installation Guide [Reserved] Release Notes [Reserved]Basic Tutorials [Open] Advanced Tutorials[Reserved]


19/45

=

10 Management Web Services [OXE, ICS] {Open}

Management Web Services


Management Web Servicesare designed to manage Alcatel-Lucent OmniPCX

configuration data, including information about subscribers and their phone sets.

FEATURES

Manages main Alcatel-LucentOmniPCX Enterprise attributes:

o Entitieso Cost centerso Phonebooko Internal subscriberso External subscriberso Secondary subscriberso Hunting groupso Phone set parameters

Supports basic and advancedservices:

o Play, pause, resume, stop avoice mail

o Forward, sendo Deleteo Recordo Call back sender

BENEFITS


Applications run anywhere, on anytechnology or devices



Central management for the entireOXE network

RESOURCES



20/45

=

11 One-Number Web Services [OXE, ICS] {Open}

One-Number Web Services


One-Number Web Servicesset and review the rules for routing incoming calls to an

Alcatel-Lucent OmniPCX Enterprise user.

FEATURES

Supports different routes forincoming calls, depending on userstatus:

o Availableo Busyo Not available: do not

disturbo Not available: filtering

based on caller number,

time/date

Supports several destinations forrouted calls:

o Office phoneo External PSTN phones

(mobile, home phone, etc.)o Voice mail

BENEFITS



Based on industry-standard protocolsthat are universally supported


Powerful, customized filter/screening rules

RESOURCES



21/45

=

12 Teamwork Web Services [OXE, ICS] {Open}

Teamwork Web Services

XML Web services are fundamental building blocks for distributed computing on theInternet. Alcatel-Lucent OmniTouch 8410 Instant Communications Web Servicesare open interfaces that link the world of telephony to that of the Web, connectingAlcatel-Lucent's communication services to customer business applications. They aredesigned for use on the Alcatel-Lucent OmniPCX Enterprise communication platform.

Teamwork Web Servicesinclude services for managing contact lists, user presence

and conferences.

RESOURCESFramework Software [Reserved] Developers' Guide [Open]Installation Guide [Reserved] Release Notes [Reserved]License Guide [Reserved] Technical Overview [Reserved]

FEATURES

Supports collaboration services:o Session managemento Conference managemento Participant managemento Buddy managemento Presence states

BENEFITS


Applications run anywhere, on anytechnology or devices




22/45

=

13 Paging Interface [OXE] {Restricted}

Paging

The Paging Interface provides a powerful way to deliver calls with text messages toall types of terminals: TDM, IP, DECT, WiFi.

It is the core component for integrating an alarm or notification server.

FEATURES

Sends text messages to all types ofdevices:

o Mobile terminals (DECT,WiFi)

o TDM: Reflex, 9 serieso IP: 8 series

Acknowledges messages sent

Provides several different rings,depending on type of message

Stores messages on the device

BENEFITS

Very simple interface that providesinstant notification of system eventsto a mobile workforce

Enables messaging to any device

RESOURCES

Paging Overview Paging Guidelines [Restricted]


23/45

=

14 AHL Interface [OXE] {Reserved}

AHL

The Alcatel-Lucent Hotel/Hospitality Link Interface (AHL) is a proprietary protocol forbuilding a hospitality Property Management System (PMS).

Guest services (do-not-disturb, wake-up, voice mail, etc.) and front-office services(check-in, check-out, room management, etc.) are accessed through a serial orEthernet link.

FEATURES

Handles guest arrivals and

departures

Manages wake-up calls and guestvoice mail

Dynamic suite configuration

Handles call billing

Verifies and tracks room status

Manages room services

Manages waiting messages

Communication between third-partyapplication and OmniPCXEnterprise via Serial V24 or IP

BENEFITS

Dedicated OmniPCX Enterprise

telephony features are available fordesigning hospitality applications(hotel, hospitality, cruise ships, etc.)

PMS can easily manage room- orguest-based mode

Improves staff efficiency by directlymanaging all operations from thefront office (check-in, room cleaning,etc.)

Enhances guest satisfaction by

providing efficient telephonyfeatures from the guest set (hotelservices, do not disturb, direct dial-in, wake-up, messages, etc.)

Improves cost control by managingcall charging

RESOURCES

AHL Developers' Guide OmniPCX Configuration

Product Description


24/45

=

15 CDR Interface [OXE] {Reserved}

CDR

The Call Detail Report (CDR) Interface is a proprietary protocol for creating billingapplications.

Tickets containing detailed call information (e.g., calling number, called number, call,duration, etc.) can be used by a third-party application to generate all types ofreports.

FEATURES

Provides extended and reducedtickets

Generates new tickets for each newcall

BENEFITS

External third-party application canmanage call costs and charge

units.

RESOURCES

CDR Developers' Guide


25/45

=

16 SNMP Interface [OXE] {Reserved}

SNMP

The Simple Network Management Protocol (SNMP) is a standard protocol thatenables the OmniPCX Enterprise to be managed by an external networkmanagement platform.

SNMP traps can be processed by the SNMP supervisor using SNMP agents hostedby the OmniPCX Enterprise.

FEATURES

Standard Management Information

Base (MIB)

Incident filtering

Two types of event traps aregenerated:

o Compacto Extended

Status traps are provided for allnetwork nodes

BENEFITS

The OmniPCX Enterprise is fully

compatible with SNMP protocol

It acts as a central repository foralarms and events coming from allcomponents (terminals, boards,gateways, etc.)

It can also centralize all alarms andevents from the entirecommunications network

RESOURCES

SNMP Developers' Guide SNMP traps list for OXE


26/45

=

17 4760 Ticket Collector [OXE, OXO, NMS]{Reserved}

4760 Ticket Collector

The OmniVista 4760 Ticket Collector is a powerful interface for collecting Alcatel-Lucent OmniPCX Call Detailed Records (CDR) for provision tothird-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

Compatible with all OmniPCXplatforms (4400, OXE, 4200, OXO)

Client/server architecture

BENEFITS

This interface is fully embedded inOmniVista 4760 platform andbenefits from OmniVistaarchitecture, services andadministration

RESOURCES

Overview Guidelines


27/45

=

18 4760 VoIP Performance [OXE, NMS] {Reserved}

4760 VoIP Performance Ticket Collector

OmniVista 4760 VoIP Performance Ticket Collector Interface enables Alcatel-LucentOmniPCX Enterprise solutions to be integrated in global VoIP performanceapplications.

Using VoIP statistics records that contain various data items (e.g., codec used, jitter,packet loss delay, etc.), the third-party application can analyze the global traffic andidentify potential issues with quality of service (QoS).

FEATURES

The tickets generated at the end ofeach call cover all types of devices:IP phones, IP soft phones, GDboards, INT-IP boards, etc.

Tickets include VoIP parametersthat impact voice quality:

o Codec usedo Voice activity detection

(VAD)o Echo

Tickets also include various datapertinent for calculating VoIP QoS:

o Framingo Jittero Lost packetso Delayo Silence

BENEFITS

Essential software for assessing VoIPcall quality

Feature-rich tickets with allinformation needed to determine QoS

RESOURCES

Developers' Guide VoIP ticket samplesTools


28/45

=

19 VoIP Tickets-on-the-Fly [OXE] {Reserved}

VoIP Tickets-onthe-Fly over Ethernet

The VoIP Tickets-on-the-Fly over Ethernet Interface enables Alcatel-Lucent OmniPCXEnterprise solutions to be integrated in global VoIP performance applications.

Using VoIP statistics records that contain various data items (e.g., codec used, jitter,packet loss delay, etc.), a third-party application can identify any degradation in thequality of IP communications.

FEATURES

The tickets generated at the end of

each call cover all types of devices:IP phones, IP soft phones, GDboards, INT-IP boards, etc.

Tickets include VoIP parametersthat impact voice quality:

o Codec usedo Voice activity Detection

(VAD)o Echo

Tickets also include various datapertinent to calculating VoIP QoS:

o Framingo Jittero Lost packetso Delayo Silence

BENEFITS

Essential software for assessing VoIP

call quality

Feature-rich tickets with allinformation needed to determine QoS

Secure, real-time connection

RESOURCES

Developers' Guide VoIP ticket samples


29/45

=

20 VPS [OXE] {Reserved}

Voice Processing Systems

The Voice Processing Systems (VPS) Interface is a protocol based on Dual-ToneMulti-Frequency (DTMF) signaling, designed to interface with external voice-processing systems, such as voice mail and unified messaging applications.

FEATURES

Analog two-wire ports

Two services are provided:

Automated attendant services

Voice mail management

Call progress based on:

Signal detection

Tone management

MF signaling

BENEFITS

Very simple protocol with basic andextended features

RESOURCES

Developers' Guide


30/45

=

21 QSIG [OXE] {Reserved}

QSIG

The QSIG is an ISDN-based signaling protocol for signaling between Private BrancheXchange (PBXs) in a Private Integrated Services Network, using connection-levelQ.931 protocol and the application-level ROSE protocol.

FEATURES

First layer of services through QSIG

Basic Service (QSIG-BC)

Supplementary services throughQSIG Generic Function (QSIG-GF)

BENEFITS

Harmonized method for

interconnecting multi-vendorequipment

Mechanism for manufacturers toprovide innovative features within aheterogeneous environment

Extensive list of supplementaryservices to enhance businesscommunications

RESOURCES

QSIG Executive Brief QSIG Implementation forOXE


31/45

=

22 CSTA for OXE [OXE, OTCCSE, OTCCPE]{Reserved}

CSTA

The Computer Supported Telecommunications Applications (CSTA) is a standardizedECMA protocol that enables third-party applications to control all OmniPCX Enterprisedevices.

The CSTA protocol enables information exchanges to initiate services: monitor andcontrol calls and devices; set and query features; route calls; send and receive data.

FEATURES

Supports CSTA Phase 1 and 2:o Switching function services

(answer call, clear call,conference call, divert call,etc.)

o Status reporting services(monitor start/stop,snapshot call, etc.)

o Computing function services(RSI)

o Input/output services (fastdata)

o Voice unit services (recordmessage)

o Bi-directional services(escape, system status)

Explicit monitoring of all devices

CSTA application correlator data isfully supported

Use of private information in eventsand services

BENEFITS

Alcatel-Lucent adds value throughCSTA private information (events andservices)

Powerful associated tools to observesystem behavior, supervise systemsecurity, trace and logcommunication links

Uses a lowcost, high-bandwidthEthernet connection

Core component for any ComputerTelephony Integration (CTI) solution,whatever the protocol used: TAPI,TSAPI, XML, etc.

RESOURCES

ECMA Standard CSTA v2 DocumentationSetCountr Trunk Su ort Features List


32/45

=

23 InfoCenter [OXE] {Reserved}

InfoCenter

The InfoCenter Interface is a protocol used by a third-party application to retrieve dataabout Alcatel-Lucent OmniPCX Enterprise users and to update users' status. Thesedata are very useful for attendants' daily activities, and include: reason for absence,phone book updates, forward and do-not-disturb requests, etc.

InfoCenter messages are available over a TCP/IP or serial connection.

FEATURES

Manages the reasons for absenceand the expected time and date ofreturn

Generates immediate requests forforwarding and do-not-disturb

BENEFITS

Improve customer accessibility andservice for incoming telephone calls

Alcatel-Lucent adds values to theattendant console

Advanced call and presence handling

RESOURCES

Overview Attendant ProductDescriptionGuidelines Test Plan


33/45

=

24 RTI [OTCCSE] {Reserved}

RTI

The Real-Time Interface (RTI) obtains real-time information from Alcatel-LucentOmniTouch Contact Center Supervisor (CCS) objects, such as pilot, waiting queues,agent processing groups, agents, etc.

FEATURES

Provides access to various CCSobjects:

o

Piloto Filtero Waiting queueo PG Groupo PG Otherso Agents

Provides notification andsubscription service for all data

BENEFITS

Complements the Contact CenterAgent (CCA) application

Improves contact centeradministration by providing real-time agent phone status data, andby enabling supervisors andmanagement to monitor agentschedule adherence in real time

RESOURCES

SDK Developers' GuideCCS Configuration RTI within DCOM


34/45

=

25 WMI [OTCCSE] {Reserved}

WMI

The Workforce Management Interface (WMI) provides statistical reports for export toan external Workforce Management (WFM) solution in order to:

o Forecast future call volumeso Schedule and manage agentso Manage everyday contact center events to adjust the scheduleso Provide cost and staffing information to the contact center

FEATURES

Provides historical data on

Automatic Call Distribution (ACD)for:

o Queue and skills statisticso Agent productivity

Provides information periodicallythrough a V24 link or via filetransfer using FTP

Two main formats:o TCX formato IEX format

BENEFITS

Improve contact center administration

by enabling historical call volumes tobe used for forecasting and patternsfor future schedule periods. Inparticular:

o Forecast future call volumeso Determine the number of

agents needed throughout theday

o Create flexible and efficientagent work schedules

o Automatically assign agentsto schedules

o Immediately respond to

changes in call patterns andagent availability

o Prepare and analyze what ifscenarios for budgeting andplanning

RESOURCES

Developers' Guide TCX/IEX format example


35/45

=

26 CCTI or CCA SDK [OTCCSE] {Reserved}

CCTI or CCA SDK

The Contact Center Telephony Integration API, based on Contact Center Agent(CCA), provides a set of high-level development tools for the integration ofbusiness applications in a desktop contact center. Functions include:

o OLE Server - CCA features an OLE server that allows other applications touse CCA information or execute telephony functions

o DDE Interface A Dynamic Data Exchange interface allows applications toreceive notification of any telephony event and to control telephonyfunctions

o Support of Visual Basic scripting - enables users to write scripts controllingevents, properties andmethods of OLE objects

FEATURES

Includes an OLE (Object Linkingand Embedding) server, enablingexternal applications to use CCA toprovide information or to executetelephony functions (triggered bytelephony events such as anincoming call)

Includes DDE (Dynamic DataExchange), enabling Windowsapplications to receive telephonyevents and control telephonyfunctions, along with specific call-related information

Includes Visual Basic scripting tocontrol events, properties andmethods of CCA OLE objects (andalso ActiveX controls)

BENEFITS

Seamless integration with leadingCRM solutions

Empowers contact center agent byproviding access to criticalinformation

RESOURCESCCA Software CCA Release NotesSamples CCA Collecting GuideCCA Trouble Shooting Guide Developers' GuideDevelopment Requirement Specifications Installation Manual


36/45

=

27 TAPI Server [OXO] {Reserved}

TAPI Server

The Alcatel-Lucent Telephone Application Programming Interface (TAPI) Server is a TAPITelephony Service Provider (TSP) that enables TAPI applications to access the telephonyservices of the Alcatel-Lucent OmniPCX Office system. Its client/server architectureenables support for a wide range of telephone sets, compatibility with all networkarchitectures and fulfillment of all Computer Telephony Integration (CTI) needs, at lowcost.

An SDK is available for integrating applications that benefit from OmniPCX Officetelephony features.

FEATURES

TAPI client/server TSP Compatible with applications that interwork with TAPI Releases 2.0, 2.1

and 3.0 Support for basic telephony services,

supplementary telephony services,assisted telephony services andextended telephony services

SDK provides access to uniqueOmniPCX Office telephony features

Designed for Alcatel-LucentOmniPCX Office system with Alcatel-Lucent IP Touch phones andAlcatel-Lucent digital phones, analogphones and virtual sets

Direct Computer SupportedTelecommunications Applications(CSTA) mapping

BENEFITS

Compatible with all TAPI applications

Client/server architecture reducescosts for support, maintenance andhardware

Simplified installation, administrationand integration for any networktopology

Compatible with non-TAPI standardWindows applications using theassisted telephony function

RESOURCES

TAPI Conformance Guide Developers' GuideTAPI drivers TAPI samples


37/45

=

28 CSTA for OXO [OXO] {Reserved}

CSTA

The Computer Supported Telecommunications Applications (CSTA) is a standardizedECMA protocol that enables third-party applications to control all Alcatel-LucentOmniPCX Office devices.

The CSTA protocol enables information exchanges to initiate services as well as tomonitor and control calls and devices.

FEATURES

Supports CSTA Phase 1

o Switching function services(answer call, clear call,conference call, divert call,etc.)

o Status reporting services(monitor start/stop,snapshot device, etc.)

o Bi-directional services(escape, systems status)

Explicit monitoring of all devices

Use of private information in events

and services

BENEFITS

Alcatel-Lucent adds values through

CSTA private information (events andservices)

Powerful associated tools to observesystem behavior, supervise systemsecurity, trace and logcommunication links

Uses a low-cost, high-bandwidthEthernet connection

Core component for any ComputerTelephony Integration (CTI) solution

whatever the protocol level used:TAPI, XML, etc.

RESOURCES

Conformance Guide Reference GuideUsers' Guide Developers' GuideCSTA drivers


38/45

=

29 OHL Interface [OXO] {Reserved}

OHL

The Alcatel-Lucent Office Hotel/Hospitality Link Interface is a proprietary, IP-basedprotocol used for building a hospitality Property Management System (PMS).

Built on the same protocol element as the well-known AHL for OmniPCX Enterprise,this interface enables Hospitality and Healthcare applications to benefit from allfeatures of the OmniPCX Office.

In version R.50 and above, the new driver (called OLD, for Office Link Driver) addscall accounting functionality, which generates XML tickets.

FEATURES

Handles guest arrivals anddepartures

Manages wake-up calls and guestvoice mail

Handles call billing

Verifies and tracks room status

Manages room services

Manages waiting messages

BENEFITS

Dedicated OmniPCX telephonyfeatures for designing hospitalityapplications (hotel, hospitality,cruise chips, etc.)

Improves staff efficiency by directlymanaging all operations from thefront office (check-in, roomcleaning, etc.)

Enhances guest satisfaction by

providing efficient telephonyfeatures from the guest set (hotelservices, do not disturb, direct dial-in, wake-up, messages, etc.)

Improves cost control by managingcall charging.

RESOURCESOHL Presentation Developers' GuideInstallation & Configuration Release NotesFAQ Test PlanOHL driver


39/45

=

30 XML IP Touch Service [OXE, OXO, ICS] {Open}

XML IP Touch

XML IP Touch Services enable an application to interact with users of OmniPCXcommunication servers through the users' IP Touch terminals. The application cantake control of the IP Touch terminal to build screens and collect user actions.

Screen control is granted when a user activates an application on his terminal.Even if the user has not activated an application, XML IP Touch Services still allow

the application to issue notifications to the terminal.

FEATURES

Provides means for interacting withapplications other than calls andtelephony services.

Displays information, collects inputsand reacts to keypress navigationon all sets in the Alcatel-Lucent IPTouch series 8 range

Services are provided via thePresentation Server (an HTTP

client)

Several forms are provided to helpdevelop the application: List, Input,Check, Radio List, Slider, Select,etc.

BENEFITS Based on universally supported,

industry-standard protocols

Allows the end customer to easilyintegrate real-time communicationin their business processes

RESOURCES

Framework Software [Reserved] Developers' Guide [Open]Installation Guide [Reserved] Release Notes [Reserved]Basic Tutorials [Open] Advanced Tutorials [Reserved]License Guide [Reserved] Technical Overview [Reserved]


40/45

=

31 My IC Phone SDK [OXE, OXO, ICS] {Open}

My IC Phone

The Alcatel-Lucent My IC Phone SDK is composed of a full set of tools to simplifydevelopment on new range of 80xx phones, an innovative, open series of IP phonesthat delivers the experience of a smartphone to the desk.

FEATURES

Enables the building of webapplications (webapps) that are

embedded in the phone

Enables the customization ofexisting webapps

Based on a Linux platform, enablesinteraction with a 7-inch touch panelwith capacitive haptic feedback

Uses standard SIP protocol tocommunicate with any standard SIPcommunication server

BENEFITS

Is based on standard Webtechnology and languages (HTML,

CSS and JavaScript)

Provides a graphical library and listof telephony services to simplifyimplementation

Supplies a powerful toolkit,including Emulator, deploymenttool, RPM packager

Includes a dedicated developerportal for the developer communityto simplify application design

through collaboration with otherprojects

RESOURCES

AAPP Factory [Open]


41/45

=

32 CDR Interface [OXO] {Reserved}

CDR

The Call Details Report (CDR) interface is a proprietary protocol for creating billingapplications.

Tickets containing detailed call information (e.g., calling number, called number, call,duration, etc.) can be used by a third-party application to generate all types ofreports.

FEATURES

Provides extended and reduced

tickets

Generates new tickets for each newcall

BENEFITS

External third-party application can

manage call costs and chargeunits.

RESOURCES

CDR Developers' Guide


42/45

=

33 Call Accounting Web Service [OXO] {Reserved}

Call Accounting Web Service

The Call Accounting over IP Web Service is used to design applications that managecall accounting tickets generated by an Alcatel-Lucent OmniPCX Office system.

The tickets collect information on:o Incoming/outgoing telephone callso Supplementary services in the public network

o User services, such as appointment reminder or wake-up

FEATURES

Provides two types of call metering:

o Internal metering like thenumber of call chargesincurred or cost of calls andservices

o External metering about calls

Call accounting ticket structure isprovided through an XML schema

(defined through an XSD file)

BENEFITS

Access server secured byauthentication (HTTPS)

Standard HTTP/SOAP protocol

Existing embedded solutionprovides XML files

RESOURCES

Developers' Guide Source Code SampleTicket Samples WSDL FileTicket Description Test Plan


43/45

=

34 PIMphony SDK [OXO] {Reserved}

PIMphony SDK

PIMphony is a personal communication manager that links desktop computers andtelephones to provide a powerful, user-friendly phone assistant that manageseveryday phone tasks.

It offers a complete set of phone services, including call logging, voice mail andset monitoring. Services are continuously available on the PC, regardless of anyother applications running. Company contact databases are fully integrated with

PIMphony to provide optimal service.

FEATURES

Provides pop-ups based on the CLI(for incoming and outgoing calls)

Performs a search in the PIM,based on the search string (dial byname)

BENEFITS Specifically designed for small and

medium enterprises that do nothave specialized IT skills

Can be integrated with anyexternal database

RESOURCES

Developers' Guide Samples


44/45

=

35 Glossary

Acronym DefinitionAAPP Alcatel-Lucent Application Partner Program

ACD Automatic Call DistributionACS Alcatel-Lucent OmniTouch 8460 Advanced Communications Server

AHL Alcatel-Lucent Hotel/Hospitality Link Interface

AMDS Automated Message Delivery System

API Application Programming Interface

CC Contact Center

CCA Call Center Agent

CCS Contact Center Supervisor

CCTI Contact Center Telephony Integration

CDR Call Detail Record

CSTA Computer Supported Telephony Application

CTI Computer Telephone Integration

DCOM Distributed Component Object Model

DDE Dynamic Data ExchangeDECT Digital Enhanced Cordless Telecommunications

DR-Link Dedicated Recording Link

DTMF Dual-Tone Multi-Frequency

FTP File Transfer ProtocolGUI Graphical User Interface

HTTP Hypertext Transfer Protocol

HTTPS Hypertext Transport Protocol Secure

IC Instant Communications

ICS Alcatel-Lucent OmniTouch 8400 Instant Communications Suite for

EnterpriseIP Internet Protocol

IT Information Technology

IVR Interactive Voice Response

NMS Alcatel-Lucent OmniVista 4760 Network Management System

OEM Original Equipment Manufacturer

OHL Alcatel-Lucent Office Hotel/Hospitality Link Interface

OLD Office Link Driver

OLE Object Linking and Embedding

OTCCPE Alcatel-Lucent OmniTouch Contact Center Premium Edition

OTCCSE Alcatel-Lucent OmniTouch Contact Center Standard Edition

OXE Alcatel-Lucent OmniPCX Enterprise Communication ServerOXO Alcatel-Lucent OmniPCX Office Communication Server

PBX Private Branch Exchange

PMS PBX Management Service

PSTN Public Switched Telephone Network

QoS Quality of Service

QSIG ISDN-based signaling protocol using connection-level Q.931 protocol

REST Representational State Transfer


45/45

=

RFC Request for Comments

RPM Package management system (from Red Hat Package Manager)

RTI Real-Time Interface

SDK Software Development Kit

SIP Session Initiation Protocol

SNMP Simple Network Management Protocol

SOAP Simple Object Access ProtocolTAPI Telephone Application Programming Interface

TDM Time-Division Multiplexing

TSAPI Telephony Server Application Programming Interface

UC Unified Communications

VAD Voice Activity Detection

VCS Voice Communications System

VoIP Voice over IP

VPS Voice Processing Systems

WiFi Wireless Fidelity

WMI Workforce Management Interface

WSDL Web Services Description LanguageXML Extensible Markup Language

XSD XML Schema Definition

applicationpartner.alcatel-lucent.com

Documents

Alcatel-Lucent Application Partner Program API Definitions