Integrate Yeastar P-Series Cloud Edition with Telnyx Fax

By integrating Yeastar P-Series Cloud Edition with Telnyx 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 Telnyx to enable Internet-based faxing, allowing PBX extension users to send and receive faxes through Telnyx's reliable communications network.

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

  • When a fax arrives at Telnyx fax number, Telnyx 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 Telnyx.
    • An API Key to authenticate your account and access Telnyx API endpoints.
    • An Outbound Voice Profile to initiate outbound fax traffic.
    • A Fax-enabled Phone Number for sending and receiving faxes.
    • A Fax Application to manage inbound and outbound fax traffic.
  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

Step 1. Obtain Webhook URL from Yeastar PBX

Obtain a Webhook URL from Yeastar PBX first, which is required when you set up a fax application on Telnyx.

  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 Telnyx.

    1. In the Service Provider drop-down list, select Telnyx.
    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 Telnyx

Create the necessary resources and obtain the required credentials from Telnyx, so as to authenticate and authorize interactions between Yeastar PBX and Telnyx.

You need to complete the following settings within Telnyx portal.

1. Create an API key
  1. Access the creation page of API key.
    1. Log in to Telnyx portal.
    2. At the top-right corner, click your account, then select API keys.

  2. Create an API key.
    1. At the top-right corner, click Create API Key.

    2. In the pop-up window, set tag and expiration date for the API key as needed, then click Create.

      A new API key is generated and displayed.

    3. Copy the API key and save it for later use, then close the window.

2. Create outbound voice profile
  1. Access the creation page of outbound voice profile.
    1. At the top-left corner, click Back to return to the home menu.

    2. On the left navigation bar, go to Real-Time Communications > Voice > Settings > Outbound Voice Profiles.
  2. At the top-right corner, click Create Profile.

  3. Customize the profile as needed.
3. Buy a phone number
  1. On the left navigation bar, go to Real-Time Communications > Numbers > Buy Numbers.

  2. Search and buy a number with fax capability.
    1. Under the Buy Number tab, set Features to Fax and configure additional filters as needed, then click Search Numbers to display available numbers.

    2. Select the desired number and complete payment.

      You will be redirected to the Manage Numbers page, where the purchased number is displayed.

4. Create a fax application
  1. Access the fax creation page.

    1. On the left navigation bar, go to Real-Time Communications > Fax.
    2. At the top-right corner, click Create Fax App.
  2. For Details, configure the following settings, then click Create.

    Setting Description
    Application name Enter a name to help you identify the application.
    Webhook URL Paste the Webhook URL obtained from Yeastar PBX.
    Timezone

    Specify the time zone used in the fax header timestamps.
  3. For Inbound, retain the default settings or configure it as needed, then click Next.

  4. For Outbound, select the OVP from the drop-down list of Outbound Voice Profile to enable outbound fax traffic, the click Next.

  5. For Numbers, click to assign the number to the application.

  6. At the bottom-left corner, click Complete.

    A window pops up, indicating that the fax application is created.

  7. Obtain the application ID.
    1. Click View my application.

    2. Under the Details tab, copy the application ID and save it for later use.

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

On Yeastar PBX, fill in the credentials obtained from Telnyx, 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 Telnyx.
    API Key Paste the API key obtained from Telnyx.
    Application ID Paste the application ID obtained from Telnyx.
  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 the 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 Telnyx 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: