Retrieve a Fax
Retrieve a fax.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Fax.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing
the word Basic followed by a space and a base64-encoded string of project_id:token.
The project ID will be used as the username and the API token as the password.
Example:
```
Authorization: Basic base64(project_id:token)
```
Path parameters
AccountSid
The Project ID that uniquely identifies the Account.
Sid
The Fax ID that uniquely identifies the Fax.
Response
The request has succeeded.
account_sid
The unique identifier for the account this fax is associated with.
api_version
The version of the SignalWire API.
date_created
The date and time, in ISO 8601 format, the fax was created.
date_updated
The date and time, in ISO 8601 format, the fax was updated.
direction
The direction of the fax.
Allowed values:
from
The phone number, in E.164 format, the fax was sent from.
media_url
The URL hosting the received media, or null if not available.
media_sid
The unique identifier for the media instance associated with the fax instance.
num_pages
The number of pages in the fax document, or null if not yet determined.
price
The cost of the fax, or null if not yet calculated.
price_unit
The currency, in ISO 4217 format, of the price.
quality
The quality of the fax.
Allowed values:
sid
The unique identifier of the fax.
status
The status of the fax.
to
The phone number, in E.164 format, the fax was sent to.
duration
The time, in seconds, it took to deliver a fax.
links
The URL links for resources associated with the fax.
url
The URL of this resource.
error_code
Error code for this resource, or null if no error.
error_message
The description of this error, or null if no error.
