Sign in

v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Outbox

Get outgoing fax

Get specific details of a fax currently scheduled for sending. (Permitted scopes: fax:all:read, fax:fax:read)

get/accounts/{user_id}/outbox/{outbox_fax_id}

Path parameters

user_idstring required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

outbox_fax_idstring required

ID of the outgoing fax to get

Response

Response containing a single outbox object

contact_namestring
designated_srcstring
extra_infoobject
filesstring[]

Files to send

idstring required

Fax ID

ipstring

IP address from which the send request originated

last_updated_status_timestring

Time and date when the send request status was last updated. Format: YYYY-MM-DD HH:mm:ss

page_countinteger

Number of fax pages

send_timestring
should_enhanceboolean
srcstring
status'submitted' | 'converting' | 'scheduled_for_sending' | 'sending' required

Outbound fax status

submit_timestring

Date and time when the fax was submitted for sending

tostring[]
uidstring required

User ID

Example response

{
  "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"
}