Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

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

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

Names in PHP format
sid
sid<ME> Not PII

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

accountSid
sid<AC> Not PII

The SID of the Account that created the FaxMedia resource.

faxSid
sid<FX> Not PII

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

contentType
string Not PII

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

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
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
Names in None format
fax_sid
Required
get sid<FX> Not PII

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

sid
Required
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
        Names in None format
        fax_sid
        Required
        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
              Names in None format
              fax_sid
              Required
              delete sid<FX> Not PII

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

              sid
              Required
              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.