|
@@ -1,72 +1,75 @@
|
|
|
-*****************
|
|
|
+************************************************
|
|
|
Voicemail Transcription in FusionPBX 5.3
|
|
|
-*****************
|
|
|
-
|
|
|
-- Log in to FusionPBX
|
|
|
-
|
|
|
- - Access the FusionPBX administrative interface.
|
|
|
-
|
|
|
-- Check for the "Transcribe" Option
|
|
|
-
|
|
|
- - Navigate to Advanced > Default Settings.
|
|
|
-
|
|
|
- - Use the drop-down filter to select "Transcribe".
|
|
|
-
|
|
|
- - If the "Transcribe" option exists, skip to step 5. Otherwise, continue to step 3.
|
|
|
-
|
|
|
-- Install the Transcribe and Speech Apps
|
|
|
-
|
|
|
- - SSH into your server and run the following commands::
|
|
|
-
|
|
|
- cd /var/www/fusionpbx/app
|
|
|
-
|
|
|
- git clone https://github.com/fusionpbx/fusionpbx-app-transcribe.git transcribe
|
|
|
+************************************************
|
|
|
|
|
|
- git clone https://github.com/fusionpbx/fusionpbx-app-speech.git speech
|
|
|
+Overview
|
|
|
+========
|
|
|
+This document provides a step-by-step guide for setting up the email transcription service in FusionPBX version 5.3. It supports various service providers such as OpenAI, Google, Azure, or a custom solution.
|
|
|
|
|
|
- chown -R www-data:www-data /var/www/fusionpbx
|
|
|
+Step-by-step
|
|
|
+++++++++++++
|
|
|
+1. **Log in to FusionPBX**
|
|
|
|
|
|
- php /var/www/fusionpbx/core/upgrade/upgrade.php
|
|
|
+ * Access the FusionPBX administrative interface.
|
|
|
|
|
|
-- Reload the FusionPBX Interface
|
|
|
+2. **Check for the "Transcribe" Option**
|
|
|
|
|
|
- - Navigate back to Advanced > Default Settings.
|
|
|
+ * Navigate to **Advanced** > **Default Settings**.
|
|
|
+ * Use the drop-down filter to select "**Transcribe**".
|
|
|
+ * If the "**Transcribe**" option is already available, skip to step **5**. Otherwise, proceed to step **3**.
|
|
|
|
|
|
- - The "Transcribe" section should now be available.
|
|
|
+3. **Install the Transcribe and Speech Apps**
|
|
|
|
|
|
-- Configure Transcription Settings
|
|
|
+ * SSH into your server and run the following commands:
|
|
|
|
|
|
- - In the **"Transcribe"**category, find and enable the following settings:
|
|
|
+ .. code-block:: console
|
|
|
|
|
|
- - api_key: Enter your API key for the transcription service.
|
|
|
+ cd /var/www/fusionpbx/app
|
|
|
+ git clone https://github.com/fusionpbx/fusionpbx-app-transcribe.git transcribe
|
|
|
+ git clone https://github.com/fusionpbx/fusionpbx-app-speech.git speech
|
|
|
+ chown -R www-data:www-data /var/www/fusionpbx
|
|
|
+ php /var/www/fusionpbx/core/upgrade/upgrade.php
|
|
|
|
|
|
- - enabled: Set to True.
|
|
|
+4. **Reload the FusionPBX Interface**
|
|
|
|
|
|
- - engine: Type your transcription provider (e.g., openai, google, azure, etc.).
|
|
|
+ * Navigate back to **Advanced** > **Default Settings**.
|
|
|
+ * The "**Transcribe**" section should now be available.
|
|
|
|
|
|
- - api_url: Leave this blank
|
|
|
+5. **Configure Transcription Settings**
|
|
|
|
|
|
- - Click Reload to apply the changes.
|
|
|
+ * In the "**Transcribe**" category, enable the following settings:
|
|
|
|
|
|
-- Enable Transcription for one Extension
|
|
|
+ ============ ========= =============== ========= ====================================================
|
|
|
+ Subcategory Type Value Enabled Description
|
|
|
+ ============ ========= =============== ========= ====================================================
|
|
|
+ api_key text secret_key true Speech to Text API key
|
|
|
+ api_url text https://api... false ***Leave this alone unless you are using a custom service***
|
|
|
+ enabled boolean true true Speech to Text Enabled
|
|
|
+ engine text openai true Options: openai, google, azure, custom
|
|
|
+ ============ ========= =============== ========= ====================================================
|
|
|
|
|
|
- - Navigate to Accounts > Extensions.
|
|
|
+ * Click **Reload** to apply the changes.
|
|
|
|
|
|
- - Select the desired extension.
|
|
|
+6. **Enable Transcription for a Single Extension**
|
|
|
|
|
|
- - Set Transcription Enabled to True.
|
|
|
+ * Navigate to **Accounts** > **Extensions**.
|
|
|
+ * Select the desired extension.
|
|
|
+ * Set **Transcription Enabled** to **True**.
|
|
|
|
|
|
-- Enable Transcription by Default for Everyone.
|
|
|
+7. **Enable Transcription by Default for All Extensions**
|
|
|
|
|
|
- - Navigate to Advanced > Default Settings.
|
|
|
+ * Navigate to **Advanced** > **Default Settings**.
|
|
|
+ * Use the drop-down filter to select "**Voicemail**".
|
|
|
+ * Enable the **transcription_enabled_default** setting.
|
|
|
|
|
|
- - Use the drop-down filter to select "Voicemail".
|
|
|
+8. **Test the Service**
|
|
|
|
|
|
- - Find and enable the setting transcription_enabled_default.
|
|
|
+ * Leave a voicemail for the enabled extension to verify that the transcription works correctly.
|
|
|
|
|
|
-- Test the Service
|
|
|
+.. note::
|
|
|
|
|
|
- - Leave a voicemail for that extension to verify the transcription works correctly.
|
|
|
+ The primary function handling voicemail transcriptions is defined in
|
|
|
+ `transcribe.php <https://github.com/fusionpbx/fusionpbx/blob/master/app/email_queue/resources/functions/transcribe.php>`_.
|
|
|
|
|
|
|
|
|
|