How do I set up Clickatell SMS text messaging with AYS?

Clickatell is an affordable and reliable international SMS text messaging provider that allows for seamless integrated SMS text messaging from within AYS.

Configuring Clickatell SMS text messaging is a two-step process:

  • Set up and configure an account with Clickatell
  • Enter your Clickatell settings within AYS

Step 1: Go the Clickatell web site to set up an account.

Step 2: Sign up for a Send SMS or Americas 2 Way SMS account. Accounts may be set up for North America, international, or for selected individual countries. (Be sure to ask for extra free credits for testing.)

Step 3: You will be provided with a Client ID, User name, and Password. Keep a record of these as you will need them.

Step 4: Go to the Clickatell Login page and login using your user name and password. If you already had a Clickatell account with a username instead of an email to login, you may need to use their old Communicator login portal here.

Step 5: Once you are logged in, open the APIs menu and select Manage APIs

Step 6a: If you do not already have an auto-created API of type HTTP, click the Setup a new API button and you will be provided with an API ID. (There are additional optional settings on the HTTP API that you may wish to explore and configure.)

Step 6b: If you have an auto-created HTTP API, click on “info & help” for that API in the table. This will display your API ID.

Step 7: You may need to configure a Sender ID so that message recipients see the name or phone number of who is sending the message. This is a requirement in some countries such as the United States.  Open the Manage account menu and select Manage Sender ID. Click the Add Sender ID button and follow the directions on screen. (Note that the verification process for your Sender ID may take some time while Clickatell verifies that you are who you say you are.)

Your Clickatell account is now set up!

Step 1: From either the main AYS program or the Internet Utility, select Setup > Communication Options from the main menu.

Step 2: Select the SMS Text Messaging tab.

Step 3: In the SMS method field, select Clickatell Mobile Messaging Internet SMS Service (via HTTP).


The Clickatell Mobile Messaging Internet SMS Service (via e-mail) is deprecated and no longer supported. While it may work for the time being, you should consider configuring the HTTP API as above.

Step 5: In the Clickatell user name field, enter your Clickatell user name.

Step 6: In the Clickatell password field, enter your Clickatell password.

Step 7: In the Clickatell HTTP API ID, enter the Clickatell API ID you generated above.

Step 8: If you have registered a Clickatell sender ID as described in the above section, then in the Clickatell sender ID field, enter your Sender ID.

To test your settings, enter a test mobile phone number and click the checkbox icon to try sending a test message. If the message is successful, you should receive an acknowledgement message and a long message ID. You can verify the message status on “Message reports” on the Clickatell site. You may need to select “Generate detailed report” to see recent messages.