Enable WebSocket Audio Streaming

This topic describes how to enable WebSocket Audio Streaming to transmit real-time audio streams from active calls to third-party platforms.

Requirements

  • Firmware: 83.20.0.74 or later
  • Subscription: Ultimate Plan

  • You have obtained the WebSocket server address of the third-party platform for receiving the audio stream.

  • If authentication is required by the third party, ensure that you have obtained the appropriate credentials.

Procedure

  1. Log in to PBX web portal, go to Integrations > WebSocket Audio Streaming.
  2. Turn on WebSocket Audio Streaming to enable the feature.
  3. Configure WebSocket audio streaming settings.

    1. In the Server Address field, select the protocol (ws:// or wss://) as required by the third-party platform, then enter its server address to receive the audio stream.
    2. Optional: In the Secret field, enter the authentication credentials provided by the third-party platform.
      Note: You can click to customize the option name based on the specific authentication field names required by different platforms.
    3. In the Sample Rate drop-down list, select the sample rate of the audio stream to be transmitted.
    4. In the Subscription Object, specify which calls will be transmitted to the third-party platform via WebSocket protocol.
      Object Description
      Extension Audio streams from calls involving the selected extensions will be transmitted to the third-party platform.
      Trunk Audio streams from inbound and outbound calls routed through the selected trunks will be transmitted to the third-party platform.
      DID Number Audio streams from inbound calls to the specified DID numbers will be transmitted to the third-party platform.
  4. Click Save.

Result

For calls that involve the subscribed extensions, trunks, or DID numbers, the audio streams of all participants in the call will be transmitted to the third-party platform via WebSocket in real time.

Note:
  • The audio streams are encoded in PCM format.
  • For more information about the audio stream content, see Audio Stream Fields.