Live Chat Addon

From WHMCS Documentation

Revision as of 19:31, 28 September 2021 by SarahK (talk | contribs) (→‎First Use)

Available on marketplace.png

For more information and to order, go to the WHMCS marketplace.

Download

To start using Live Chat:

  1. Log in here].
  2. Go to Services > All Products & Services.
  3. Perform one of the following actions:
    1. If you purchased your WHMCS license directly, select your main WHMCS license, select the Information tab, and download Live Chat.
    2. If you purchased your WHMCS license from a reseller, select your Live Chat purchase, select the Downloads tab, and download Live Chat.

Installation

Watch the video tutorial for this feature.  

To install Live Chat, perform the steps below.

  1. Unzip the ZIP file download.
  2. Upload the contents of the upload_me directory to your WHMCS installation root directory.
  3. Check to ensure that the /modules/livehelp/templates_c/ directory is writeable.
  4. Go to www.yourdomain.com/whmcs/modules/livehelp/install, where www.yourdomain.com is the domain for your WHMCS installation, to complete installation.
After installation, delete the /modules/livehelp/install/ directory.
License Update
If you purchased the Live Chat Addon prior to installation, you may need to force a license update for your WHMCS installation to recognise the purchase. If you receive a license error or have trouble logging in after installation, log in to the WHMCS Admin Area, go to Help > License Information, and click Force License Update. Then, reattempt login.

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

You will be able to log in using the same username and password as you use for the WHMCS Admin Area.

Upgrading

If you have an earlier version of the Live Chat Addon, follow the steps below to upgrade to the latest version.

  1. Log in [here].
  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.yourdomain.com/whmcs/modules/livehelp/admin, where www.yourdomain.com is the domain for your WHMCS installation.
  9. Delete the /modules/livehelp/install/ directory.

Integration Outside of WHMCS

Do Not Attempt to add this code to WHMCS templates. Those templates handle it automatically.

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

  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>
    Make certain to updatewww.example.com/support/modules with the path to your WHMCS installation's modules directory.
  2. Optionally, you can either or both of these chat initiation methods:
    1. To display the Live Chat Operator status and end user chat initiation button:
      <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>
    2. To display a static text link for chat initiation:
       <a href="#" class="LiveHelpButton">Chat With Us Live</a>

Web Admin Interface

You can access the Live Help administration interface at http://www.yourdomain.com/whmcs/modules/livehelp/admin/, where http://www.yourdomain.com is the domain for your WHMCS installation.

Desktop Applications

Downloadable clients are available for Windows®, Mac®, and Linux®.

Mobile Apps are also available for iPhone® and Android™.

In most cases, these apps are available through the standard app stores for these devices. The Windows app is available via the download link below.

Windows

Requirements

The Windows app has the following minimum requirements:

  • Windows 7 / Vista / XP SP 2
  • Internet Explorer 7 or above
  • .NET Framework 3.5 SP1 or above - Download
  • Internet Connection

Installation

[Download the latest version of the Windows desktop application] and follow the automated installation process.

First Use

The first time that you use this, a login prompt will display. Enter your account, username and password:

  • 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, in the future on this device you will only need to enter your password.

For more information, see the ChatStack website.

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.

Common Troubleshooting Tips

Chat button non-functional / Blank live chat window

If clicking the chat button results in nothing happening or the live chat popup window is showing a blank chat window, make certain that the /modules/livehelp/templates_c/ directory both exists and is writeable.

We recommend that you try the following permissions in this order: 755, 775, and 777.

The requested content cannot be loaded. Please try again later.

This message may appear when you click Chat Now. This indicates that the system cannot create the templates cache.

To resolve this, make certain that the /modules/livehelp/templates_c/ directory exists and is writeable.

We recommend that you try the following permissions in this order: 755, 775, and 777.

License Invalid / Unable to login

If you see a "License Invalid" warning message when you open the Live Chat admin interface, your WHMCS installation has not yet updated to recognise your purchase of the addon. Your WHMCS installation only calls home to validate your license with us periodically. If you recently purchased the addon, you may need to force a local key update to have it take effect.

To do this, navigate to Help > License Information and click Force License Update. Then, attempt logging in again.

Connection Error

Connection errors when attempting to log in to the Live Chat administration area are typically due to misconfigured file and folder permissions.

This configuration varies depending on your particular server environment. For example, the permissions setting for the /modules/livehelp/xml/WebService.php file should be 644.

  • suPHP and PHP suEXEC require more restriction. If you use DSO as your PHP handler, you must use 644 permissions.
  • Limit access to only the account that owns the web server process. Make sure that no other system or user accounts can read your configuration file or modify any WHMCS-related files.

If the issue persists, enable your browser network console and examine the response for more information.

Incorrect Server/Host

Receiving this error message in one of the Desktop or Mobile clients indicates that the Live Help installation cannot be found at the given URL. Make certain that you entered the correct URL.

Retrieved from "http://3.17.75.209/index.php?title=Live_Chat_Addon&oldid=30787"