sms_aero

SmsAero

HTTP(s) client to SMS Aero service API written on top of evil-client "framework".

Synopsis

See operation specs for more verbose examples.

Initialize a client with user and password:

client = SmsAero.new user: "joe",        # required
                     password: "foobar", # required
                     testsend: true      # optional - to send test SMS

Then send requests:

answer = client.send_sms text: "Hello!",
                         to:   "[phone]",
                         date: "2100/01/12", # Date, Time, DateTime are accepted as well
                         type: 3 # see API docs for details

answer.result   # => "accepted"
answer.id       # => "38293"
answer.success? # => true (checks whether an id has been returned)

answer = client.check_status id: "38293"
answer.result # => "pending"

answer = client.send_sms text:  "Hello!",
                         group: "customers",
                         date:  Date.new("2100/01/12"),
                         type:  1

answer.result   # => "accepted"
answer.id       # => "894924"
answer.success? # => true (checks whether an id has been returned)

answer = client.check_sending id: "894924"
answer.result # => "pending"

answer = client.add_blacklist phone: "[phone]"
answer.result # => "accepted"

answer = client.add_group group: "baz"
answer.result # => "accepted"

answer = client.add_phone phone: "[phone]",
                          group: "customers",
                          fname: "John",
                          lname: "Paul",
                          lname: "Doe",
                          bday:  "1998/08/12",
                          param: "VIP"

answer.result # => "accepted"

answer = client.check_balance
answer.result  # => "accepted"
answer.balance # => 1973.2

answer = client.check_groups
answer.result   # => "accepted"
answer.channels # => ["customers", "employee"]

answer = client.check_senders sign: "qux"
answer.result # => "accepted"
answer.result # => ["peter", "paul"]

answer = client.check_sign sign: "qux"
answer.result # => "accepted"
answer.data   # => ["approved"]   

answer = client.check_tariff
answer.result # => "accepted"
answer.tariff # => { direct: 10.3, digital: 3.89 }

answer = client.delete_group group: "employee"
answer.result   # => "accepted"

answer = client.delete_phone phone: "[phone]",
                             group: "customers"

answer.result   # => "accepted"

# checking existance & availability of phone number
answer = client.hlr phone: "[phone]"
answer.result   # => "accepted"
id = answer.id  # => "12345", id of request

answer = client.hlr_status id
answer.result   # => "accepted"
answer.status   # => any of :available, :unavailable or :nonexistent