Avaya Breeze™ Client SDK Developer Hub Structure

The Breeze Client SDK Developer Hub is organised by Operating System (OS) platform and Breeze Client SDK packages. Each platform lists its supported packages. Each package has a logical grouping of functionality that can be used independently or with other packages. These grouping of functionalities ensures developers have control over which SDK libraries are included with their application which in turn will reduce complexity and optimize the application size. Documentation for each package will include:

  • Guides articles: These will lead the developer through their first project using the SDK package.
  • Technical articles: Articles written by developers, for developers, on more advanced concepts. The library of technical articles will increase over time driven by developer feedback/questions.
  • API reference
  • Sample application

The Breeze™ Client SDK libraries can be downloaded by OS platform via the Developer Download tab.

The following supported packages by platform are shown in the table below for Avaya Breeze™ Client SDK 3.2 and later releases:

Package Definition iOS Android Windows macOS JavaScript Infrastructure requirements1
Communication Services Calls ( Audio, Video ), Signaling Features (MWI, feature buttons, ...), Conferencing, Collaboration, Contacts, Presence, Messaging Service Yes Yes Yes Yes Yes Avaya Aura(R) Infrastructure
IP Office is not supported through the Client SDK
Deskphone Services N/A Yes N/A N/A N/A Used in conjunction with the Communication package to provide additional call control capabilities with the Avaya Vantage device
Recording Management Services N/A N/A N/A N/A Yes Avaya Equinox Conferencing
Meeting Scheduling Services N/A N/A N/A N/A Yes Avaya Equinox Conferencing
Customer Interaction Services Agent, Supervisor, Work/Interactions and Team Services N/A N/A N/A N/A Yes Avaya Oceana
Customer Interaction Utilities Provides additional Customer Interaction functionality: eMail services N/A N/A N/A N/A Yes Avaya Oceana
Identity Services2
Data Services Context Data N/A N/A N/A N/A Yes Avaya Oceana
Sharing Services Sharing Web Pages, Co Browse N/A N/A N/A N/A Yes Avaya Oceana

Note 1: See release notes for solution line up.

Note 2: The Identity Services Package is Obsolete as of 3.2. Please see package documentation for further details.

Avaya Breeze™ Client SDK Solution Architecture

Breeze™ Client SDK Platform Unified Communication and Collaboration Deployment

Partners or Customer Developers can create applications over a mix of device platforms such as mobile, desktop or browser applications. Which ever platform they choose to develop against, the SDK's methods and class provide an abstraction such that the developer does not need to have an understanding of the communication protocols or infrastructure to create their application.

If the partner select mobile and or desktop platforms this abstractions is done within the SDK allowing the developer to create new solutions or integrate communication capabilities into their existing application without the need to understand any of the SIP protocols used by the SDK to communication with the Avaya infrastructure. Applications can avail of a wide range of Unified Communications and Collaboration (UC&C) capabilities from voice and video call control (direct from the application or through the control of a SIP deskphone phone), to IM and presence integration, to a full conferencing and collaboration experience.

Similarly developers can utilize JavaScript to integrate too or create an application using a web container, a browser extension or through the use of a web portal. They will utilize WebRTC 1.0 for real time voice and video communication built directly into the browser (Chrome) or in conjunction with third party extension which can add this capability to Firefox, Safari and Internet Explorer.

Applications utilizing the Avaya Breeze™ Client SDK JavaScript platform when deployed will utilize the following components:

  • Avaya Aura® Web Gateway,
  • Avaya Aura® Media Server.

Client sdk deployment genetic TE

The Avaya Aura® Web Gateway provides an active-active and highly scale-able set of capabilities comprise of a Endpoint Service Gateway and Web Portal.

  • The Endpoint Service Gateway (ESG) provides the abstraction of the Avaya infrastructure for developers creating web based / JavaScript applications. This abstraction includes the conversion of WebRTC signalling to SIP which is required by the Avaya infrastructure. When acting as a WebRTC Signalling Gateway the Endpoint Service Gateway controls Audio and Video calls and provides a full range of call / conferencing controls. In addition Presence is mediation through the gateway.
  • A Web Portal host the Avaya Equinox Conferencing, Meetings for Web client. This portal functionality is utilized by applications created by Avaya and is not accessible to third party developers

The Avaya Aura Media Server provide the Adaption and transcoding of WebRTC Media.

Breeze™ Client SDK: Full Solution Deployment

The following diagram shows the additional functionality available through the Breeze™ Client SDK when the Avaya Oceana™ Omni-Channel Contact Center infrastructure is also deployed. These Oceana Omni-Channel capabilities are developed on the Avaya Breeze™ platform utilizing several Breeze Snap-ins and are exposed to the developer community through the Avaya Breeze™ Client SDK JavaScript API's. The Avaya Breeze Unified Collaboration Model (UCM) Snap-in utilizes a Computer Telephony Integration (CTI) frame work to control of Avaya Endpoints.

Client sdk deployment TE+CE


Your feedback has been successfully submitted.

There was a problem submitting your feedback. Please contact your product support representative.

Page Feedback