The enhanced Twilio API Ruby client

Available methods

Twi::Message

When receiving an incoming direct message via webhook:

message = Twi::Message.new params
message.id # => 'SM083e290bef7794c407f14e22a891aa6d'
message.content # => 'Hello world'
message.sender # => '8009007000'
message.recipient # => '8008008000'
message.wallflower # nil
message.opt_in? # false
message.opt_out? # false
message.image_urls # => ['https://example.com/image.png']

When building a Twilio-like webhook payload:

Twi::Message.params_for id: 'SM12', content: 'Hello', sender: '8009007000', recipient: '8008008000'
 # => { MessageSid: 'SM12', Body: 'Hello',From: '+18009007000', To: '+18008008000' }

Twi::Delivery

When receiving a delivery notification via webhook:

delivery = Twi::Delivery.new params
delivery.id # => 'SM083e290bef7794c407f14e22a891aa6d'
delivery.status # => 'draft'
delivery.code # => '30006'

When building a Twilio-like webhook payload:

Twi::Delivery.params_for id: 'SM12', status: 'sent'
 # => { SmsSid: 'SM12', MessgeStatus: 'sent', ErrorCode: nil }

Twi::Event

When receiving events about a conversation:

event = Twi::Event.new params
event.id # => 'SM083e290bef7794c407f14e22a891aa6d'
event.conversation_id # => 'CH123'
event.target # => :participant
event.participant # => #<Participant id: 'SH12', phone: '9008009000', identity: nil>

To Do

  1. have a Rails engine with the webhook URLs already set?
  2. have an interface to send and receive SMS with photos
  3. another webhook for conversations
  4. another one to be notified of deliveries
  5. Assistant > create a phone number
  6. have an error code URL for each error code and a sid_url
  7. Declare some phones like Twilio.homeowner_phone or Twilio.numbers[:ddd] and a default Twilio.number and similar Twilio.messaging_service
  8. a way to reopen closed conversations
  9. a way to create conversations
  10. and upload pictures in a conversation
  11. x_twilio_webhook_enabled: true
  12. return SIDs so we can store them
  13. Set up defaults likw Twi::Lio.sid
  14. Twi.mock = true