@cognigy/rest-api-client 0.13.1 → 0.14.0

package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js

@@ -1,52 +1,108 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transfer = void 0;
+exports.prepareTransferParams = exports.transfer = void 0;
+/* Node modules */
+const path_1 = require("path");
+/* Custom modules */
 const constants_1 = require("../utils/constants");
+const helper_1 = require("../../../descriptors/voicegateway2/utils/helper");
+const helper_2 = require("../utils/helper");
 exports.transfer = {
     handleInput(endpointType, params, isGenericNode) {
         try {
-            if (endpointType === constants_1.ENDPOINTS.AUDIO_CODES && isGenericNode && params.transferSipHeaders) {
-                const { transferReason, transferTarget, useTransferSipHeaders, transferSipHeaders } = params;
-                let headers = [];
-                for (const [key, value] of Object.entries(transferSipHeaders)) {
-                    const entry = { "name": key, "value": value };
-                    headers.push(entry);
-                }
-                ;
-                const target = transferTarget.includes("@")
-                    ? transferTarget
-                    : `tel:${transferTarget}`;
-                return this.handleAudioCodesInput({ transferReason, transferTarget: target, useTransferSipHeaders, transferSipHeaders: headers });
-            }
-            if (endpointType === constants_1.ENDPOINTS.VOICE_GATEWAY) {
-                return this.handleVGInput(params);
-            }
-            else if (endpointType === constants_1.ENDPOINTS.AUDIO_CODES) {
-                return this.handleAudioCodesInput(params);
-            }
-            else {
-                return this.handleVGInput(params);
+            switch (endpointType) {
+                case constants_1.ENDPOINTS.AUDIO_CODES:
+                    if (isGenericNode && params.transferSipHeaders) {
+                        let headers = [];
+                        for (const [key, value] of Object.entries(params.transferSipHeaders)) {
+                            headers.push({
+                                name: key,
+                                value
+                            });
+                        }
+                        ;
+                        params.transferSipHeaders = headers;
+                    }
+                    return this.handleAudioCodesInput((0, exports.prepareTransferParams)(params));
+                case constants_1.ENDPOINTS.VOICE_GATEWAY:
+                default:
+                    return this.handleVGInput((0, exports.prepareTransferParams)(params));
             }
-            ;
         }
         catch (error) {
             throw Error(error.message);
         }
     },
     handleVGInput(transferParam) {
-        const { transferTarget, useTransferSipHeaders, transferSipHeaders } = transferParam;
+        const { transferType, transferTarget, transferReason, useTransferSipHeaders, transferSipHeaders, dialMusic, dialTranscriptionWebhook, dialCallerId } = transferParam;
         const payload = {
             _voiceGateway2: {
-                json: {
-                    "sip:refer": {
-                        "referTo": transferTarget,
-                        "actionHook": 'refer'
-                    }
-                }
+                json: {}
             }
         };
+        let headers = {
+            "X-Reason": transferReason,
+        };
         if (useTransferSipHeaders && typeof transferSipHeaders === "object") {
-            payload._voiceGateway2.json["sip:refer"]["headers"] = transferSipHeaders;
+            headers = Object.assign(Object.assign({}, headers), transferSipHeaders);
+        }
+        switch (transferType) {
+            case "dial":
+                const dialVerb = {
+                    actionHook: "dial",
+                    headers,
+                    target: [],
+                };
+                const phoneTarget = {
+                    type: "phone",
+                    number: (0, helper_1.cleanTarget)(transferTarget, false),
+                };
+                const sipTarget = {
+                    type: "sip",
+                    sipUri: (0, helper_1.cleanTarget)(transferTarget, false),
+                };
+                /* By default we set the target to phone */
+                dialVerb.target = [phoneTarget];
+                /* If targets includes an @ we set the target to sip */
+                if (transferTarget === null || transferTarget === void 0 ? void 0 : transferTarget.includes("@")) {
+                    dialVerb.target = [sipTarget];
+                }
+                if (dialTranscriptionWebhook === null || dialTranscriptionWebhook === void 0 ? void 0 : dialTranscriptionWebhook.length) {
+                    if (!(0, helper_2.isValidUrl)(dialTranscriptionWebhook)) {
+                        throw new Error(`Transcription webhook URL is invalid ${dialTranscriptionWebhook}`);
+                    }
+                    const transcribeVerb = {
+                        transcriptionHook: dialTranscriptionWebhook,
+                    };
+                    dialVerb.transcribe = transcribeVerb;
+                }
+                if (dialMusic === null || dialMusic === void 0 ? void 0 : dialMusic.length) {
+                    if (!(0, helper_2.isValidUrl)(dialMusic)) {
+                        throw new Error(`Audio file URL is invalid ${dialMusic}`);
+                    }
+                    const extension = (0, path_1.extname)(dialMusic);
+                    if (extension !== (".mp3" || ".wav")) {
+                        throw new Error(`Audio file must be from type .mp3 or .wav. Extension was: ${extension}`);
+                    }
+                    dialVerb.dialMusic = dialMusic;
+                }
+                if (dialCallerId === null || dialCallerId === void 0 ? void 0 : dialCallerId.length) {
+                    if (!(0, helper_2.isValidPhoneNumber)(dialCallerId)) {
+                        throw new Error(`Caller ID must be a valid phone number ${dialCallerId}`);
+                    }
+                    dialVerb.callerId = dialCallerId;
+                }
+                payload._voiceGateway2.json["dial"] = dialVerb;
+                break;
+            case "refer":
+            default:
+                const referVerb = {
+                    "referTo": (0, helper_1.cleanTarget)(transferTarget, false),
+                    "actionHook": 'refer',
+                    headers
+                };
+                payload._voiceGateway2.json["sip:refer"] = referVerb;
+                break;
         }
         return payload;
     },
@@ -56,7 +112,7 @@ exports.transfer = {
             "type": "event",
             "name": "transfer",
             "activityParams": {
-                "transferTarget": transferTarget,
+                "transferTarget": (0, helper_1.cleanTarget)(transferTarget, true),
                 "handoverReason": transferReason,
             }
         };
@@ -83,4 +139,9 @@ exports.transfer = {
         return payload;
     }
 };
+const prepareTransferParams = (transferParam) => {
+    const { transferReason, dialMusic, dialTranscriptionWebhook } = transferParam;
+    return Object.assign(Object.assign({}, transferParam), { transferReason: transferReason === null || transferReason === void 0 ? void 0 : transferReason.trim(), dialMusic: dialMusic === null || dialMusic === void 0 ? void 0 : dialMusic.trim(), dialTranscriptionWebhook: dialTranscriptionWebhook === null || dialTranscriptionWebhook === void 0 ? void 0 : dialTranscriptionWebhook.trim() });
+};
+exports.prepareTransferParams = prepareTransferParams;
 //# sourceMappingURL=transfer.mapper.js.map

package/build/shared/charts/descriptors/voice/nodes/bargeIn.js

@@ -42,12 +42,65 @@ exports.BARGE_IN = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 step: 1,
             },
         },
