Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About WHMCS Analyzer)
Line 1: Line 1:
−
<meta name="keywords" content="whmcs analyzer, whmcs analyzer configuration, whmcs analyzer management, whmcs analyzer installation, whmcs analyzer common problems, about whmcs analyzer, whmcs analyzer documentation, whmcs analyzer faq, whmcs analyzer help, whmcs analyzer guide, whmcs analyzer wiki, whmcs analyzer tutorial,whmcs analyzer tips, whmcs analyzer wiki"></meta>
+
<meta name="keywords" content="sms center for whmcs, sms center configuration, whmcs sms center management, whmcs sms center installation, whmcs sms center common problems, about whmcs sms center, whmcs sms center documentation, whmcs sms center faq, whmcs sms center help, whmcs sms center guide, whmcs sms center wiki, whmcs sms center tutorial, whmcs sms center tips, whmcs sms center wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Clients Profiler For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The SMS Center For WHMCS Module."></meta>
−
=About [http://www.modulesgarden.com/products/whmcs/whmcs_analyzer/features WHMCS Analyzer]=
+
 
 +
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links and unclear descriptions!<br/>
 +
We are sorry for the inconvenience caused.</h4>
 +
 
 +
=About [http://www.modulesgarden.com/products/whmcs/sms_center/features SMS Center For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''WHMCS Analyzer''' is an innovative product that allows constant monitoring of your WHMCS system. Gather crucial data on your system,<br/> server and many others. Make regular scans to get a list of current issues that may raise and read suggested solutions to avoid or clarify them.  
+
|style="padding: 10px 0px 5px 0px;"|'''SMS Center For WHMCS''' is a module created to send text messages to your clients and administrators each time an email notification is sent through WHMCS.<br />
 +
You will be able to choose from seven different SMS gateways, define SMS templates in various languages and manage text messages in queues.<br />
 +
The module will allow you to verify new clients and orders as well as enable SMS codes as a part of two-factor authentication while logging in to your system.<br />
 +
You will also get the access to SMS messages logs in order to verify the status of each sent text message.<br />
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
−
*'''Global Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View WHMCS Modification Rating
+
|style="padding: 10px 0px 0px 30px;"|✔ Notify Both Your Clients And Administrators via SMS Message
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server Environment Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Use SMS Queue To Send SMS Within Defined Time Period
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Environment Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Manage List Of Queued SMS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Files Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Define SMS Template Counterpart For Each Email Template
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Database Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Default SMS Template Version For Each Language
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View List Of Possible Issues And Solutions
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Notifications To Receive Per Administrator
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Download WHMCS Environment Scan As PDF
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Administrator Notifications Per Admin
 
|}
 
|}
−
*'''Scan Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Files:
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable SMS Gateways
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Brief Files Summary
+
|style="padding: 0px 0px 0px 30px;"|✔ Check Connection With SMS Gateways
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Addon Modules
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable SMS Templates
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Template Files
+
|style="padding: 0px 0px 0px 30px;"|✔ Send SMS From Client Summary Page
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Order Form Template Files
+
|style="padding: 0px 0px 0px 30px;"|✔ Merge Fields Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Custom Files - Not Existing In Clean WHMCS Installation
+
|style="padding: 0px 0px 0px 30px;"|✔ Characters Counter - Trace Length Of Your Messages
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View List Of Suspicious Files
+
|style="padding: 0px 0px 0px 30px;"|✔ Adjust Format Number To International Automatically
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Modules:
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
 
|}
 
|}
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Addon Modules
+
|style="padding: 10px 0px 10px 30px;"|✔ Define SMS Notifications To Receive
 
|}
 
|}
 +
*'''Security And Verification:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Registrar Modules
+
|style="padding: 10px 0px 0px 30px;"|✔ Two-Factor Authentication Submodule - Use Second Layer Of Security
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Payment Gateway Modules
+
|style="padding: 0px 0px 0px 30px;"|✔ Verify New Client Accounts With SMS Token
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Provisioning Modules
+
|style="padding: 0px 0px 10px 30px;"|✔ Verify New Orders With SMS Token
 
|}
 
|}
 +
*'''Supported Gateways:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Hooks:
+
|style="padding: 10px 0px 0px 30px;"|✔ BearSMS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Complex Information About Installed Hook Files
+
|style="padding: 0px 0px 0px 30px;"|✔ BoxisSMS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Database:
+
|style="padding: 0px 0px 0px 30px;"|✔ Clickatell
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Basic WHMCS Database Information
+
|style="padding: 0px 0px 0px 30px;"|✔ InfoBip
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Database Tables List
+
|style="padding: 0px 0px 0px 30px;"|✔ MessageBird
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Logged Database Errors
+
|style="padding: 0px 0px 0px 30px;"|✔ SMSEagle
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View List Of Suspicious Email Templates
+
|style="padding: 0px 0px 10px 30px;"|✔ SMSGlobal
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ System Environment:
+
|style="padding: 10px 0px 0px 30px;"|✔ Module API - Integrate Other SMS Gateways
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Server Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Clients Profiler For WHMCS</u> -  Send SMS From Any WHMCS Place [http://www.modulesgarden.com/products/whmcs/clients_profiler/features (read more)]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View List Of Installed PHP Modules
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View PHP Configuration
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ WHMCS Environment:
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
 
|}
 
