Skip to content
  • Documentation >
  • Apps >
  • Communication >
  • Phaxio

Phaxio

The Phaxio modules allow you to create, send, resend, and cancel as fax in your Phaxio account.

Prerequisites

  • A Phaxio account

In order to use Phaxio with Ibexa Connect, it is necessary to have a Phaxio account. If you do not have one, you can create a Phaxio account at https://www.phaxio.com/.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Phaxio to Ibexa Connect

To connect your Phaxio account to Ibexa Connect, you need to obtain your API Key and API Secret.

1. Login to your Phaxio account.

2. From the left menu, click API Keys.

61f2756408e79.gif

3. Copy the API Key and API Secret to your clipboard.

61f2756600561.png

4. Go to Ibexa Connect and open the Phaxio module's Create a connection dialog.

61f27566da3b4.gif

5. In the Connection name field, enter a name for the connection.

6. In the API Key and API Secret fields, enter the details copied in step 3 respectively.

7. Click Continue.

61f27568ebd33.png

The connection has been established.

Actions

Cancel Fax

Cancels a fax.
Fax ID Enter the Fax ID you want to cancel.

Create and Send Fax

Create and sends a fax.

Phone number

Enter the phone number to which you want to send the fax. You can send multiple phone numbers in the following format:

(+[country code][number])

Files

Add files you want to fax:

File name

Enter the file name. For example, sample.doc

Data

Enter the file data to the field or map the source of the file.

URL

Enter the URL to the fax files you want to attach to the message.

Header Text

Enter the text that appears at the top of the fax.

Callback URL

Enter the URL that can overwrite the defined URL globally.

Batch Delay

Enter the time in seconds for which you want to delay sending the fax. You can delay the batch up to 1 hour (3600 seconds).

Batch collision avoidance

Select Yes if you want to block the fax until the receiving machine is ready or not busy:

  • Yes

  • No

  • Not defined

Cancel timeout

Enter the number of minutes after which the fax will be canceled if it has not been completed yet.

Enter a value between 3 and 60.

Caller ID

Enter the Phaxio phone number which you would like to use for the caller ID.

Resend Fax

Resends a fax.
Fax ID Enter the Fax ID you want to resend.