Skip to main content

A Python module for interacting with the Phaxio API.

Installation

Via pip:

$ pip install pyphaxio

Usage

Send a fax to multiple people using HTML message:

from phaxio import PhaxioApi

api = PhaxioApi(key, secret)
r = api.send(to=['4141234567', '5141234567', '6151234567'],
    string_data='Hello World!',
    string_data_type='text')
print(r.get('faxId'))

Generally, each supported method takes keyword arguments with the exact same names of the API method parameters as they’re described in the documentation. One exception to this rule is that filename is instead referred to as files. For example, to send a fax using files:

llama = os.path.join(os.path.dirname(__file__), 'tests/llama.pdf')
alpaca = os.path.join(os.path.dirname(__file__), 'tests/alpaca.pdf')
f = open(alpaca, 'rb')
r = api.send(to='4141234567', files=(llama, f))

See the tests for additional examples.

Error Handling

By default, the api calls return a dictionary. However, you can use PhaxioApi(key, secret, raise_errors=True) which will raise the following errors: * AuthenticationError - key/secret are invalid * APIError - error with api call * ServerError - server had an error and could not complete your request

Errors can be imported from the phaxio.exceptions module.

Currently Supported API Calls

Implemented and tested:

  • send

  • testReceive

  • faxStatus

  • faxFile

Implemented and untested:

  • attachPhaxCodeToPdf

  • createPhaxCode

  • getHostedDocument

  • provisionNumber

  • releaseNumber

  • numberList

  • faxList

  • faxCancel

  • accountStatus

Testing

python setup.py test

You will be prompted for a test api key and secret

Contributing

  1. Fork it

  2. Create your feature branch (git checkout -b my-new-feature)

  3. Commit your changes (git commit -am 'Added some feature')

  4. Push to the branch (git push origin my-new-feature)

  5. Create new Pull Request

Release files for pyphaxio 0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyphaxio 0.11
File Size Uploaded
pyphaxio-0.11.tar.gz 4.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyphaxio 0.11
File Interpreter ABI Platform
pyphaxio-0.11-py2-none-any.whl Python 2 none any Details

Total release size: 12.5 kB

Release files / pyphaxio-0.11.tar.gz

Download URL pyphaxio-0.11.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
bdbf63c5542c5c7f52bb2520fd090a0598b44791cf9547afbecac6cf78a966ae
BLAKE2b-256 checksum
How to use checksums
c226fc4c381cff019c5e269a1d61c0bee55d2a7484e4c62270763de67721cc96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pyphaxio-0.11-py2-none-any.whl

Download URL pyphaxio-0.11-py2-none-any.whl
Size 7.8 kB
Tags Python 2
SHA-256 checksum
How to use checksums
f952e4c1fac5ee502d18ac686c55dcf2837f4819d160fdfafff104dcf56dbfe9
BLAKE2b-256 checksum
How to use checksums
67d80f04f25e47c69659c078709615c12fa31321da0b2fcc225f6802efda8e7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.11 This release

2 release files

0.10

2 release files

0.9

1 release file

0.8

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page