List faxes in the outbox

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 listOutboxFaxes() {
    const reqParams = {
        "userId": '13d8z73c'
    }
    const req = await OutboxApiFp(config).listOutboxFaxes(reqParams);
    const resp = await req(axios);
}

listOutboxFaxes()

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

GET

accounts

{user_id}

outbox

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 listOutboxFaxes() {
    const reqParams = {
        "userId": '13d8z73c'
    }
    const req = await OutboxApiFp(config).listOutboxFaxes(reqParams);
    const resp = await req(axios);
}

listOutboxFaxes()

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

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 listOutboxFaxes() {
    const reqParams = {
        "userId": '13d8z73c'
    }
    const req = await OutboxApiFp(config).listOutboxFaxes(reqParams);
    const resp = await req(axios);
}

listOutboxFaxes()

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.

Response

Response containing a list of faxes waiting to be sent

List of the outgoing faxes

records

object[]

required

Show child attributes

records.id

string

required

Fax ID

records.status

enum<string>

required

Outbound fax status

Available options:

submitted,

converting,

scheduled_for_sending,

sending

records.uid

string

required

User ID

records.comment

object

Comment to set for the fax job

Show child attributes

records.comment.tags

string[]

records.comment.text

string

default:""

records.contact_name

string

records.designated_src

string

records.extra_info

object

records.file_changes

object[]

Show child attributes

records.file_changes.at

string

records.file_changes.files

object[]

Show child attributes

records.file_changes.files.file_name

string

records.file_changes.files.mime_type

string

records.file_changes.files.size

number

records.files

string[]

Files to send

records.initiated_from

object

Show child attributes

records.initiated_from.from_id

string

records.initiated_from.type

string

records.ip

string

IP address from which the send request originated

records.last_updated_status_time

string

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

records.options

object

Additional configuration for sending a fax

Show child attributes

records.options.enhancement

boolean

default:true

Text enhancement. Set to True to optimize fax file for text.

records.options.retry

object

Fax retry settings

Show child attributes

records.options.retry.count

integer

Number of tries to send the fax

Required range: 0 <= x <= 3

records.options.retry.delay

integer

Delay in seconds between two retries

Required range: 0 <= x <= 180

Example:

{ "retry": { "count": 2, "delay": 10 } }

records.options.partially_sent_retry

boolean

Enable automatic retry for partially sent faxes. Please make sure that the remote will accept chunked submissions before using it

records.page_count

integer

Number of fax pages

Required range: x >= 0

records.retry

object

Fax retry settings

Show child attributes

records.retry.count

integer

Number of tries to send the fax

Required range: 0 <= x <= 3

records.retry.delay

integer

Delay in seconds between two retries

Required range: 0 <= x <= 180

Example:

{ "retry": { "count": 2, "delay": 10 } }

records.send_time

string

records.should_enhance

boolean

records.src

string

records.status_changes

object[]

Show child attributes

records.status_changes.at

string

required

Date and time at which status changed. Format: YYYY-MM-DD HH:mm:ss

records.status_changes.status

enum<string>

required

Outbound fax status

Available options:

submitted,

converting,

scheduled_for_sending,

sending

records.submit_time

string

Date and time when the fax was submitted for sending

records.to

string[]

records.cover_page

object

Fax cover page

Show child attributes

records.cover_page.name_to

string

required

TO field on the cover page

records.cover_page.name_from

string

required

FROM field on the cover page

records.cover_page.subject

string

required

SUBJECT field on the cover page

records.cover_page.flags

enum<string>[]

Cover page flags

Allowed flags for the cover page

Available options:

urgent,

for_review,

please_reply,

confidential

records.cover_page.message

string

MESSAGE field on the cover page

records.cover_page.include_company_logo

boolean

Use company logo on the cover page

Get fax thumbnail Send a fax

⌘I

Get Started

Concepts

SDKs

API Reference

List faxes in the outbox

Authorizations

Path Parameters

Response