Omni Web SDK

This repository provides details for Avaya Infinity™ Omni SDK, which is a set of libraries that provides APIs and UI components to integrate with Avaya Infinity™ platform.

⚠️

WARNING

Disclaimer Installing, downloading, copying or using this SDK is subject to terms and conditions available in the LICENSE file.

The Omni Web SDK and its related artifacts are available here:

GitHub | SDK API Docs

The Avaya Infinity™ platform Web Omni SDK consist of the following modules:

  • Avaya Infinity Core
  • Avaya Infinity Messaging
  • Avaya Infinity Messaging UI

Core

The Core module provides the basic functionality to establish session with Avaya Infinity™ platform, start and end a conversation for the user along with providing other related utilities. This module is a prerequisite for using any of the other modules.

npm | SDK API Docs

Messaging

The Messaging module provides capability to send messages and listen to events occurring on the conversation. This module is dependent on the Core module.

npm | SDK API Docs

Messaging UI

The Messaging UI module provides a built-in Messaging UI component to view the messages exchanged on the conversation and send messages or attachments. The module is dependent on the Core and Messaging modules.

The look and feel of the Messaging UI component is highly customizable so that you can blend it with your application’s theme. It takes care of rendering the rich media action buttons and sending the respective response from the user. Using this module is the quickest and easiest way to add Avaya Infinity™ Web Chat capabilities into your client application.

npm | SDK API Docs.

Omni SDK Starter Kit

To integrate your client application with Avaya Infinity™ Platform, apart from using the Omni SDK libraries, you need to write logic in your Backend Web App to fetch the JWT for each end user.

This repository provides sample code that not only demonstrates how the backend web application service can be implemented, but by running this Node.js based application, you can jump start on testing your client application.

⚠️

WARNING

The sample applications are provided are only for the purpose of reference and shouldn't be used in production.

Sample Backend Web App Server

A sample Node.js based application demonstrating how the Backend Web Application Server can be implemented to fetch JWT from Avaya Infinity™ Platform.

GitHub | Readme