Skip to main content
GET
/
accounts
/
{user_id}
/
outbox
/
{outbox_fax_id}
const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getOutboxFax() {
    const reqParams = {
        "userId": '13d8z73c',
        "outboxFaxId": '132esd4cs31'
    }
    const req = await OutboxApiFp(config).getOutboxFax(reqParams);
    const resp = await req(axios);
}

getOutboxFax()

{
  "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"
}
const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getOutboxFax() {
    const reqParams = {
        "userId": '13d8z73c',
        "outboxFaxId": '132esd4cs31'
    }
    const req = await OutboxApiFp(config).getOutboxFax(reqParams);
    const resp = await req(axios);
}

getOutboxFax()

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

​
user_id
string
default:self
required

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

​
outbox_fax_id
string
required

ID of the outgoing fax to get

Response

Response containing a single outbox object

Model for the outbound fax stored in the outbox

​
id
string
required

Fax ID

​
status
enum<string>
required

Outbound fax status

Available options:
submitted,
converting,
scheduled_for_sending,
sending
​
uid
string
required

User ID

​
comment
object

Comment to set for the fax job

​
contact_name
string
​
designated_src
string
​
extra_info
object
​
file_changes
object[]
​
files
string[]

Files to send

​
initiated_from
object
​
ip
string

IP address from which the send request originated

​
last_updated_status_time
string

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

​
options
object

Additional configuration for sending a fax

​
page_count
integer

Number of fax pages

Required range: x >= 0
​
retry
object

Fax retry settings

Example:
{ "retry": { "count": 2, "delay": 10 } }
​
send_time
string
​
should_enhance
boolean
​
src
string
​
status_changes
object[]
​
submit_time
string

Date and time when the fax was submitted for sending

​
to
string[]
​
cover_page
object

Fax cover page