The SMS Addon + Admin Secure Documentation

SMS Addon + Admin Security

Survey + Testimonial Addon

Staff Wiki / Knowledgebase

File Monitor

Getting Started

Features

SMS API's

Getting Started

Installation / Upgrading

Installing The SMS Addon is very simple. The following steps will guide you through the process:
  1. Unzip the contents of the zip file to a folder on your computer
  2. Upload the contents into the WHMCS directory
  3. Continue with Initial Setup

Initial Setup

Once all the files have been uploaded on the server follow the following instructions to get the module activated for use.
  1. From within the WHMCS admin panel click Setup > Addon Modules
  2. Activate the module titled SMS Addon
  3. Scroll down to the settings titled SMS Addon and enter the following settings
    • SMS Gateway: Select the SMS provider you wish to use
    • Access Control: Ticket what administrator roles you wish to have access to the addon
  4. Click the Save Changes button
  5. Continue with Custom Client Fields

Custom Client Fields

To be able to send SMS messages to the client we need a few custom clients fields what are details entered when the client registers.
  1. From within the WHMCS admin panel click Setup > Custom Client Fields
  2. Enter the following custom fields shown in the picture below
    images/addons/documentation/sms/sms_addon_customfields.gif
  3. Click the Save Changes button
  4. Continue with Addon Settings

Addon Settings

Once the addon has been installed it is time to configure the WHMCS integration and customised messages.
To access these settings click Addons > SMS Addon > Settings > General Settings
  1. Select the Custom Client Fields options as setup in the previous step
  2. In the Notify True Field selection, select the option the client must select to send a SMS
  3. Under Client Actions / Admin Actions you can set wether you wish a message to be sent out for each action,
  4. You can also customise each message what will be sent for that action, messages can be customised with sms tags as described below

Cron File

A cron file is included within the main directory of the addon which is a replacement for the standard WHMCS cron.

This only needs to be used when using the Directory re-namer function included in Admin Secure as the default cron file is contained within the admin directory which is renamed.

This cron file operates as a dynamic 'shortcut' to the cron file contained within the admin directory.

Features

SMS Tags

Tags are a new feature of the addon, This allow you to personalise the SMS even more with client details.
The following tags are included in the module, each action has there own tags assigned to them.

ActionTags
Global Tags
  • {fullname}
  • {firstname}
  • {lastname}
  • {clientemail}
Client Registration
  • {password}
Password Change
  • {newpassword}
Invoice Created
  • {invoiceid}
  • {total}
  • {datecreated}
  • {datedue}
  • {currency_prefix}
  • {currency_suffix}
Invoice Paid
  • {invoiceid}
  • {paymentmethod}
  • {total}
  • {datecreated}
  • {datepaid}
  • {currency_prefix}
  • {currency_suffix}
Invoice Reminder
Invoice Overdue
  • {invoiceid}
  • {datecreated}
  • {datedue}
  • {total}
  • {currency_prefix}
  • {currency_suffix}
Module Created
Module Unsuspend
Module Password Change
  • {serviceid}
  • {domain}
  • {username}
  • {password}
Module Suspend
  • {serviceid}
  • {domain}
  • {username}
  • {password}
  • {suspendreason}
Domain Registration
Domain Transfer
Domain Renewal
  • {domain}
  • {registrar}
  • {regperiod}
Domain Renewal Notices
  • {domain}
  • {expiredays}
  • {duedate}
Support Ticket Opened
Support Ticket Reply
  • {ticketid}
  • {ticketref}
  • {subject}
  • {message}
  • {deptname}
  • {priority}
  • {status}
New Order Received
  • {orderid}
  • {ordernumber}
  • {totaldue}
Fraud Order
  • {orderid}
Cancellation Request
Admin Cancellation Request
  • {type}
  • {reason}
Affiliate Activation
  • {affiliatelink}
Two-Factor Authentication
  • {twofactor}
Domain Registration Failed
Domain Transfer Failed
Domain Renewal Failed
  • {domain}
  • {registrar}
  • {regperiod}
  • {error}
Admin Secure-New Admin IP
  • {ip}
  • {admin}
Admin Secure-New Admin Directory
  • {newadmindir}
Support Ticket Flagged
  • {ticketid}
  • {ticketref}
  • {subject}
  • {priority}
  • {status}

Client Profile Intergration

If you would like to add a sms button to each client summary page then using a FTP client edit the following file.

admin / templates / (template name) / clientssummary.tpl

Find the location which you would like to place the link (I choose the Send Email box) and add the following code,

<a href="addonmodules.php?module=sms_addon&page=sendsms&cid={$clientsdetails.userid}">Send SMS Message</a>


Example Code
images/addons/documentation/sms/codeintemplate.png

Example Output
images/addons/documentation/sms/pflintergrationexample.png

SMS API's

Clickatell

  1. Regiser an Clickatell Central API account with Clickatell - Click here
  2. Login, Navigate to "Manage my Products" and add a new HTTP connection
  3. Enter Description and click "Add"
  4. Under "My Settings", click "Manage Senders IDs", "Add sender ID", Now fill in the details you would like the message to be sent from
    Note: They need to approve this before it can be used

SMS Global

  1. Register for an account at SMS Global - Click here