const axios = require('axios');
const fs = require('fs');
const FilesApiFp = require('@alohi/faxplus-api').FilesApiFp;
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 uploadFile() {
    // IMPORTANT: fs.createReadStream() requires a local file system path.
    // It does NOT support URLs or remote streams.
    // 
    // If your file is stored remotely (e.g., AWS S3, Google Cloud Storage, or HTTP URL),
    // you must first download it to a local path or load it into memory as a Blob.
    const reqParams = {
        "userId": '13d8z73c',
        "faxFile": fs.createReadStream(FILE_PATH)  // FILE_PATH must be a local file path
    }
    const req = await FilesApiFp(config).uploadFile(reqParams);
    const resp = await req(axios);
}

uploadFile()

{
  "path": "/storage/2937237320213-213-21323"
}

Files

Upload a file

Before sending a fax you need to upload your files using this API. In order to upload your fax file, you have to send a multipart/form-data request with your file. Set the name to fax_file, filename to your file’s name with extension, and the Content-Type to the file’s MIME type. In most cases, the filename directive will be automatically added by your library of choice. If the upload was successful you would receive a file_path which you can use to send your fax. (Permitted scopes: fax:all:edit, fax:file:edit)

POST

accounts

{user_id}

files

const axios = require('axios');
const fs = require('fs');
const FilesApiFp = require('@alohi/faxplus-api').FilesApiFp;
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 uploadFile() {
    // IMPORTANT: fs.createReadStream() requires a local file system path.
    // It does NOT support URLs or remote streams.
    // 
    // If your file is stored remotely (e.g., AWS S3, Google Cloud Storage, or HTTP URL),
    // you must first download it to a local path or load it into memory as a Blob.
    const reqParams = {
        "userId": '13d8z73c',
        "faxFile": fs.createReadStream(FILE_PATH)  // FILE_PATH must be a local file path
    }
    const req = await FilesApiFp(config).uploadFile(reqParams);
    const resp = await req(axios);
}

uploadFile()

{
  "path": "/storage/2937237320213-213-21323"
}

const axios = require('axios');
const fs = require('fs');
const FilesApiFp = require('@alohi/faxplus-api').FilesApiFp;
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 uploadFile() {
    // IMPORTANT: fs.createReadStream() requires a local file system path.
    // It does NOT support URLs or remote streams.
    // 
    // If your file is stored remotely (e.g., AWS S3, Google Cloud Storage, or HTTP URL),
    // you must first download it to a local path or load it into memory as a Blob.
    const reqParams = {
        "userId": '13d8z73c',
        "faxFile": fs.createReadStream(FILE_PATH)  // FILE_PATH must be a local file path
    }
    const req = await FilesApiFp(config).uploadFile(reqParams);
    const resp = await req(axios);
}

uploadFile()

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.

Query Parameters

format

enum<string>

Can be 'pdf' or 'tiff' File type

Available options:

tiff,

pdf

Body

multipart/form-data

A file to be uploaded. The file can be in PDF, TIFF, Word, Excel, RTF or image format.

File to be uploaded

fax_file

file

required

Path to file to upload

Response

Simple object containing path of created file

File path object

path

string

required

Path of newly uploaded file

Assign contacts to groups Download fax file

⌘I