@onereach/step-voice 7.0.9 → 7.0.11-VOIC1604.0

package/dst/Initiate Call.d.ts

@@ -1,4 +1,15 @@
 import VoiceStep, { CallStartEvent, TODO } from './voice';
+declare const enum GATEWAY_SETTINGS_MODE {
+    DEFAULT = "default",
+    CUSTOM = "custom",
+    INHERIT = "inherit",
+    PROFILE = "profile"
+}
+declare const enum SIP_PROFILE {
+    DEFAULT = "default",
+    INTERNAL = "internal",
+    EXTERNAL = "external"
+}
 interface INPUT {
     callId?: string;
     sessionTimeout?: number | string;
@@ -8,9 +19,11 @@ interface INPUT {
     tts: TODO;
     from: string;
     endUserNumber: string;
+    gatewaySettingsMode?: GATEWAY_SETTINGS_MODE;
     sipHost?: string;
     sipUser?: string;
     sipPassword?: string;
+    sipProfile?: SIP_PROFILE;
     timeout?: number | string;
     headers?: Array<{
         name: string;
@@ -19,6 +32,11 @@ interface INPUT {
     enableSpoofCallerId?: boolean;
     spoofCallerId?: string;
     isAMD?: boolean;
+    enableWhisperTransfer?: boolean;
+    whisperAnnounceAudio?: TODO[];
+    textType?: string;
+    whisperCustomerConversation?: string;
+    whisperCustomerConversationThread?: string;
 }
 export default class InitiateCall extends VoiceStep<INPUT, TODO, CallStartEvent> {
     get conversation(): string | import("@onereach/flow-sdk/types").IMergeField;

package/dst/Initiate Call.js

@@ -47,7 +47,7 @@ class InitiateCall extends voice_1.default {
         this.exitStep('cancel');
     }
     async waitForCall() {
-        const { asr, tts, from: botNumber, endUserNumber, sipHost, sipUser, sipPassword, timeout, headers, enableSpoofCallerId, spoofCallerId, isAMD, otherCallRef, otherCallRefThread, handleCancel } = this.data;
+        const { asr, tts, from: botNumber, endUserNumber, gatewaySettingsMode, sipHost, sipUser, sipPassword, sipProfile, timeout, headers, enableSpoofCallerId, spoofCallerId, isAMD, otherCallRef, otherCallRefThread, handleCancel, enableWhisperTransfer, whisperAnnounceAudio, textType, whisperCustomerConversation, } = this.data;
         const call = await this.fetchData();
         this.triggers.once(`in/voice/${call.id}/event`, async (event) => {
             switch (event.params.type) {
@@ -84,7 +84,7 @@ class InitiateCall extends voice_1.default {
                         reportingSettingsKey: 'transcript',
                         actionFromBot: true
                     });
-                    await this.sendCommands(newCall, [
+                    const commands = [
                         ...isAMD
                             ? [{
                                     name: 'start-avmd',
@@ -100,8 +100,39 @@ class InitiateCall extends voice_1.default {
                                         type: asr.serverSettings.engine
                                     }
                                 }]
-                            : []
-                    ]);
+                            : [],
+                    ];
+                    if (enableWhisperTransfer === true) {
+                        const ttsSettings = tts.getSettings(call.tts);
+                        const announceSpeechSections = whisperAnnounceAudio?.map(section => ({
+                            text: section.voiceTextMsg,
+                            url: section.audioUrl,
+                            bargeInVoice: false,
+                            bargeInKeypad: false,
+                            textType,
+                            provider: ttsSettings.provider,
+                            ...ttsSettings
+                        }));
+                        const announceMessageCommand = {
+                            name: 'speak',
+                            params: {
+                                sections: announceSpeechSections,
+                                reporterTranscriptEventId: '',
+                            }
+                        };
+                        const customerCall = await this.getConversationByName(whisperCustomerConversation ?? '');
+                        const transferCommand = {
+                            name: 'defer_replaces',
+                            params: {
+                                callerId: customerCall['id']
+                            }
+                        };
+                        commands.push(...[
+                            announceMessageCommand,
+                            transferCommand,
+                        ]);
+                    }
+                    await this.sendCommands(newCall, commands);
                     return this.exitStep('success');
                 }
                 case 'hangup': {
@@ -160,6 +191,25 @@ class InitiateCall extends voice_1.default {
                 memo[header.name] = `${header.value}`;
                 return memo;
             }, {});
+            // GET SIP PROFILE SETTINGS
+            let gateway;
+            const profile = sipProfile !== "default" /* SIP_PROFILE.DEFAULT */ ? sipProfile : undefined;
+            switch (gatewaySettingsMode) {
+                case "custom" /* GATEWAY_SETTINGS_MODE.CUSTOM */:
+                    gateway = {
+                        host: sipHost,
+                        user: sipUser,
+                        username: sipUser,
+                        password: sipPassword,
+                        profile
+                    };
+                    break;
+                case "profile" /* GATEWAY_SETTINGS_MODE.PROFILE */:
+                    gateway = {
+                        profile
+                    };
+                    break;
+            }
             const params = {
                 id: call.id,
                 from: botNumber,
@@ -169,16 +219,10 @@ class InitiateCall extends voice_1.default {
                     enableSpoofCallerId,
                     spoofCallerId
                 },
-                gateway: sipHost
-                    ? {
-                        host: sipHost,
-                        username: sipUser,
-                        password: sipPassword
-                    }
-                    : undefined,
                 timeout: originateTimeout,
                 version: 2,
-                sessionExpireTime: this.session.expireTime
+                sessionExpireTime: this.session.expireTime,
+                gateway,
             };
             if (otherCallRef) {
                 // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing

package/dst/Say Message.js

@@ -46,7 +46,8 @@ class SayMessage extends voice_1.default {
                 name: 'speak',
                 params: {
                     sections: speechSections,
-                    reporterTranscriptEventId: ''
+                    reporterTranscriptEventId: '',
+                    useWhisperFeature: true
                 }
             };
             const eventId = await this.transcript(call, {

package/dst/Transfer.d.ts

@@ -1,4 +1,15 @@
 import VoiceStep, { VoiceEvent } from './voice';
+declare const enum GATEWAY_SETTINGS_MODE {
+    DEFAULT = "default",
+    CUSTOM = "custom",
+    INHERIT = "inherit",
+    PROFILE = "profile"
+}
+declare const enum SIP_PROFILE {
+    DEFAULT = "default",
+    INTERNAL = "internal",
+    EXTERNAL = "external"
+}
 interface INPUT {
     destination: string;
     phoneNumber: string;
@@ -8,11 +19,12 @@ interface INPUT {
         value: string;
     }>;
     refer: boolean;
-    gatewaySettigsMode?: string;
     from?: string;
+    gatewaySettingsMode?: GATEWAY_SETTINGS_MODE;
     sipHost?: string;
     sipUser?: string;
     sipPassword?: string;
+    sipProfile?: SIP_PROFILE;
     muteRecording?: boolean;
 }
 interface EVENT extends VoiceEvent {

package/dst/Transfer.js

@@ -52,13 +52,32 @@ class Transfer extends voice_1.default {
             return this.exitFlow();
         });
         this.triggers.otherwise(async () => {
-            const { phoneNumber, sessionTimeout, destination, sipHeaders = [], sipHost, sipUser, sipPassword, refer, gatewaySettigsMode, from, muteRecording } = this.data;
+            const { phoneNumber, sessionTimeout, destination, sipHeaders = [], sipHost, sipUser, sipPassword, sipProfile, refer, gatewaySettingsMode, from, muteRecording } = this.data;
             const destinationIsSip = (/^sip:/i).test(destination);
             const destinationIsUser = (/^user:/i).test(destination);
             const callerID = phoneNumber;
             const timeout = Number(sessionTimeout);
-            const inheritGatewaySetting = gatewaySettigsMode === 'inherit';
+            const inheritGatewaySetting = gatewaySettingsMode === 'inherit';
             const headers = Object.fromEntries(sipHeaders.map(({ name, value }) => [name, value]));
+            // GET SIP PROFILE SETTINGS
+            let gateway;
+            const profile = sipProfile !== "default" /* SIP_PROFILE.DEFAULT */ ? sipProfile : undefined;
+            switch (gatewaySettingsMode) {
+                case "custom" /* GATEWAY_SETTINGS_MODE.CUSTOM */:
+                    gateway = {
+                        host: sipHost,
+                        user: sipUser,
+                        username: sipUser,
+                        password: sipPassword,
+                        profile
+                    };
+                    break;
+                case "profile" /* GATEWAY_SETTINGS_MODE.PROFILE */:
+                    gateway = {
+                        profile
+                    };
+                    break;
+            }
             const command = {
                 name: destinationIsSip ? (refer ? 'refer' : 'bridge_sip') : (destinationIsUser ? 'bridge_user' : 'bridge'),
                 params: {
@@ -66,14 +85,7 @@ class Transfer extends voice_1.default {
                     transferFrom: callerID,
                     transferTo: destination,
                     headers,
-                    gateway: sipHost
-                        ? {
-                            host: sipHost,
-                            user: sipUser,
-                            username: sipUser,
-                            password: sipPassword
-                        }
-                        : undefined,
+                    gateway,
                     timeout
                 }
             };

package/dst/step.d.ts

@@ -25,6 +25,7 @@ export default class ConvStep<TData extends IConversationData, TIn = unknown, TO
     get useQueue(): boolean;
     fetchData(): Promise<TData>;
     getConversation(): Promise<IConversation>;
+    getConversationByName(conversation: string): Promise<IConversation>;
     updateData(): Promise<void>;
     hasConversation(): Promise<boolean>;
     runBefore(): Promise<void>;

package/dst/step.js

@@ -51,6 +51,10 @@ class ConvStep extends step_1.default {
     async getConversation() {
         return (await this.fetchData())._conv;
     }
+    async getConversationByName(conversation) {
+        const convDataThread = this.process.getSafeThread(this.dataThreadId);
+        return await convDataThread.get(conversation);
+    }
     async updateData() {
         if (this.convDataCache == null)
             throw new Error(`missing conversation cache in state ${this.state.name}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "7.0.9",
+  "version": "7.0.11-VOIC1604.0",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",