Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Tips)
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="support tickets limiter for whmcs, support tickets limiter configuration, whmcs support tickets limiter management, whmcs support tickets limiter installation, whmcs support tickets limiter common problems, about whmcs support tickets limiter, whmcs support tickets limiter documentation, whmcs support tickets limiter faq, whmcs support tickets limiter help, whmcs support tickets limiter guide, whmcs support tickets limiter wiki, whmcs support tickets limiter tutorial, whmcs support tickets limiter tips, whmcs support tickets limiter 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 Support Tickets Limiter 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 [http://www.modulesgarden.com/products/whmcs/support_tickets_limiter/features Support Tickets Limiter 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;"|'''Support Tickets Limiter For WHMCS''' will allow you to control the access to your support and charge fees for creating tickets in certain departments.<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 enables your clients to purchase products and product addons containing support credit points used for creating support tickets in chosen departments.
−
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 -->
−
*'''Admin Area Features:'''
+
*'''Module Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Notify Both Your Clients And Administrators via SMS Message
+
|style="padding: 10px 0px 0px 30px;"|✔ Add Support Credit Points Upon Ordering Specified Product Or Addon - Depending On Applied Rule
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Use SMS Queue To Send SMS Within Defined Time Period
+
|style="padding: 0px 0px 0px 30px;"|✔ Remove Fixed Number Of Support Credit Points Upon Ticket Creation
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage List Of Queued SMS
+
|style="padding: 0px 0px 0px 30px;"|✔ Block Possibility To Create Tickets When Client Has Insufficient Number Of Support Credit Points
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define SMS Template Counterpart For Each Email Template
+
|style="padding: 0px 0px 10px 30px;"|✔ Store And Manage Support Credit Points Per Department
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Default SMS Template Version For Each Language
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Notifications To Receive Per Administrator
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Administrator Notifications Per Admin
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable SMS Gateways
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Check Connection With SMS Gateways
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable SMS Templates
+
 
|}
 
|}
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Send SMS From Client Summary Page
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Merge Fields Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Create/Edit/Remove Rules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Characters Counter - Trace Length Of Your Messages
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Rules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Adjust Format Number To International Automatically
+
|style="padding: 0px 0px 0px 30px;"|✔ View Support Credit Points Owned By Clients
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
|style="padding: 0px 0px 10px 30px;"|✔ Modify Number Of Support Credit Points Owned By Clients
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 10px 30px;"|✔ Define SMS Notifications To Receive
+
|style="padding: 10px 0px 0px 30px;"|✔ Order Support Credit Points
 
|}
 
|}
−
*'''Security And Verification:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Two-Factor Authentication Submodule - Use Second Layer Of Security
+
|style="padding: 0px 0px 0px 30px;"|✔ View Available Support Credit Points Per Ticket Department
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Verify New Client Accounts With SMS Token
+
|style="padding: 0px 0px 10px 30px;"|✔ View Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority
 
|}
 
|}
 +
*'''Rules Configuration:'''
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Verify New Orders With SMS Token
+
|style="padding: 10px 0px 0px 30px;"|✔ Set Rule Type - Product/Product Group/Product Addon
 
|}
 