|}
 +
 +
=Installation=
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Basic WHMCS Settings
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure SMS Center For WHMCS.''' <br />
 +
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
−
*'''General Info:'''
+
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports WHMCS V5.3.14 and Later
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download SMS Center For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Requires PHP 5.3 or Later
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
 +
Files in your WHMCS directory should look like on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3. When you install SMS Center For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/addons/sms_center/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
 +
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'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_4.png]]
 +
|}
 +
==Activate The Addon==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''5. Now, you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
 +
Afterwards, find '' 'SMS Center' '' and press '' 'Activate' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
 +
To do so, click on '' 'Configure' '' button, tick checkboxes to assign desired admin roles.<br />
 +
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'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''7. Now, proceed to the addon → '' 'Integration Code' '' and follow integration instructions.'''<br/>
 +
Remember that integration depends on the WHMCS version and template that you are using. If your system used is WHMCS V6.x.x and template: '' 'Six', '' there is no need for you to do any integration. <br/>
 +
However, if you are working with WHMCS V6.x.x template '' 'Five' '' or WHMCS V5 then you must insert the code snippets as it is explained on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|'''8. The last thing you need to still do is setting up a cron job. It is advised to set the cron job with a 1 or 2 minutes interval.'''<br/>
 +
/your_whmcs_dir/modules/addons/sms_center/crons/cron.php
 +
Remember to replace ''your_whmcs_dir'' with a correct directory of your system.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''9. You have just successfully installed SMS Center For WHMCS!'''
 
|}
 
|}
  
−
=Installation and Configuration=
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure WHMCS Analyzer.''' <br/>
+
|style="padding: 10px 0px 30px 15px;"|'''SMS Center For WHMCS is a module which allows you to send predefined text messages to your clients the same way emails are sent.'''
−
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. [http://www.modulesgarden.com/products/whmcs/whmcs_analyzer/download Download] WHMCS Analyzer directly from our webpage.'''
+
|style="padding: 10px 0px 30px 15px;"|Under '' 'Configuration' '' tab you will find  '' 'Submodules', 'Administrators' '' and '' 'General Settings' '' sections. Configure each of them to allow full usage of SMS Center For WHMCS module.<br /> Press the first one '' 'Submodules' '' to configure and check connection with SMS gateways.
 
|}
 
|}
 +
===Submodules Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_1.png]]
+
|style="padding: 10px 0px 20px 15px;"|Find here all possible gateways that can be used in our module.
 +
You can use a recommended '' 'FastSMS' '' gateway:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the files into the main WHMCS directory.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9_1.png]]
−
Files in your WHMCS directory should look like on the following screen.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|Or choose form other acceptable gateways:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''3. Now you have to allow access to '' 'analyzer' '' and '' 'temp' '' files, change access rights as writable.'''<br/> Proceed to '' 'YourWHMCS → Analyzer'. '' Set access rights to the mentioned file as writable.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9_2.png]]
−
'''That is all, you may move the script itself!'''
+
 
|}
 
|}
−
=Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''WHMCS Analyzer''' is a disparate product that works outside of your WHMCS system to provide you a comprehensive view on its every single aspect.
+
|style="padding: 0px 0px 15px 15px;"|Press '' 'Configuration' '' next to a gateway you wish to use.
 
|}
 
|}
−
==Start Analysis==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to start your system analysis, please enter '' 'analyzer' '' directory in your browser, like in the example:
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9.png]]
−
http://your_WHMCS/analyzer
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the every beginning you will be asked to generate htaccess. This step is obligatory due to security reasons.<br/> You will be asked to do that only when using the script for the first time.
+
|style="padding: 0px 0px 15px 15px;"|Configuration of each gateway may vary depending on its requirements.<br />
 +
As an example we will configure SMSEagle gateway.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Please note the generated username and the password, you will need them in the every next step to get access to the product.
+
|style="padding: 0px 0px 20px 15px;"|You can check whether configuration is correct through pressing '' 'Check Connection'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Now, type in the generated in the previous step username and password to continue.  
+
|style="padding: 0px 0px 15px 15px;"|If connection is successful, we can proceed.<br />
 +
Activate the gateway, press '' 'Enable' '' next to it.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_12.png]]
 
|}
 
|}
 +
 +
