Upgrading from SimpleDesk Gem
Be sure to change your initializer and API calls from SimpleDesk
to SendSonar
.
SendSonar
Sonar is an SMS customer engagement platform that allows companies to have 2-way conversations with their customers over SMS - whether it's for sales, customer service, funnel abandonment, or transactional messages.
Installation
Add this line to your application's Gemfile:
gem 'send_sonar'
And then execute:
$ bundle
Compatibility
Works with Ruby 1.8.7 or greater
Changes
See RELEASE.md
- Configuration is now done through an initializer
- Support for sandbox server
- When creating a customer, properties is no longer a separate param (see readme)
Setup
Initialize the gem by creating an initializer.
- Your production token can be found at https://www.sendsonar.com/api_info.
- Your sandbox token can be found at https://sandbox.sendsonar.com/api_info
# config/initializers/send_sonar.rb
SendSonar.configure do |config|
if Rails.env.production?
config.env = :live
config.token = ENV['SONAR_PRODUCTION_TOKEN'] || 'YOUR_PRODUCTION_TOKEN'
elsif Rails.env.staging?
config.env = :sandbox
config.token = ENV['SONAR_SANDBOX_TOKEN'] || 'YOUR_PRODUCTION_TOKEN'
end
end
Usage
The API currently allows sending messages and adding customers.
Sending Messages
SendSonar.(text: 'message text', to: '1234567890')
The response is a SendSonar::Message
object with the following accessors:
- to (phone number as string)
- text
- status
Status is one of "queued" or "unsubscribed". Messages with "queued" status are usually sent within seconds. Messages with "unsubscribed" status will not be sent, as customer has previously unsubscribed from API messages.
If you send a message to a new phone number the API will automatically create a new user.
Adding Customers
If a customer already exists with the given phone number, that customer will be updated.
SendSonar.add_customer(
phone_number: "5555555555",
email: "[email protected]",
first_name: "john",
last_name: "doe",
properties: { great_customer: "true" }
)
You can send an unlimited number of properties with arbitrary keys and values.
The response is a SendSonar::Customer
object with the following accessors:
- id
- phone_number (string)
- first_name
- last_name
- subscribed (boolean)
- properties (hash)
Errors
There are many reasons why requests can fail. There are custom error classes to help you figure out what went wrong.
Note, all request errors inherit from SendSonar::RequestException
. Therefore you can rescue all request errors with rescue SendSonar::RequestException
. The current supported error classes are:
- SendSonar::BadToken
- SendSonar::NoActiveSubscription
- SendSonar::ApiDisabledForCompany
- SendSonar::RequestTimeout
- SendSonar::ConnectionRefused
- SendSonar::UnknownRequestError (the server return an error response that your version of the gem does not recognize.)
Support
Email [email protected] if you are having issues with the gem or service.
Contributing
Please file an issue on Github and have a conversation with us before creating a pull request
- Fork it ( https://github.com/[my-github-username]/send_sonar/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request