Skip to content

mberman84/simple_desk

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SimpleDesk

Simple Desk 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 'simple_desk'

And then execute:

$ bundle

Or install it yourself as:

$ gem install simple_desk

Then add your API token to your application_root/.env file, or create one if you don't have it.

	SIMPLE_DESK_TOKEN=MY_TOKEN

Usage

###Adding Customers To get started and add a new customer, run: SimpleDesk.add_customer({phone_number: "1231231232"})

While phone_number is required, you can pass additional properties in: - phone_number (required) - email (optional) - first_name (optional) - last_name (optional)

Like this:

	params = {phone_number: "1231231232", email: "[email protected]", first_name: "Elijah", last_name: "Murray"}
	SimpleDesk.add_customer(params)

###Messaging To message a user the format is similar Note: They do not have to be existing in the system to message. You'll automatically create a new user if you message a new phone number

	message_and_phone_number = {to: 5551231234, text: "Howdy partner!"}
	SimpleDesk.message_customer(message_and_phone_number)

To Do List

Features that still need to be implemented

	- Add ability to pass in properties and convert to base 64
	- Add auto capitalization for names
	- Parse formatting for phone number

Contributing

  1. Fork it ( https://github.com/[my-github-username]/simple_desk/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

API for getsimpledesk.com

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%