Here are a few sample bot integrations, which demonstrate some of the use cases that can be achieved with the SDK. Before getting started with any of these examples, you must check that you have the following prerequisites:

  1. You must have a LiveEngage account.

  2. You must configure an agent in your LiveEngage account.

  3. You must have the latest version of node.js installed on your machine. Here's a guide on how to do so: Mac / Windows.

Greeting Bot Example

This example demonstrates running a System Message type bot, which subscribes to all of the incoming conversation, and sends the first welcome message. In this example, you will:

  • Run a bot on your account that answers a conversation.

  • This bot will send a greeting to the visitor.

  • The bot will then transfer the conversation to an agent.

There are two parts to making this example work:

  1. In order to setup the agent-side code which achieves the Greeting Bot, follow this link: to review the greeting bot example on Github.

  2. In order to generate a conversation with the account (and the Greeting Bot by extension), follow the steps included in this guide inside the Messaging Window API.

Agent Bot Example

This example demonstrates running an Agent Bot, which serves as the standard agent of this account, and echoes every message sent to it. This example is meant to help you understand how to handle messages as a bot.

There are two parts to making this example work:

  1. In order to setup the agent-side code which achieves the Agent Bot example (echo bot), follow this link: to review the Agent Bot (echo bot) example on Github.

  2. In order to generate a conversation with the account (and the Echo Bot by extension), follow the steps included in this guide inside the Messaging Window API.

Use the Agent Bot example when you are looking to review and develop with the various available API calls, such as:

  • getClock

  • agentRequestConversation

  • subscribeExConversations

  • unsubscribeExConversations

  • updateConversationField

  • publishEvent

  • queryMessages

  • updateRingState

  • subscribeRoutingTasks

  • updateRoutingTaskSubscription

  • getUserProfile

  • setAgentState

  • subscribeAgentsState

Click here to review the full code repository on Github for this example. You can also watch this demo video, which will guide you on how to run this example bot.

Return To Same Agent Bot Example

This example demonstrates running an Agent Bot, which serves as a routing bot for an account, and transfers incoming conversations to the agent that consumer was most satisfied with (according to MCS). This example is meant to help you understand to flow for this scenario.

In this example, you will:

  • Run a bot on your account that transfers a conversation.

  • This bot will check the interaction history for an incoming conversation's consumer.

  • The bot will find the best agent (according to MCS) to accept the conversation and check that agent's availability.

  • The bot will then transfer the conversation to the agent.

There are two parts to making this example work:

  1. In order to setup the agent-side code which achieves the Agent Bot example (routing bot), follow this link: to review the Agent Bot (routing bot) example on Github.

  2. In order to generate a conversation with the account (and the Return To Same Agent Bot by extension), follow the steps included in this guide inside the Messaging Window API.

Click here to review the full code repository on Github for this example.

Bots Cluster Example

This example demonstrates running a bot on a ​horizontal scalable cluster. It can be used for a few use cases:

  • Bot Resiliency - If one node crashes, one ​of the other ​clusters ​will reconnect the bot.

  • Multiple Bots - The bots will be spread across the cluster’s nodes. If one node fails the other will share its bots. If a new node is added to the cluster it will take some of the bots from other nodes.

Click here to review the full code repository on Github for this example. You can also watch this demo video, which will guide you on how to run this example bot, as well as a code review video.