Integrate Cloud Voice with IXICA Fax

Cloud Voice can pass faxing over to IXICA, so the people in your organization send and receive faxes securely over the internet, straight from the Cloud Voice App on desktop or web. This page walks an administrator through connecting the two systems.

How the integration works

The link between the two platforms is built from two pieces: a webhook from your Cloud Voice PBX (Private Branch Exchange, the phone system) and the IXICA Fax API (Application Programming Interface, the channel one system uses to ask another to do something). A webhook is an automatic notification that one system posts to another the moment an event happens, which is how IXICA tells Cloud Voice a fax has arrived without Cloud Voice having to keep checking. Faxes flow in both directions.

• Sending: When an extension user submits a fax from the Cloud Voice App, Cloud Voice calls the IXICA API to hand the fax off for delivery.

  

• Receiving: When a fax lands on one of your IXICA fax numbers, IXICA posts a webhook notification to Cloud Voice. Cloud Voice then retrieves the fax file through the API and delivers it to the extension users you have authorized, where it appears in their Cloud Voice App.

  

Setup follows three stages, which the steps below cover in order:

1. Copy a webhook URL out of Cloud Voice.
2. In IXICA, create the resources and gather the credentials you need, a fax-enabled phone number for sending and receiving, and an API key that authorizes access to the IXICA API.
3. Return to Cloud Voice, enter those credentials, and set up your fax numbers and routing.

Requirements

Before you begin, confirm your Cloud Voice system meets both of these:

• Firmware: 84.21.0.117 or later
• Plan: Enterprise or Ultimate

Before you start

• You have already purchased one or more fax numbers from IXICA.

Step 1: Copy the webhook URL from Cloud Voice

Cloud Voice generates the webhook URL that IXICA needs in order to notify it of incoming faxes. Copy it first.

1. Open the fax integration form.

   

   a. Sign in to the Cloud Voice admin portal and go to Integrations > Fax.

   b. On the Fax Integration tab, click Add.

2. Grab the webhook URL for IXICA.

   Caution

   The webhook URL is regenerated the moment you navigate away from this form. Keep this page open until you have saved the URL in IXICA and entered the credentials back in Step 3, and always use the most recent URL.

   

   a. From the Service Provider drop-down, choose IXICA.

   b. Click the copy icon in the Webhook URL field and set the URL aside for the next step.

Step 2: Create credentials and set the webhook in IXICA

In the IXICA portal you generate an API key and tell IXICA where to send incoming-fax notifications.

Create an API key

1. Sign in to the IXICA portal.

   

   a. Click your account in the top-right corner and choose My Account.

2. Generate the key.

   a. Above the API Key field, click Generate New. IXICA creates and displays a new key.

   

   b. Copy the API key and save it for later.

   

   Tip

   The API key is a credential that lets anyone holding it send and receive faxes on your IXICA account. Store it somewhere private (a password manager, not a plain text file or chat message) and do not share it outside the setup.

Point the webhook at Cloud Voice

1. On the account details page, set the webhook type.

   

   a. From the Webhook Type drop-down, select Cloud Voice.

   b. Click Save.

2. Point each fax number at Cloud Voice.

   a. In the left navigation bar, go to Fax management > Fax Numbers, then click Manage Fax DID (DID stands for Direct Inward Dialing, the phone number that routes an inbound fax straight to its destination) next to the number you want to use.

   

   b. On the number’s management page, scroll to the Fax API Settings section.

   c. In the Customer Fax Webhook URL field, paste the webhook URL you copied from Cloud Voice in Step 1.

   

   d. Click Save changes.

Step 3: Enter credentials and configure faxing in Cloud Voice

Return to Cloud Voice, supply the IXICA API key, and define how faxes are routed.

1. Switch back to the fax form you left open in the Cloud Voice admin portal.

2. Fill in the Authorization section.

   

   Setting	What to enter
   Name	A label that helps you recognize this integration.
   Service Provider	Select IXICA.
   API Key	The API key you copied from IXICA.

3. Optional: To also deliver inbound faxes as email attachments, set up email routing.

   

   a. In the Settings section, click Add.

   Note

   You can define up to 5 email entries.

   b. From the Email Type drop-down, pick a recipient type and complete the matching fields:

   • Extension’s Email: Delivers inbound faxes to the mailboxes of extension users. Choose the extensions from the Extension/Email drop-down.

     Note

     Make sure the extensions you select have a valid email address on file, or those users will not receive the emails.

   • Specified Email: Delivers inbound faxes to a fixed address. Type the address into the Extension/Email field.

4. Add your fax numbers and decide who may use them.

   a. In the Fax Number section, click Add.

   b. In the pop-up, complete the fields below, then click Save.

   Setting	What to enter
   Fax Number	The fax number from IXICA. For example, 12498037994.
   Fax Reception Destination	The extensions or extension groups allowed to receive inbound faxes. These users read incoming faxes in the Cloud Voice App under Fax Management > Fax.
   Extensions Allowed to Send Fax	The extensions or extension groups allowed to send faxes. These users send faxes from the Cloud Voice App under Fax Management > Fax.

   Caution

   Enter the fax number without a leading +. Including it causes fax delivery to fail.

   c. Repeat steps a and b for each additional fax number.

5. Click Save.

Result

• The Status shows a success indicator, confirming the IXICA Fax integration is live.

  

• The authorized extension users can now send and receive faxes through IXICA directly from the Cloud Voice App (Web or Desktop).

Next steps

• (Optional) Build cover pages. Create reusable cover sheets that fax senders can attach to outbound faxes. See Add a Fax Cover Page.
• Brief your users. Show the authorized extension users how to send faxes and review inbound faxes from the Cloud Voice App under Fax Management > Fax.