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 systemconverting : The fax is being converted to the appropriate format for transmissionscheduled_for_sending : The fax is scheduled to be sent at a future timesending : The fax is currently being transmitted
Actions on Outbox Faxes The Outbox interface allows you to perform several actions on faxes:
Delete : To cancel the fax transmissionDownload : To retrieve a copy of the fax documentAdd note : To attach a note to the fax for reference
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
Available options:
submitted,
converting,
scheduled_for_sending,
sending
Comment to set for the fax job
records.cover_page. name_from
FROM field on the cover page
records.cover_page. name_to
TO field on the cover page
records.cover_page. subject
SUBJECT field on the cover page
Available options:
urgent,
for_review,
please_reply,
confidential
records.cover_page. message
MESSAGE field on the cover page
records.file_changes. files
records.file_changes.files. file_name
records.file_changes.files. mime_type
records.file_changes.files. size
records.initiated_from. from_id
records.initiated_from. type
IP address from which the send request originated
records. last_updated_status_time
Time and date when the send request status was last updated. Format: YYYY-MM-DD HH:mm:ss
Additional configuration for sending a fax
records.options. enhancement
Text enhancement. Set to True to optimize fax file for text.
records.options.retry. count
Number of tries to send the fax
Required range: 0 < x < 3
records.options.retry. delay
Delay in seconds between two retries
Required range: 0 < x < 30
Number of tries to send the fax
Required range: 0 < x < 3
Delay in seconds between two retries
Required range: 0 < x < 30
records.status_changes. at
Date and time at which status changed. Format: YYYY-MM-DD HH:mm:ss
records.status_changes. status
Available options:
submitted,
converting,
scheduled_for_sending,
sending
Date and time when the fax was submitted for sending
