Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 2.36 KB

README.md

File metadata and controls

108 lines (76 loc) · 2.36 KB
Raw

ruby-transmitsms

Ruby gem to easily access TransmitSMS RESTful APIs

Gem Version Build Status

Sample Usage

require 'ruby-transmitsms'

# Create new Sms instance using API key and secret
sms = SmsApi.new("15eg266c832fb23c4d90f01055aef355", "bluebird")

# Send a message
response = sms.send("Hello, world", "61455123456")

# Show the result
puts response.code
puts response.body

Installation

gem install ruby-transmitsms

Installation with bundler's Gemfile

gem "ruby-transmitsms"

Development

To install the required gems:

$ ./setup.sh

To run the tests:

$ ./runtest.sh

API

SmsApi

Instance method parameter documentation: SmsApi Method Params Doc

  • send
  • format_number
  • get_sms
  • get_sms_responses
  • get_user_sms_responses
  • get_sms_sent
  • cancel_sms

ListsApi

Instance method parameter documentation: ListsApi Method Params Doc

  • remove_list
  • get_list
  • get_lists
  • add_list
  • add_to_list
  • delete_from_list
  • optout_list_member
  • edit_list_member

NumbersApi

Instance method parameter documentation: NumbersApi Method Params Doc

  • get_number
  • get_numbers
  • lease_number

EmailApi

Instance method parameter documentation: EmailApi Method Params Doc

  • add_email
  • delete_email

KeywordsApi

Instance method parameter documentation: KeywordsApi Method Params Doc

  • add_keyword
  • edit_keyword
  • get_keywords

ResellersApi

Instance method parameter documentation: ResellersApi Method Params Doc

  • get_client
  • get_clients
  • add_client
  • edit_client
  • get_transactions
  • get_transaction

AccountApi

Instance method parameter documentation: AccountApi Method Params Doc

  • get_balance