|}
−
*'''Supported Gateways:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ BearSMS
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Items Upon Ordering Which, Support Credit Points Are Added To Client's Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ BoxisSMS
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Number Of Support Credit Points That Client's Account Shall Be Increased By
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Clickatell
+
|style="padding: 0px 0px 0px 30px;"|✔ Define To Which Department Support Credit Points Should Be Added
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ InfoBip
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Whether Support Credit Points Are Added To Client's Account After Each Billing Cycle Or Once Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ MessageBird
+
|style="padding: 0px 0px 10px 30px;"|✔ View Rule Status
−
|}
+
−
{|
+
−
|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;"|✔ Multi-Language Support
+
 
|}
 
|}
 
{|
 
{|
Line 114: Line 79:
 
=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 0px 15px;"|'''This tutorial will show you how to successfully install and configure Support Tickets Limiter 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==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download SMS Center For WHMCS.'''
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Support Tickets Limiter For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_1.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
 
|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.
+
Files in your WHMCS directory should look like these.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_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 />
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Support Tickets Limiter 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'. ''
+
File is located in '' 'modules/addons/SupportTicketsLimiter/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 20px 25px;"|[[File:STL_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 />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a 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'. ''  
+
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]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_4.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. 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 />
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Support Tickets Limiter' '' and press '' 'Activate' '' button.
−
Afterwards, find '' 'SMS Center' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_5.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
 
|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 />
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near desired admin role groups and press '' 'Save Changes'. ''
−
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:STL_6.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. Proceed to '' 'Addons' '' → '' 'Support Tickets Limiter' '' → '' 'Integration Code' '' and follow steps listed there.'''
−
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 20px 25px;"|[[File:STL_7.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 30px 15px;"|'''8. You have just successfully installed Support Tickets Limiter For WHMCS!'''
−
/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!'''
+
 
|}
 
|}
  
 
=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;"|'''At this section we will show you possibilities of Support Tickets Limiter For WHMCS.'''<br />
 +
Our module allows you to limit the quantity of new support tickets through introducing Support Credit Points.<br />
 +
Those Support Credit Points will be required to open new tickets.<br />
 +
The amount of Support Credit Points required to do so may vary depending on tickets' status and department they are created in.<br />
 +
Support Credit Points may be obtained along with your products or by ordering special products or product addons.
 
|}
 
|}
−
==Configuration==
+
==Rules List==
 
{|
 
{|
−
|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;"|Rules section defines which products or product addons your clients can receive Support Credit Points for.<br />
 +
Additionally, they define which department they can be spent in and if they are granted one time or with product's each billing cycle.<br />
 +
As you can see, basic information related to the rules is listed in the '' 'Rules List''' tab.
 
|}
 
|}
−
===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:STL_9.png]]
−
You can use a recommended '' 'FastSMS' '' gateway:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|You can view items assigned to the rule as well as departments, which Support Credit Points will be granted to, by pressing buttons marked on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Or choose form other acceptable gateways:
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9_2.png]]
+
|style="padding: 0px 0px 20px 15px;"|Additionally, you can easily manage each of the rules by using buttons in the '' 'Actions' '' column.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Press '' 'Configuration' '' next to a gateway you wish to use.
+
|style="padding: 0px 0px 30px 25px;"|[[File:STL_11.png]]
 
|}
 
|}
 +
 +
==Add Rule==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_9.png]]
+
|style="padding: 10px 0px 20px 15px;"|Let us add a new rule, press '' 'Add Rule' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Configuration of each gateway may vary depending on its requirements.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_12.png]]
−
As an example we will configure SMSEagle gateway.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_10.png]]
+
|style="padding: 0px 0px 15px 15px;"|Step 1. Fill in rule name and select rule type through pressing '' 'Select' '' button next to the desired item.<br />
 +
Item type selected here defines the type of the item, for ordering which, your clients receive Support Credit Points.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can check whether configuration is correct through pressing '' 'Check Connection'.''
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_11.png]]
+
|style="padding: 0px 0px 15px 15px;"|Step 2. Select items which order and activation result in receiving Support Credit Points.<br />
 +
Alternatively, you can switch '' 'Select All' '' to '' 'On' '', then, this rule will be applied to all items in the selected items type.<br />
 +
Press '' 'Next' '' or '' 'Step 3' '' to continue.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If connection is successful, we can proceed.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_14.png]]
−
Activate the gateway, press '' 'Enable' '' next to it.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_12.png]]
+
|style="padding: 0px 0px 15px 15px;"|Step 3. Now, define departments to apply Support Credit Points to by selecting desired ones or switching '' 'Select All' '' to '' 'On' ''<br />
 +
Next, select billing options for this rule, fill in amount of Support Credit Points added by the rule and select the rule status.<br />
 +
Confirm creation of this rule through pressing '' 'Finish' '' button.
 
|}
 
|}
−
 
