Media Resource

The Media subresource of the Message resource represents a piece of media, such as an image, that is associated with a Message.

Twilio creates a Media resource and stores the contents of the media when the following events occur:

You send an MMS with an image via Twilio.
You send a WhatsApp message with an image via Twilio.
You receive media in a message sent to one of your Twilio numbers or messaging channel addresses.

Twilio retains the stored media until you delete the related Media resource instance.

To secure access to media stored on Twilio, you can enable HTTP basic authentication in the Console settings for Programmable Messaging.

(warning)

Warning

Messages sent via Twilio can include up to 10 media files that have a total size of up to 5MB. Twilio resizes images as necessary for successful delivery based on carrier specifications. Messages with over 5MB of media will not be accepted.

media Properties

Property nameTypeRequiredDescriptionChild properties

accountSidSID<AC>

Optional

Not PII

The SID of the Account associated with this Media resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

contentTypestring

Optional

Not PII

The default MIME type of the media, for example image/jpeg, image/png, or image/gif.

dateCreatedstring<date-time-rfc-2822>

Optional

Not PII

The date and time in GMT when this Media resource was created, specified in RFC 2822 format.

dateUpdatedstring<date-time-rfc-2822>

Optional

Not PII

The date and time in GMT when this Media resource was last updated, specified in RFC 2822 format.

parentSidSID<SM|MM>

Optional

Not PII

The SID of the Message resource that is associated with this Media resource.

