Documentation

Documentation for running a Live Chat Bot

Live Chat Bot Overview

Live Chat Bot is free live chat for your website that uses telegram to facilitate receiving and sending messages with your website users. By using telegram groups with your Live Chat Bot, you and your team can monitor and reply to live chats with your website users as a group. Because telegram runs on all popular desktop and mobile environments, you can seamlessly switch devices while providing live chat support for your website users.

Live Chat Bot can be added to your site in three steps. First, you will sign up for an account on our website and create your Live Chat Bot. Next, start a telegram conversation with our bot or add our bot to your telegram group and send the bot the link code. Last, take the HTML code for your bot and place it in your website.

After performing these steps, when a user opens the chat widget that is on your website and sends a message Live Chat Bot will send the message to your telegram conversation or group. To send a message back to a live chat user use the telegram reply function and compose your message. When you send your reply the bot will route it back to the chat window from which the user sent the message.

Overview Summary

To summarize, there are three basic steps to adding a Live Chat Bot to your site:

  1. Create your Live Chat Bot on livechatbot.net
  2. Link a telegram.org conversation or group to your Live Chat Bot
  3. Get HTML code to add to your site's footer

You can find a walkthrough on the Instructions tab.

Step by Step Instructions

This document provides step by step instructions for your Live Chat Bot. You will create a bot on livechatbot.net, add code to your website, and link a telegram.org conversation or group to your Live Chat Bot. After you are done users from your website will be able to live chat with you and your team.

Create your Live Chat Bot on livechatbot.net

If you haven't done so yet, create an account on livechatbot.net. After logging in, you will be shown the Live Chat Bot administration panel. Now create your new Live Chat Bot. To do that, click the wrench in the Live Chat Bot list table to open the Live Chat Bot toolbox and then choose the "New Bot" option:

After clicking the "New Bot" option a blank bot editor will open. Here is a screenshot of part of the editor:

Here is some information regarding each field to help you decide what to choose for a value:

  • Name: Name your bot. This value is used for the header of the chat window that is created from the HTML you add to your site. It is also used when livechatbot.org sends you messages regarding the active Live Chat Bot. Keep it short. This version of the chat window does not have much real estate in the header and long names will cause the value to wrap.
  • Sender: When you reply to a message to a website user in telegram, the bot will use the name the sender of the message has configured as their name in telegram. But frequently the user may not have set a name in telegram. In this case, this value is used as the name of the message sender.
  • Greeting: This is the message that is automatically sent to the user when they open the chat window on your website. You'll want to have a message like "How may we help you today?" or something along those lines. You can put HTML in this field, so be creative! But if you do choose to put HTML in here be careful or you can break the chat window.
  • Email: This field gives an email address to the user when they open a chat window but you have told the bot that you are away and not immediately responding to messages.
  • Message: This is the message that is sent when the user opens the chat window but you have told the bot that you are away. In this case, this message is sent instead of the greeting. You'll want to have a message like "Apologies but no one is available to repond to your question at the moment." or something along those lines. You can put HTML in this field, so be creative! But if you do choose to put HTML in here be careful or you can break the chat window.

After clicking save your Live Chat Bot will be saved in the livechatbot.net system and the table that shows the list of your Live Chat Bots will be updated with the new bot. Also, another popup will immediately display that provides info on how to link your Live Chat Bot with telegram. This process is described in the next section.

Now that your Live Chat Bot has been created, you can link it to a telegram conversation or telegram group. This tells livechatbot.net where to send messages from your website. If you do not yet have telegram installed, you will need to install it now. Also, if you are going to be using your Live Chat Bot in a group, create the group after installing telegram. Following one of the links below will tell you how to install telegram:

If you are the only person that will be responding to live chat messages from your website, use the "Telegram Conversation" link. If you want other team members to be able to see and reply to messages from your website, use the "Telegram Group" link. If for some reason you already connected to the bot in telegram, run the /start command shown in the popup in the telegram conversation or group.

