@onereach/step-voice 7.0.9-processttschunk.0 → 7.0.9-processttschunk.10

package/dst/Global Command.d.ts

@@ -12,6 +12,8 @@ interface INPUT {
     recordFileTtl: number;
     limitLinkTtl: boolean;
     recordLinkTtl: number;
+    loopPrevention_enabled: boolean;
+    loopPrevention_maxLoops: number;
 }
 interface OUTPUT {
     type: string;

package/dst/Global Command.js

@@ -93,6 +93,14 @@ class GlobalCommand extends voice_1.default {
                 await this.initGrammar(call);
             }
         });
+        // Set loop prevention settings on call object
+        if (this.data.loopPrevention_enabled) {
+            this.session.data.loopPrevention = {
+                enabled: this.data.loopPrevention_enabled,
+                maxLoops: this.data.loopPrevention_maxLoops
+            };
+            await this.updateData();
+        }
         if (allowAck) {
             this.triggers.local('ack', ({ params: { ack } }) => {
                 const worker = this.process.getThread(this.workerThreadId);

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,10 @@ interface INPUT {
     enableSpoofCallerId?: boolean;
     spoofCallerId?: string;
     isAMD?: boolean;
+    enableWhisperTransfer?: boolean;
+    whisperAnnounceAudio?: TODO[];
+    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, } = 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,9 @@ class InitiateCall extends voice_1.default {
                                         type: asr.serverSettings.engine
                                     }
                                 }]
-                            : []
-                    ]);
+                            : [],
+                    ];
+                    await this.sendCommands(newCall, commands);
                     return this.exitStep('success');
                 }
                 case 'hangup': {
@@ -160,6 +161,23 @@ 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 = gateway = profile != null ? { profile } : undefined;
+                    break;
+            }
             const params = {
                 id: call.id,
                 from: botNumber,
@@ -169,16 +187,11 @@ 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,
+                maxLoops: this.session.data?.loopPrevention?.enabled && this.session.data.loopPrevention.maxLoops,
             };
             if (otherCallRef) {
                 // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing

package/dst/Join Conference.d.ts

@@ -2,6 +2,7 @@ import VoiceStep, { TODO, VoiceEvent } from './voice';
 interface INPUT {
     conferenceName: string;
     stayInConference: boolean;
+    mute: boolean;
     volumeIn?: number;
     volumeOut?: number;
 }

package/dst/Join Conference.js

@@ -6,7 +6,7 @@ const voice_1 = tslib_1.__importDefault(require("./voice"));
 class JoinConference extends voice_1.default {
     async runStep() {
         const call = await this.fetchData();
-        const { conferenceName, stayInConference, volumeIn, volumeOut } = this.data;
+        const { conferenceName, stayInConference, volumeIn, volumeOut, mute } = this.data;
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
             switch (event.params.type) {
                 case 'hangup':
@@ -49,7 +49,10 @@ class JoinConference extends voice_1.default {
                 name: 'conference.start',
                 params: {
                     room: conferenceName,
-                    flags: [call.vv >= 3 ? 'mandatory_member_endconf' : 'endconf'],
+                    flags: [
+                        call.vv >= 3 ? 'mandatory_member_endconf' : 'endconf',
+                        ...mute ? ['mute'] : []
+                    ],
                     stayInConference,
                     volumeIn,
                     volumeOut

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/Start TTS Chunks Processing.js

@@ -37,6 +37,15 @@ class StartTTSChunksProcessing extends voice_1.default {
                     this.log.info('tts-chunks-playback-done', event.params);
                     return this.exitStep('next', {}, false);
                 }
+                case 'tts-audio/started':
+                case 'tts-audio/finished':
+                case 'tts-audio/interrupted':
+                case 'asr-input/started':
+                case 'asr-input/ended':
+                case 'asr-input/processed': {
+                    this.log.warn('Received asr/tts status event', event.params);
+                    return;
+                }
                 case 'timeout': {
                     this.log.info('timeout', event.params);
                     return this.exitStep(event.params.type, {}, false);

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,15 @@ interface INPUT {
         value: string;
     }>;
     refer: boolean;
-    gatewaySettigsMode?: string;
+    withReplaces: boolean;
+    replacesConversation?: string;
+    replacesConversationThread?: 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,33 +52,77 @@ 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, withReplaces, replacesConversation, replacesConversationThread, 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]));
+            let transferFrom = callerID;
+            let transferTo = destination;
+            let replacesDialog;
+            if (refer && withReplaces && replacesConversation) {
+                const replacesCall = replacesConversationThread
+                    ? await this.process.getSafeThread(replacesConversationThread).get(replacesConversation)
+                    : await this.getConversationByName(replacesConversation);
+                // For attended transfer: transferFrom becomes current call's ID,
+                // and replacesDialog carries the dialog identifiers for Replaces header
+                transferFrom = call.id;
+                replacesDialog = {
+                    callId: replacesCall['toCallId'],
+                    toTag: replacesCall['toTag'],
+                    fromTag: replacesCall['fromTag'],
+                    uri: replacesCall['toUri'],
+                };
+            }
+            // 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 = gateway = profile != null ? { profile } : undefined;
+                    break;
+            }
+            let commandName = 'bridge';
+            if (destinationIsSip) {
+                commandName = refer ? 'refer' : 'bridge_sip';
+            }
+            else if (destinationIsUser) {
+                commandName = 'bridge_user';
+            }
+            const botNumber = inheritGatewaySetting ? from : call.botNumber;
+            const maxLoops = this.session.data?.loopPrevention?.enabled
+                ? this.session.data.loopPrevention.maxLoops
+                : undefined;
             const command = {
-                name: destinationIsSip ? (refer ? 'refer' : 'bridge_sip') : (destinationIsUser ? 'bridge_user' : 'bridge'),
+                name: commandName,
                 params: {
-                    botNumber: inheritGatewaySetting ? from : call.botNumber,
-                    transferFrom: callerID,
-                    transferTo: destination,
+                    botNumber,
+                    transferFrom,
+                    transferTo,
                     headers,
-                    gateway: sipHost
-                        ? {
-                            host: sipHost,
-                            user: sipUser,
-                            username: sipUser,
-                            password: sipPassword
-                        }
-                        : undefined,
-                    timeout
+                    gateway,
+                    timeout,
+                    maxLoops,
+                    ...(replacesDialog && { replacesDialog }),
                 }
             };
             const muteAfterTransfer = !!muteRecording;
-            await this.pauseRecording(call, command, { muteStep: muteAfterTransfer, muteBot: muteAfterTransfer, muteUser: muteAfterTransfer });
+            await this.pauseRecording(call, command, {
+                muteStep: muteAfterTransfer,
+                muteBot: muteAfterTransfer,
+                muteUser: muteAfterTransfer
+            });
             await this.transcript(call, {
                 action: 'Transfer Start',
                 actionFromBot: true,

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/dst/voice.d.ts

@@ -33,7 +33,7 @@ export interface IVoiceCall extends IConversationData {
         user: string;
     };
 }
-export type EventType = 'hangup' | 'ack' | 'error' | 'cancel' | 'background' | 'avm-detected' | 'recognition' | 'digit' | 'digits' | 'conference-start' | 'conference-end' | 'playback' | 'timeout' | 'record' | 'bridge' | 'bridge/ended' | 'is_flow_ready' | 'call' | 'dtmf-sent' | 'tts-chunks-playback-done';
+export type EventType = 'hangup' | 'ack' | 'error' | 'cancel' | 'background' | 'avm-detected' | 'recognition' | 'digit' | 'digits' | 'conference-start' | 'conference-end' | 'playback' | 'timeout' | 'record' | 'bridge' | 'bridge/ended' | 'is_flow_ready' | 'call' | 'dtmf-sent' | 'tts-chunks-playback-done' | 'tts-audio/started' | 'tts-audio/finished' | 'tts-audio/interrupted' | 'asr-input/started' | 'asr-input/ended' | 'asr-input/processed';
 export declare class VoiceStepError extends BasicError {
 }
 export type VoicerError = Error & {

package/dst/voice.js

@@ -76,12 +76,14 @@ class VoiceStep extends step_1.default {
     }
     async handleHeartbeat(call) {
         const allowHeartbeat = this.canVoicerHeartbeat(call);
+        this.log.debug('handleHeartbeat', { allowHeartbeat });
         if (allowHeartbeat) {
             if (this.thread.background) {
                 delete this.waits.timeout;
                 return;
             }
             const expectHeartbeatBefore = Date.now() + 290000;
+            this.log.debug('expectHeartbeatBefore', { expectHeartbeatBefore });
             this.triggers.deadline(expectHeartbeatBefore, () => {
                 this.thread.background = true;
                 if (call.ended) {

package/package.json

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