===Administrators Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|That's it! You may finally scan your system. Press '' 'Start Scanning' '' button when such appears.
+
|style="padding: 10px 0px 20px 15px;"|This section contains a list of all staff administrators. You have the possibility here to decide who of them will receive SMS notifications and which notifications exactly. <br />Follow the steps described below to configure staff notifications properly.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_4.png]]
+
|style="padding: 0px 0px 20px 15px;"|Press '' 'Administrators' '' under '' 'Configuration' '' tab.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| Wait a moment until every part is completed successfully.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_22.png]]
 +
|}
 +
{|<br />
 +
|style="padding: 0px 0px 15px 15px;"|In order to enable SMS notifications for administrators individually, firstly set configuration for them. <br />
 +
1. Fill in the administrator's phone number, where text messages with notifications will be sent.<br />
 +
2. Choose which of the available admin messages shall be sent to that administrator.<br />
 +
Save changes.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_23.png]]
 
|}
 
|}
−
==Analysis Summary==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When the analysis process has finished successfully, a full summary will be displayed on your screen.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Press '' 'Enable Notifications.' ''<br />
−
Read the below section to get a full view on data you will find there.
+
Repeat these steps for every administrator you wish to receive admin notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_5_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_24.png]]
 
|}
 
|}
−
===Total Rating===
+
 
 +
===General Settings===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|As a very first piece of information you will find '' 'Total Rating'. '' This is an objective evaluation of your system as a whole. <br/> The highest possible rate of any system is 6.0. If you have a lower grade, then your system probably lacks in some of the below features.<br/>
+
|style="padding: 10px 0px 20px 15px;"|In '' 'General' '' section there are specific SMS configuration possibilities. Configure those you wish to activate and '' 'Save' '' the changes once ready!<br/>
−
Aspects taken into consideration when carrying out the evaluation:
+
By default, '' 'SMS Center' '' for client area is enabled, you may disable it here.
−
*WHMCS version
+
−
*PHP version
+
−
*detected possible issues
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_24_1.png]]
 
|}
 
|}
−
===Analysis In Details===
+
====Order SMS Activation====
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|WHMCS Analyzer prepares a detailed summary on your system condition. The results are divided into four general categories, these are:
+
|style="padding: 10px 0px 20px 15px;"|Enable '' 'Order SMS Activation' '' to allow activating orders once placed. Once an order is placed a client will receive a text message with a token,<br/> which must be then used to finish the order.<br/>
−
*Server Environment
+
''Note, this option does not support orders upgrades!''
−
*WHMCS Environment
+
−
*WHMCS Files
+
−
*WHMCS Database<br/>
+
−
Underneath, you will find enumerated all of the scanned options in every category.
+
 
|}
 
|}
−
====Files====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The first section is dedicated to any types of files that exist in your system, with some brief info and divided into categories:
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_24_2.png]]
−
*WHMCS Addons Files
+
−
*WHMCS Templates Files
+
−
*WHMCS Order Forms Templates Files
+
−
*Custom Files
+
−
*Suspicious Files
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_8.png]]
+
|style="padding: 0px 0px 20px 15px;"|If the above option is enabled, a client when placing an order before being able to complete it must enter a valid token that was sent via SMS.<br/> Only then the order can be completed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You will also find there a list of '' 'Possible Issues'. '' In this box there are always enumerated and described points which may cause some interruptions<br/> in your WHMCS usage. It is important to always analyze them carefully and clarify if possible.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_37.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_8_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|If provided token is correct, the order's verification status is changed to '' 'Confirmed'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In some cases we try to suggest the best action to prevent or solve the issue. Press '' 'Possible Solution' '' to see it, '' 'Hide Solution' '' if you are already familiar with it.
+
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_37_1.png]]
 
|}
 
|}
 +
 +
====Client SMS Activation====
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_8_2.png]]
+
|style="padding: 10px 0px 20px 15px;"|Enable '' 'Client SMS Activation' '' and every newly activated client will receive a token, which must be used to end up the activation process.<br/>
 +
Declare time intervals for sending tokens here.
 
|}
 
|}
−
====Modules====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|This section is very short but clear. There is a list of all active addons and again possible issues if such exist.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_24_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_9.png]]
+
|style="padding: 0px 0px 10px 15px;"|With the above option enabled, the process of a new client's activation is a little bit different. Start with filling out the client's details.
 
|}
 
|}
−
====Hooks====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|See details of '' 'Main Hook Directory' '' and '' 'Modules Hooks Files'. ''
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_10.png]]
+
|style="padding: 0px 0px 10px 15px;"|When added, the client's verification status will be '' 'Unconfirmed'. ''
 
|}
 