+        {
+            key: "dtmfInterDigitTimeout",
+            type: "number",
+            label: "DTMF Inter Digit Timeout",
+            description: "Defines the timeout in between collected DTMF digits",
+            defaultValue: 2000,
+            params: {
+                min: 0,
+            },
+        },
+        {
+            key: "dtmfMaxDigits",
+            type: "number",
+            label: "DTMF Max Digits",
+            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,
+            },
+        },
+        {
+            key: "dtmfSubmitDigit",
+            type: "cognigyText",
+            label: "DTMF Submit Digit",
+            description: "Defines the DTMF submit digit which will be used for submitting the previously entered digits.",
+            defaultValue: "#",
+        },
+    ],
+    sections: [
+        {
+            key: "paramsDtmf",
+            label: "DTMF",
+            defaultCollapsed: false,
+            fields: ["dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfSubmitDigit"],
+            condition: {
+                key: "bargeInOnDtmf",
+                value: true
+            }
+        }
+    ],
+    form: [
+        { type: "field", key: "bargeInOnSpeech" },
+        { type: "field", key: "bargeInOnDtmf" },
+        { type: "field", key: "bargeInMinWordCount" },
+        { type: "section", key: "paramsDtmf" }
     ],
     function: async ({ cognigy, config }) => {
         const { api, input } = cognigy;
         const { endpointType } = input;
         try {
+            if (config.bargeInOnDtmf) {
+                config.dtmfEnable = true;
+            }
+            if (config.bargeInOnSpeech || config.bargeInOnDtmf) {
+                config.bargeInEnable = true;
+            }
             const payload = setSessionConfig_mapper_1.setSessionConfig.handleInput(endpointType, (0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, api));
+            /* we need to store this for the DTMF Collect - Config node */
+            api.setSystemContext("vgSettings", { bargeInOnDtmf: config.bargeInOnDtmf });
             api.say(null, {
                 _cognigy: payload,
             });

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

@@ -64,16 +64,18 @@ exports.DTMF = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
     ],
     function: async ({ cognigy, config }) => {
+        var _a, _b;
         const { api, input } = cognigy;
         const { endpointType } = input;
-        const dtmfConfig = {
+        const voiceConfig = {
             dtmfEnable: config.dtmfEnable,
             dtmfInterDigitTimeout: config.dtmfInterDigitTimeout,
             dtmfMaxDigits: config.dtmfMaxDigits,
-            dtmfSubmitDigit: config.dtmfSubmitDigit
+            dtmfSubmitDigit: config.dtmfSubmitDigit,
+            bargeInOnDtmf: (_b = (_a = api.getSystemContext("vgSettings")) === null || _a === void 0 ? void 0 : _a.bargeInOnDtmf) !== null && _b !== void 0 ? _b : false,
         };
         try {
-            const payload = setSessionConfig_mapper_1.setSessionConfig.handleInput(endpointType, (0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(dtmfConfig, api));
+            const payload = setSessionConfig_mapper_1.setSessionConfig.handleInput(endpointType, (0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(voiceConfig, api));
             api.say(null, {
                 _cognigy: payload,
             });

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

@@ -7,9 +7,18 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const play_mapper_1 = require("../mappers/play.mapper");
 const design_1 = require("../utils/design");
 const setSessionConfig_1 = require("../../voicegateway2/nodes/setSessionConfig");
+const fields = (setSessionConfig_1.voiceConfigFields.map(field => {
+    if (field.key !== "sttDisablePunctuation" &&
+        field.key !== "sttVadEnabled" &&
+        field.key !== "sttVadMode" &&
+        field.key !== "sttVadVoiceMs") {
+        return field;
+    }
+    return null;
+})).filter(f => !!f);
 exports.PLAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "play",
-    defaultLabel: "Play",
+    defaultLabel: "Play URL",
     tags: ['voice'],
     preview: {
         key: "url",
@@ -35,14 +44,14 @@ exports.PLAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
             type: "toggle",
             defaultValue: false
         },
-        ...setSessionConfig_1.voiceConfigFields
+        ...fields
     ],
     sections: [
         {
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttLanguage", "sttVendor", "sttHints"],
+            fields: ["sttVendor", "sttHints", "enableAdvancedSTTConfig", "azureSttContextId", "azureEnableAudioLogging"],
             condition: {
                 key: "setActivityParams",
                 value: true
@@ -67,14 +76,14 @@ exports.PLAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 key: "setActivityParams",
                 value: true
             }
-        }
+        },
     ],
     form: [
         { type: "field", key: "url" },
         { type: "field", key: "setActivityParams" },
         { type: "section", key: "params_stt" },
         { type: "section", key: "params_bargein" },
-        { type: "section", key: "params_dtmf" }
+        { type: "section", key: "params_dtmf" },
     ],
     summary: "Streams a media file into the call",
     function: async ({ cognigy, config }) => {

package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js

@@ -37,6 +37,81 @@ exports.voiceConfigFields = [
         description: "Prevents the STT response from the bot to include punctuation marks",
         defaultValue: false
     },
+    {
+        key: "enableAdvancedSTTConfig",
+        type: "toggle",
+        label: "Enable Advanced STT Config",
+        description: "Advanced STT Configuration",
+        defaultValue: false
+    },
+    {
+        key: "azureSttContextId",
+        type: "cognigyText",
+        label: "Azure STT Context ID",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "azureEnableAudioLogging",
+        type: "toggle",
+        label: "Enable Audio Logging",
+        description: "Enables recording and logging of audio from the user on Azure.",
+        defaultValue: false,
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "enableAdvancedTTSConfig",
+        type: "toggle",
+        label: "Enable Advanced TTS Config",
+        description: "Enable Advanced TTS Configuration",
+        defaultValue: false,
+        condition: {
+            key: "ttsVendor",
+            value: "microsoft"
+        }
+    },
+    {
+        key: "azureTtsDeploymentId",
+        type: "cognigyText",
+        label: "Azure Custom Voice Endpoint",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedTTSConfig",
+                    value: true
+                },
+                {
+                    key: "ttsVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
     {
         key: "ttsVendor",
         defaultValue: "",
@@ -66,27 +141,34 @@ exports.SESSION_SPEECH_PARAMETERS = (0, createNodeDescriptor_1.createNodeDescrip
     defaultLabel: "Session Speech Parameters - Config",
     summary: "Change configuration settings for the call session",
     appearance: {
-        color: design_1.nodeColor
+        color: design_1.nodeColor,
     },
-    tags: ['voice'],
+    tags: ["voice"],
     fields: exports.voiceConfigFields,
     sections: [
         {
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttVendor", "sttHints", "sttDisablePunctuation"]
+            fields: [
+                "sttVendor",
+                "sttHints",
+                "sttDisablePunctuation",
+                "enableAdvancedSTTConfig",
+                "azureSttContextId",
+                "azureEnableAudioLogging",
+            ],
         },
         {
             key: "params_tts",
             label: "Synthesizer (TTS)",
             defaultCollapsed: true,
-            fields: ["ttsVendor"]
-        }
+            fields: ["ttsVendor", "enableAdvancedTTSConfig", "azureTtsDeploymentId"],
+        },
     ],
     form: [
         { type: "section", key: "params_tts" },
-        { type: "section", key: "params_stt" }
+        { type: "section", key: "params_stt" },
     ],
     function: async ({ cognigy, config }) => {
         const { api, input } = cognigy;
@@ -94,12 +176,12 @@ exports.SESSION_SPEECH_PARAMETERS = (0, createNodeDescriptor_1.createNodeDescrip
         try {
             const payload = setSessionConfig_mapper_1.setSessionConfig.handleInput(endpointType, (0, setSessionConfig_mapper_1.voiceConfigParamsToVoiceSettings)(config, api));
             api.say(null, {
-                _cognigy: payload
+                _cognigy: payload,
             });
         }
         catch (error) {
             throw new Error(`Error on Session Speech Parameters node. Error message: ${error.message}`);
         }
-    }
+    },
 });
 //# sourceMappingURL=sessionSpeechParameters.js.map

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

@@ -88,9 +88,13 @@ exports.TRANSFER_VOICE = (0, createNodeDescriptor_1.createNodeDescriptor)({
         const { referTo, useTransferSipHeaders, transferSipHeaders, transferReason, } = config;
         const { endpointType } = input;
         try {
+            if (input.channel === "adminconsole") {
+                api.say("Transferring a call is not supported in the Interaction Panel.", null);
+                return;
+            }
             const transferParams = {
-                transferReason: transferReason,
-                transferTarget: (0, helper_1.cleanTarget)(referTo),
+                transferReason,
+                transferTarget: referTo,
                 useTransferSipHeaders: useTransferSipHeaders,
                 transferSipHeaders: transferSipHeaders,
             };

package/build/shared/charts/descriptors/voice/utils/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidDTMF = void 0;
+exports.isValidPhoneNumber = exports.isValidUrl = exports.isValidDTMF = void 0;
 function isValidDTMF(dtmf) {
     if (dtmf.length !== 1)
         return false;
@@ -8,4 +8,14 @@ function isValidDTMF(dtmf) {
     return regex.test(dtmf);
 }
 exports.isValidDTMF = isValidDTMF;
+const isValidUrl = (url) => {
+    const regex = new RegExp("^(http|https)://");
+    return regex.test(url);
+};
+exports.isValidUrl = isValidUrl;
+const isValidPhoneNumber = (number) => {
+    const regex = /^\+{0,2}([\-\. ])?(\(?\d{0,3}\))?([\-\. ])?\(?\d{0,3}\)?([\-\. ])?\d{3}([\-\. ])?\d{4}/;
+    return regex.test(number);
+};
+exports.isValidPhoneNumber = isValidPhoneNumber;
 //# sourceMappingURL=helper.js.map

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

@@ -40,14 +40,14 @@ exports.agentAssistNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     { value: "callee", label: "Callee (Agent) only" },
                 ]
             }
-        }
+        },
     ],
     appearance: {
         color: design_1.nodeColor
     },
     form: [
         { type: "field", key: "activity" },
-        { type: "field", key: "targetParticipant" }
+        { type: "field", key: "targetParticipant" },
     ],
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;

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

@@ -117,7 +117,7 @@ exports.handoverNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
         }
     ],
     function: async ({ cognigy, config }) => {
-        const { api } = cognigy;
+        const { api, input } = cognigy;
         const { handoverReason, transferTarget, transferReferredByURL, useTransferSipHeaders, transferSipHeaders, transferNotifications, transferNotificationsHangupMS } = config;
         const transferParams = {
             transferReason: handoverReason,
@@ -129,6 +129,10 @@ exports.handoverNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
             transferReferredByURL
         };
         try {
+            if (input.channel === "adminconsole") {
+                api.say("Transferring a call is not supported in the Interaction Panel, please use the AudioCodes endpoint.", null);
+                return;
+            }
             const payload = transfer_mapper_1.transfer.handleInput("audioCodes", transferParams, false);
             api.say(null, {
                 _cognigy: payload

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

@@ -61,7 +61,17 @@ exports.playNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttLanguage", "sttVendor", "sttHints", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"],
+            fields: [
+                "sttVendor",
+                "sttHints",
+                "sttDisablePunctuation",
+                "sttVadEnabled",
+                "sttVadMode",
+                "sttVadVoiceMs",
+                "enableAdvancedSTTConfig",
+                "azureSttContextId",
+                "azureEnableAudioLogging"
+            ],
             condition: {
                 key: "setActivityParams",
                 value: true
@@ -81,12 +91,18 @@ exports.playNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "params_dtmf",
             label: "DTMF",
             defaultCollapsed: true,
-            fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfMinDigits", "dtmfSubmitDigit"],
+            fields: [
+                "dtmfEnable",
+                "dtmfInterDigitTimeout",
+                "dtmfMaxDigits",
+                "dtmfMinDigits",
+                "dtmfSubmitDigit"
+            ],
             condition: {
                 key: "setActivityParams",
                 value: true
             }
-        },
+        }
     ],
     form: [
         { type: "field", key: "url" },
@@ -94,7 +110,7 @@ exports.playNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "field", key: "setActivityParams" },
         { type: "section", key: "params_stt" },
         { type: "section", key: "params_bargein" },
-        { type: "section", key: "params_dtmf" },
+        { type: "section", key: "params_dtmf" }
     ],
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
@@ -107,7 +123,6 @@ exports.playNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
         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

@@ -7,7 +7,6 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 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",
@@ -81,9 +80,10 @@ exports.referNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
         const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
         const transferParams = {
             transferReason: '',
-            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            transferTarget: referTo,
             useTransferSipHeaders,
-            transferSipHeaders
+            transferSipHeaders,
+            transferType: "refer",
         };
         try {
             const payload = transfer_mapper_1.transfer.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, transferParams, false);