Receive and Download Images on Incoming MMS Messages with Sinatra

You know how to receive and reply to incoming SMS messages. What if you receive an MMS message containing an image you’d like to download? Let’s learn how we can grab that image and any other incoming MMS media using Ruby.

Create MMS Processing Project

When Twilio receives a message for your phone number, it can make an HTTP call to a webhook that you create. The easiest way to handle HTTP requests in Ruby is to use the Sinatra web framework.

Twilio expects, at the very least, for your webhook to return a 200 OK response if everything is peachy. Often, however, you will return some TwiML in your response as well. TwiML is just a set of XML commands telling Twilio how you’d like it to respond to your message. Rather than manually generating the XML, we’ll use the `twilio-ruby` helper library that can make generating the TwiML and the rest of the webhook plumbing easy peasy.

To install Sinatra and the Twilio library, open your terminal and run the following:

gem install sinatra
gem install twilio-ruby

 

Receive MMS Message and Images

Get Incoming Message Details

When Twilio calls your webhook, it sends a number of parameters about the message you just received. Most of these, such as the `To` phone number, the From phone number, and the Body of the message are available as properties of the request body.

Get Number of attachments

We may receive more than one media per message, so this parameter informs us how many we received. We also cast it to an Integer, to be used in a following loop:

num_media = params['NumMedia'].to_i

Get URLs to the Media

Since an MMS message can have multiple attachments, Twilio will send us form variables named MediaUrlX, where X is a zero-based index. So, for example, the URL for the first media attachment will be in the MediaUrl0 parameter, the second in MediaUrl1, and so on.

In order to handle a dynamic number of attachments, we pull the URLs out of the body request like this:

for i in 0..(num_media - 1) do
  media_url = params["MediaUrl#{i}"]
end

Determine Content Type of Media

Attachments to MMS messages can be of many different file types. JPG and GIF images as well as MP4 and 3GP files are all common. Twilio handles the determination of the file type for you and you can get the standard mime type from the MediaContentTypeX parameter. If you are expecting photos, then you will likely see a lot of attachments with the mime type image/jpeg. We will also use the `mime-types` gem to get the file extension from its type.

for i in 0..(num_media - 1) do
  media_url = params["MediaUrl#{i}"]
  content_type = params["MediaContentType#{i}"]
end

Process MMS Images

Save the Media URLs

Depending on your use case, storing the URLs of the images (or videos or whatever) may be all you need. There are two key features to these URLs that make them very pliable for your use in your apps:

  1. They are publicly accessible without any need for authentication to make sharing easy.
  2. They are permanent (unless you explicitly delete the media, see later).

For example, if you are building a browser-based app that needs to display the images, all you need to do is drop an <img src="twilio url to your image"> tag into the page. If this works for you, then perhaps all you need is to store the URL in a database character field.

Save Media to Local File System

If you want to save the media attachments to a file, then you will need to make an HTTP request to the media URL and write the response stream to a file. If you need a unique filename, you can use the last part of the media URL. For example, suppose your media URL is the following:

https://api.twilio.com/2010-04-01/Accounts/ACxxxx/Messages/MMxxxx/Media/ME27be8a708784242c0daee207ff73db67

You can use that last part of the URL as a unique filename. Figuring out a good extension to use is a little tricker. If you are only expecting images, you could just assume a “.jpg” extension. For a little more flexibility, you can lookup the mime type and determine a good extension to use based on that.

Here’s the complete code for our view that saves each MMS attachment to the current folder.

<code sample: receive-mms-sinatra repo>

Loading Code Samples...
Language
require 'open-uri'
require 'mime-types'
require 'sinatra'
require 'twilio-ruby'

post '/sms' do
  num_media = params['NumMedia'].to_i

  if num_media > 0
    for i in 0..(num_media - 1) do
      # Prepare the file information
      media_url = params["MediaUrl#{i}"]
      content_type = params["MediaContentType#{i}"]
      file_name = media_url.split('/').last
      file_extension = MIME::Types[content_type].first.extensions.first
      file = "#{file_name}.#{file_extension}"

      # Dowload the files
      open(media_url) do |url|
        File.open(file, 'wb') do |f|
          f.write(url.read)
        end
      end

    end
  end

  # Reply message
  twiml = Twilio::TwiML::MessagingResponse.new do |resp|
    body = num_media > 0 ? "Thanks for sending us #{num_media} file(s)!" : 'Send us an image!'
    resp.message body: body
  end

  content_type 'text/xml'
  twiml.to_s