−
===Administrators Configuration===
 
 
{|
 
{|
−
|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:STL_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Press '' 'Administrators' '' under '' 'Configuration' '' tab.
+
|style="padding: 0px 0px 20px 15px;"|As you can see on the following screen, the rule has been successfully added.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:STL_16.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===
+
==Department 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: 10px 0px 15px 15px;"|By default, all tickets are free to open.<br />
 +
In the '' 'Department Settings' '' tab you can define price per ticket.<br />
 +
Let's set up support credit points required to open tickets in the '' 'Feedback' '' support department.<br />
 +
Press '' 'Show Details' '' next to the '' 'Feedback' '' department as shown on the following screen to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_37.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_17.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 15px 15px;"|Now, start by defining base price per ticket. That price will be added to the price per ticket status.<br />
 +
Afterwards, fill in the prices for low, normal and high status tickets.<br />
 +
Confirm those settings through pressing '' 'Save' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_37_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:STL_18.png]]
 
|}
 
|}
  
−
====Client SMS Activation====
+
==Clients==
 
{|
 
{|
−
|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/>
+
|style="padding: 10px 0px 15px 15px;"|In the '' 'Clients' '' tab you can view the amount of Support Credit Points owned by your clients.<br />
−
Declare time intervals for sending tokens here.
+
You can use filter to search for a specific client.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_24_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_19.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 15px;"|To display/hide client's Support Credit Points, press '' 'Show Detailed Information' ''/'' 'Hide  Detailed Information' '' as shown on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|When added, the client's verification status will be '' 'Unconfirmed'. ''
+
|style="padding: 0px 0px 20px 15px;"|You can also manually add/remove credit points to a client, press '' 'Modify Support Credit Points' '' to do so.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_21.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 15px;"|Now, fill in the amount of Support Credit Points to be added or removed and then press '' 'Save' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_36_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:STL_22.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====
+
==Client Area==
−
{|
+
−
|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 />
+
|style="padding: 10px 0px 15px 15px;"|Let's proceed to the client area in order to create a ticket.<br />
−
You can remove any additional language through pressing '' 'x' '' icon next to it.<br />
+
As you can see, one of the departments is unavailable because this client does not own any Support Ticket Points of this department.<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.''
+
Let's create a ticket in '' '24/7 Support' '' department.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Module template supports merge fields which can be easily injected into messages.<br />
+
|style="padding: 0px 0px 15px 15px;"|As you can see, your client can view his Support Credit Points for chosen department.<br />
−
Simply, click on the wanted merge field, it will be injected into currently edited version of the message.
+
Additionally, he can see price per each ticket priority as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_16.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:STL_23_1.png]]
 
|}
 
|}
  
−
===SMS Queue===
+
==Sample Workflow==
 
{|
 
{|
−
|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: 10px 0px 30px 15px;"|In this section we will show you basic workflow of Support Ticket Limiter For WHMCS usage.
 
|}
 
|}
 +
===New Product Department===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Actions:<br/>
+
|style="padding: 10px 0px 15px 15px;"|1. Let's start by creating new ticket department, proceed to '' 'Setup' '' → '' 'Support' '' → '' 'Support Departments' ''.<br />
−
1. Send - send message manually.<br/>
+
Now, press '' 'Add New Department' ''.
−
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]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_24.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.  
+
|style="padding: 0px 0px 15px 15px;"|2. Fill in department name, description and email address.<br />
 +
Additionally, assign administrators to it, mark '' 'Clients Only' '' and press '' 'Add New Department' ''.
 
|}
 
|}
−
====Mass SMS Templates====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Firstly, please move to '' 'Mass SMS' → 'Templates', '' there create templates for mass texting.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:STL_25.png]]
−
Press '' 'Create New Template' '' to begin.
+
 
|}
 
|}
 +
===New Product Addon===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:SMSC_44.png]]
+
|style="padding: 10px 0px 15px 15px;"|3. Now, let's create a rule, which will add Support Credit Points to the new department.<br />
 +
