Skip to main content
GET
/
accounts
/
{user_id}
/
faxes
/
{fax_id}
const axios = require('axios');
const FaxesApiFp = require('@alohi/faxplus-api').FaxesApiFp;
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 getFax() {
    const reqParams = {
        "userId": '13d8z73c',
        "faxId": '132esd4cs31'
    }
    const req = await FaxesApiFp(config).getFax(reqParams);
    const resp = await req(axios);
}

getFax()

{
  "comment": "",
  "cost": 2,
  "cost_details": {
    "multiplier": 1,
    "notification_cost": 0
  },
  "description": "OK",
  "direction": "incoming",
  "duration": 0,
  "file": "ec28edc283a74daca1787efb5fa6fae2.tiff",
  "file_name": "fax-from-12076001783",
  "from_number": "+12076001783",
  "header": null,
  "id": "5e7de3ad54cfd54eb568cc76",
  "is_read": false,
  "is_spam": false,
  "last_update": "2020-03-27 11:29:49",
  "max_retry": null,
  "owner_id": "74d59d2779fb42a99cd5bb993c0c89d2",
  "pages": 2,
  "retry_delay": null,
  "scheduled_time": null,
  "start_time": "2020-03-27 11:29:21",
  "status": "failed",
  "submit_time": null,
  "to": "+12076001783"
}
const axios = require('axios');
const FaxesApiFp = require('@alohi/faxplus-api').FaxesApiFp;
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 getFax() {
    const reqParams = {
        "userId": '13d8z73c',
        "faxId": '132esd4cs31'
    }
    const req = await FaxesApiFp(config).getFax(reqParams);
    const resp = await req(axios);
}

getFax()

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.

​
fax_id
string
required

Response

Response containing a single fax object

​
comment
string
required

Free-form comment

​
cost_details
object
required
​
id
string
required

Fax ID

​
owner_id
string
required

User ID of the fax owner

​
pages
integer
required

Number of pages in the fax

Required range: x >= 0
​
status
enum<string>
required

Fax status. Some failure codes use failed_fs_* values which represent low-level fax transport issues (for example, fax protocol incompatibility, the remote endpoint stopping responding, or remote disconnections). In particular: failed_fs_8/failed_fs_9 indicate protocol incompatibility; failed_fs_31/failed_fs_32 indicate that the remote stopped responding; failed_fs_35/failed_fs_39 indicate that the remote disconnected.

Available options:
success,
partially_sent,
partially_received,
in_progress,
insufficient_credit,
failed,
failed_internal_process_error,
failed_user_busy,
failed_no_answer,
failed_unallocated_number,
failed_office_converter_issue,
failed_separate_file_pages_issue,
failed_render_header_issue,
failed_invalid_number_format,
failed_mimetype_not_supported,
failed_destination_not_supported,
failed_image_preparation,
failed_to_send,
failed_normal_temporary_failure,
failed_unknown_converter_issue,
failed_normal_clearing,
failed_convert_to_tiff_issue,
failed_fs_2,
failed_fs_3,
failed_fs_8,
failed_fs_9,
failed_fs_31,
failed_fs_32,
failed_fs_35,
failed_fs_39,
failed_fs_48,
failed_fs_49
​
cost
integer

Fax cost in the user currency

Required range: x >= 0
​
description
string
​
direction
enum<string>

Fax direction

Available options:
outgoing,
incoming
​
duration
integer

Fax transmission duration in seconds

Required range: x >= 0
​
file
string

Fax file ID for the getFile handle

​
file_name
string

Human-readable file name

​
from
string

Sender number. Might be a userId for faxes sent or received with free accounts

​
header
string
​
is_read
boolean
​
is_spam
boolean

True if the fax is marked as spam

​
last_update
string
​
max_retry
integer

Maximum number of retries

Required range: 0 <= x <= 3
​
retry_delay
integer

Delay between two retries

Required range: 0 <= x <= 180
​
scheduled_time
string
​
start_time
string

Time at which faxing session started. Format: YYYY-MM-DD HH:mm:ss

​
submit_time
string

Time when the fax was submitted for sending. For outgoing faxes only

​
to
string

Fax destination number. Might be a userId for faxes sent or received with free accounts

​
cover_page
object

Fax cover page