end
Receive MMS images with Ruby

Another idea for these image files could be uploading them to a cloud storage service like Azure Blob Storage or Amazon S3. You could also save them to a database, if necessary. They’re just regular files at this point. Go crazy. In this case, we are saving them to the database in order to retrieve them later.

Delete Media from Twilio

If you are downloading the attachments and no longer need them to be stored by Twilio, you can easily delete them. You can send an HTTP DELETE request to the media URL, and it will be deleted, but you will need to be authenticated to do this. 

Loading Code Samples...
Language
SDK Version:
  • 4.x
  • 5.x
# Get twilio-ruby from twilio.com/docs/ruby/install
require 'rubygems' # This line not needed for ruby > 1.8
require 'twilio-ruby'

# Get your Account Sid and Auth Token from twilio.com/user/account
account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
auth_token = 'your_auth_token'
client = Twilio::REST::Client.new account_sid, auth_token

media = client.messages
              .get('MM800f449d0399ed014aae2bcc0cc2f2ec')
              .media
              .get('ME557ce644e5ab84fa21cc21112e22c485')
media.delete
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'rubygems'
require 'twilio-ruby'

# Your Account Sid and Auth Token from twilio.com/console
account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
auth_token = 'your_auth_token'
@client = Twilio::REST::Client.new(account_sid, auth_token)

@client.messages('MM800f449d0399ed014aae2bcc0cc2f2ec')
       .media('ME557ce644e5ab84fa21cc21112e22c485')
       .delete
Delete a Media

What’s Next?

If you need to dig a bit deeper, you can head over to our API Reference and learn more about the Twilio webhook request and the REST API Media resource. Also, you will want to be aware of the pricing for storage of all the media files that you keep on Twilio’s servers.

We’d love to hear what you build with this.

Carlos Villavicencio
Jose Oliveros
David Prothero
Samuel Mendes
Orlando Hidalgo
Kat King
Agustin Camino

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

Loading Code Samples...
require 'open-uri'
require 'mime-types'
require 'sinatra'
require 'twilio-ruby'

post '/sms' do
  num_media = params['NumMedia'].to_i

  if num_media > 0
    for i in 0..(num_media - 1) do
      # Prepare the file information
      media_url = params["MediaUrl#{i}"]
      content_type = params["MediaContentType#{i}"]
      file_name = media_url.split('/').last
      file_extension = MIME::Types[content_type].first.extensions.first
      file = "#{file_name}.#{file_extension}"

      # Dowload the files
      open(media_url) do |url|
        File.open(file, 'wb') do |f|
          f.write(url.read)
        end
      end

    end
  end

  # Reply message
  twiml = Twilio::TwiML::MessagingResponse.new do |resp|
    body = num_media > 0 ? "Thanks for sending us #{num_media} file(s)!" : 'Send us an image!'
    resp.message body: body
  end

  content_type 'text/xml'
  twiml.to_s
end
SDK Version:
  • 4.x
  • 5.x
# Get twilio-ruby from twilio.com/docs/ruby/install
require 'rubygems' # This line not needed for ruby > 1.8
require 'twilio-ruby'

# Get your Account Sid and Auth Token from twilio.com/user/account
account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
auth_token = 'your_auth_token'
client = Twilio::REST::Client.new account_sid, auth_token

media = client.messages
              .get('MM800f449d0399ed014aae2bcc0cc2f2ec')
              .media
              .get('ME557ce644e5ab84fa21cc21112e22c485')
media.delete
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'rubygems'
require 'twilio-ruby'

# Your Account Sid and Auth Token from twilio.com/console
account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
auth_token = 'your_auth_token'
@client = Twilio::REST::Client.new(account_sid, auth_token)

@client.messages('MM800f449d0399ed014aae2bcc0cc2f2ec')
       .media('ME557ce644e5ab84fa21cc21112e22c485')
       .delete