Menu

Expand
Rate this page:

Fax Media Resource

The Fax Media resource is a subresource of each Fax resource, which gives you more information about the media attached to an individual Fax resource.

If you've used our Messaging Media API, this should look very familiar to you.

FaxMedia properties

Resource Properties in REST API format
sid
sid<ME> Not PII

The unique string that we created to identify the FaxMedia resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the FaxMedia resource.

fax_sid
sid<FX> Not PII

The SID of the fax the FaxMedia resource is associated with.

content_type
string Not PII

The content type of the stored fax media. For example: application/pdf.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the FaxMedia resource.

Fetch a Fax Media resource

get
https://fax.twilio.com/v1/Faxes/{FaxSid}/Media/{Sid}

If you request Fax Media from a web application, you must specify an HTTP User-Agent header in your request.

Parameters
Parameters in REST API format
fax_sid
Path
get sid<FX> Not PII

The SID of the fax with the FaxMedia resource to fetch.

sid
Path
get sid<ME> Not PII

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

Example 1
        
        
        
        

        Read multiple Fax Media resources

        get
        https://fax.twilio.com/v1/Faxes/{FaxSid}/Media
        Parameters
        Parameters in REST API format
        fax_sid
        Path
        get sid<FX> Not PII

        The SID of the fax with the FaxMedia resources to read.

        Example 1
              
              
              
              

              Delete a Fax Media resource

              delete
              https://fax.twilio.com/v1/Faxes/{FaxSid}/Media/{Sid}

              Deletes the Fax Media resource and associated media file.

              This action cannot be undone.

              Parameters
              Parameters in REST API format
              fax_sid
              Path
              delete sid<FX> Not PII

              The SID of the fax with the FaxMedia resource to delete.

              sid
              Path
              delete sid<ME> Not PII

              The Twilio-provided string that uniquely identifies the FaxMedia resource to delete.

              Example 1
                    
                    
                    
                    
                    Rate this page:

                    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.

                          
                          
                          

                          Thank you for your feedback!

                          We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                          Sending your feedback...
                          🎉 Thank you for your feedback!
                          Something went wrong. Please try again.

                          Thanks for your feedback!

                          Refer us and get $10 in 3 simple steps!

                          Step 1

                          Get link

                          Get a free personal referral link here

                          Step 2

                          Give $10

                          Your user signs up and upgrade using link

                          Step 3

                          Get $10

                          1,250 free SMSes
                          OR 1,000 free voice mins
                          OR 12,000 chats
                          OR more