Skip to content

A Crystal shard for communicating with the Twilio API

License

Notifications You must be signed in to change notification settings

acidtib/twilio.cr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

twilio.cr

Build Status

Twilio API wrapper for Crystal.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      twilio:
        github: arubinofaux/twilio.cr
  2. Run shards install

Usage

Setup Work

require "twilio"

# put your own credentials here
account_sid = "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
auth_token = "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"

# set up a client to talk to the Twilio API
client = Twilio::Client.new(account_sid, auth_token)

Make a Call

client.calls.create(
  from: "+15005550006",
  to: "+15005550006",
  url: "http://demo.twilio.com/docs/voice.xml"
)

Send an SMS

client.messages.create(
  from: "+15005550006",
  to: "+15005550006",
  body: "Hey there!"
)

List your Messages

client.messages.list(limit: 20)

Fetch a single message by sid

# put the message sid you want to retrieve here:
message_sid = "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
client.messages.fetch(message_sid)

Progress

API methods

Core

  • Client
Messages
  • Create a message

  • Fetch a message

  • Read multiple messages

  • Update a message

  • Delete a message

Calls
  • Create a call

  • Fetch a call

  • Fetch call recordings

  • Fetch call feedback

  • Read multiple calls

  • Update a call

  • Delete a call

Development

For development, you will need API Credentials from Twilio. You can find instructions on how to acquire one for your account here.

If you found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

Contributing

  1. Fork it (https://github.com/arubinofaux/twilio.cr/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

Contributors

About

A Crystal shard for communicating with the Twilio API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published