SMS Plugin for OpenCart v1.5.x.x Manual

v1.0.0

Installation
To install the SMS Plugin for OpenCart please follow the steps below: (Warning! The SMS Plugin for OpenCart-1.5.x.x requires VQMod)
1. Download extract and copy over the sms-plugin-com-oc-x.x.x.zip into your OpenCart's main directory
2. Login to your OpenCart's Admin area and select "Extensions" then "Modules" from the main menu.
3. Scroll down the Modules list and find the "SMS Plugin" module. Click on the "Install" link
4. Click on the "Edit" link to open the SMS Plugin module for OpenCart settings
5. You see the plugin configuration page. Here you may modify the plugin settings
Configuration
Account Info Tab

In order to be able to use SMS Plugin you need to have an active account. If you don't have one please create an account here. After installation you will be able to see the "SMS Plugin" menu item on the Opencart administration area main menu under Extensions > Modules. Click on the "Edit" link to the right. You are now able to see the SMS Plugin configuration page. The configuration page is divided into 3 main sections (Fig.1). At the top is the TABS area, right below is the TAB CONTENT area and to the right is the Plugin info area. The TAB area has 3 tabs namely "Account", "Actions" and "History". Each of the tabs when clicked shows different tab content which contains different set of plugin configuration settings.

Fig.1 - The SMS Plugin configuration page

The Account tab contains two panels. At the top there is the Account Info panel and below it there is the Send SMS panel (Fig.2).

Fig.2 - The Account tab panels

Each of the fields contained in the panels at any of the three tabs, has a black circle with a white questionmark to the right. Hover your mouse over the circle and an info balloon will pop up. This info balloon contains information about the purpose of the field next to it.

Fig.3 - The info balloon


Account Setup

In order to be able to use the SMS Plugin you need to insert your account info to the "Username" and "Password" fields and get an API key. Insert your username and password in the corresponding fields and click on the "Get Key" button. If your credentials are correct will see an info balloon informing you that your API key has been fetched (Fig.4) otherwise you will see an info balloon informing you that your username and/or password is incorrect (Fig.5).

Fig.4 - Get an API Key

Fig.5 - Wrong credentials info balloon

If you wish to reset your key insert your credentials and click the "Reset Key" button. You will see an info balloon informing you that your key has been reset and saved (Fig.6).

Fig.6 - Reset key info balloon

If you have successfully got or reset your key you will be able to see your remaining balance in a red circle just above of your API key (Fig.7).

Fig.7 - Your remaining balance


Send SMS panel

You can use the Send SMS Panel (Fig.8) in order to send SMS to any mobile in the world. In order to do so enter Your name in the "Sender". For the Sender field you can enter up to 16 numeric or up to 11 alphanumeric fields (Names over 16 numeric or 11 alphanumeric characters characters will be cut out). Then enter the mobile phone number you wish to send message to in the "Recipient" field. Select the SMS encoding type from the drop-down. Please note that for GSM encoding you may enter up to 157 characters per SMS and for UCS encoding you may enter up to 67 characters per SMS. Enter your SMS text in the "Text" field. Here you can enter up to 918 characters. Lengthy texts (over 160 characters for GSM encoding and 70 characters for UCS encoding) may incur additional charges. Below the "Text" area you can see a character and SMS counter. These counters increase as you type and will inform you about the size of your SMS message. When you have finished click on the "Send" button at the bottom of the panel to send your message to the Recipient.

Fig.8 - Send an SMS


Actions Tab

The Actions tab (Fig.9) contains three panels. The New Order, Order Status and Additional Settings panel.

Fig.9 - The Actions tab


New Order Panel