Once you decide how you will communicate with your Live Chat Bot (just yourself or in a group) click the applicable link in the popup. This will open a browser window to telegram.org in a new tab and start telegram for you. If you click "Telegram Conversation" telegram will open a conversation with the bot and perform the link. If you click "Telegram Group" then telegram will open a dialog in which you choose which group to add the livechatbot.net bot. After choosing the group the link will be performed. You should see a message from Live Chat Bot in telegram similar to the one in this screenshot:

If you see this message, that means the telegram conversation or group is linked to your Live Chat Bot and you are ready to add the HTML provided by livechatbot.net to add a live chat window to your website.

Get HTML code to add to your site's footer

The last step is to add a line of HTML to the pages on which you want the live chat widget to appear. On the livechatbot.net dashboard, close the "Bot Link" popup if it is still open by pressing the escape key or clicking "Copy to Clipboard". Now, click the "Get Bot HTML" action in the action set for your bot. It looks like </>. When you click it, a popup like the screenshot below will appear:

Copy this code in to your website just above the closing body tag (</body>) and load your website in to your browser window. Send a test message to your telegram conversation or group by opening the live chat window and entering a message. It should appear in your telegram group or conversation. To reply to the message right click (or press and hold on mobile) and choose the "Reply" option. After you type your response and send it, it will appear in the live chat window on your website. Your Live Chat Bot is now active!

Telegram Bot Commands

After linking a Live Chat Bot to a telegram conversation or group, you can send it commands to perform functions in addition to its main function of receiving and replying to messages from website users. To send a command to the bot you enter a message that starts with a forward slash (/) and the command you want to run. For example, to run the help command, send the message /help.

Here is the list of commands:

  • /start - link me to this chat
  • /help - this help message
  • /settings - see my current status
  • /away - tells your website users that you are not available
  • /available - tells me to no longer show the away message
  • /here - synonym for /available
  • /code - get the HTML you need to put in your web page
  • /unlink - removes link to this chat

Bot Command Reference

Documentation for each of the available bot commands:

/start BOT-SECRET - link me to this chat

The /start command is used to link a telegram conversation or group to your Live Chat Bot. This link tells livechatbot.net where to send a message from your website. It also authorizes the current telegram conversation or group to relay replies to messages back to the user that send the message. Be sure not to share the secret or make it public. Please keep it save like you would any other password.

/help - this help message

The /help command gives some basic info about the Live Chat Bot that is connected to the current telegram conversation or group and also outputs a list of commands that you can run on the currently linked Live Chat Bot.

/settings - see my current status

The /settings command displays information about the Live Chat Bot that is connected to the current telegram conversation or group. The bot's name and away status will be displayed along with the bot's current welcome and away messages that were configured in the bot administration tool on livechatbot.net. You can change the away/available status with a command. To change the messaging, log in to livechatbot.net and edit the bot's messaging.

/away - tells your website users that you are not available

The /away command puts the currently linked Live Chat Bot in to 'away' mode. What this means is when a user opens the chat window on your website and sends a message they will be displayed the away message that has been configured instead of displaying the welcome message.

/available - tells me to no longer show the away message

The /available command takes the currently linked Live Chat Bot out of 'away' mode. After the /available command is ran, your user will be displayed the welcome message that has been configured in the bot administration instead of showing the away message.

/here - synonym for /available

The /here command is a synonym of the /available command. It performs the exact same function.

/code - get the HTML you need to put in your web page

The /code command is a helper to get the HTML code that needs to be put in the website to make the website portion of the Live Chat Bot function. You can also get the code from the bot administration at livechatbot.net by clicking the </> icon when logged in.

The /unlink command effectively undoes the linking done by the /start command. Running this command detaches the current telegram conversation or group from the Live Chat Bot that it was linked to prior to running this command. After running this command no messages entered in to chat windows that are on websites via the bot's HTML code will be displayed in this chat. Any message sent from a website will be lost.