Outbox

{
  "records": [
    {
      "comment": {
        "tags": [],
        "text": ""
      },
      "contact_name": "",
      "designated_src": "",
      "extra_info": {},
      "file_changes": [],
      "files": [
        "/transient-29362c0c-eeff-45c1-9f4e-4ef5865a41df"
      ],
      "id": "13a4afb0585345639733857e8f36df8d",
      "initiated_from": {
        "from_id": "",
        "type": ""
      },
      "ip": "8.8.8.8",
      "last_updated_status_time": "2017-09-24 06:43:04",
      "options": {},
      "page_count": 0,
      "retry": {
        "count": 0,
        "delay": 0
      },
      "send_time": "2017-09-24 06:43:04 +0000",
      "should_enhance": false,
      "src": "+16699990000",
      "status": "submitted",
      "status_changes": [
        {
          "at": "2017-09-24 06:43:04",
          "status": "submitted"
        }
      ],
      "submit_time": "2017-09-24 06:43:04 +0000",
      "to": [
        "+16699990000"
      ],
      "uid": "53a1afb8585345a39033857e1f36bf8d"
    }
  ]
}

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:

Delete: To cancel the fax transmission
Download: To retrieve a copy of the fax document
Add 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

Fax Number

Get Started

Concepts

SDKs

API Reference

Definition

Key Concepts

Fax Statuses in Outbox

Actions on Outbox Faxes

Monitoring Fax Progress

Schema

Get Started

Concepts

SDKs

API Reference

​Definition

​Key Concepts

​Fax Statuses in Outbox

​Actions on Outbox Faxes

​Monitoring Fax Progress

​Schema

Definition

Key Concepts

Fax Statuses in Outbox

Actions on Outbox Faxes

Monitoring Fax Progress

Schema