Skip to content
README.md 2.43 KiB
Newer Older
dpi's avatar
dpi committed
Enables modules to use Clickatell API, and integrates with SMS Framework.

dpi's avatar
dpi committed
Copyright (C) 2018 Daniel Phin (@dpi)
dpi's avatar
dpi committed

# License

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
dpi's avatar
dpi committed
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

# Installation

dpi's avatar
dpi committed
 1. Download [SMS Framework][sms-framework] and its dependencies.
 2. Install module as per [standard procedure][drupal-module-install].
 3. This module has composer dependencies, see [instructions][composer-dependencies]
dpi's avatar
dpi committed
    for information on how to resolve these dependencies.

dpi's avatar
dpi committed
# Create a Clickatell API.

 1. Log in to Clickatell. When you are logging in you should be using 
    'Communicator / Central'. Not 'SMS Platform'. If your account logs in with
    'SMS Platform', then you should change your SMS Clickatell module install
    to the 2.x branch.
    After logging in, your Clickatell panel should have the 
    central.clickatell.com domain. If it is portal.clickatell.com, then you are
    using the wrong version of this module.
 2. Click 'Set up a new API' from the menu.
 3. Find the 'REST' option. Then click 'Add REST API.'
 4. Copy the _Auth token_, then see Configuration section below.    

# Configuration

 1. Create a SMS gateway plugin at _/admin/config/smsframework/gateways_.
 2. Fill out the form, click 'Save' button.
 3. The page will reload, fill out the _Authorization token_ field. Click 
    'Save'.
    
# Testing

If you need to test, you should take advantage of the _SMS Devel_ module
bundled with _SMS Framework_. It is accessible at _Configuration » Development »
Test SMS_.

[sms-framework]: https://drupal.org/project/smsframework
dpi's avatar
dpi committed
[drupal-module-install]: https://www.drupal.org/docs/8/extending-drupal/installing-contributed-modules "Installing Contributed Modules"
[composer-dependencies]: https://www.drupal.org/docs/8/extending-drupal/installing-modules-composer-dependencies "Installing modules' Composer dependencies"