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 Django.
When Twilio receives a message for your phone number, it can make an HTTP call to a webhook that you create.
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.twiml.messaging_response module in the helper library that can make generating the TwiML and the rest of the webhook plumbing easy peasy.
To install the library, run:
pip install twilio
Add a new route in your urls.py file that handles incoming SMS requests.
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.
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 request body like this:
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
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:
- They are publicly accessible without any need for authentication which makes sharing easy.
- They are permanent (unless you explicitly delete the media).
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.
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:
You can use that last part of the URL as a unique filename and look up the corresponding file extension for the mime type.
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 public directory in order to serve them later.
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. To make this easy, you can use the Twilio Python Helper Library. As shown here:
All the code, in a complete working project, is available on GitHub. 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.