@cognigy/rest-api-client 0.11.0 → 0.13.0

package/build/shared/charts/descriptors/voicegateway/nodes/playURL.js

@@ -4,9 +4,10 @@ exports.playURLNode = void 0;
 /** Custom Modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
+const play_mapper_1 = require("../../voice/mappers/play.mapper");
 const design_1 = require("../utils/design");
 const paramUtils_1 = require("../utils/paramUtils");
-exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.playURLNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "playURL",
     defaultLabel: "Play URL",
     summary: "Plays an audio prompt from a file url",
@@ -25,6 +26,7 @@ exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
             label: "Media Format",
             type: "select",
             defaultValue: "wav/lpcm16",
+            description: "Either Mu-Law (8 bit, 8 kHz) or Linear PCM (16 bit, 16 kHz) encoded with or without a WAV header",
             params: {
                 options: [
                     {
@@ -34,6 +36,14 @@ exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
                     {
                         label: "raw/lpcm16",
                         value: "raw/lpcm16"
+                    },
+                    {
+                        label: "wav/mulaw",
+                        value: "wav/mulaw"
+                    },
+                    {
+                        label: "raw/mulaw",
+                        value: "raw/mulaw"
                     }
                 ]
             }
@@ -63,7 +73,7 @@ exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
             type: "json",
             defaultValue: "{}"
         }
-    ].concat(paramUtils_1.getParameterFields()),
+    ].concat((0, paramUtils_1.getParameterFields)()),
     sections: [
         {
             key: "advanced",
@@ -77,7 +87,7 @@ exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
                 value: true
             }
         }
-    ].concat(paramUtils_1.getParamSections({ key: "setActivityParams", value: true })),
+    ].concat((0, paramUtils_1.getParamSections)({ key: "setActivityParams", value: true })),
     form: [
         { type: "field", key: "playUrlUrl" },
         { type: "field", key: "playUrlMediaFormat" },
@@ -103,34 +113,18 @@ exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
     },
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
-        const { playUrlUrl, playUrlMediaFormat, playUrlAltText, setActivityParams, activityParams, playUrlCaching } = config;
+        const { playUrlUrl, playUrlMediaFormat } = config;
         if (playUrlUrl && playUrlMediaFormat) {
-            let compiledParams = Object.assign(activityParams || {}, {
-                playUrlUrl,
-                playUrlMediaFormat
-            });
-            if (playUrlAltText)
-                compiledParams["playUrlAltText"] = playUrlAltText;
-            if (playUrlCaching !== null)
-                compiledParams["playUrlCaching"] = !!playUrlCaching;
-            if (setActivityParams) {
-                paramUtils_1.compileParams(config, compiledParams);
+            try {
+                const payload = play_mapper_1.play.handleInput('audioCodes', config);
+                api.say(null, {
+                    _cognigy: payload
+                });
             }
-            api.output(null, {
-                "_cognigy": {
-                    "_voiceGateway": {
-                        "json": {
-                            "activities": [
-                                {
-                                    "type": "event",
-                                    "name": "playUrl",
-                                    "activityParams": compiledParams
-                                }
-                            ]
-                        }
-                    }
-                }
-            });
+            catch (error) {
+                throw new Error(`Error on play node. Error message: ${error.message}`);
+            }
+            ;
         }
     }
 });

package/build/shared/charts/descriptors/voicegateway/nodes/sendMessage.js

@@ -6,7 +6,7 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
 const paramUtils_1 = require("../utils/paramUtils");
-exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.sendMessageNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "sendMessage",
     defaultLabel: "Send Message",
     summary: "Sends a prompt via VG",
@@ -208,7 +208,7 @@ exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
             type: "json",
             defaultValue: "{}"
         }
-    ].concat(paramUtils_1.getParameterFields()),
+    ].concat((0, paramUtils_1.getParameterFields)()),
     sections: [
         {
             key: "advanced",
@@ -222,7 +222,7 @@ exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
                 value: true
             }
         }
-    ].concat(paramUtils_1.getParamSections({ key: "setActivityParams", value: true })),
+    ].concat((0, paramUtils_1.getParamSections)({ key: "setActivityParams", value: true })),
     form: [
         { type: "field", key: "text" },
         { type: "field", key: "setActivityParams" },
@@ -249,10 +249,10 @@ exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
         const { text, activityParams, setActivityParams } = config;
         let compiledParams = activityParams || {};
         if (setActivityParams) {
-            paramUtils_1.compileParams(config, compiledParams);
+            (0, paramUtils_1.compileParams)(config, compiledParams);
         }
         if (text) {
-            api.output(text, {
+            api.output(null, {
                 "_cognigy": {
                     "_voiceGateway": {
                         "json": {

package/build/shared/charts/descriptors/voicegateway/nodes/sendMetaData.js

@@ -5,7 +5,7 @@ exports.sendMetaDataNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-exports.sendMetaDataNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.sendMetaDataNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "sendMetaData",
     defaultLabel: "Send Meta Data",
     summary: "Sends meta data via SIP INFO messages",

package/build/shared/charts/descriptors/voicegateway/nodes/setSessionParams.js

@@ -6,7 +6,7 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
 const paramUtils_1 = require("../utils/paramUtils");
-exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.setSessionParamsNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "setSessionParams",
     defaultLabel: "Set Session Parameters",
     summary: "Sets VG configuration settings for the session",
@@ -21,7 +21,7 @@ exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
                 required: true
             }
         }
-    ].concat(paramUtils_1.getParameterFields()),
+    ].concat((0, paramUtils_1.getParameterFields)()),
     sections: [
         {
             key: "advanced",
@@ -31,7 +31,7 @@ exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
                 "sessionParams",
             ]
         }
-    ].concat(paramUtils_1.getParamSections()),
+    ].concat((0, paramUtils_1.getParamSections)()),
     appearance: {
         color: design_1.nodeColor
     },
@@ -51,7 +51,7 @@ exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
         const { api } = cognigy;
         const { sessionParams } = config;
         let compiledParams = sessionParams || {};
-        paramUtils_1.compileParams(config, compiledParams);
+        (0, paramUtils_1.compileParams)(config, compiledParams);
         // output the activity to the voice gateway
         api.output(null, {
             "_cognigy": {

package/build/shared/charts/descriptors/voicegateway/utils/paramUtils.js

@@ -9,6 +9,7 @@ exports.getParamSections = exports.getParameterFields = exports.compileParams =
 const compileParams = (config, compiledParams) => {
     const EXCLUDEDKEYS = ["activityParams", "text", "setActivityParams", "sttContextBoostAzure", "sttContextBoost", "azureUseContextPhrases"];
     Object.keys(config).forEach((key) => {
+        var _a;
         if (EXCLUDEDKEYS.indexOf(key) === -1) {
             if (!key.startsWith("dtmfCollect") || (key.startsWith("dtmfCollect") && config["dtmfCollect"])) {
                 switch (typeof config[key]) {
@@ -38,7 +39,7 @@ const compileParams = (config, compiledParams) => {
                         break;
                     case "number":
                     case "string":
-                        if (config[key])
+                        if (config[key] || ((_a = config[key]) === null || _a === void 0 ? void 0 : _a.toString()) === '0')
                             compiledParams[key] = config[key];
                         break;
                     case "boolean":
@@ -84,6 +85,13 @@ const getParameterFields = () => [
         description: "Azure's Custom Speech model ID",
         defaultValue: ""
     },
+    {
+        key: "ttsDeploymentId",
+        type: "cognigyText",
+        label: "Azure TTS Deployment ID",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: ""
+    },
     {
         key: "azureEnableAudioLogging",
         type: "toggle",
@@ -120,10 +128,10 @@ const getParameterFields = () => [
         key: "bargeInMinWordCount",
         type: "slider",
         label: "Barge In Minimum Words",
-        description: "Defines the minimum number of words that the user must say for the Voice Gateway to consider it a barge-in",
-        defaultValue: 0,
+        description: "Defines the minimum number of words that the user must say for the Voice Gateway to consider it a barge in",
+        defaultValue: 1,
         params: {
-            min: 0,
+            min: 1,
             max: 5,
             step: 1,
         },
@@ -181,7 +189,7 @@ const getParameterFields = () => [
         key: "userNoInputRetries",
         type: "number",
         label: "No User Input Retries",
-        description: "Defines the maximum number of allowed timeouts for no user input",
+        description: "Defines the maximum number of allowed timeouts for no user input.",
         defaultValue: 0,
     },
     {
@@ -191,6 +199,17 @@ const getParameterFields = () => [
         description: "Send an data input to the Flow if there is no user input",
         defaultValue: false,
     },
+    {
+        key: "userNoInputAutoHangup",
+        type: "toggle",
+        label: "Hangup after all retries",
+        description: "Automatically hangup if there is still no user input after all retries",
+        defaultValue: false,
+        condition: {
+            key: "userNoInputSendEvent",
+            value: true
+        }
+    },
     {
         key: "userNoInputSpeech",
         type: "cognigyText",
@@ -232,10 +251,14 @@ const getParameterFields = () => [
         type: "number",
         label: "Continuous ASR Timeout",
         description: "Defines the automatic speech recognition (ASR) timeout (in milliseconds)",
-        defaultValue: 0,
+        defaultValue: 3000,
         condition: {
             key: "continuousASR",
             value: true
+        },
+        params: {
+            min: 500,
+            max: 60000
         }
     },
     {
@@ -310,6 +333,9 @@ const getParameterFields = () => [
         condition: {
             key: "dtmfCollect",
             value: true
+        },
+        params: {
+            min: 1
         }
     },
     {
@@ -391,6 +417,7 @@ const getParamSections = (condition) => [
             "azureUseContextPhrases",
             "sttContextPhrasesAzure",
             "sttContextBoostAzure",
+            "ttsDeploymentId",
             "azureEnableAudioLogging",
         ],
         condition
@@ -427,6 +454,7 @@ const getParamSections = (condition) => [
             "userNoInputTimeoutMS",
             "userNoInputRetries",
             "userNoInputSendEvent",
+            "userNoInputAutoHangup",
             "userNoInputSpeech",
             "userNoInputUrl",
         ],

package/build/shared/charts/descriptors/voicegateway2/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cognigyVoiceGateway2Module = void 0;
+/** Cognigy Modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const dtmf_1 = require("./nodes/dtmf");
+const hangup_1 = require("./nodes/hangup");
+const play_1 = require("./nodes/play");
+const refer_1 = require("./nodes/refer");
+const transfer_1 = require("./nodes/transfer");
+const setSessionConfig_1 = require("./nodes/setSessionConfig");
+const sendMetadata_1 = require("./nodes/sendMetadata");
+exports.cognigyVoiceGateway2Module = (0, createNodeDescriptor_1.createExtension)({
+    nodes: [
+        setSessionConfig_1.setSessionConfigNode,
+        dtmf_1.dtmfNode,
+        hangup_1.hangupNode,
+        play_1.playNode,
+        refer_1.referNode,
+        transfer_1.transferNode,
+        sendMetadata_1.sendMetadataNode
+    ],
+    connections: []
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dtmfNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+exports.dtmfNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "dtmf",
+    defaultLabel: "DTMF",
+    summary: "Plays DTMF digits to the caller",
+    preview: {
+        key: "dtmf",
+        type: "text"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: [
+        {
+            key: "dtmf",
+            label: "Digit Sequence",
+            description: "Digit sequence to play to the caller",
+            type: "cognigyText",
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "duration",
+            label: "Pause Time",
+            description: "Pause time in ms between digits",
+            type: "slider",
+            defaultValue: 500,
+            params: {
+                min: 500,
+                max: 1000,
+                step: 50
+            }
+        }
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { dtmf, duration } = config;
+        const voiceGateway2Payload = {
+            dtmf: {
+                dtmf,
+                duration
+            }
+        };
+        api.say(null, {
+            _cognigy: {
+                _voiceGateway2: {
+                    json: voiceGateway2Payload
+                }
+            }
+        });
+    }
+});
+//# sourceMappingURL=dtmf.js.map

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hangupNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const constants_1 = require("../utils/constants");
+const design_1 = require("../utils/design");
+const hangup_mapper_1 = require("../../voice/mappers/hangup.mapper");
+exports.hangupNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "hangup",
+    defaultLabel: "Hang Up",
+    preview: {
+        key: "hangupReason",
+        type: "text"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    summary: "Hangs up the call",
+    fields: [
+        {
+            key: "hangupReason",
+            label: "Reason for hang up",
+            type: "cognigyText",
+            defaultValue: "Bot ended the call",
+            params: {
+                required: true
+            }
+        }
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { hangupReason } = config;
+        try {
+            const payload = hangup_mapper_1.hangUp.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, hangupReason);
+            api.say(null, {
+                _cognigy: payload
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on hangup node. Error message: ${error.message}`);
+        }
+    }
+});
+//# sourceMappingURL=hangup.js.map

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

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const play_mapper_1 = require("../../voice/mappers/play.mapper");
+const constants_1 = require("../utils/constants");
+const design_1 = require("../utils/design");
+const setSessionConfig_1 = require("./setSessionConfig");
+exports.playNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "play",
+    defaultLabel: "Play",
+    summary: "Streams a media file into the call with the ability to loop it",
+    preview: {
+        key: "url",
+        type: "text"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: [
+        {
+            key: "url",
+            label: "Media URL",
+            type: "cognigyText",
+            description: "You can use MP3 or WAV encoded files",
+            params: {
+                required: true
+            },
+            defaultValue: "https://www2.cs.uic.edu/~i101/SoundFiles/PinkPanther30.wav"
+        },
+        {
+            key: "loop",
+            label: "Loop count",
+            description: "Number of times the media will be looped",
+            type: "number",
+            defaultValue: 1,
+            params: {
+                min: 1,
+                max: 10,
+                step: 1
+            }
+        },
+        {
+            key: "setActivityParams",
+            label: "Set Activity Parameters",
+            type: "toggle",
+            defaultValue: false
+        },
+        {
+            key: "activityParams",
+            label: "Other Activity Params",
+            type: "json",
+            defaultValue: "{}"
+        },
+        ...setSessionConfig_1.voiceConfigFields
+    ],
+    sections: [
+        {
+            key: "params_stt",
+            label: "Recognizer (STT)",
+            defaultCollapsed: true,
+            fields: ["sttLanguage", "sttVendor", "sttHints", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"],
+            condition: {
+                key: "setActivityParams",
+                value: true
+            }
+        },
+        {
+            key: "params_bargein",
+            label: "Barge In",
+            defaultCollapsed: true,
+            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"],
+            condition: {
+                key: "setActivityParams",
+                value: true
+            }
+        },
+        {
+            key: "params_dtmf",
+            label: "DTMF",
+            defaultCollapsed: true,
+            fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfMinDigits", "dtmfSubmitDigit"],
+            condition: {
+                key: "setActivityParams",
+                value: true
+            }
+        },
+    ],
+    form: [
+        { type: "field", key: "url" },
+        { type: "field", key: "loop" },
+        { type: "field", key: "setActivityParams" },
+        { type: "section", key: "params_stt" },
+        { type: "section", key: "params_bargein" },
+        { type: "section", key: "params_dtmf" },
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        try {
+            const payload = play_mapper_1.play.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, config);
+            api.say(null, {
+                _cognigy: payload
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on play node. Error message: ${error.message}`);
+        }
+        ;
+    }
+});
+//# sourceMappingURL=play.js.map

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

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.referNode = 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.referNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "refer",
+    defaultLabel: "Refer",
+    summary: "Transfer the call to another target",
+    preview: {
+        key: "referTo",
+        type: "text"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    constraints: {
+        placement: {},
+        creatable: false,
+    },
+    fields: [
+        {
+            key: "referTo",
+            label: "Target",
+            type: "text",
+            params: {
+                required: true
+            },
+            description: "E.164 syntax or a SIP URI are supported",
+            defaultValue: "+49176123456789"
+        },
+        {
+            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"
+        }
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api, input } = cognigy;
+        const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
+        const transferParams = {
+            transferReason: '',
+            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            useTransferSipHeaders,
+            transferSipHeaders
+        };
+        try {
+            const payload = transfer_mapper_1.transfer.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, transferParams, false);
+            if (input.channel === "adminconsole") {
+                api.output('You are using the deprecated Refer Node. Please replace it with new Transfer Node in the Node Selection Menu.', null);
+            }
+            api.log('error', 'You are using the deprecated Refer Node. Please replace it with new Transfer Node in the Node Selection Menu.');
+            api.say(null, {
+                _cognigy: payload
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on Refer node. Error message: ${error.message}`);
+        }
+    }
+});
+//# sourceMappingURL=refer.js.map