Pattern: ^(SM|MM)[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<ME>

Optional

Not PII

The unique string that identifies this Media resource.

Pattern: ^ME[0-9a-fA-F]{32}$Min length: 34Max length: 34

uristring

Optional

Not PII

The URI of this Media resource, relative to https://api.twilio.com.

Fetch a Media resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json

Returns a single Media resource using one of several representations:

content-type
XML
JSON

Default: content-type

Without an extension, the media is returned using the mime-type provided when the media was generated.

1GET /2010-04-01/Accounts/AC.../Message/MM.../Media/ME557ce644e5ab84fa21cc21112e22c485
2

Alternative: XML

Appending ".xml" to the URI returns a familiar XML representation. For example:

1GET /2010-04-01/Accounts/AC.../Message/MM.../Media/ME557ce644e5ab84fa21cc21112e22c485.xml
2

1<TwilioResponse>
2 <Media>
3   <Sid>ME557ce644e5ab84fa21cc21112e22c485</Sid>
4   <AccountSid>ACda6f1e11047ebd6fe7a55f120be3a900</AccountSid>
5   <ParentSid>MM8dfedb55c129dd4d6bd1f59af9d11080</ParentSid>
6   <ContentType>image/jpeg</ContentType>
7   <DateCreated>Fri, 17 Jul 2009 01:52:49 +0000</DateCreated>
8   <DateUpdated>Fri, 17 Jul 2009 01:52:49 +0000</DateUpdated>
9   <Uri>/2010-04-01/Accounts/ACda6f1e11047ebd6fe7a55f120be3a900/Message/MM8dfedb55c129dd4d6bd1f59af9d11080/Media/ME557ce644e5ab84fa21cc21112e22c485.xml</Uri>
10 </Media>
11</TwilioResponse>

Alternative: JSON

Appending ".json" to the URI returns a familiar JSON representation. For example:

1GET /2010-04-01/Accounts/AC.../Message/MM.../Media/ME557ce644e5ab84fa21cc21112e22c485.json
2

1{
2    "sid": "ME557ce644e5ab84fa21cc21112e22c485",
3    "account_sid": "ACda6f1e11047ebd6fe7a55f120be3a900",
4    "parent_sid": "MM8ff928b2451c0db925bd2d581f0fba79",
5    "content_type": "image/jpeg",
6    "date_created": "Fri, 26 Apr 2013 05:41:35 +0000",
7    "date_updated": "Fri, 26 Apr 2013 05:41:35 +0000",
8    "uri": "/2010-04-01/Accounts/ACda6f1e11047ebd6fe7a55f120be3a900/Message/MM8dfedb55c129dd4d6bd1f59af9d11080/Media/ME557ce644e5ab84fa21cc21112e22c485.json"
9}

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

Not PII

The SID of the Account associated with the Media resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

messageSidSID<SM|MM>

required

Not PII

The SID of the Message resource that is associated with the Media resource.

Pattern: ^(SM|MM)[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<ME>

required

Not PII

The Twilio-provided string that uniquely identifies the Media resource to fetch.

Pattern: ^ME[0-9a-fA-F]{32}$Min length: 34Max length: 34

(information)

Info

Because the stored media URLs are useful for many external applications, they are public and do not require HTTP Basic Auth to access. This allows you to embed the URL in a web application without revealing your Twilio API credentials.

If you have a need to restrict access to media stored with Twilio, you can enable HTTP Auth in the Console settings. When you fetch your Message Media after enabling HTTP auth, you will be directed to a signed URL that is only valid for 4 hours.

You can make subsequent API requests for new short-lived URLs for your media at any time.

Fetch a media

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchMedia() {
11  const media = await client
12    .messages("SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .media("MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .fetch();
15
16  console.log(media.accountSid);
17}
18
19fetchMedia();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "content_type": "image/jpeg",
4  "date_created": "Sun, 16 Aug 2015 15:53:54 +0000",
5  "date_updated": "Sun, 16 Aug 2015 15:53:55 +0000",
6  "parent_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7  "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
9}

Read multiple Media resources

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json

Returns a list of Media associated with your Message. The list includes paging information.

Filter by date created

You may limit the list of Message Media to media created on a given date. Provide the following query string parameter to your API call:

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

Not PII

The SID of the Account that is associated with the Media resources.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

messageSidSID<SM|MM>

required

Not PII

The SID of the Message resource that is associated with the Media resources.

Pattern: ^(SM|MM)[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

dateCreatedstring<date-time>

Optional

Not PII

Only include Media resources that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read Media that were created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read Media that were created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read Media that were created on or after midnight of this date.

dateCreatedBeforestring<date-time>

Optional

Not PII

dateCreatedAfterstring<date-time>

Optional

Not PII

pageSizeinteger<int64>

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Read Media

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listMedia() {
11  const media = await client
12    .messages("MMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .media.list({ limit: 20 });
14
15  media.forEach((m) => console.log(m.accountSid));
16}
17
18listMedia();

Response

1{
2  "end": 0,
3  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0",
4  "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0",
5  "media_list": [
6    {
7      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8      "content_type": "image/jpeg",
9      "date_created": "Sun, 16 Aug 2015 15:53:54 +0000",
10      "date_updated": "Sun, 16 Aug 2015 15:53:55 +0000",
11      "parent_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12      "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
14    }
15  ],
16  "next_page_uri": null,
17  "num_pages": 1,
18  "page": 0,
19  "page_size": 50,
20  "previous_page_uri": null,
21  "start": 0,
22  "total": 1,
23  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0"
24}

Delete a Media resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json

Deletes Media from your account.

If successful, returns HTTP 204 (No Content) with no body.

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

Not PII

The SID of the Account that is associated with the Media resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

messageSidSID<SM|MM>

required

Not PII

The SID of the Message resource that is associated with the Media resource.

Pattern: ^(SM|MM)[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<ME>

required

Not PII

The unique identifier of the to-be-deleted Media resource.

Pattern: ^ME[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete Media from your account

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteMedia() {
11  await client
12    .messages("MM800f449d0399ed014aae2bcc0cc2f2ec")
13    .media("ME557ce644e5ab84fa21cc21112e22c485")
14    .remove();
15}
16
17deleteMedia();

Hints and Advanced Uses

Twilio attempts to cache the media file the first time it is used. This may add a slight delay in sending the message.
Twilio caches files when HTTP headers allow it (via ETag and Last-Modified headers). Responding with Cache-Control: no-cache ensures Twilio always checks if the file has changed, allowing your web server to respond with a new version or with a 304 Not Modified to instruct Twilio to use its cached version.