alohi / faxplus-python

Python SDK to use FAX.PLUS API

Fax.Plus Python SDK

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

API Documentation • Home • Help Center • Contact Us

• Only available to Enterprise clients

Requirements.

Python 3.5+

Installation

pip install

To install the package from PyPi

# From PyPi
pip install faxplus-api

# Directly from Github
pip install git+https://github.com/alohi/faxplus-python.git

Setuptools

Install via Setuptools.

git clone https://github.com/alohi/faxplus-python.git
cd faxplus-python
python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Getting Started

Example usage:

from faxplus import ApiClient, Configuration, FaxesApi

configuration = Configuration()
configuration.access_token = "YOUR_ACCESS_TOKEN"
client = ApiClient(configuration)
api = FaxesApi()
faxes = api.list_faxes("self", category=FaxCategory.INBOX)

Documentation

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

Author

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

faxplus-python's Issues

get access_token and clinet_id?

I can’t find a way to get access_token and clinet_id in the SDK, how do I get it?

Send Fax Returning null with status code 500 Server Error

Calling send_fax returns null as a response with status code 500. What causes this issue?

Here's the code:

retry_options = RetryOptions(count=2, delay=15)
outbox_options = OutboxOptions(
    enhancement=True, retry=retry_options
)

payload_outbox = PayloadOutbox(
    from_number="+1234567",
    to=["+1234567"],
    files=["file.pdf"],
    options=outbox_options,
)

res = outbox_api.send_fax(
    user_id="self", body=payload_outbox
)

This raises an ApiException with 500 Internal Server Error.