Elibom Ruby API Client

A ruby client of the Elibom REST API. The full API reference is here.

Getting Started

1. Install the gem

gem install elibom

2. Configure the Elibom object passing your credentials.

require 'rubygems' # only if using ruby <= 1.8
require 'elibom'

Elibom.configure(
  :user => 'your@user.com', 
  :api_password => 'your_api_password'
)

Note: You can find your api password at http://www.elibom.com/api-password (make sure you are logged in).

You are now ready to start calling the API methods!

API methods

Send SMS
Schedule SMS
Show Delivery
List Scheduled SMS Messages
Show Scheduled SMS Message
Cancel Scheduled SMS Message
List Users
Show User
Show Account

Send SMS

response = Elibom.send_message(
  :to => '51965876567, 573002111111', 
  :text => 'this is a test'
)
puts response["deliveryToken"] # all methods return a hash (or nil if there is no response)

Schedule SMS

response = Elibom.schedule_message(
  :to => '51965876567, 573002111111', 
  :text => 'this is a test',
  :schedule_date => Time.now + 3600 # in an hour
)
puts response["scheduleId"]

Show Delivery

response = Elibom.delivery('<delivery_token>')
puts response

List Scheduled SMS Messages

response = Elibom.scheduled_messages
puts response

Show Scheduled SMS Message

response = Elibom.scheduled_message(<schedule_id>)
puts response

Cancel Scheduled SMS Message

Elibom.unschedule(<schedule_id>)

List Users

response = Elibom.users
puts response

Show User

response = Elibom.user(<user_id>)
puts response

Show Account

response = Elibom.account
puts response

elibom

Runtime