@cognigy/rest-api-client 0.11.0 → 0.12.0

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

@@ -0,0 +1,21 @@
+"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 setSessionConfig_1 = require("./nodes/setSessionConfig");
+exports.cognigyVoiceGateway2Module = createNodeDescriptor_1.createExtension({
+    nodes: [
+        setSessionConfig_1.setSessionConfigNode,
+        dtmf_1.dtmfNode,
+        hangup_1.hangupNode,
+        play_1.playNode,
+        refer_1.referNode
+    ],
+    connections: []
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,56 @@
+"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 = createNodeDescriptor_1.createNodeDescriptor({
+    type: "dtmf",
+    defaultLabel: "DTMF",
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: [
+        {
+            key: "dtmf",
+            label: "Digit sequence",
+            description: "Digit sequence to play to the caller",
+            type: "text",
+            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
+            }
+        }
+    ],
+    summary: "Plays DTMF digits to the caller",
+    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,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hangupNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+exports.hangupNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "hangup",
+    defaultLabel: "Hang Up",
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: [
+        {
+            key: "hangupReason",
+            label: "Reason for hang up",
+            type: "text",
+            defaultValue: "Bot ended the call",
+            params: {
+                required: true
+            }
+        }
+    ],
+    summary: "Hangs up the call",
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { hangupReason } = config;
+        const voiceGateway2Payload = {
+            hangup: {}
+        };
+        if (hangupReason) {
+            voiceGateway2Payload.hangup = {
+                headers: {
+                    "X-Reason": hangupReason
+                }
+            };
+        }
+        api.say(null, {
+            _cognigy: {
+                _voiceGateway2: {
+                    json: voiceGateway2Payload
+                }
+            }
+        });
+    }
+});
+//# sourceMappingURL=hangup.js.map

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

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const strip_nulls_1 = require("../utils/strip-nulls");
+const setSessionConfig_1 = require("./setSessionConfig");
+exports.playNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "play",
+    defaultLabel: "Play",
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: [
+        {
+            key: "url",
+            label: "Media URL",
+            type: "text",
+            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_tts",
+            label: "Synthesizer (TTS)",
+            defaultCollapsed: true,
+            fields: ["ttsVoice", "ttsLanguage", "ttsVendor"],
+            condition: {
+                key: "setActivityParams",
+                value: true
+            }
+        },
+        {
+            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_user_timeouts",
+            label: "User Input Timeout",
+            defaultCollapsed: true,
+            fields: ["userNoInputMode", "userNoInputSpeech", "userNoInputUrl", "userNoInputTimeout", "userNoInputRetries"],
+            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_tts" },
+        { type: "section", key: "params_stt" },
+        { type: "section", key: "params_bargein" },
+        { type: "section", key: "params_user_timeouts" },
+        { type: "section", key: "params_dtmf" },
+    ],
+    summary: "Streams a media file into the call with the ability to loop it",
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { url, loop, setActivityParams } = config;
+        const voiceGateway2Payload = {
+            play: {
+                url,
+                loop,
+            }
+        };
+        if (setActivityParams) {
+            const activityConfig = {};
+            const synthesizer = {
+                language: config.ttsLanguage,
+                voice: config.ttsVoice,
+                vendor: config.ttsVendor
+            };
+            activityConfig.synthesizer = synthesizer;
+            const recognizer = {
+                language: config.sttLanguage,
+                vendor: config.sttVendor || "default",
+                hints: config.sttHints,
+                vad: {
+                    enable: config.sttVadEnabled,
+                    mode: config.sttVadMode,
+                    voiceMs: config.sttVadVoiceMs
+                }
+            };
+            activityConfig.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;
+            }
+            activityConfig.bargeIn = bargein;
+            const user = {
+                noInputMode: config.userNoInputMode,
+                noInputTimeout: (config.userNoInputTimeout || 10000) / 1000,
+                noInputRetries: config.userNoInputRetries,
+                noInputSpeech: config.userNoInputSpeech,
+                noInputUrl: config.userNoInputUrl
+            };
+            activityConfig.user = user;
+            if (config.dtmfEnable) {
+                if (!activityConfig.bargeIn) {
+                    activityConfig.bargeIn = {
+                        enable: false
+                    };
+                }
+                activityConfig.bargeIn.interDigitTimeout = (config.dtmfInterDigitTimeout || 500) / 1000;
+                activityConfig.bargeIn.maxDigits = config.dtmfMaxDigits;
+                activityConfig.bargeIn.minDigits = config.dtmfMinDigits;
+                activityConfig.bargeIn.finishOnKey = config.dtmfSubmitDigit;
+                if (!voiceGateway2Payload.play.activityConfig) {
+                    voiceGateway2Payload.play.activityConfig = {};
+                }
+                voiceGateway2Payload.play.activityConfig.dtmf = true;
+            }
+            if (Object.keys(activityConfig).length > 0) {
+                voiceGateway2Payload.play.activityConfig = activityConfig;
+            }
+        }
+        strip_nulls_1.stripNulls(voiceGateway2Payload);
+        api.say(null, {
+            _cognigy: {
+                _voiceGateway2: {
+                    json: voiceGateway2Payload
+                }
+            }
+        });
+    }
+});
+//# sourceMappingURL=play.js.map

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.referNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+exports.referNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "refer",
+    defaultLabel: "Refer",
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: [
+        {
+            key: "referTo",
+            label: "Target",
+            type: "text",
+            params: {
+                required: true
+            },
+            description: "E.164 syntax or a SIP URI are supported",
+            defaultValue: "+49176123456789"
+        }
+    ],
+    summary: "Transfer the call to another target",
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { referTo } = config;
+        const voiceGateway2Payload = {
+            "sip:refer": {
+                referTo
+            }
+        };
+        api.say(null, {
+            _cognigy: {
+                _voiceGateway2: {
+                    json: voiceGateway2Payload
+                }
+            }
+        });
+    }
+});
+//# sourceMappingURL=refer.js.map