Send a Fax
Send 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.
Request
This endpoint expects an object.
MediaUrl
The URL hosting the fax media to send.
To
The phone number, in E.164 format, or SIP URI the fax will be sent to.
From
The phone number, in E.164 format, or client identifier the fax will be sent from.
Quality
The quality of the fax. Default is 'fine'.
Allowed values:
StatusCallback
The URL to send status callback requests to when the fax status changes.
StatusCallbackMethod
The HTTP method to use for status callback requests. Default is 'POST'.
Allowed values:
StatusCallbackEvent
The events that trigger status callback requests. Valid values: ‘initiated’, ‘ringing’, ‘answered’, ‘completed’, ‘ringing_forwarded’, ‘ringing_queued’. Default is [‘completed’].
StoreMedia
Whether to store the fax media. Default is 'true'.
Allowed values:
Ttl
Time to live in minutes for the fax. Must be between 5 and 300. Default is 60.
SipAuthUsername
The username for SIP authentication.
SipAuthPassword
The password for SIP authentication.
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.
