Skip to main content
GET
/
accounts
/
{user_id}
/
files
/
{fax_id}
const axios = require('axios');
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 getFile() {
    const reqParams = {
        "userId": '13d8z73c',
        "faxId": '132esd4cs31',
        "format": 'tiff'
    }
    const req = await FilesApiFp(config).getFile(reqParams);
    const resp = await req(axios);
}

getFile()

"<string>"
const axios = require('axios');
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 getFile() {
    const reqParams = {
        "userId": '13d8z73c',
        "faxId": '132esd4cs31',
        "format": 'tiff'
    }
    const req = await FilesApiFp(config).getFile(reqParams);
    const resp = await req(axios);
}

getFile()

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

ID of the fax which you want to download

Query Parameters

​
format
enum<string>

File format for the response. Deprecated - use Accept header instead. Optional.

Available options:
tiff,
pdf

Response

CDR file content in corresponding mimetype e.g. application/pdf

Binary data. Will save to file and return file path if _preload_content is True, otherwise will return binary stream