Clickatell SMS Sender

Overview

The Clickatell SMS Sender Communication Handler enables Integriti to send SMS messages via the Clickatell messaging service. Messages can be sent manually from the Users list or automatically via Alerts and Scheduled Tasks.

Version: This document is based on Version 2 of the Clickatell SMS Sender documentation.

Prerequisites

• Integriti License: Integriti Professional v20 license (part number 996901) or higher.
• Clickatell Account: An active Clickatell account with One API integration configured. Sign up at https://www.clickatell.com/.
• API Key: A Clickatell One API key (obtained from Clickatell Portal).
• User Mobile Numbers: A custom field of type “Telephone Number” must be configured for Users (see System Configuration Handbook - Custom Fields section).

Step-by-Step

1. Clickatell Portal Configuration

1. Log in to the Clickatell Portal with your account.
2. From the My Workspace tab, click +New SMS Setup.
3. Select API and One Way messaging type, then click Next.
4. Select One API and Create a new One API, then click Next.
5. Enter a name for the One API Setup, choose Production under Setup Type, and click Complete.
   • The “Enable Delivery Notifications” and “Enable message parts” options are not used by Integriti.
6. Copy the API Key from the “One API Details” section of the SMS Setup Details page.

Account Migration: To migrate an existing Clickatell account, contact Clickatell support at support@clickatell.com.

2. Add Mobile Numbers to Users

1. Create a custom field of type Telephone Number (see System Configuration Handbook - Custom Fields).
2. Open the User editor for a selected user.
3. Enter the user’s mobile phone number under Custom Fields with the country calling code prefix (e.g., +61 for Australia).
4. Save and close.

3. Create the Communication Handler (One API)

1. Navigate to Administration → Communication Handlers → Add New.
2. Configure the Handler Settings:
   • Handler Type: Select “Clickatell SMS Sender”.
   • API Type: Specify the API type for the messaging service.
   • API KEY: Enter the API Key obtained from Clickatell Portal.
   • Channel: “SMS” is selected by default. Alternatively, manually type a channel supported by Clickatell.
3. Save and close.

4. Create the Communication Handler (XML API - Alternative)

If using the older XML API instead of One API:

1. Navigate to Administration → Communication Handlers → Add New.
2. Configure the Handler Settings:
   • Handler Type: Select “Clickatell SMS Sender”.
   • API Type: Specify the API type.
   • User Name: Enter the Clickatell account username.
   • Password: Enter the Clickatell account password.
   • API ID: Select the API ID for the messaging service.
   • API URI: Select the API URI for the messaging service.
   • From: Select the sender name that appears on messages.
3. Save and close.

5. Retry Settings

In the Communication Handler options, configure the Retry Settings:

• Retry Rate (mins): Time interval between retry attempts (e.g., 1 minute).
• Stop Retrying After (mins): Maximum time to continue retrying (e.g., 5 minutes).

Example: If Retry Rate = 1 min and Stop Retrying After = 5 min, Integriti will attempt to send the message 5 times every minute over 5 minutes.

6. Sending Messages

Manual Send:

1. Right-click a user in the Users list and select Send Message.
2. Type the message under the Message tab and click Send.

Via Alerts:

1. Create an alert (see System Configuration Handbook - Alerts section).
2. Under the Created tab, click Add to add an action.
3. Select Send Communication Message as the Action Type.
4. Choose the Clickatell Communication Handler in the Sender field.
5. Add recipients under the Recipients tab (users must have mobile numbers configured).
6. Specify the message under the Message tab.
7. This process applies to all remaining alert tabs as needed.

Verification

1. Check the Status column in the Communication Handlers list. A successfully created and connected handler will show Running with the Clickatell account balance.
2. Review messages are logged to indicate:
   • Handler creation status.
   • Outcome of each message send attempt.
   • Status of each retry attempt (if applicable).
3. If the handler cannot communicate with Clickatell, an error summary is logged instead.

Troubleshooting

Issue	Check
Handler status shows an error	Verify the API Key / credentials are correct. Ensure internet connectivity from the Integriti server.
Messages not delivered	Confirm the recipient’s mobile number includes the country calling code. Check Clickatell account balance.
Retries not working	Verify Retry Rate and Stop Retrying After settings are configured correctly. Check review logs for retry status.
API Key missing	Log into Clickatell Portal → SMS Setup Details → One API Details to retrieve the key.

Related Pages

• Integriti System Configuration - Custom Fields and Alerts sections
• Integriti Comms Tasks Automation
• Integriti Communication Handlers