REST Client MethodsFax Media

Retrieve

View as Markdown

Use this endpoint for the Fax Media method to retrieve a single fax media.

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
FaxSidstringRequiredformat: "uuid"
The Fax ID that uniquely identifies the Fax.
SidstringRequiredformat: "uuid"
The Fax ID that uniquely identifies the Fax.

Response

account_sidstringRequired
The unique identifier for the account.
content_typestringRequired
The content type of the media.
date_createdstringRequired
The date, in ISO 8601 format, this media was created.
date_updatedstringRequired
The date, in ISO 8601 format, this media was updated.
fax_sidstringRequired
The unique identifier for the fax.
sidstringRequired
The unique identifier for the media.
uristringRequired
The URI for the media.
urlstringRequired
The URL for the media.
Response
1{
2  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
3  "content_type": "application/pdf",
4  "date_created": "2018-11-26T20:00:00Z",
5  "date_updated": "2018-11-27T20:00:00Z",
6  "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
7  "sid": "b3877c40-da60-4998-90ad-b792e98472me",
8  "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
9  "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
10}

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.fax.faxes('FaxSid')
5      .media('MediaSid')
6      .fetch()
7      .then(media => console.log(media.contentType))
8      .done();