Live Chat

Latest ReleaseCurrent VersionIncluded in WHMCS
May 17, 20215.8.9800No

Live Chat allows you to chat and engage with customers. It includes in-chat access to customer products and billing, and chat transcripts become support tickets after the chat concludes. You can use Live Chat on most major mobile and desktop operating systems.

Activation

Before you can activate Live Chat, you must download it from the WHMCS Marketplace.

To do this:

  1. If you have not already purchased it, purchase Live Chat from the Live Chat listing.
  2. Log in to the WHMCS Member Area.
  3. Go to Services > All Products & Services.
  4. Perform one of the following actions:
    1. If you purchased your WHMCS license directly, select your main WHMCS license and select the Information tab.
    2. If you purchased your WHMCS license from a reseller, select your Live Chat purchase and select the Downloads tab.
  5. Download Live Chat.
  6. Unzip the .zip file.
  7. Upload the contents of the upload_me directory to the root directory in your WHMCS installation.
  8. Check to ensure that the /modules/livehelp/templates_c/ directory is writeable.
  9. Go to www.example.com/whmcs/modules/livehelp/install, where www.example.com is the domain for your WHMCS installation.
  10. Follow the displayed instructions to finish installation.
  11. Delete the /modules/livehelp/install/ directory.

Using this Addon

To log in to Live Chat, visit www.example.com/whmcs/modules/livehelp/admin, where www.example.com is the domain for your WHMCS installation.

You can log in using the same username and password that you use for the WHMCS Admin Area.

First Login

The first time that you log in, you will configure the following settings:

  • Account or Server — Enter the full path to the modules directory for your WHMCS installation.
  • Username / Password — Enter the same username and password that you use to log in to the WHMCS Admin Area.
  • Enable Secure Sign In — Enable this if your WHMCS installation uses SSL.
  • Sign In Automatically — Enable this to sign in automatically for future logins. If you enable this, you will only need to enter your password for future logins on this device.

For more information, see the ChatStack website.

Desktop Applications

Downloadable clients are available for Windows®, Mac®, and Linux®. Mobile Apps are also available for iPhone® and Android™.

The downloadable Windows app has the following minimum requirements:

For other operating systems, check their app stores for the downloadable clients.

Upgrading

To upgrade from an earlier version of the Live Chat addon:

  1. Log in to the WHMCS Member Area.
  2. Go to Services > All Products & Services.
  3. Select your Live Chat purchase.
  4. Go to the Downloads tab.
  5. Download Live Chat.
  6. Unzip the ZIP file download.
  7. Upload the contents of the upload_me directory to your WHMCS installation’s root directory.
  8. Log in to the Live Chat addon administration panel to complete the upgrade process at www.example.com/whmcs/modules/livehelp/admin, where www.example.com is the domain for your WHMCS installation.
  9. Delete the /modules/livehelp/install/ directory.

Uninstallation

To remove the Live Chat addon from your installation, delete the /modules/livehelp/ directory and the /includes/hooks/livehelp.php file. Optionally, you can also remove the database tables that begin with mod_livehelp.

Integration Outside of WHMCS

Do not add this code to WHMCS templates. WHMCS templates already handle the Live Chat addon automatically.

To integrate visitor tracking and live help in pages outside of your WHMCS installation (for example, your main website):

  1. Add the following lines to each page, once per page, after the <title> tag and jQuery call and before the </head> tag:
    <script type="text/javascript">
    <!--
    var Chatstack = { server: 'www.example.com/support/modules' };
    (function(d, undefined) {
      // JavaScript
      Chatstack.e = []; Chatstack.ready = function (c) { Chatstack.e.push(c); }
      var b = d.createElement('script'); b.type = 'text/javascript'; b.async = true;
      b.src = ('https:' == d.location.protocol ? 'https://' : 'http://') + Chatstack.server + '/livehelp/scripts/js.min.js';
      var s = d.getElementsByTagName('script')[0];
      s.parentNode.insertBefore(b, s);
    })(document);
    -->
    </script>
    
    Replace www.example.com/support/modules with the path to your WHMCS installation’s modules directory.
  2. Optionally, you can use either or both of these chat initiation methods:
    • To display the Live Chat operator status and end user chat initiation button, add:
      <a href="#" class="LiveHelpButton"><img src="http://www.example.com/whmcs/modules/livehelp/status.php" id="LiveHelpStatus" name="LiveHelpStatus" class="LiveHelpStatus" border="0" alt="Live Help" /></a>
      
    • To display a static text link for chat initiation:
      <a href="#" class="LiveHelpButton">Chat With Us Live</a>
      

Change Log

To view the addon’s change log, see the Live Chat Marketplace listing.

Last modified: June 14, 2024