In our case, Support Credit Points will be added through product addon.<br />
 +
Therefore, we need to create the product addon first.<br />
 +
Proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and press '' 'Add New Addon' ''.
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:STL_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:SMSC_45.png]]
+
|style="padding: 0px 0px 15px 15px;"|4. Fill in addon name, description and one time pricing.<br />
 +
Additionally, choose one time billing type, mark '' 'Show on Order' '' and assign desired products.<br />
 +
Proceed through pressing '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|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:STL_27.png]]
−
|}
+
−
{|
+
−
|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===
+
===New Rule===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Messages sent to your clients are logged under '' 'Logs' '' tab.<br />
+
|style="padding: 10px 0px 20px 15px;"|5. Go to '' 'Addons' '' → '' 'Support Ticket Limiter' '' and press '' 'Add Rule'. ''<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.
+
6. Fill in rule name and select '' 'Product Addon' '' rule type.<br />
 +
7. Now, select previously created product addon and press '' 'Next'. ''<br />
 +
8. Set up previously created department and select '' 'One Time' '' from '' 'Support Credit Points Frequency' '' dropdown menu.<br />
 +
Now, fill in 200 into '' 'Support Credit Points' '' field and press '' 'Finish'. ''<br />
 +
9. As you can see, rule appeared in rule list and is ready for use.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:STL_28.png]]
 
|}
 
|}
  
−
===Client's Summary Page===
+
===Department Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|From the clients' summary page you can send text messages to clients using only a simple box.<br />
+
|style="padding: 10px 0px 15px 15px;"|10. Let's set up amount of points required to open tickets in previously created department.<br />
−
Type in the message text into the text field like on the screen below and press '' 'Send'. ''
+
Proceed to the '' 'Department Settings' '' tab and press '' 'Show Details' '' next to the previously created department.
−
|}
+
<br/><br/>
−
{|
+
11. Let's leave '' 'Required Points' '' at 0, and fill in ''Low' '', '' 'Normal' '' and '' 'High' '' ticket statuses sequentially with 30, 60 and 120.<br />
−
|style="padding: 0px 0px 30px 25px;"|[[File:SMSC_25.png]]
+
Press '' 'Save' '' to confirm changes.
 
|}
 
|}
  
−
==Client Area==
+
===Example Order===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|After placing integration code, a new position appears in the client area navigation menu.<br />
+
|style="padding: 10px 0px 20px 15px;"|12. Log into client account and order one of product with the previously created product addon.
−
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 30px 25px;"|[[File:STL_29.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===
+
===New Ticket===
 
{|
 
{|
−
|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 />
+
|style="padding: 10px 0px 15px 15px;"|13. After payment, both the product and the ordered along with it product addon are active.<br />
−
Here is how to enable such functionality: <br />
+
200 Support Credit Points were granted to this account and now can be spent on '' '24/7 Support' '' department as shown on the following screen.<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 25px;"|[[File:STL_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|2. Press '' 'Get Started' '' button to proceed with the process.
+
|style="padding: 0px 0px 15px 15px;"|14. Let's use Support Credit Points by opening new ticket in the '' '24/7 Support' '' department with '' 'High' '' status.<br />
 +
It will cost us 120 Support Credit Points, there should be 200 points on your account so you can afford creating of only one ticket with '' 'High' '' status.<br />
 +
Proceed with creation of this ticket.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_33.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_31.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 15px;"|15. As you can see on the following screen, ticket was successfully created.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_34.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STL_32.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SMSC_35.png]]
+
|style="padding: 0px 0px 20px 15px;"|16. As well as Support Credit Points was removed from '' '24/7 Support' '' department.
 
|}
 
|}
 
{|
 
{|
−
|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:STL_33.png]]
−
|}
+
−
{|
+
−
|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. You may customize the text of '' 'Two-Factor Authentication' '' verification message delivered to a user.
+
|style="padding: 10px 0px 30px 15px;"|1. It is advised to set one of the departments as a free of charge one. Remember to assign it the lowest priority of support to keep other competitive.
−
:Change the message content in the addon language file.
+
 
|}
 
