@cognigy/rest-api-client 0.12.0 → 0.13.1

package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js

@@ -5,7 +5,8 @@ exports.setSessionConfigNode = exports.voiceConfigFields = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-const strip_nulls_1 = require("../utils/strip-nulls");
+const setSessionConfig_mapper_1 = require("../../voice/mappers/setSessionConfig.mapper");
+const setSessionConfig_mapper_2 = require("../../voice/mappers/setSessionConfig.mapper");
 exports.voiceConfigFields = [
     {
         key: "bargeInMinWordCount",
@@ -30,7 +31,7 @@ exports.voiceConfigFields = [
         key: "bargeInOnDtmf",
         type: "toggle",
         label: "Barge In On DTMF",
-        description: "Allows the user to interrupt bot output with DTMF",
+        description: "Allows the user to interrupt bot output with DTMF. If you enable this feature, you also need to enable the sending of DTMF digits",
         defaultValue: false
     },
     {
@@ -50,25 +51,6 @@ exports.voiceConfigFields = [
         description: "Array of words or phrases to assist speech detection",
         defaultValue: [""]
     },
-    {
-        key: "ttsDisableCache",
-        type: "toggle",
-        label: "Disable TTS audio caching",
-        description: "Disable TTS audio caching for a reduced number of queries to TSS vendor. Warning, " +
-            "disabling caching increases your TTS costs",
-        defaultValue: false
-    },
-    {
-        key: "ttsVendor",
-        defaultValue: "",
-        type: "ttsSelect",
-        label: "_unused_",
-        description: "_unused_",
-        params: {
-            languageKey: "config.ttsLanguage",
-            voiceKey: "config.ttsVoice"
-        }
-    },
     {
         key: "sttVadEnabled",
         type: "toggle",
@@ -76,10 +58,17 @@ exports.voiceConfigFields = [
         description: "Delay connection to cloud recognizer until speech is detected",
         defaultValue: true
     },
+    {
+        key: "sttDisablePunctuation",
+        type: "toggle",
+        label: "Disable STT Punctuation",
+        description: "Prevents the STT response from the bot to include punctuation marks",
+        defaultValue: false
+    },
     {
         key: "sttVadMode",
         type: "slider",
-        label: "VAD sensitivity",
+        label: "VAD Sensitivity",
         description: "Detection sensitivity, the lowest value has the highest sensitivity",
         defaultValue: 1,
         params: {
@@ -95,7 +84,7 @@ exports.voiceConfigFields = [
     {
         key: "sttVadVoiceMs",
         type: "slider",
-        label: "Minimal voice duration",
+        label: "Minimal Voice Duration",
         description: "Milliseconds of speech activity required before connecting to the cloud recognizer",
         defaultValue: 100,
         params: {
@@ -108,63 +97,25 @@ exports.voiceConfigFields = [
             value: true
         }
     },
-    /*
-    {
-        key: "azureTtsDeploymentId",
-        type: "text",
-        label: "Azure TTS deployment ID",
-        description: "Define a custom azure deployment for TTS",
-        defaultValue: ""
-    },
-    {
-        key: "azureSttDeploymentId",
-        type: "text",
-        label: "Azure STT deployment ID",
-        description: "Define a custome azure STT deployment",
-        defaultValue: ""
-    },
-    {
-        key: "azureSpeechRecognitionMode",
-        type: "text",
-        label: "Azure Speech recognition mode",
-        description: "Define azure STT mode",
-        defaultValue: ""
-    },
-    {
-        key: "azureEnableAudioLogging",
-        type: "toggle",
-        label: "Azure Audio logging",
-        description: "Select the desired TTS Vendor",
-        defaultValue: false
-    },
-    {
-        key: "azureHintsBoost",
-        type: "number",
-        label: "Azure Hints Boost",
-        description: "Define if Azure Hints needs to be boosted",
-        defaultValue: 0
-    },
     {
-        key: "googleDisablePunctuation",
+        key: "ttsDisableCache",
         type: "toggle",
-        label: "Google Disable Punctuation",
-        description: "Disable Punctuation detection in Google's STT",
+        label: "Disable TTS Audio Caching",
+        description: "Disable TTS audio caching for a reduced number of queries to TSS vendor. Warning, " +
+            "disabling caching increases your TTS costs",
         defaultValue: false
     },
     {
-        key: "googleInteractionType",
-        type: "text",
-        label: "Google STT Interaction type",
-        description: "Define Google STT interaction type",
-        defaultValue: ""
+        key: "ttsVendor",
+        defaultValue: "",
+        type: "ttsSelect",
+        label: "_unused_",
+        description: "_unused_",
+        params: {
+            languageKey: "config.ttsLanguage",
+            voiceKey: "config.ttsVoice"
+        }
     },
-    {
-        key: "googleHintsBoost",
-        type: "number",
-        label: "Google STT Hints Boost",
-        description: "Define if Google Hints needs to be boosted",
-        defaultValue: 0
-    },*/
     {
         key: "userNoInputMode",
         type: "select",
@@ -190,18 +141,24 @@ exports.voiceConfigFields = [
         type: "number",
         label: "User No Input Timeout",
         description: "Define the timeout for user input in ms",
-        defaultValue: 10000
+        defaultValue: 10000,
+        params: {
+            min: 1000,
+        },
     },
     {
         key: "userNoInputRetries",
         type: "number",
         label: "User No Input Retries",
         description: "Define how often the bot should retry to get an input from a user before completing the call",
-        defaultValue: 1
+        defaultValue: 1,
+        params: {
+            min: 0,
+        },
     },
     {
         key: "userNoInputSpeech",
-        type: "text",
+        type: "cognigyText",
         label: "User No Input Speech",
         description: "Define a prompt to speak in case a user does not answer the bot in time",
         defaultValue: "",
@@ -215,7 +172,7 @@ exports.voiceConfigFields = [
     },
     {
         key: "userNoInputUrl",
-        type: "text",
+        type: "cognigyText",
         label: "User No Input URL",
         description: "Define which URL will be played in case a user does not answer the bot in time. MP3 and WAV files are supported",
         defaultValue: "",
@@ -227,74 +184,37 @@ exports.voiceConfigFields = [
             required: true
         }
     },
-    /*
-    {
-        key: "botFailOnError",
-        type: "toggle",
-        label: "Bot Fail on Error",
-        description: "Define if the Bot should fail and escalate the call if an error occured",
-        defaultValue: true
-    },
-    {
-        key: "botNoOutputGiveupTimeout",
-        type: "number",
-        label: "Bot No Output Giveup Tinmeout",
-        description:
-            "Define the time in ms, after which the bot should escalate if no output has been provided by cognigy",
-        defaultValue: 0
-    },
-    {
-        key: "botNoOutputTimeout",
-        type: "number",
-        label: "Bot No Output Timeout",
-        description: "Define the timeout for bot outputin ms",
-        defaultValue: 0
-    },
-    {
-        key: "botNoOutputRetries",
-        type: "number",
-        label: "Bot No Input Retries",
-        description: "Define how many times should we try to get bot output",
-        defaultValue: 0
-    },
-    {
-        key: "botNoOutputSpeech",
-        type: "text",
-        label: "Bot No Input Speech",
-        description: "Define the default speech the bot will speak if no bot output detected",
-        defaultValue: ""
-    },
-    {
-        key: "botNoOutputUrl",
-        type: "text",
-        label: "Bot No Input URL",
-        description: "Define the file which should be played if no bot output was detected",
-        defaultValue: ""
-    },*/
     {
         key: "dtmfEnable",
         type: "toggle",
-        label: "Capture DTMF signals",
-        description: "Enable capturing of DTMF signals by the bot",
+        label: "Capture DTMF Signals",
+        description: "Enables capturing of DTMF signals by the bot",
         defaultValue: false
     },
     {
         key: "dtmfInterDigitTimeout",
         type: "number",
         label: "DTMF Inter Digit Timeout",
-        description: "Define the max timeout between entering the digits on the phone",
-        defaultValue: 1000,
+        description: "Defines the timeout in between collected DTMF digits",
+        defaultValue: 2000,
+        params: {
+            min: 1000,
+            max: 60000,
+        },
         condition: {
             key: "dtmfEnable",
             value: true
-        }
+        },
     },
     {
         key: "dtmfMaxDigits",
         type: "number",
         label: "DTMF Max Digits",
-        description: "Define the max number of digits which can be entered by the user. After reaching the max number of entered digits these will be automatically submited to the bot",
+        description: "Defines the maximum number of digits which can be entered by the user, the digits are being submitted automatically once this limit is reached",
         defaultValue: 1,
+        params: {
+            min: 1,
+        },
         condition: {
             key: "dtmfEnable",
             value: true
@@ -304,8 +224,11 @@ exports.voiceConfigFields = [
         key: "dtmfMinDigits",
         type: "number",
         label: "DTMF Min Digits",
-        description: "Define the min number of digits a user needs to submit before they are forwarded to the bot. Can be overriden by a submit digit",
+        description: "Defines the mininum number of digits before they are forwarded to the bot. This can be overridden by a submit digit",
         defaultValue: 1,
+        params: {
+            min: 1,
+        },
         condition: {
             key: "dtmfEnable",
             value: true
@@ -313,60 +236,52 @@ exports.voiceConfigFields = [
     },
     {
         key: "dtmfSubmitDigit",
-        type: "text",
+        type: "cognigyText",
         label: "DTMF Submit Digit",
-        description: "Define the DTMF submit digit which will be used for submitting the previously entered digits. Overrides min digits validation",
+        description: "Defines the DTMF submit digit which will be used for submitting the previously entered digits. This overrides the minimum digits validation",
         defaultValue: "#",
         condition: {
             key: "dtmfEnable",
             value: true
         }
     },
-    /*
-    {
-        key: "asrDigits",
-        type: "text",
-        label: "ASR Digits",
-        description: "???????",
-        defaultValue: ""
-    },
-    {
-        key: "asrTimeout",
-        type: "number",
-        label: "ASR Timeout in ms",
-        description: "???",
-        defaultValue: 0
-    },
-    */
-    /*
     {
-        key: "setBotOutputParams",
-        label: "Set Bot Output Parameters",
-        type: "toggle",
-        defaultValue: false
+        key: "asrDigit",
+        type: "cognigyText",
+        label: "Continuous ASR Submit Digit",
+        description: "Defines a special DTMF key, which sends the accumulated recognitions to the flow",
+        defaultValue: "",
+        condition: {
+            key: "asrEnabled",
+            value: true
+        }
     },
     {
-        key: "setContiniousASR",
-        label: "Set continous ASR params",
+        key: "asrEnabled",
         type: "toggle",
+        label: "Enable Continuous ASR",
+        description: "Enables Continuous ASR",
         defaultValue: false
     },
     {
-        key: "setAzureParams",
-        label: "Set Azure STT/TTS params",
-        type: "toggle",
-        defaultValue: false
+        key: "asrTimeout",
+        type: "number",
+        label: "Continuous ASR Timeout",
+        description: "Defines the number of milliseconds of silence before the accumulated recognitions are send to the flow",
+        defaultValue: 0,
+        params: {
+            min: 0,
+        },
+        condition: {
+            key: "asrEnabled",
+            value: true
+        }
     },
-    {
-        key: "setGoogleParams",
-        label: "Set Google STT/TTS params",
-        type: "toggle",
-        defaultValue: false
-    }*/
 ];
-exports.setSessionConfigNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "setSessionConfig",
     defaultLabel: "Set Session Config",
+    summary: "Change configuration settings for the call session",
     appearance: {
         color: design_1.nodeColor
     },
@@ -376,7 +291,7 @@ exports.setSessionConfigNode = createNodeDescriptor_1.createNodeDescriptor({
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttVendor", "sttHints", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"]
+            fields: ["sttVendor", "sttHints", "sttDisablePunctuation", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"]
         },
         {
             key: "params_tts",
@@ -390,33 +305,6 @@ exports.setSessionConfigNode = createNodeDescriptor_1.createNodeDescriptor({
             defaultCollapsed: true,
             fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"]
         },
-        /*
-        {
-            key: "params_azure",
-            label: "Azure STT/TTS Configuration",
-            defaultCollapsed: true,
-            fields: [
-                "azureTtsDeploymentId",
-                "azureSttDeploymentId",
-                "azureSpeechRecognitionMode",
-                "azureEnableAudioLogging",
-                "azureHintsBoost"
-            ],
-            condition: {
-                key: "setAzureParams",
-                value: true
-            }
-        },
-        {
-            key: "params_google",
-            label: "Google STT/TTS Configuration",
-            defaultCollapsed: true,
-            fields: ["googleDisablePunctuation", "googleInteractionType", "googleHintsBoost"],
-            condition: {
-                key: "setGoogleParams",
-                value: true
-            }
-        },*/
         {
             key: "params_user_timeouts",
             label: "User Input Timeout",
@@ -429,156 +317,38 @@ exports.setSessionConfigNode = createNodeDescriptor_1.createNodeDescriptor({
                 "userNoInputRetries"
             ]
         },
-        /*
-        {
-            key: "params_bot_timeouts",
-            label: "Configure what should happen on bot output timeout",
-            defaultCollapsed: true,
-            fields: [
-                "botFailOnError",
-                "botNoOutputGiveupTimeout",
-                "botNoOutputTimeout",
-                "botNoOutputRetries",
-                "botNoOutputSpeech",
-                "botNoOutputUrl"
-            ],
-            condition: {
-                key: "setBotOutputParams",
-                value: true
-            }
-        },*/
         {
             key: "params_dtmf",
             label: "DTMF",
             defaultCollapsed: true,
             fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfMinDigits", "dtmfSubmitDigit"]
-        }
-        /*
+        },
         {
-            key: "params_continuousasr",
-            label: "Configgure the cotinious Audio Speech Recognition",
+            key: "params_continuous_asr",
+            label: "Continuous ASR",
             defaultCollapsed: true,
-            fields: ["arsDigits", "asrTimeout"],
-            condition: {
-                key: "setContiniousASR",
-                value: true
-            }
-        }*/
+            fields: ["asrEnabled", "asrDigit", "asrTimeout"],
+        }
     ],
     form: [
         { type: "section", key: "params_tts" },
         { type: "section", key: "params_stt" },
         { type: "section", key: "params_bargein" },
         { type: "section", key: "params_user_timeouts" },
-        //{ type: "field", key: "setBotOutputParams" },
-        //{ type: "section", key: "params_bot_timeouts" },
         { type: "section", key: "params_dtmf" },
-        //{ type: "field", key: "setContiniousASR" },
-        //{ type: "section", key: "params_continuousasr" },
-        //{ type: "field", key: "setAzureParams" },
-        //{ type: "section", key: "params_azure" },
-        //{ type: "field", key: "setGoogleParams" },
-        //{ type: "section", key: "params_google" }
+        { type: "section", key: "params_continuous_asr" },
     ],
-    summary: "Change configuration settings for the call session",
     function: async ({ cognigy, config }) => {
-        const { api } = cognigy;
-        const voiceGateway2VerbConfig = {};
-        const voiceGateway2CongnigyConfig = {};
-        const synthesizer = {
-            language: config.ttsLanguage,
-            voice: config.ttsVoice,
-            vendor: config.ttsVendor
-        };
-        voiceGateway2VerbConfig.synthesizer = synthesizer;
-        const recognizer = {
-            language: config.sttLanguage,
-            vendor: config.sttVendor || "default",
-            hints: config.sttHints,
-            vad: {
-                enable: config.sttVadEnabled,
-                mode: config.sttVadMode,
-                voiceMs: config.sttVadVoiceMs
-            }
-        };
-        voiceGateway2VerbConfig.recognizer = recognizer;
-        const bargein = {
-            enable: false,
-            minBargeinWordCount: config.bargeInMinWordCount,
-            input: [],
-            actionHook: "voice"
-        };
-        if (config.bargeInOnDtmf) {
-            bargein.dtmfBargein = true;
-            bargein.input.push("digits");
-        }
-        if (config.bargeInOnSpeech) {
-            bargein.input.push("speech");
-        }
-        if (bargein.input.length > 0) {
-            bargein.enable = true;
-            bargein.sticky = true;
+        try {
+            const payload = setSessionConfig_mapper_1.setSessionConfig.handleVGInput((0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, cognigy.api));
+            cognigy.api.say(null, {
+                _cognigy: payload,
+            });
         }
-        voiceGateway2VerbConfig.bargeIn = bargein;
-        const user = {
-            noInputMode: config.userNoInputMode,
-            noInputTimeout: (config.userNoInputTimeout || 10000) / 1000,
-            noInputRetries: config.userNoInputRetries,
-            noInputSpeech: config.userNoInputSpeech,
-            noInputUrl: config.userNoInputUrl
-        };
-        voiceGateway2CongnigyConfig.cognigyConfig = { user };
-        /*
-        todo this needs to be implemented on voiceGateway2 side first
-        if (setBotOutputParams) {
-            const bot: BotOutputConfig = {
-                failOnError: config.botFailOnError,
-                noInputGiveUpTimeoutMs: config.botNoOutputGiveupTimeout,
-                noInputTimeout: config.botNoOutputTimeout,
-                noInputRetries: config.botNoOutputRetries,
-                noInputSpeech: config.botNoOutputSpeech,
-                noInputUrl: config.botNoOutputUrl
-            };
-
-            sessionConfig.bot = bot;
+        catch (error) {
+            throw new Error(`[VG2] Error on set session config node. Error message: ${error.message}`);
         }
-        */
-        if (config.dtmfEnable) {
-            if (!voiceGateway2VerbConfig.bargeIn) {
-                voiceGateway2VerbConfig.bargeIn = {
-                    enable: false
-                };
-            }
-            voiceGateway2VerbConfig.bargeIn.interDigitTimeout =
-                (config.dtmfInterDigitTimeout || 500) / 1000;
-            voiceGateway2VerbConfig.bargeIn.maxDigits = config.dtmfMaxDigits;
-            voiceGateway2VerbConfig.bargeIn.minDigits = config.dtmfMinDigits;
-            voiceGateway2VerbConfig.bargeIn.finishOnKey = config.dtmfSubmitDigit;
-            if (!voiceGateway2CongnigyConfig.cognigyConfig) {
-                voiceGateway2CongnigyConfig.cognigyConfig = {};
-            }
-            voiceGateway2CongnigyConfig.cognigyConfig.dtmf = true;
-        }
-        //if (setContiniousASR) {
-        //	// todo
-        //}
-        //if (setAzureParams) {
-        //	// todo
-        //}
-        //if (setGoogleParams) {
-        // todo
-        //}
-        if (Object.keys(voiceGateway2VerbConfig).length > 0) {
-            voiceGateway2CongnigyConfig.voiceGateway2Config = voiceGateway2VerbConfig;
-        }
-        strip_nulls_1.stripNulls(voiceGateway2CongnigyConfig);
-        api.say(null, {
-            _cognigy: {
-                _voiceGateway2: {
-                    json: voiceGateway2CongnigyConfig
-                }
-            }
-        });
+        ;
     }
 });
 //# sourceMappingURL=setSessionConfig.js.map

package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transferNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const transfer_mapper_1 = require("../../voice/mappers/transfer.mapper");
+const constants_1 = require("../utils/constants");
+const design_1 = require("../utils/design");
+const helper_1 = require("../utils/helper");
+exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "transfer",
+    defaultLabel: "Transfer",
+    preview: {
+        key: "referTo",
+        type: "text",
+    },
+    appearance: {
+        color: design_1.nodeColor,
+    },
+    fields: [
+        {
+            key: "referTo",
+            label: "Target",
+            type: "cognigyText",
+            params: {
+                required: true,
+            },
+            description: "E.164 syntax or a SIP URI are supported",
+            defaultValue: "+49123456789",
+        },
+        {
+            key: "useTransferSipHeaders",
+            label: "Custom Transfer SIP Headers",
+            type: "toggle",
+            description: "Add data to be sent as SIP headers in the generated SIP message",
+            defaultValue: false,
+        },
+        {
+            key: "transferSipHeaders",
+            label: "Transfer SIP Headers",
+            type: "json",
+            description: "The data to be sent as SIP headers in the generated SIP message",
+            defaultValue: {
+                "X-Custom-Header": "YourValue",
+            },
+            condition: {
+                key: "useTransferSipHeaders",
+                value: true,
+            },
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: ["useTransferSipHeaders", "transferSipHeaders"],
+        },
+    ],
+    form: [
+        {
+            type: "field",
+            key: "referTo",
+        },
+        {
+            type: "section",
+            key: "advanced",
+        },
+    ],
+    summary: "Transfer the call to another target",
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
+        const transferParams = {
+            transferReason: "",
+            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            useTransferSipHeaders,
+            transferSipHeaders,
+        };
+        try {
+            if (useTransferSipHeaders &&
+                transferSipHeaders &&
+                !(0, helper_1.isValidJSON)(transferSipHeaders)) {
+                delete transferParams.transferSipHeaders;
+                transferParams.useTransferSipHeaders = false;
+                api.log("error", "Invalid JSON in Transfer SIP Headers");
+            }
+            const payload = transfer_mapper_1.transfer.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, transferParams, false);
+            api.say(null, {
+                _cognigy: payload,
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on Transfer node. Error message: ${error.message}`);
+        }
+    },
+});
+//# sourceMappingURL=transfer.js.map