Start sending faxes in 4 steps
Create a Fax.Plus Account
Get Your API Key
Upload a file
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() { const reqParams = { "format": 'tiff', "userId": '13d8z73c', "faxFile": fs.createReadStream(FILE_PATH) } const req = await FilesApiFp(config).uploadFile(reqParams); const resp = await req(axios); } uploadFile()
path
{ "path": "/storage/2937237320213-213-21323" }
Send a fax
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 sendFax() { const reqParams = { "userId": '13d8z73c', "payloadOutbox": { "comment": { "tags": [ "tag1", "tag2" ], "text": "text comment" }, "files": [ "filetosend.pdf" ], "from": "+12345667", "options": { "enhancement": true, "retry": { "count": 2, "delay": 15 } }, "send_time": "2000-01-01 01:02:03 +0000", "to": [ "+12345688", "+12345699" ], "return_ids": true } } const req = await OutboxApiFp(config).sendFax(reqParams); const resp = await req(axios); } sendFax()
{ "ids": { "+1234567890": "1a2b3c4d5e6f7890", "+1345678912": "78901a2b3c4d5e6f" } }