Skip to main content
Outbox

Definition

An Outbox is a collection of faxes that are in the process of being sent or have been sent recently. It serves as a management interface for outgoing faxes, allowing you to monitor their status and perform various actions.

Key Concepts

Fax Statuses in Outbox

Faxes in the outbox can have various statuses, including:
  • submitted: The fax has been submitted to the system
  • converting: The fax is being converted to the appropriate format for transmission
  • scheduled_for_sending: The fax is scheduled to be sent at a future time
  • sending: The fax is currently being transmitted

Actions on Outbox Faxes

The Outbox interface allows you to perform several actions on faxes:
  1. Delete: To cancel the fax transmission
  2. Download: To retrieve a copy of the fax document
  3. Add note: To attach a note to the fax for reference
  4. Resend/Forward: To reuse the fax file for sending to new recipients

Resending and Forwarding Faxes

You can reuse files from existing faxes without uploading them again. This is useful for:
  • Resending failed faxes: Quickly retry a fax that didn’t go through
  • Forwarding received faxes: Send a received fax to new recipients
  • Bulk operations: Send the same document to multiple recipients over time
  • Combining documents: Append additional files to an existing fax. When combining, uploaded files are sent first, followed by the file from the existing fax.
When you resend or forward a fax, you can customize all parameters including destination numbers, cover pages, and sending options.
To preserve the original quality when resending, set options.enhancement: false to prevent reprocessing the fax file.

Monitoring Fax Progress

The Outbox is your primary tool for monitoring the progress of sent faxes. You can:
  • See which faxes are currently being sent
  • Track the success of your fax transmissions

Schema

List of the outgoing faxes

records
object[]
required