kOOL offers the possibilty to send sms messages to addresses stored in the kOOL database using an external sms provider. At the moment this is only possible with the provider Clickatell (www.clickatell.com).

As an administrator of your kOOL installation you'll have to follow the steps outlined below to activate the sms sending functionality. After that kOOL users with the sms module will be able to send messages from kOOL.

Create an account with Clickatell

First you'll have to go to www.clickatell.com and create a new account for the "Clickatell Central (API)". This should give you a username, client id and a password which you can now use to log in.

Now you'll have to go to "Manage my products" and add a new connection of the type "HTTP". You can give it any name, all you need is the API ID, which you'll find in the list of your connections after having added the new connection.

Adjust settings in kOOL

After completing the above steps you can adjust the settings in kOOL. You can either do this by manually editing the configuration file config/ko-config.inc in your kOOL web directory or by calling the installation tool of kOOL.

The installation tool will simply adjust the following line in config/ko-config.inc.

(The array $SMS_PARAMETER is already defined in the default configuration file, but the values are empty. So make sure you adapt the existing one if you edit the file manually).

$SMS_PARAMETER = array("user" => "USERNAME", "pass" => "PASSWORD", "api_id" => "API_ID");

If you entered the above values correctly you should be able to send messages from kOOL. But please read on about the sender ids!

Register sender ids

What is a sender id?

A sender id is either a mobile number or a string which will be used as the sender for your messages, which you will send out of kOOL. If you add your mobile number, the recipients will be able to respond to your message and you will receive their answer.

How does kOOL handle sender ids?

In order for kOOL to be able to use your mobile number as the sender id of your sent messages the following conditions have all to be true:

- You have to be logged in to kOOL

- A person's record from the people module of kOOL has to be assigned to your login

- This person's record must have a valid mobile number

- Your mobile number must be registered as a sender id with Clickatell

- Your mobile number must be entered in the kOOL config file (config/ko-config.inc) (see below)

If all these conditions are met, your mobile number will be used as the sender of your messages. If one or more of these are not met, the default sender id "kOOL" will be used. This is only a string which will show up on the mobile phone of your recipients, and they will not be able to answer to your messages.

Register your sender ids with Clickatell

Go to "My settings -> Manage Sender IDs" when logged in to Clickatell and click "Add sender ID" to add the default sender id "kOOL".

For every user that will be allowed to send SMS messages from kOOL, you can add their mobile number as a sender id. This step is not mandatory - as outlined above.

Register your sender ids in kOOL

Now you'll have to let kOOL know about the available sender ids, so it may use the sender id of the currently logged in user - if available.

To do so, you'll have to manually edit the config file config/ko-config.inc in your web directory. You'll have to add another entry "sender_id" to the array $SMS_PARAMETER which you entered above.

$SMS_PARAMETER = array("user" => "USERNAME", "pass" => "PASSWORD", "api_id" => "API_ID", "sender_id" => array("41791234567", "41782345678"));

In the above example the two sender ids "+41 079 123 45 67" and "+41 078 234 56 78" have been added as sender ids. You don't have to add the default sender id "kOOL".

About the format of mobile numbers

Clickatell expects the mobile numbers in the international format without any leading zeros of plus signs or spaces. But storing your numbers in this format in kOOL doesn't look very nice, so kOOL will take care of this for you.

As most of your addresses in kOOL will have the same country code, you will most likely not store it for every address but you can set the default country code in "Admin->General settings" in kOOL. This default country code will be used for all mobile numbers without a country code.