Personal tools
Namespaces

Variants
Actions

SMS Center For WHMCS

From ModulesGarden Wiki
Revision as of 15:10, 29 April 2015 by Joanna (Talk | contribs)

Jump to: navigation, search

Contents

About SMS Center For WHMCS

SMS Center For WHMCS is a module created to send SMS messages to your clients each time email notification is sent through WHMCS.

The module will let you define SMS templates in various languages for all email templates.
You will also get the access to SMS messages logs in order to verify the status of each sent text message.
In addition, you will be able to choose from four different SMS gateways.

  • Admin Area Features:
✔ Define SMS Template Counterpart For Each Email Template
✔ Enable/Disable SMS Gateways
✔ Enable/Disable SMS Templates
✔ Define Default SMS Template Version For Each Language
✔ Check Connection With SMS Gateways
✔ Merge Fields Support
✔ Characters Counter - Trace Length Of Your Messages
✔ Adjust Format Number To International Automatically
✔ Logs
  • Client Area Features:
✔ Define SMS Notifications To Receive
  • Supported Gateways:
✔ BoxisSMS
✔ Clickatell
✔ SMSEagle
✔ SMSGlobal
  • General Info:
✔ Supported Gateways - Clickatell, SMSGlobal And SMSEagle
✔ Module API - Integrate Other SMS Gateways
✔ Multi-Language Support
✔ Supports WHMCS V5.2 and Later

Installation

This tutorial will show you how to successfully install and configure SMS Center For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to your client area and download SMS Center For WHMCS.
SMSC 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like on the following screen.

SMSC 2.png
3. When you install SMS Center For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/sms_center/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php' .

SMSC 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file .

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products' .

SMSC 4.png

Activate The Addon

5. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area and proceed to 'Setup' 'Addon Modules' .
Afterwards, find 'SMS Center' and press 'Activate' button.

SMSC 5.png
6. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick checkboxes to assign desired admin roles.
Choose a country code prefix that will be automatically added to the client's SMS number if it has not been specified. Press 'Save Changes' .

SMSC 6.png
7. Now, proceed to the addon → 'Integration Code' and follow integration instruction.
SMSC 8.png
8. You have just successfully installed SMS Center For WHMCS!

Configuration and Management

SMS Center For WHMCS is a module which allows you to send predefined text messages to your clients the same way emails are sent.

Configuration

Under 'Configuration' tab you are able do configure and check connection with SMS gateway.

Press 'Configure' next to a gateway you wish to use.

SMSC 9.png
Configuration of each gateway may vary depending on its requirements.

As an example we will configure SMSEagle gateway.

SMSC 10.png
You can check whether configuration is correct through pressing 'Check Connection'.
SMSC 11.png
If connection is successful, we can proceed.

Activate the gateway, press 'Enable' next to it.

SMSC 12.png

Templates

'Templates' tab contains the list of message templates.

Each email template in your system has its text message counterpart.
Any of these messages can be enabled/disabled through marking/unmarking checkbox next to them and pressing 'Save' .

SMSC 13.png
Module comes with default message templates, but you can edit each of them.

Press 'Edit' to do so.

SMSC 13 1.png
The first field is a default message of the template. Our module allows you to define messages for selected languages.

In order to prepare a message in an additional language, select desired language from a dropdown menu and press 'Add' as shown on the following screen.

SMSC 14.png
As you can see on the screen below, a new field for chosen language appeared.

You can remove any additional language through pressing 'x' icon next to it.
Note: Language of a message sent is based on client's language, if message for client's language is not defined, default message will be sent.

SMSC 15.png
Module template supports merge fields which can be easily injected into messages.

Simply, click on the wanted merge field, it will be injected into currently edited version of the message.

SMSC 16.png

Logs

Messages sent to your clients are logged under 'Logs' tab.

As you can see on the following screen, here you can find detailed information about each message.

SMSC 17.png

Client Area

After placing integration code, a new position appears in the client area navigation menu.

Through pressing it your client will be moved to configuration of SMS notification.

SMSC 18.png
In this place your client can choose which notifications to receive.

Note! Provide SMS Number in the client's profile. Otherwise SMS Notifications will be unavailable for that client.

SMSC 19.png

Tips

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
SMS Center For WHMCS