Vivocha Javascript SDKs

Welcome to the Vivocha Javascript SDK documentation site!

Vivocha provides several distinct Javascript SDKs that enable you to customize and control the behaviour of both the Visitor and Agent's interfaces: each SDK is dedicated to a specific environment or use case.

The currently available SDKs are:

• Frontend SDK
• Console Application SDK
• Embedded Console SDK
• Agent SDK

At any given time, only a single SDK can be loaded. All the SDKs have in common the fact that all the features are accessed through the global variable vivocha and that the function vivocha.ready must be called make sure the SDK can be safely used:

vivocha.ready().then(function() {
  // you can now safely use the SDK
});

Frontend SDK

The Frontend SDK is the main Vivocha SDK and it's used to create visitor side integrations and customizations, like:

• Custom engagement widgets
• Proactive rules
• Ecommerce integrations
• Virtual assistants
• Knowledge base integrations

The SDK is automatically loaded by the Vivocha Activation Code (VAC) in each page where Vivocha is installed. The full documentation of the SDK can be accessed at the following link: VivochaVisitor.

Console Application SDK

This SDK is used to create Console Apps, extensions to the Vivocha Agent Console, the Agent Desktop used by default by the agents. The console apps are loaded on the left hand side of the console when a contact is accepted by an agent. The SDK is the same used by the official Vivocha Console Apps (e.g. the customer info, the customer history, the co-browsing app) and allows the creation of powerful applications that can fully control a Vivocha contact. Apps using this SDK can for example:

• Monitor and read messages received and send by the agent to suggest possible answers or automatically search relevant content in a knowledge base
• Send message, links and files to the visitor
• Load, display and let the agent edit data coming from a CRM, using data attached to the contact to query it
• Display the contents of a visitor's shopping cart
• Provide useful tools to the agent, such as a quotation tool, an invoice creation app or shipment tracking report

The full documentation of the SDK can be accessed at the following link: VivochaApp.

Embedded Console SDK

The Embedded Console is a special version of the Vivocha Console, designed to be easily integrated into existing third party Agent Desktops or Softphones. A typical use of the Agent Desktop console is a CTI integration, where the Vivocha capabilities are brought over into an existing contact center environment. The Embedded Console SDK lets a hosting application communicate with Vivocha and control multimedia contacts.

The full documentation of the SDK can be accessed at the following link: VivochaEmbeddedConsoleManager.

Agent SDK

The Agent SDK is an advanced Javascript library that can be used to fully implement a Vivocha Agent Desktop from scratch, leveraging Vivocha's low-level communication protocols. The SDK is the same one used by the standard Vivocha Console to interface the agent's browser to the Vivocha backend services.

The full documentation of the SDK can be accessed at the following link: VivochaAgent.