|}
  
 
=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.
+
 
|}
 
|}

Revision as of 10:15, 31 March 2016

Contents

About Support Tickets Limiter For WHMCS

Support Tickets Limiter For WHMCS will allow you to control the access to your support and charge fees for creating tickets in certain departments.

The module enables your clients to purchase products and product addons containing support credit points used for creating support tickets in chosen departments.

  • Module Features:
✔ Add Support Credit Points Upon Ordering Specified Product Or Addon - Depending On Applied Rule
✔ Remove Fixed Number Of Support Credit Points Upon Ticket Creation
✔ Block Possibility To Create Tickets When Client Has Insufficient Number Of Support Credit Points
✔ Store And Manage Support Credit Points Per Department
  • Admin Area Features:
✔ Define Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority
✔ Create/Edit/Remove Rules
✔ Enable/Disable Rules
✔ View Support Credit Points Owned By Clients
✔ Modify Number Of Support Credit Points Owned By Clients
  • Client Area Features:
✔ Order Support Credit Points
✔ View Available Support Credit Points Per Ticket Department
✔ View Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority
  • Rules Configuration:
✔ Set Rule Type - Product/Product Group/Product Addon
✔ Define Items Upon Ordering Which, Support Credit Points Are Added To Client's Account
✔ Define Number Of Support Credit Points That Client's Account Shall Be Increased By
✔ Define To Which Department Support Credit Points Should Be Added
✔ Define Whether Support Credit Points Are Added To Client's Account After Each Billing Cycle Or Once Only
✔ View Rule Status
  • General Info:
✔ 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 Support Tickets Limiter For WHMCS.

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

1. Log in to your client area and download Support Tickets Limiter For WHMCS.
File:STL 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

File:STL 2.png
3. When you install Support Tickets Limiter for the first time you have to rename 'license_RENAME.php' file.

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

File:STL 3.png
4. In order to configure your license key, you have to edit a 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'.

File:STL 4.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Support Tickets Limiter' and press 'Activate' button.

File:STL 5.png
6. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes'.

File:STL 6.png
7. Proceed to 'Addons' → 'Support Tickets Limiter' → 'Integration Code' and follow steps listed there.
STL 7.png
8. You have just successfully installed Support Tickets Limiter For WHMCS!

Configuration and Management

At this section we will show you possibilities of Support Tickets Limiter For WHMCS.

Our module allows you to limit the quantity of new support tickets through introducing Support Credit Points.
Those Support Credit Points will be required to open new tickets.
The amount of Support Credit Points required to do so may vary depending on tickets' status and department they are created in.
Support Credit Points may be obtained along with your products or by ordering special products or product addons.

Rules List

Rules section defines which products or product addons your clients can receive Support Credit Points for.

Additionally, they define which department they can be spent in and if they are granted one time or with product's each billing cycle.
As you can see, basic information related to the rules is listed in the 'Rules List' tab.

STL 9.png
You can view items assigned to the rule as well as departments, which Support Credit Points will be granted to, by pressing buttons marked on the following screen.
STL 10.png
Additionally, you can easily manage each of the rules by using buttons in the 'Actions' column.
STL 11.png

Add Rule

Let us add a new rule, press 'Add Rule' to proceed.
STL 12.png
Step 1. Fill in rule name and select rule type through pressing 'Select' button next to the desired item.

Item type selected here defines the type of the item, for ordering which, your clients receive Support Credit Points.

STL 13.png
Step 2. Select items which order and activation result in receiving Support Credit Points.

Alternatively, you can switch 'Select All' to 'On' , then, this rule will be applied to all items in the selected items type.
Press 'Next' or 'Step 3' to continue.

STL 14.png
Step 3. Now, define departments to apply Support Credit Points to by selecting desired ones or switching 'Select All' to 'On'

Next, select billing options for this rule, fill in amount of Support Credit Points added by the rule and select the rule status.
Confirm creation of this rule through pressing 'Finish' button.

