Sendcloud SMS

Brief

sendcloud-sms an unofficial support for developers to send SMS with SendCloud API in Ruby. The gem packaged the official Restful API to a better ruby-style methods.

Installation

For scaling projects using bundler to manage the gems, just add one line to your Gemfile

gem 'sendcloud-sms'

And then execute in shell:

bundle

Or install it yourself via gem as:

gem install sendcloud-sms

Getting Started

Config

This gem is both rails friendly and pure ruby friendly. You could config the gem via the following three ways.

For Rails Developers

Create config/initializers/sendcloud-sms.rb

SendCloud::SMS.auth('user', 'api_key')

It's ready to go.

For Other Developers

Add the following line before calling any method to send SMS.

SendCloud::SMS.auth('user', 'api_key')

Using Config File

If you are in need of using seperated configuration of different environments. You could first create config/sendcloud.yml or whatever file you want with the following YAML.

development:
  user: user for development
  api_key: api_key for development
production:
  user: user for production
  api_key: api_key for production

Load it before calling any other method

In Development

SendCloud::SMS.load!('./config/sendcloud.yml', :development)

In Production

SendCloud::SMS.load!('./config/sendcloud.yml', :production)

For Rails Developers

SendCloud::SMS.load!('./config/sendcloud.yml', (Rails.env.development ? :development: :production))

Send SMS

parameter phone could be either an array of phone numbers or one phone number

Usage:

SendCloud::SMS.send(template_id, phone, vars)

Example:

SendCloud::SMS.send(1234, '18000000000', {veri_code: '1234'})
SendCloud::SMS.send(4321, %w'18000000000 13800000000 13700000000', {broadcast: 'Hello SMS!'})

Send Voice Message

The SendCloud Voice message is only available for verification code. What's more, it does not support receiving an array of phone numbers.

Usage:

SendCloud::SMS.send_voice(phone, code)

Example:

SendCloud::SMS.send_voice('18000000000', '1234')

Return

The method returns an integer as code of response. Check the following list for details.

Roadmap

• Support timing SMS
• Add spec to get 100% code covered
• Support SMS Hook