Integrate Yeastar P-Series Cloud Edition with IZT Cloud Fax

By integrating Yeastar P-Series Cloud Edition with IZT Cloud Fax, employees within your organization can send and receive faxes instantly and securely over the Internet - directly from their own Linkus Desktop or Web Client.

Introduction

Yeastar P-Series Cloud Edition supports the integration with IZT Cloud to enable Internet-based faxing, allowing PBX extension users to send and receive faxes through IZT Cloud's reliable communications network.

The integration is implemented using Yeastar PBX Webhook and IZT Cloud Fax API.
  • When an extension user sends a fax from Linkus, Yeastar PBX calls IZT Cloud API to submit the fax for delivery.

  • When a fax arrives at IZT Cloud fax number, IZT Cloud sends a webhook notification to Yeastar PBX. PBX then retrieves the fax file via API and delivers it to the designated extension users' Linkus.

You can easily set up the integration by following the instructions below:

  1. Obtain Webhook URL from Yeastar PBX.
  2. Create the necessary resources and obtain the required credentials from IZT Cloud.
    • A Fax-enabled Phone Number for sending and receiving faxes.
    • An API Key to authenticate your account and access IZT Cloud API endpoints.
    • A Notification Group for webhook notifications.
  3. Fill in the obtained credentials in Yeastar PBX, then configure fax-related settings.

Requirements

To integrate online faxing capability into Yeastar PBX, ensure Yeastar PBX meets the following requirements.

  • Firmware: Version 84.20.0.X or later
  • Plan: Enterprise Plan or Ultimate Plan

Prerequisites

Purchase fax number(s) from IZT Cloud.

Step 1. Obtain Webhook URL from Yeastar PBX

Obtain a Webhook URL from Yeastar PBX first, which is required when you set up a notification group on IZT Cloud.

  1. Go to the fax integration page.

    1. Log in to PBX web portal, go to Integrations > Fax.
    2. Under Fax Integration tab, click Add.
  2. Obtain the Webhook URL for IZT Cloud Fax.

    1. In the Service Provider drop-down list, select IZT Cloud Fax.
    2. In the Webhook URL field, click to copy the URL and save it for later use.

Step 2. Create resources and obtain credentials from IZT Cloud

Create the necessary resources and obtain the required credential from IZT Cloud, so as to authenticate and authorize interactions between Yeastar PBX and IZT Cloud.

You need to complete the following settings within IZT Cloud portal.
1. Create an API key
  1. Access the creation page of API key.

    1. Log in to IZT Cloud Fax portal.
    2. Go to Settings > API Keys, then click Manage API Keys.
  2. Create an API key.
    1. At the top-right corner, click Generate New Key.

    2. In the API Key Name field, enter a name to help you identify the key, then click Generate API Key.

      A new API key is generated and displayed.

    3. Copy the API key and save it for later use, then click I've Saved the Key to close the window.

2. Create a notification group
  1. Access the creation page of notification group.

    1. On the left navigation bar, click Notifications.
    2. At the top-right corner, click Create Group.
  2. Configure the notification group, then click Create Group.

    Setting Description
    Group Name Enter a name to help you identify the group.
    Email Notifications Keep the default setting or customize it as needed.
    User Notifications Keep the default setting or customize it as needed.
    Webhooks Click Add Webhook, then paste the Webhook URL obtained from Yeastar PBX.
    Note: Set the Method to POST.
3. Associate notification group with fax number
  1. Access the configuration page of fax number.
    1. On the left navigation bar, click Numbers, then click View beside the desired number.

    2. On the side panel, click Edit Number Settings.

  2. In the Notification Group drop-down list, select the created group, then click Save Changes.

Step 3. Fill in credentials and configure fax settings on Yeastar PBX

On Yeastar PBX, fill in the credentials obtained from IZT Cloud, then configure the fax-related settings to complete the fax integration.

  1. Go to the fax integration page.

    1. Log in to PBX web portal, go to Integrations > Fax.
    2. Under Fax Integration tab, click Add.
  2. In the Authorization section, complete the authorization settings.

    Setting Description
    Name Enter a name to help you identify the integration.
    Service Provider Select IZT Cloud Fax.
    API Key Paste the API key obtained from IZT Cloud.
  3. Optional: To forward inbound faxes as email attachments to designated addresses, perform the following operations.

    1. In the Settings section, click Add.
      Note: You can add up to 5 email entries.
    2. In the Email Type drop-down list, select the type of email address and complete the corresponding settings.
      • Extension's Email: Send the inbound faxes as email attachments to extension users' mailboxes.
        If you choose this option, select the desired extensions from the Extension/Email drop-down list.
        Note: Ensure the selected extensions have valid email addresses configured. Otherwise, users will not receive the emails.
      • Specified Email: Send the inbound faxes as email attachments to a specified email address.

        If you choose this option, enter a custom email address in the Extension/Email field.

  4. Set fax number(s) and specify which extension users are authorized to send and receive faxes.
    1. In the Fax Number section, click Add.
    2. In the pop-up window, configure the following settings, then click Save.
      Setting Description
      Fax Number Enter fax number in E.164 format.
      Example: +12498037994
      Important: Remove hyphens - from the fax number, otherwise the fax delivery will fail.
      Fax Reception Destination Select extensions or extension groups that can receive inbound faxes.

      The designated users can view inbound faxes from Linkus Desktop or Web Client (Path: Fax Management > Fax).
      Extensions Allowed to Send Fax Select extensions or extension groups that can send faxes.

      The designated users can send faxes from Linkus Desktop or Web Client (Path: Fax Management > Fax).
    3. To add more fax numbers, repeat steps a-b.
  5. Click Save.

Result

The Status displays , indicating the integration with IZT Cloud Fax has been set up successfully.

What to do next

  1. (Optional) Customize cover pages, which will be accessible to extension users when they send faxes.

    For more information, see Add a Fax Cover Page.

  2. Instruct extension users on how to send faxes and check inbound faxes from their Linkus Desktop or Web Client.
    For more information, see the following topics: