Brightpearl uses Clickatell to send SMS messages. You will need to sign up for a Clickatell Developers Central account to integrate with Brightpearl and buy your credits from Clickatell.
Developers Central accounts are not available directly through the Clickatell website any longer, please contact their Support team at firstname.lastname@example.org to set this up.
Connecting Clickatell to Brightpearl
After registering for a Developers Central account with Clickatell.
Create an API connection ID on Clickatell
- Log into your Clickatell account.
- Go to the APIs menu.
- Clickatell automatically set up an HTTP API which is ready to use at Manage APIs. Alternatively you can create a new HTTP API.
- So that you know what the API is being used for, you can edit the name of the API in Clickatell at APIs > Manage APIs .
- Once you have an HTTP API, make a note of the API ID , you'll need to enter this in the Brightpearl set up.
- In Brightpearl, go to Settings > Brightpearl Apps > Clickatell SMS.
- Enter the name you want your SMS to be from. You will also need to authorize the send ID with Clickatell.
- Enter the API ID taken from Clickatell.
- Enter your Clickatell account username and log in password. Note that if you ever update your Clickatell account password you will also need to update it here.
- Save your changes and you're ready to start sending SMS from Brightpearl.
Using SMS templates
You can create some templates to drop into SMS send windows to save time:
- Go to Settings > Templates > SMS templates.
- Click Add a new template.
- Click Save.
You can use "merge fields" in your SMS templates, so that they are personalized and also relevant to the message. Fields available are:
#name# - Full name
#fname# - First name
#lname# - Last name
#order# - Order reference (only when sending SMS from the order list reports)
#invoice# - Invoice reference (only when sending SMS from invoice list reports)
#salu# - Salutation of the contact, e.g. "Mr"
#user# - Full name of the user sending the message
Example SMS Templates
Send an SMS when updating orders to "shipped":
Sending SMS messages
There are a number of ways to send an SMS:
- To a single contact from the contact record.
- To a contact on an order; click the Send SMS link next the mobile number in the Addresses tab .
- To a batch of contacts from the contact list screen.
- To a batch of contacts from various sales and accounting reports.
SMS sending will use up your Clickatell credits depending on the customer location. Since Brightpearl supports international SMS messaging, it's important to make sure that the contact has the correct country set, and that country has the correct dialing code. Go to Settings > Localization > Countries to create countries.
If you've opened the SMS send window from the order edit screen, you can use any of the Customer, Billing or Delivery addresses as the message template; very handy for notifying contractors of site addresses - plus many other uses we're sure!
Clickatell will allow you to send messages in batches of up to 100 with a daily limit (24 hour period) of 5000 and a monthly limit of 10,000. Use can read more in the Clickatell help guides available on their website.
You can see a record of all SMS messages sent to your contacts on the SMS Log in Brightpearl. Find the link to this report at Settings > Brightpearl Apps > Clickatell .
Two-way SMS messaging
Clickatell support two-way messaging . However, it is not possible to send or receive these messages from Brightpearl.