The New Order panel (Fig.10) has a group of settings that allow you to send SMS to your customers as soon as they place a new order. At the top there is the "Send SMS on new order?" drop-down which allows you to set whether an SMS will be sent to your customer when a new order is placed. Below is the Sender name, that is the name that will appear as the sender of the SMS. You can enter up to 16 numeric or up to 11 alphanumeric fields (Names over 16 numeric or 11 alphanumeric characters characters will be cut out). Select the SMS encoding type from the drop-down. Please note that for GSM encoding you may enter up to 157 characters per SMS and for UCS encoding you may enter up to 67 characters per SMS. For the SMS Message you can type up to 918 characters. This is the default message that will be sent to all customers upon checkout. There are some default keywords you may use in your text. You can use {first_name} for Firstname, {last_name} for Lastname, {user_email} for EmailAddress, {total} for Order's Total Price, {currency_code} for the Currency, {order_id} for Order Number and {order_status} for the Order's Status.

Fig.10 - The New Order panel


Order Status Panel

The Order Status panel (Fig.11) allows you to notify your customers upon order status change. For example you may notify your customers when their order Status changes from "Processing" to "Completed". Again at the top there is the "Send SMS on order status change?" drop-down which allows you to set whether an SMS will be sent to your customer when his/her order's status is changed. Below is the Sender name that will appear as the sender of the SMS. You can enter up to 16 numeric or up to 11 alphanumeric fields (Names over 16 numeric or 11 alphanumeric characters characters will be cut out). Select the SMS encoding type from the drop-down. Please note that for GSM encoding you may enter up to 157 characters per SMS and for UCS encoding you may enter up to 67 characters per SMS. For the SMS Message you can type up to 918 characters. This is the default message that will be sent to all customers when order status is changed. The keywords you may use in your text are {first_name} for Firstname, {last_name} for Lastname, {user_email} for EmailAddress, {total} for Order's Total Price, {currency_code} for the Currency, {order_id} for Order Number and {order_status} for the Order's Status.

Fig.11 - The Order Status panel


Additional Notification Settings Panel

The Additional Notification Settings panel (Fig.12) allows you to notify your e-shop administrator when a new user signs-up (account registration), a new order is placed or an order's status is changed. First from the top you may use the "Notify Admin?" drop-down to select whether the administrator will be notified at all or not. If you select that you want to notify administrator you need to enter his/her mobile phone number at the "Admin mobile No *" field. Then select the SMS encoding type for all administrator notifications, from the drop-down. Again note that for GSM encoding you may enter up to 157 characters per SMS and for UCS encoding you may enter up to 67 characters per SMS. Next is the "Notify admin on new account registration" checkbox. If you select this you must enter the corresponding text just below this checkbox. This is the message that will be sent to the administrator each time a customer signs up. The keywords available are the same as before but the most relevant are: {first_name} for Firstname, {last_name} for Lastname, {user_email} for Email Address. Then the "Notify admin when customer checkouts" checkbox allows you to notify the administrator when a customer checks outs. You may set the message for this notification in the textarea immediately below. A good example for this notification is: "{first_name} {last_name} (email: {user_email}) has placed an order (id: {order_id}) with amount {total} {currency_code}". Next the "Notify admin when order status changes" checkbox follows. You may enter the corresponding message in the textarea below. A good example for this notification is "{first_name} {last_name}'s (email: {user_email}) order (id: {order_id}) has changed to {order_status}".

Fig.12 - The Additional Notification Settings panel


History Tab

The History tab contains a table that lists all the SMS sent from your e-shop (Fig.13). The History table has columns such as the SMS ID, Datetime sent, Sender name, Recipient mobile phone , Message content, SMS status (Sent, Delivered, Failed, Insufficient Balance) and Order ID. Above each table column you find a field where you may type a search term in order to filter the corresponding column. These fields are collectively called filters. Type in your search term in any of the filters and click the "Filter" button to the right. When you click on the "Datetime sent" filter a calendar will pop-up (Fig14). Select the date you wish to filter the SMS list and click on the "Filter" button. To clear all filter fields click on the "Clear" button to the right. At the top right corner there is a "Download CSV" button. If you click on this button a window will pop up that allows you to save your SMS History list in a .csv file. Select the location you wish to save your .csv list and click the save button.

Fig.13 - The History Tab


Fig.14 - "Datetime sent" calendar


Fig.15 - The Download CSV button


menu