public
Description: Ruby interface to the Clickatell SMS Gateway API
Homepage: http://clickatell.rubyforge.org
Clone URL: git://github.com/lukeredpath/clickatell.git
name age message
file .gitignore Thu Jun 25 04:02:00 -0700 2009 Cleared a lot of gumph from the Rakefile courte... [Luke Redpath]
file History.txt Loading commit data...
file License.txt Fri Aug 17 06:16:20 -0700 2007 Initial newgem import git-svn-id: svn://lukere... [luke]
file RDOC_README.txt Tue Aug 19 06:41:13 -0700 2008 Rename readme for Rdoc so it doesnt confuse github [Luke Redpath]
file README.textile Tue Aug 19 06:04:39 -0700 2008 Added a proper textile README [Luke Redpath]
file Rakefile
directory bin/ Mon Sep 10 13:45:16 -0700 2007 Fixed SSL support and added --secure option to ... [luke]
file clickatell.gemspec
directory lib/
directory scripts/ Fri Aug 17 06:16:20 -0700 2007 Initial newgem import git-svn-id: svn://lukere... [luke]
directory spec/
directory website/ Thu Jun 25 04:09:01 -0700 2009 Updated website [Luke Redpath]
README.textile

Clickatell SMS Library

To use this gem, you will need sign up for an account at www.clickatell.com. Once you are registered and logged into your account centre, you should add an HTTP API connection to your account. This will give you your API_ID.

Basic Usage

You will need your API_ID as well as your account username and password.

require ‘rubygems’ require ‘clickatell’ api = Clickatell::API.authenticate(‘your_api_id’, ‘your_username’, ‘your_password’) api.send_message(‘447771234567’, ‘Hello from clickatell’)

Command-line SMS Utility

The Clickatell gem also comes with a command-line utility that will allow you to send an SMS directly from the command-line.

You will need to create a YAML configuration file in your home directory, in a file called .clickatell that resembles the following:

  1. ~/.clickatell
    api_key: your_api_id
    username: your_username
    password: your_password

You can then use the sms utility to send a message to a single recipient:

sms 447771234567 ‘Hello from clickatell’

Alternatively, you can specify the username and password as a command line option. Run sms without any arguments for a full list of options.

See http://clickatell.rubyforge.org for further instructions.