|
|
(735 intermediate revisions by 6 users not shown) |
Line 1: |
Line 1: |
− | <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="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta> |
− | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The SMS Center For WHMCS Module."></meta> | + | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta> |
| | | |
− | <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/>
| + | =About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]= |
− | 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;"|'''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 /> | + | |style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage. |
− | You will be able to choose from seven different SMS gateways, define SMS templates in various languages and manage text messages in queues.<br />
| + | Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<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 can also define email templates and view details of each sent notification owing to logs. |
− | You will also get the access to SMS messages logs in order to verify the status of each sent text message.<br /> | + | |
| |} | | |} |
− | <!-- fixed --> | + | <!--a comment maybe? --> |
| *'''Admin Area Features:''' | | *'''Admin Area Features:''' |
| {| | | {| |
− | |style="padding: 10px 0px 0px 30px;"|✔ Notify Both Your Clients And Administrators via SMS Message | + | |style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Use SMS Queue To Send SMS Within Defined Time Period | + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Manage List Of Queued SMS | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define SMS Template Counterpart For Each Email Template | + | |style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Default SMS Template Version For Each Language | + | |style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Notifications To Receive Per Administrator | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Administrator Notifications Per Admin | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable SMS Gateways | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Check Connection With SMS Gateways
| + | |style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable SMS Templates
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Send SMS From Client Summary Page
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Merge Fields Support
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Characters Counter - Trace Length Of Your Messages
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Adjust Format Number To International Automatically
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 10px 30px;"|✔ View Logs | + | |
− | |}
| + | |
− | *'''Client Area Features:'''
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 10px 30px;"|✔ Define SMS Notifications To Receive
| + | |
− | |}
| + | |
− | *'''Security And Verification:'''
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 0px 30px;"|✔ Two-Factor Authentication Submodule - Use Second Layer Of Security
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Verify New Client Accounts With SMS Token
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 10px 30px;"|✔ Verify New Orders With SMS Token
| + | |
− | |}
| + | |
− | *'''Supported Gateways:'''
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 0px 30px;"|✔ BearSMS
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ BoxisSMS
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Clickatell
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ InfoBip
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ MessageBird
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ SMSEagle
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 10px 30px;"|✔ SMSGlobal
| + | |
| |} | | |} |
| *'''General Info:''' | | *'''General Info:''' |
| {| | | {| |
− | |style="padding: 10px 0px 0px 30px;"|✔ Module API - Integrate Other SMS Gateways | + | |style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support |
| |} | | |} |
| {| | | {| |
− | |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 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2 |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
| + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6 | + | |
| |} | | |} |
| | | |
| =Installation= | | =Installation= |
| {| | | {| |
− | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure SMS Center For WHMCS.''' <br /> | + | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br /> |
− | We will guide you step by step through the whole installation and configuration process. | + | We will guide you step by step through the whole installation and configuration process. |
| |} | | |} |
| ==Installation== | | ==Installation== |
| {| | | {| |
− | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download SMS Center For WHMCS.''' | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]] |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br /> | + | |style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/> |
− | Files in your WHMCS directory should look like on the following screen.
| + | '' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.''' |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_2.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.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 /> | + | |style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br /> |
− | File is located in '' 'modules/addons/sms_center/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
| + | The content of PHP version files should look like this. |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_3.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:drfere.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 /> | + | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.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'. ''
| + | File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:SMSC_4.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]] |
| |} | | |} |
− | ==Activate The Addon==
| |
| {| | | {| |
− | |style="padding: 10px 0px 15px 15px;"|'''5. Now, you have to activate the module in your WHMCS system.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br /> |
− | Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
| + | Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products' ''. |
− | Afterwards, find '' 'SMS Center' '' and press '' 'Activate' '' button.
| + | |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_5.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]] |
| |} | | |} |
| + | |
| + | ==Configuration of Addon== |
| {| | | {| |
− | |style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br /> | + | |style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> |
− | To do so, click on '' 'Configure' '' button, tick checkboxes to assign desired admin roles.<br />
| + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button. |
− | 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 25px;"|[[File:HQN_5.png]] |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 15px;"|'''7. Now, proceed to the addon → '' 'Integration Code' '' and follow integration instructions.'''<br/> | + | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<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/>
| + | To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''. |
− | 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 30px 25px;"|[[File:HQN_6.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/> | + | |style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br /> |
− | /your_whmcs_dir/modules/addons/sms_center/crons/cron.php
| + | You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''. |
− | 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!''' | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]] |
| |} | | |} |
| | | |
| =Configuration and Management= | | =Configuration and Management= |
| {| | | {| |
− | |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.''' | + | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.''' |
| |} | | |} |
| ==Configuration== | | ==Configuration== |
| {| | | {| |
− | |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. | + | |style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br /> |
| + | You can enable/disable any of them, as well as alter or completely remove them.<br /> |
| + | Press '' 'Create New Group' '' to proceed. |
| |} | | |} |
− | ===Submodules Configuration===
| |
| {| | | {| |
− | |style="padding: 10px 0px 20px 15px;"|Find here all possible gateways that can be used in our module. | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]] |
− | You can use a recommended '' 'FastSMS' '' gateway:
| + | |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9_1.png]] | + | |style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br /> |
| + | You can choose between two types of resource usage counting:<br /> |
| + | *Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent. |
| + | *Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent. |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 15px 15px;"|Or choose form other acceptable gateways: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]] |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9_2.png]] | + | |style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br /> |
| + | As you can see, we have defined limits for both bandwidth and disk.<br /> |
| + | Settings shown below result in sending notification to client upon: |
| + | *bandwidth usage growth by 5GB during 21 days. |
| + | *disk usage growth by 100GB over period of 14 days. |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 15px 15px;"|Press '' 'Configuration' '' next to a gateway you wish to use. | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]] |
| |} | | |} |
| + | ==Logs== |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9.png]] | + | |style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications. |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 15px 15px;"|Configuration of each gateway may vary depending on its requirements.<br /> | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]] |
− | As an example we will configure SMSEagle gateway.
| + | |
| |} | | |} |
| + | ==Notifications== |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_10.png]] | + | |style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br /> |
| + | The only requirement is their type being set to '' 'Product/Service' ''.<br /> |
| + | Additionally, you can use {if} statement, as shown below: |
| + | {if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if} |
| + | {if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if} |
| + | It will allow you to use this email template for bandwidth and disk notifications at the same time. |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 15px;"|You can check whether configuration is correct through pressing '' 'Check Connection'.''
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]] |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_11.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |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 30px 25px;"|[[File:SMSC_12.png]] | + | |
| |} | | |} |
| | | |
− | ===Administrators Configuration=== | + | =Tips= |
− | {|
| + | |
− | |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 15px;"|Press '' 'Administrators' '' under '' 'Configuration' '' tab.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |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 20px 25px;"|[[File:SMSC_23.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|Press '' 'Enable Notifications.' ''<br />
| + | |
− | Repeat these steps for every administrator you wish to receive admin notifications.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:SMSC_24.png]]
| + | |
− | |}
| + | |
− | | + | |
− | ===General Settings===
| + | |
− | {|
| + | |
− | |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/>
| + | |
− | By default, '' 'SMS Center' '' for client area is enabled, you may disable it here.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:SMSC_24_1.png]]
| + | |
− | |}
| + | |
− | ====Order SMS Activation====
| + | |
− | {|
| + | |
− | |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/>
| + | |
− | ''Note, this option does not support orders upgrades!''
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_24_2.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 25px;"|[[File:SMSC_37.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 30px 25px;"|[[File:SMSC_37_1.png]]
| + | |
− | |}
| + | |
− | | + | |
− | ====Client SMS Activation====
| + | |
− | {|
| + | |
− | |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.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_24_4.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.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 10px 15px;"|When added, the client's verification status will be '' 'Unconfirmed'. ''
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36_1.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.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36_2.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 10px 15px;"|Client's status has now changed to '' 'Confirmed'.''
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:SMSC_36_3.png]]
| + | |
− | |}
| + | |
− | | + | |
− | ====SMS Queuing====
| + | |
− | {|
| + | |
− | |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: 0px 0px 30px 25px;"|[[File:SMSC_24_3.png]]
| + | |
− | |}
| + | |
− | | + | |
− | ==Management==
| + | |
− | ===Templates===
| + | |
− | {|
| + | |
− | |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]]
| + | |
− | |}
| + | |
− | | + | |
− | ===SMS Queue===
| + | |
− | {|
| + | |
− | |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 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 25px;"|[[File:SMSC_16_1.png]]
| + | |
− | |}
| + | |
− | ===Mass SMS===
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 30px 15px;"|Sending mass text messaged to your clients is a convenient tool that allows preparing ready made messages that will be delivered to group of clients according to specified configuration.
| + | |
− | |}
| + | |
− | ====Mass SMS Templates====
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|Firstly, please move to '' 'Mass SMS' → 'Templates', '' there create templates for mass texting.<br/>
| + | |
− | Press '' 'Create New Template' '' to begin.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 25px;"|[[File:SMSC_44.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|You are move to template creation site.<br/> Enter your template name, choose a group it will belong to and type in the message text. Use available for the group merge fields. Do not forget to save the changes.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 25px;"|[[File:SMSC_45.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|All created templates are available to edit or remove when no longer used.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:SMSC_46.png]]
| + | |
− | |}
| + | |
− | ====Mass SMS Configuration====
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|Now, that you have created the templates move to '' 'Mass SMS', '' there configure the recipient group. Use filtering fields to set it up as you need.<br/>
| + | |
− | Select the type of filtering, you can choose from:
| + | |
− | *'' 'General' '' filtering
| + | |
− | *filtering according to addons, domains or products. <br/><br/>
| + | |
− | Each filter type configuration differs slightly, but there are some general settings available for each type. These are:
| + | |
− | *Custom Fields - Marketing SMS - if you enable it, clients will receive marketing notifications
| + | |
− | *Client Group - select which of your client groups will receive mass messages
| + | |
− | *Client Status - you may choose clients to receive messages depending on their status in your system.
| + | |
− | *Language - select default language for the messages.<br/>
| + | |
− | All the above sections are available for '' ' General' '' client filter.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 25px;"|[[File:SMSC_40.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|Every other filter includes these options as well, but there are also some additional filters to choose form for each of the types:<br/>
| + | |
− | '''Client Filter - Addon'''<br/>
| + | |
− | *select addon status
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 25px;"|[[File:SMSC_41.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|'''Client Filter - Domain'''<br/>
| + | |
− | *select domain status
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 25px;"|[[File:SMSC_42.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|'''Client Filter - Product'''<br/>
| + | |
− | *select products
| + | |
− | *select product status
| + | |
− | *select assigned server
| + | |
− | Press '' 'Compose Message' '' to contiune sending mass messages.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 25px;"|[[File:SMSC_43.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|When you have your filter ready, you will be moved to the next step where you may create a new text message or upload one of your previously prepared templates.<br> Choose it from dropdown menu and press '' 'Load'.'' When message is ready, press '' 'Next'. ''
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 25px;"|[[File:SMSC_47.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|You can see now how the final SMs looks like and see the list of clients that will receive the message. If everything is correct, press '' 'Send Message'.''
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:SMSC_48.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;"| | | |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= | + | =Update Instructions= |
| {| | | {| |
− | |style="padding: 10px 0px 30px 15px;"|1. You may customize the text of '' 'Two-Factor Authentication' '' verification message delivered to a user. | + | |style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/> |
− | :Change the message content in the addon language file.
| + | Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/> |
| + | To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/> |
| |} | | |} |
− |
| |
| =Common Problems= | | =Common Problems= |
| {| | | {| |
− | |style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' | + | |style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' |
− | |}
| + | |
− | {|
| + | |
− | |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 30px 15px;"|3. The module is not compatible with Resellers Center For WHMCS functionality.
| + | |
| |} | | |} |