Fax Media Resource
We have made the difficult decision to disable Programmable Fax for all accounts on December 17, 2021. For new and inactive accounts, access to Programmable Fax is disabled effective immediately. We recognize the challenges this decision might cause and have provided detailed migration plans to prevent disruptions.
For Japan customers, please refer to this migration plan. For all other customers, please refer to this migration plan. Learn more.
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
|
The unique string that we created to identify the FaxMedia resource. |
account_sid
|
The SID of the Account that created the FaxMedia resource. |
fax_sid
|
The SID of the fax the FaxMedia resource is associated with. |
content_type
|
The content type of the stored fax media. For example: |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
url
|
The absolute URL of the FaxMedia resource. |
Fetch a Fax Media resource
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
|
The SID of the fax with the FaxMedia resource to fetch. |
sid
Path
|
The Twilio-provided string that uniquely identifies the FaxMedia resource to fetch. |
Example 1
Read multiple Fax Media resources
https://fax.twilio.com/v1/Faxes/{FaxSid}/Media
Parameters
| Parameters in REST API format | |
|---|---|
fax_sid
Path
|
The SID of the fax with the FaxMedia resources to read. |
Example 1
Delete a Fax Media resource
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
|
The SID of the fax with the FaxMedia resource to delete. |
sid
Path
|
The Twilio-provided string that uniquely identifies the FaxMedia resource to delete. |
Example 1
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.