Coder Social home page Coder Social logo

faxplus-js's Introduction

Fax.Plus JavaScript SDK

Made for third-party developers and organizations to send and receive faxes from their own software or application.

NPM version License

API Documentation 3.0.4HomeHelp CenterContact Us

  • Also includes TypeScript definition
  • Only available to Enterprise clients

Installation

// with npm
npm install @alohi/faxplus-api

// with yarn
yarn add @alohi/faxplus-api

Getting Started

Example usage:

const axios = require('axios');
const Configuration = require('@alohi/faxplus-api').Configuration;
const FaxesApiFp = require('@alohi/faxplus-api').FaxesApiFp;
const FilesApiFp = require('@alohi/faxplus-api').FilesApiFp;

const accessToken = "YOUR_ACCESS_TOKEN"
const configuration = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
});

// Get the first entry in the corporate member's inbox
const request = await FaxesApiFp(configuration).listFaxes({userId: "self"});

const response = await request(axios);

const cdrId = response.data.data.records[0].id;

// Upload file
const request = await FilesApiFp(configuration).uploadFile("self",
  fs.createReadStream("./test/sample.pdf")
);

const response = await request(axios);

// Send fax

Documentation

Visit the full API reference at apidoc.fax.plus.

Author

© 2023 Alohi (Geneva, Switzerland) - Alohi.com

faxplus-js's People

Contributors

alohi avatar

Stargazers

 avatar Bob M avatar Andreas Eder avatar

Watchers

Math Ha Sum avatar  avatar  avatar

faxplus-js's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.