List Fax Media
Returns the document media associated with one fax. Use it when a fax SID is known and you need the media SID or metadata; Message Media contains MMS attachments and is a separate collection.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Fax.
Learn more about API scopes.
Path parameters
Universal Unique Identifier.
The Project ID that uniquely identifies the Account.
Universal Unique Identifier.
The Fax ID that uniquely identifies the Fax.
Query parameters
The page index to retrieve. Zero-indexed.
The number of results per page. Default is 50, maximum is 1000.
Token for cursor-based pagination. Required when Page > 0.
Response
The request has succeeded.
Example response
{
"uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?Page=0&PageSize=50",
"first_page_uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?PageSize=50",
"page_size": 50,
"media": [
{
"account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
"content_type": "application/pdf",
"date_created": "2018-11-26T20:00:00Z",
"date_updated": "2018-11-27T20:00:00Z",
"fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
"sid": "b3877c40-da60-4998-90ad-b792e98472me",
"uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
"url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
}
],
"fax_media": [
{
"account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
"content_type": "application/pdf",
"date_created": "2018-11-26T20:00:00Z",
"date_updated": "2018-11-27T20:00:00Z",
"fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
"sid": "b3877c40-da60-4998-90ad-b792e98472me",
"uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
"url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
}
]
}Changes
Changed in 5 of the 40 revisions of this API.638
- ○
added 'unevaluatedProperties' constraint to the response body for the status
response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the
/response property for the statusresponse-property-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the
/response property for the statusresponse-property-unevaluated-properties-added
- ○
- ▲
response property
next_page_urilist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
previous_page_urilist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ○
added the new optional
queryrequest parameterPagenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterPageSizenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterPageTokennew-optional-request-parameter
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
added the required property
to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
- ▲
the response's body type changed from no type to
objectfor statusresponse-body-type-changed
- ○
removed
subschema #2from the response bodyallOflist for the response statusresponse-body-all-of-removed
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