|}
−
====Database====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In this section a complete analysis of the following WHMCS database aspects is available:
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36_1.png]]
−
*Database Table List
+
−
*Suspicious Templates
+
−
*Logged Errors<br/>
+
−
Additionally, there is again a '' 'Brief Info' '' and '' 'Possible Issues' '' sections with suggested solutions.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_11.png]]
+
|style="padding: 0px 0px 10px 15px;"|To verify activation the new client needs to log in to their client area page and type in the token received via SMS.
 
|}
 
|}
−
====System Environment====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under this section you will find information on your system in general. These can be data on:<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36_2.png]]
−
''Please note that the below, these are only examples, results will depend on your system customization.''
+
 
|}
 
|}
 
{|
 
{|
−
|
+
|style="padding: 0px 0px 10px 15px;"|Client's status has now changed to '' 'Confirmed'.''
−
*Server Info
+
−
*Installed PHP Modules
+
−
*apache2handler
+
−
*Apache_Environment
+
−
*HTTP_Headers_Information
+
−
*bcmath
+
−
*bz2
+
−
*calendar
+
−
*Core
+
−
*ctype
+
−
*curl
+
−
*date
+
−
*dba
+
−
*dom
+
−
*ereg
+
−
*exif
+
−
*fileinfo
+
−
*filter
+
−
*ftp
+
−
*gd
+
−
*gettext
+
−
*hash
+
−
*iconv
+
−
|
+
−
*imap
+
−
*json
+
−
*libxml
+
−
*mbstring
+
−
*mcrypt
+
−
*mhash
+
−
*mongo
+
−
*mysql
+
−
*mysqli
+
−
*OAuth
+
−
*openssl
+
−
*pcre
+
−
*PDO
+
−
*pdo_mysql
+
−
*pdo_pgsql
+
−
*pgsql
+
−
*Phar
+
−
*posix
+
−
*pspell
+
−
*radius
+
−
*Reflection
+
−
*rrd
+
−
*runkit
+
−
|
+
−
*session
+
−
*shmop
+
−
*SimpleXML
+
−
*snmp
+
−
*soap
+
−
*sockets
+
−
*SPL
+
−
*ssh2
+
−
*standard
+
−
*svn
+
−
*sysvmsg
+
−
*tokenizer
+
−
*wddx
+
−
*xml
+
−
*xmlreader
+
−
*xmlrpc
+
−
*xmlwriter
+
−
*zip
+
−
*zlib
+
−
*Environment
+
−
*PHP_Variables
+
−
*PHP Init
+
−
*'''Possible Issues'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_36_3.png]]
 
|}
 
|}
 +
 +
====SMS Queuing====
 
{|
 
{|
−
====WHMCS Environment====
+
|style="padding: 10px 0px 20px 15px;"|Enable this option to allow text messages queues. Declare time intervals between attempts to send text messages and the number of messages <br/> that can be sent in one attempt. Finally, choose time period when text messages can be sent to clients.<br/><br/> Detailed information on this function is described [http://www.docs.modulesgarden.com/SMS_Center_For_WHMCS#SMS_Queue here.]
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Last but not least, your WHMCS environment with standard short summary in '' 'Brief Info' '' and '' 'Additional Info' '' boxes and a list of possible issues.<br> Besides There are details on :
+
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_24_3.png]]
−
*Active Payment Gateways
+
−
*Active Registrar Modules
+
−
*Active Provisioning Modules
+
 
|}
 
|}
 +
 +
==Management==
 +
===Templates===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_13.png]]
+
|style="padding: 10px 0px 15px 15px;"|'' 'Templates' '' tab contains the list of message templates. Each email template in your system has its text message counterpart.<br />
 +
Any of these messages can be enabled/disabled through marking/unmarking checkbox next to them and pressing '' 'Save'. ''
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Module comes with default message templates, but you can edit each of them.<br />
 +
Press '' 'Edit' '' to do so.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_13_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The first field is a default message of the template. Our module allows you to define messages for selected languages.<br />
 +
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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|As you can see on the screen below, a new field for chosen language appeared.<br />
 +
You can remove any additional language through pressing '' 'x' '' icon next to it.<br />
 +
''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.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Module template supports merge fields which can be easily injected into messages.<br />
 +
Simply, click on the wanted merge field, it will be injected into currently edited version of the message.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_16.png]]
 
|}
 
|}
  
−
===Download File===
+
===SMS Queue===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|If you want to save your scan results you may download the current analysis. Press '' 'Download Results' '' button to save the results in a ' ''.PDF' '' file.
+
|style="padding: 10px 0px 15px 15px;"|In this section you will find a list of all text messages waiting for a cron run to be sent. Specific details on messages that can be sent in one attempt are specified in '' 'General Settings' '' section.<br/> If SMS Queues are enabled every single message before being sent is placed on this list. With every cron run a previously set up number of messages is sent.<br/> If message sending fails (because the number is incorrect, there are problems with gate, no funds etc.) such SMS stays on the list for the next attempt.<br/> After three failed attempts its status is changed to '' 'Aborted'. '' <br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_15.png]]
+
|style="padding: 0px 0px 15px 15px;"|Actions:<br/>
 +
1. Send - send message manually.<br/>
 +
2. Reload - use when status has changed to '' 'Aborted' '' to bring it back to the queue.<br/>
 +
3. Delete - remove message form the list.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you decide to save the results after each scan, it will be possible to easily compare them and see any changes in your system.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_16_1.png]]
 
|}
 
|}
 +
===Mass SMS===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_16.png]]
+
|style="padding: 10px 0px 30px 15px;"|
 
|}
 
|}
 +
====Mass SMS Configuration====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|....
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_16_1.png]]
 +
|}
 +
====Mass SMS Templates====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|....
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_16_1.png]]
 +
|}
 +
 +
===Logs===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Messages sent to your clients are logged under '' 'Logs' '' tab.<br />
 +
As you can see on the following screen, here you can find detailed information about each message sent automatically to a client after certain actions.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_17.png]]
 +
|}
 +
 +
===Client's Summary Page===
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|From the clients' summary page you can send text messages to clients using only a simple box.<br />
 +
Type in the message text into the text field like on the screen below and press '' 'Send'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_25.png]]
 +
|}
 +
 +
==Client Area==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|After placing integration code, a new position appears in the client area navigation menu.<br />
 +
Through pressing it your client will be moved to configuration of SMS notification.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|In this place your client can choose which notifications to receive.<br />
 +
''Note! Provide SMS Number in the client's profile. Otherwise SMS Notifications will be unavailable for that client.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_19.png]]
 +
|}
 +
==SMS Center Two-Factor Authentication==
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''SMS center For WHMCS consists of two parts, the actual SMS Center addon and the authentication addon.'''<br /> Two-Factor Authentication adds an extra layer of protection while logging in. Once enabled and configured by a client or an admin,<br /> each time they sign in they will be asked to enter both username and password as well as a second factor such as a security code.<br />
 +
In order to activate it proceed to '' 'Setup' '' → '' 'Staff Management' '' → '' 'Two-Factor Authentication'. ''<br />
 +
Afterwards, find '' 'SMS Center Two-Factor Authentication,' '' and press '' 'Activate' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''In the next step you need to configure the addon settings. '''<br />
 +
To do so, fill out the data:
 +
*Enable for Clients - choose this option if you wish all clients to authenticate while logging in their account.
 +
*Enable for Staff - choose this option if you wish all administrators to authenticate while logging in their account.
 +
*Activation Code Valid For - decide how long a received code shall be valid, in minutes. Used once before the first log in.
 +
*SMS Code Valid For - decide how long a received via SMS code shall be valid, in minutes. Used every time to log in after the first authentication.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_21.png]]
 +
|}
 +
==Security Settings==
 +
===Clients===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|If you have activated '' 'SMS Two-Factor Authentication' '' addon, your clients will be allowed now to decide if they wish to use such security opportunity. <br />
 +
Here is how to enable such functionality: <br />
 +
1. Log in to your client area, proceed to '' 'Account Details' '' → '' 'Security Settings'. '' There is a button, which once pressed enables two factors authentication configuration for the client.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|2. Press '' 'Get Started' '' button to proceed with the process.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_27.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|3. Provide phone number to proceed with SMS Two-Factors Authentication. Press '' 'Activate'. ''<br />
 +
''This step will be skipped if the client entered a valid SMS number in the profile before!''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|4. A client should receive now an authentication code via SMS. <br /> Type in the code in the field and  press '' 'Activate.' ''<br /> ''Remember that the code is valid only temporarily, according to the addon settings!''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_29.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|5. Two-Factor Authentication is now complete.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_30.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|6. The second factor is now required to log in. Wait for the SMS with verification code and enter it in the field. Press '' 'Login.' '' <br />If you have any problems with receiving/entering the verification code, you can use your backup code. <br /> ''Remember to note and keep your new backup code in a secure place!''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_31.png]]
 +
|}
 +
 +
===Administrators===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|If  '' 'SMS Two-Factor Authentication' '' addon has been activated and enabled for staff, as an administrator you can decide if you wish to use such security opportunity. <br />
 +
Here is how to enable such functionality: <br />
 +
1. Proceed to '' 'My Account.' '' Find a button '' 'Click here to enable' '' and press it to start the Two-Factor Authentication process.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_32.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|2. Press '' 'Get Started' '' button to proceed with the process.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_33.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|3. You will receive now an authentication code via SMS.<br /> Type in the code in the field and  press '' 'Activate.' ''<br /> ''Remember that the code is valid only temporarily, according to the addon settings!''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_34.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_35.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|4. The second factor is now required to log in. Wait for the SMS with verification code and enter it in the field. Press '' 'Login.' '' <br />If you have any problems with receiving/entering the verification code, you can use your backup code. <br /> ''Remember to note and keep your new backup code in a secure place!''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_35_1.png]]
 +
|}
 +
==SMS Center And WHMCS API Integration==
 +
{|
 +
|style="padding: 10px 0px 10px 15px;"|Underneath you can find short instruction on how to integrate your SMS Center with WHMCS API.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|1. Function name:''' 'sendsms' '''<br/>
 +
 +
2. Required parameters:<br/>
 +
*''(phonenumber'') '''OR''' ''(userid)'' '''OR''' ''(adminid)''<br/>
 +
*:'''AND'''<br/>
 +
*''(messagename)'' with ''(relid)'' - ID of relation, for example invoice or service '''OR''' ''(message)'' - text of the message<br/>
 +
<br/>
 +
3. Where:<br/>
 +
''(Relid)'' for ''(userid)'' is an ''' 'integer' '''<br/>
 +
''(Relid)'' for ''(adminid)'' it is an ''' 'array' '''<br/>
 +
<br/>
 +
4. Standard usage example of sending an sms with specified message to a user with given ID:<br/>
 +
 +
localAPI('sendsms', array('userid' => $_POST['userid'], 'message' => $_POST['message']), 'admin');
 +
 +
5. Example of usage for admin 'array' with parameters:<br/>
 +
 +
array('admin' => 1,'phonenumber' => $number, 'messagename' => 'Service Unsuspension Successful',
 +
'relid' => array('client' => $params['params']['userid'], 'service' => $params['params']['serviceid']))
 +
<br/>
 +
In case you add ''phonenumber'' in the message, you must specify if it is admin's number by entering: '' 'admin' => 1,'' like in the example above.<br/> If this is user's number, then you no not need to add that.
 +
|}
 +
 +
=Additional Information=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|
 +
# SMS Center For WHMCS has been integrated with our Clients Profiler For WHMCS module.
 +
#:''Find more information about the integration on Clients Profiler For WHMCS [http://www.docs.modulesgarden.com/Clients_Profiler_For_WHMCS Wiki]. ''
 +
# SMS Center For WHMCS messages are divided into four categories:
 +
#*messages sent automatically to clients after actions (activity is logged in the addon '' 'Logs' '' tab)
 +
#*messages sent automatically to administrators after actions (activity is logged in WHMCS '' 'Activity Log' '')
 +
#*messages sent manually from client's profile (activity is logged in WHMCS '' 'Activity Log' '')
 +
#*messages sent manually from with Clients Profiler For WHMCS widget (activity is logged in WHMCS '' 'Activity Log' '').
 +
|}
 +
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1. Due to a huge size of '' 'System Environment' '' section, we advise to use '' 'Ctrl+F' '' keys shortage to look for precise information.
+
|style="padding: 10px 0px 30px 15px;"|
 
|}
 
|}
 
=Common Problems=
 
=Common Problems=
Line 367: Line 570:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|2. In case you encounter an error like on the screen below, please make sure you have completed step three of our installation instruction.  
+
|style="padding: 0px 0px 10px 15px;"|2. The module is not compatible with Multibrand For WHMCS: there are no contradictions to use the two products together, <br/>however, they are not integrated which means that a client may for example choose from (SMS) templates for every brand (text messages are not branded).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:WHA_17.png]]
+
|style="padding: 0px 0px 30px 15px;"|3. The module is not compatible with Resellers Center For WHMCS functionality.
 
|}
 
|}

Revision as of 10:39, 23 March 2016

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.

Contents

About SMS Center For WHMCS

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

You will be able to choose from seven different SMS gateways, define SMS templates in various languages and manage text messages in queues.
The module will allow you to verify new clients and orders as well as enable SMS codes as a part of two-factor authentication while logging in to your system.
You will also get the access to SMS messages logs in order to verify the status of each sent text message.

  • Admin Area Features:
✔ Notify Both Your Clients And Administrators via SMS Message
✔ Use SMS Queue To Send SMS Within Defined Time Period
✔ Manage List Of Queued SMS
✔ Define SMS Template Counterpart For Each Email Template
✔ Define Default SMS Template Version For Each Language
✔ Define Notifications To Receive Per Administrator
✔ Enable/Disable Administrator Notifications Per Admin
✔ Enable/Disable SMS Gateways
✔ Check Connection With SMS Gateways
✔ Enable/Disable SMS Templates
✔ Send SMS From Client Summary Page
✔ Merge Fields Support
✔ Characters Counter - Trace Length Of Your Messages
✔ Adjust Format Number To International Automatically
✔ View Logs
  • Client Area Features:
✔ Define SMS Notifications To Receive
  • Security And Verification:
✔ Two-Factor Authentication Submodule - Use Second Layer Of Security
✔ Verify New Client Accounts With SMS Token
✔ Verify New Orders With SMS Token
  • Supported Gateways:
✔ BearSMS
✔ BoxisSMS
✔ Clickatell
✔ InfoBip
✔ MessageBird
✔ SMSEagle
✔ SMSGlobal
  • General Info:
✔ Module API - Integrate Other SMS Gateways
✔ Integrated With Clients Profiler For WHMCS - Send SMS From Any WHMCS Place (read more)
✔ Multi-Language Support
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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 instructions.

Remember that integration depends on the WHMCS version and template that you are using. If your system used is WHMCS V6.x.x and template: 'Six', there is no need for you to do any integration.
However, if you are working with WHMCS V6.x.x template 'Five' or WHMCS V5 then you must insert the code snippets as it is explained on the screen below.

SMSC 8.png
8. The last thing you need to still do is setting up a cron job. It is advised to set the cron job with a 1 or 2 minutes interval.
/your_whmcs_dir/modules/addons/sms_center/crons/cron.php

Remember to replace your_whmcs_dir with a correct directory of your system.

9. 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 will find 'Submodules', 'Administrators' and 'General Settings' sections. Configure each of them to allow full usage of SMS Center For WHMCS module.
Press the first one 'Submodules' to configure and check connection with SMS gateways.

Submodules Configuration

Find here all possible gateways that can be used in our module.

You can use a recommended 'FastSMS' gateway:

SMSC 9 1.png
Or choose form other acceptable gateways:
SMSC 9 2.png
Press 'Configuration' 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

Administrators Configuration

This section contains a list of all staff administrators. You have the possibility here to decide who of them will receive SMS notifications and which notifications exactly.
Follow the steps described below to configure staff notifications properly.
Press 'Administrators' under 'Configuration' tab.
SMSC 22.png
In order to enable SMS notifications for administrators individually, firstly set configuration for them.

1. Fill in the administrator's phone number, where text messages with notifications will be sent.
2. Choose which of the available admin messages shall be sent to that administrator.
Save changes.

SMSC 23.png
Press 'Enable Notifications.'

Repeat these steps for every administrator you wish to receive admin notifications.

SMSC 24.png

General Settings

In 'General' section there are specific SMS configuration possibilities. Configure those you wish to activate and 'Save' the changes once ready!

By default, 'SMS Center' for client area is enabled, you may disable it here.

SMSC 24 1.png

Order SMS Activation

Enable 'Order SMS Activation' to allow activating orders once placed. Once an order is placed a client will receive a text message with a token,
which must be then used to finish the order.

Note, this option does not support orders upgrades!

SMSC 24 2.png
If the above option is enabled, a client when placing an order before being able to complete it must enter a valid token that was sent via SMS.
Only then the order can be completed.
SMSC 37.png
If provided token is correct, the order's verification status is changed to 'Confirmed'.
SMSC 37 1.png

Client SMS Activation

Enable 'Client SMS Activation' and every newly activated client will receive a token, which must be used to end up the activation process.

Declare time intervals for sending tokens here.

SMSC 24 4.png
With the above option enabled, the process of a new client's activation is a little bit different. Start with filling out the client's details.
SMSC 36.png
When added, the client's verification status will be 'Unconfirmed'.
SMSC 36 1.png
To verify activation the new client needs to log in to their client area page and type in the token received via SMS.
SMSC 36 2.png
Client's status has now changed to 'Confirmed'.
SMSC 36 3.png

SMS Queuing

Enable this option to allow text messages queues. Declare time intervals between attempts to send text messages and the number of messages
that can be sent in one attempt. Finally, choose time period when text messages can be sent to clients.

Detailed information on this function is described here.
SMSC 24 3.png

Management

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

SMS Queue

In this section you will find a list of all text messages waiting for a cron run to be sent. Specific details on messages that can be sent in one attempt are specified in 'General Settings' section.
If SMS Queues are enabled every single message before being sent is placed on this list. With every cron run a previously set up number of messages is sent.
If message sending fails (because the number is incorrect, there are problems with gate, no funds etc.) such SMS stays on the list for the next attempt.
After three failed attempts its status is changed to 'Aborted'.
Actions:

1. Send - send message manually.
2. Reload - use when status has changed to 'Aborted' to bring it back to the queue.
3. Delete - remove message form the list.

SMSC 16 1.png

Mass SMS

Mass SMS Configuration

....
SMSC 16 1.png

Mass SMS Templates

....
SMSC 16 1.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 sent automatically to a client after certain actions.

SMSC 17.png

Client's Summary Page

From the clients' summary page you can send text messages to clients using only a simple box.

Type in the message text into the text field like on the screen below and press 'Send'.

SMSC 25.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

SMS Center Two-Factor Authentication

SMS center For WHMCS consists of two parts, the actual SMS Center addon and the authentication addon.
Two-Factor Authentication adds an extra layer of protection while logging in. Once enabled and configured by a client or an admin,
each time they sign in they will be asked to enter both username and password as well as a second factor such as a security code.

In order to activate it proceed to 'Setup' → 'Staff Management' → 'Two-Factor Authentication'.
Afterwards, find 'SMS Center Two-Factor Authentication,' and press 'Activate' button.

SMSC 20.png
In the next step you need to configure the addon settings.

To do so, fill out the data:

  • Enable for Clients - choose this option if you wish all clients to authenticate while logging in their account.
  • Enable for Staff - choose this option if you wish all administrators to authenticate while logging in their account.
  • Activation Code Valid For - decide how long a received code shall be valid, in minutes. Used once before the first log in.
  • SMS Code Valid For - decide how long a received via SMS code shall be valid, in minutes. Used every time to log in after the first authentication.
SMSC 21.png

Security Settings

Clients

If you have activated 'SMS Two-Factor Authentication' addon, your clients will be allowed now to decide if they wish to use such security opportunity.

Here is how to enable such functionality:
1. Log in to your client area, proceed to 'Account Details' → 'Security Settings'. There is a button, which once pressed enables two factors authentication configuration for the client.

SMSC 26.png
2. Press 'Get Started' button to proceed with the process.
SMSC 27.png
3. Provide phone number to proceed with SMS Two-Factors Authentication. Press 'Activate'.

This step will be skipped if the client entered a valid SMS number in the profile before!

SMSC 28.png
4. A client should receive now an authentication code via SMS.
Type in the code in the field and press 'Activate.'
Remember that the code is valid only temporarily, according to the addon settings!
SMSC 29.png
5. Two-Factor Authentication is now complete.
SMSC 30.png
6. The second factor is now required to log in. Wait for the SMS with verification code and enter it in the field. Press 'Login.'
If you have any problems with receiving/entering the verification code, you can use your backup code.
Remember to note and keep your new backup code in a secure place!
SMSC 31.png

Administrators

If 'SMS Two-Factor Authentication' addon has been activated and enabled for staff, as an administrator you can decide if you wish to use such security opportunity.

Here is how to enable such functionality:
1. Proceed to 'My Account.' Find a button 'Click here to enable' and press it to start the Two-Factor Authentication process.

SMSC 32.png
2. Press 'Get Started' button to proceed with the process.
SMSC 33.png
3. You will receive now an authentication code via SMS.
Type in the code in the field and press 'Activate.'
Remember that the code is valid only temporarily, according to the addon settings!
SMSC 34.png
SMSC 35.png
4. The second factor is now required to log in. Wait for the SMS with verification code and enter it in the field. Press 'Login.'
If you have any problems with receiving/entering the verification code, you can use your backup code.
Remember to note and keep your new backup code in a secure place!
SMSC 35 1.png

SMS Center And WHMCS API Integration

Underneath you can find short instruction on how to integrate your SMS Center with WHMCS API.
1. Function name: 'sendsms'

2. Required parameters:

  • (phonenumber) OR (userid) OR (adminid)
    AND
  • (messagename) with (relid) - ID of relation, for example invoice or service OR (message) - text of the message


3. Where:
(Relid) for (userid) is an 'integer'
(Relid) for (adminid) it is an 'array'

4. Standard usage example of sending an sms with specified message to a user with given ID:

localAPI('sendsms', array('userid' => $_POST['userid'], 'message' => $_POST['message']), 'admin');

5. Example of usage for admin 'array' with parameters:

array('admin' => 1,'phonenumber' => $number, 'messagename' => 'Service Unsuspension Successful',
'relid' => array('client' => $params['params']['userid'], 'service' => $params['params']['serviceid']))


In case you add phonenumber in the message, you must specify if it is admin's number by entering: 'admin' => 1, like in the example above.
If this is user's number, then you no not need to add that.

Additional Information

  1. SMS Center For WHMCS has been integrated with our Clients Profiler For WHMCS module.
    Find more information about the integration on Clients Profiler For WHMCS Wiki.
  2. SMS Center For WHMCS messages are divided into four categories:
    • messages sent automatically to clients after actions (activity is logged in the addon 'Logs' tab)
    • messages sent automatically to administrators after actions (activity is logged in WHMCS 'Activity Log' )
    • messages sent manually from client's profile (activity is logged in WHMCS 'Activity Log' )
    • messages sent manually from with Clients Profiler For WHMCS widget (activity is logged in WHMCS 'Activity Log' ).

Tips

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. The module is not compatible with Multibrand For WHMCS: there are no contradictions to use the two products together,
however, they are not integrated which means that a client may for example choose from (SMS) templates for every brand (text messages are not branded).
3. The module is not compatible with Resellers Center For WHMCS functionality.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=23949"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community