STL 15.png
As you can see on the following screen, the rule has been successfully added.
STL 16.png

Department Settings

By default, all tickets are free to open.

In the 'Department Settings' tab you can define price per ticket.
Let's set up support credit points required to open tickets in the 'Feedback' support department.
Press 'Show Details' next to the 'Feedback' department as shown on the following screen to proceed.

STL 17.png
Now, start by defining base price per ticket. That price will be added to the price per ticket status.

Afterwards, fill in the prices for low, normal and high status tickets.
Confirm those settings through pressing 'Save' .

STL 18.png

Clients

In the 'Clients' tab you can view the amount of Support Credit Points owned by your clients.

You can use filter to search for a specific client.

STL 19.png
To display/hide client's Support Credit Points, press 'Show Detailed Information' / 'Hide Detailed Information' as shown on the screen below.
STL 20.png
You can also manually add/remove credit points to a client, press 'Modify Support Credit Points' to do so.
STL 21.png
Now, fill in the amount of Support Credit Points to be added or removed and then press 'Save' .
STL 22.png

Client Area

Let's proceed to the client area in order to create a ticket.

As you can see, one of the departments is unavailable because this client does not own any Support Ticket Points of this department.
Let's create a ticket in '24/7 Support' department.

STL 23.png
As you can see, your client can view his Support Credit Points for chosen department.

Additionally, he can see price per each ticket priority as shown on the following screen.

STL 23 1.png

Sample Workflow

In this section we will show you basic workflow of Support Ticket Limiter For WHMCS usage.

New Product Department

1. Let's start by creating new ticket department, proceed to 'Setup' → 'Support' → 'Support Departments' .

Now, press 'Add New Department' .

STL 24.png
2. Fill in department name, description and email address.

Additionally, assign administrators to it, mark 'Clients Only' and press 'Add New Department' .

STL 25.png

New Product Addon

3. Now, let's create a rule, which will add Support Credit Points to the new department.

In our case, Support Credit Points will be added through product addon.
Therefore, we need to create the product addon first.
Proceed to 'Setup' → 'Products/Services' → 'Product Addons' and press 'Add New Addon' .

STL 26.png
4. Fill in addon name, description and one time pricing.

Additionally, choose one time billing type, mark 'Show on Order' and assign desired products.
Proceed through pressing 'Save Changes' .

STL 27.png

New Rule

5. Go to 'Addons' → 'Support Ticket Limiter' and press 'Add Rule'.

6. Fill in rule name and select 'Product Addon' rule type.
7. Now, select previously created product addon and press 'Next'.
8. Set up previously created department and select 'One Time' from 'Support Credit Points Frequency' dropdown menu.
Now, fill in 200 into 'Support Credit Points' field and press 'Finish'.
9. As you can see, rule appeared in rule list and is ready for use.

STL 28.png

Department Configuration

10. Let's set up amount of points required to open tickets in previously created department.

Proceed to the 'Department Settings' tab and press 'Show Details' next to the previously created department.

11. Let's leave 'Required Points' at 0, and fill in Low' , 'Normal' and 'High' ticket statuses sequentially with 30, 60 and 120.
Press 'Save' to confirm changes.

Example Order

12. Log into client account and order one of product with the previously created product addon.
STL 29.png

New Ticket

13. After payment, both the product and the ordered along with it product addon are active.

200 Support Credit Points were granted to this account and now can be spent on '24/7 Support' department as shown on the following screen.

STL 30.png
14. Let's use Support Credit Points by opening new ticket in the '24/7 Support' department with 'High' status.

It will cost us 120 Support Credit Points, there should be 200 points on your account so you can afford creating of only one ticket with 'High' status.
Proceed with creation of this ticket.

STL 31.png
15. As you can see on the following screen, ticket was successfully created.
STL 32.png
16. As well as Support Credit Points was removed from '24/7 Support' department.
STL 33.png

Tips

1. It is advised to set one of the departments as a free of charge one. Remember to assign it the lowest priority of support to keep other competitive.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=24054"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community