Flash sale: Get up to 30% off themes and extensions. Ends April 26 at 3 pm UTC. Shop the sale.
  1. Documentation /
  2. Clickatell SMS Notifications

Clickatell SMS Notifications

Send personalized SMS notifications to WooCommerce customers when their order status changes and one-time custom messages, plus receive SMS updates when customers place orders. Clickatell has worldwide coverage, with 819 networks in more than 220 countries.

Note: This product is no longer for sale at WooCommerce.com. Documentation is not being updated. We recommend Twilio SMS Notifications as an alternative.

Requirements

↑ Back to top
You need a Clickatell Central API Account.

Installation

↑ Back to top

  1. Download the extension from your WooCommerce dashboard.
  2. Go to Plugins > Add New > Upload and select the ZIP file you just downloaded.
  3. Click Install Now, and then Activate.

Sign up for a Clickatell API Account

↑ Back to top
You need a Clickatell Central API account for this plugin to work.
  1. Go to Clickatell, and sign up.
  2. Log into the Clickatell website through the Platform log in.
  3. From your dashboard, select “SMS Notifications” in the sidebar. This will then take you to a list of all of your active integrations.
  4. Select “Create New Integration”. This will bring up a step-by-step wizard for creating an API key.
  5. Add both a name and description for your API key. This is for your own reference, so using something like “WooCommerce Connection” for the name, and then your site’s URL for the description is a good start.
  6. If you’re installing Clickatell SMS Integration on a test site, choose “Sandbox environment”. If it’s a live/active site, then choose “Production environment”. After you’re done, click next to move on.
  7. In the Features tab, choose either one- or two-way messaging. One-way is more typical, but two-way messaging will allow customers to respond to your SMS notifications. For Delivery Type, choose the option that best fits your scenario based off of the Clickatell SMS documentation. Click next to move on.
  8. In the Settings tab, select additional features or options for your API key. These can be added or removed at any time after creation as well. Click next to move on.
  9. Select the phone number you wish to use. Click next to move on.
  10. Finally, you’ll see a confirmation screen. Review your features, then click Finish.
  11. You will now be taken back to the overview screen
You will now be taken back to the overview screen. Switch your newly-created API key to “On”, then click on your API key name to view the full API key. At this point, you may wish to purchase SMS credits.

Visual Walkthrough

↑ Back to top
From the dashboard, click SMS Integration
Select “Create New Integration”
Add a name and description to your integration, and choose between sandbox (test sites) or production (live sites).
Select your messaging type and delivery type.
Choose optional features and settings.
Review your configuration.
Turn on your integration, and then click the integration name to view your full API key.
Copy the API key to your clipboard with Control + C in Windows or Command (⌘) + C in MacOS.
In your WordPress dashboard, navigate to Clickatell Gateway Settings and insert the relevant information. You can use Control + V on Windows or Command (⌘) + V on MacOS.

Setup and Configuration

↑ Back to top
To set up your Clickatell SMS Notifications plugin, go back to your WordPress dashboard and then:
  1. Go to SMS Notifications > Gateway Settings.
  2. Enter your Clickatell Username and Password in the fields – this is the same details you used to log onto the Clickatell website.
  3. Enter the API ID, the one from the previous instructions.
  4. Enter your phone number and click Save.
Next step is to setup when customers should be notified and the message they should receive, here you have the ability to turn SMS notifications on and off depending on the order status and also have to ability to personalise the SMS message with variables which will be replaced with the customer’s data. See below for a list of usable variables.
  1. Go to SMS Notifications > Settings.
  2. Check the order statuses you would like to have your customers receive SMS notifications on.
  3. Enter the message your customers will receive when their order status changes, you can personalize this with variables.
  4. If you would like to enable SMS notifications for your own user when customers place orders, check the New Orders Notifications checkbox.
  5. Enter a comma separated list of numbers your would like to notify when a new order has been placed.
  6. Enter the message you would like to send out when a new order is placed, you can use the variables below.

Usage

↑ Back to top
Your customers will now be notified by SMS when their order status changes, or one-time sms messages you send via ‘Send SMS Update’ box on the right of their order. All SMS notifications are logged as part of Order Notes and display information on the delivery or what went wrong if undelivered.

WooCommerce SMS Notifications Variables

↑ Back to top
All messages sent out can be customised based on the list of variables below. * %order_key% * %billing_first_name% * %billing_last_name% * %%billing_company% * %billing_address_1% * %billing_address_2% * %billing_city% * %billing_postcode% * %billing_country% * %billing_state% * %billing_email% * %billing_phone% * %shipping_first_name% * %shipping_last_name% * %shipping_company% * %shipping_address_1% * %shipping_address_2% * %shipping_city% * %shipping_postcode% * %shipping_country% * %shipping_state% * %shipping_method% * %shipping_method_title% * %payment_method% * %payment_method_title% * %order_subtotal% * %order_discount% * %cart_discount% * %order_tax% * %order_shipping% * %order_shipping_tax% * %order_total% * %status% * %shop_name%

Troubleshooting

↑ Back to top

How do I code special characters (Unicode)?

↑ Back to top
According to the Clickatell docs:
If you require the use of special characters (such as Arabic or Russian) in your messages, you need to convert the message to Unicode and add an additional parameter when sending the message (unicode:1 ). Take a look at our Unicode infographic for additional information.

Questions and Feedback

↑ Back to top
Already purchased and need some assistance? Get in touch with a Happiness Engineer via the Help Desk.