smsway_api Build Status Gem Version Dependency Status Code Climate

Ruby wrapper for smsway.ru xml api

Installation

# Gemfile
gem 'smsway_api'

or just

$ gem install smsway_api

Config

Parameters for smsway_api should be placed in SmswayApi.configure block. Put smsway_api.rb into config/initializers directory of your rails application or just run:

 rails generate smsway_api:install

Example of config file:

SmswayApi.configure do |config|
  config. = '123'
  config.password = 'AbCdE654'


  config.default_sender = 'smsway'
end

Usage

Now implemented only two methods of smsway api: send message and get balance. You can send sms, flash-sms, wap-push and vcard.

Simple sending message: SmswayApi::API.send_message('test message', phone). Building and sending VCard:

vcard = SmswayApi::Message::Vcard.new({
  name: 'Steave Jobs',
  email: '[email protected]',
  phone: {
    work: '1-800-275-2273'
  }
})
vcard.add_recipient('1-800-694-7466')
vcard.add_recipient('1-800-800-2775')
vcard.sender = 'apple'
SmswayApi::API.send_message(vcard)

This example will send vcard to two recipients. Field 'from' will be 'apple'.

Get balance:

SmswayApi::API.balance