twilio.cr

A Crystal shard for communicating with the Twilio API

Programming language: Crystal

License: MIT License

Tags: Third-party APIs     Services And Apps     API    

README

twilio.cr

Twilio API wrapper for Crystal.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     twilio:
       github: arubinofaux/twilio.cr

1. 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: "[phone]",
  to: "[phone]",
  url: "http://demo.twilio.com/docs/voice.xml"
)

Send an SMS

client.messages.create(
  from: "[phone]",
  to: "[phone]",
  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

• [x] Client

Messages

• [x] Create a message

• [x] Fetch a message

• [x] Read multiple messages

• [x] Update a message

• [x] Delete a message

Calls

• [x] Create a call

• [x] Fetch a call

• [ ] Fetch call recordings

• [ ] Fetch call feedback

• [ ] Read multiple calls

• [x] Update a call

• [x] 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

• arubinofaux - creator and maintainer