bump version

* feat/882: default model setting for en-IN language

* feat/882: refactored if into ||

.github/workflows/build.yml

@@ -12,6 +12,11 @@ jobs:
           node-version: 20
       - run: npm ci
       - run: npm run jslint
+      - name: Install Docker Compose
+        run: |
+          sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+          sudo chmod +x /usr/local/bin/docker-compose
+          docker-compose --version
       - run: docker pull drachtio/sipp
       - run: npm test
         env:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Drachtio Communications Services, LLC
+Copyright (c) 2018-2024 FirstFive8, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -21,6 +21,7 @@ Configuration is provided via environment variables:
 |ENCRYPTION_SECRET| secret for credential encryption(JWT_SECRET is deprecated) |yes|
 |GOOGLE_APPLICATION_CREDENTIALS| path to gcp service key file|yes|
 |HTTP_PORT| tcp port to listen on for API requests from jambonz-api-server|yes|
+|HTTP_IP| IP Address for API requests from jambonz-api-server |no|
 |JAMBONES_GATHER_EARLY_HINTS_MATCH| if true and hints are provided, gather will opportunistically review interim transcripts if possible to reduce ASR latency |no|
 |JAMBONES_FREESWITCH| IP:port:secret for Freeswitch server (e.g. '127.0.0.1:8021:JambonzR0ck$'|yes|
 |JAMBONES_LOGLEVEL| log level for application, 'info' or 'debug'|no|

lib/config.js

@@ -73,6 +73,7 @@ const JAMBONES_LOGLEVEL = process.env.JAMBONES_LOGLEVEL || 'info';
 const JAMBONES_INJECT_CONTENT = process.env.JAMBONES_INJECT_CONTENT;
 
 const PORT = parseInt(process.env.HTTP_PORT, 10) || 3000;
+const HTTP_IP = process.env.HTTP_IP;
 const HTTP_PORT_MAX = parseInt(process.env.HTTP_PORT_MAX, 10);
 
 const K8S = process.env.K8S;
@@ -170,6 +171,7 @@ module.exports = {
   JAMBONES_CLUSTER_ID,
   PORT,
   HTTP_PORT_MAX,
+  HTTP_IP,
   K8S,
   K8S_SBC_SIP_SERVICE_NAME,
   JAMBONES_SUBNET,

lib/http-routes/api/create-call.js

@@ -97,7 +97,8 @@ router.post('/',
         'X-Trace-ID': rootSpan.traceId,
         ...(req.body?.application_sid && {'X-Application-Sid': req.body.application_sid}),
         ...(restDial.fromHost && {'X-Preferred-From-Host': restDial.fromHost}),
-        ...(record_all_calls && {'X-Record-All-Calls': recordOutputFormat})
+        ...(record_all_calls && {'X-Record-All-Calls': recordOutputFormat}),
+        ...target.headers
       };
 
       switch (target.type) {
@@ -218,7 +219,7 @@ router.post('/',
       }
       if (!app.notifier && app.call_status_hook) {
         app.notifier = new HttpRequestor(logger, account.account_sid, app.call_status_hook, account.webhook_secret);
-        logger.debug({call_hook: app.call_hook}, 'creating http client for call status hook');
+        logger.debug({call_status_hook: app.call_status_hook}, 'creating http client for call status hook');
       }
       else if (!app.notifier) {
         logger.debug('creating null call status hook');

lib/middleware.js

@@ -352,6 +352,17 @@ module.exports = function(srf, logger) {
         direction: CallDirection.Inbound,
         traceId: rootSpan.traceId
       });
+      // if transferred call contains callInfo, let update original data to newly created callInfo in this instance.
+      if (app.transferredCall && app.callInfo) {
+        const {direction, callerName, from, to, originatingSipIp, originatingSipTrunkName} = app.callInfo;
+        req.locals.callInfo.direction = direction;
+        req.locals.callInfo.callerName = callerName;
+        req.locals.callInfo.from = from;
+        req.locals.callInfo.to = to;
+        req.locals.callInfo.originatingSipIp = originatingSipIp;
+        req.locals.callInfo.originatingSipTrunkName = originatingSipTrunkName;
+        delete app.callInfo;
+      }
       next();
     } catch (err) {
       span.end();

lib/session/call-session.js

@@ -19,6 +19,7 @@ const { normalizeJambones } = require('@jambonz/verb-specifications');
 const listTaskNames = require('../utils/summarize-tasks');
 const HttpRequestor = require('../utils/http-requestor');
 const WsRequestor = require('../utils/ws-requestor');
+const ActionHookDelayProcessor = require('../utils/action-hook-delay');
 const {
   JAMBONES_INJECT_CONTENT,
   JAMBONES_EAGERLY_PRE_CACHE_AUDIO,
@@ -519,13 +520,6 @@ class CallSession extends Emitter {
     this._actionHookDelayRetries = e;
   }
 
-  get actionHookDelayActions() {
-    return this._actionHookDelayActions;
-  }
-
-  set actionHookDelayActions(e) {
-    this._actionHookDelayActions = e;
-  }
   // Getter/setter for current tts vendor
   get currentTtsVendor() {
     return this._currentTtsVendor;
@@ -535,6 +529,69 @@ class CallSession extends Emitter {
     this._currentTtsVendor = vendor;
   }
 
+  get actionHookDelayProcessor() {
+    return this._actionHookDelayProcessor;
+  }
+
+  set actionHookDelayProperties(opts) {
+    if (this._actionHookDelayProcessor) {
+      this._actionHookDelayProcessor.stop();
+      if (!this._actionHookDelayProcessor.init(opts)) {
+        this._actionHookDelayProcessor.removeAllListeners();
+        this._actionHookDelayProcessor = null;
+      }
+    }
+    else {
+      try {
+        this._actionHookDelayProcessor = new ActionHookDelayProcessor(this.logger, opts, this, this.ep);
+        this._actionHookDelayProcessor.on('giveup', () => {
+          this.logger.info('CallSession: ActionHookDelayProcessor: giveup event - hanging up call');
+          this._jambonzHangup();
+          if (this.wakeupResolver) {
+            this.logger.debug('CallSession: Giveup timer expired - waking up');
+            this.wakeupResolver({reason: 'noResponseGiveUp'});
+            this.wakeupResolver = null;
+          }
+        });
+      } catch (err) {
+        this.logger.error({err}, 'CallSession: Error creating ActionHookDelayProcessor');
+      }
+    }
+  }
+
+  async clearOrRestoreActionHookDelayProcessor() {
+    if (this._actionHookDelayProcessor) {
+      await this._actionHookDelayProcessor.stop();
+      if (!this.popActionHookDelayProperties()) {
+        //this.logger.debug('CallSession:clearOrRestoreActionHookDelayProcessor - ahd settings');
+        //await this.clearActionHookDelayProcessor();
+      }
+      this.logger.debug('CallSession:clearOrRestoreActionHookDelayProcessor - say or play action completed');
+    }
+  }
+
+  async clearActionHookDelayProcessor() {
+    if (this._actionHookDelayProcessor) {
+      await this._actionHookDelayProcessor.stop();
+      this._actionHookDelayProcessor.removeAllListeners();
+      this._actionHookDelayProcessor = null;
+    }
+  }
+
+  stashActionHookDelayProperties() {
+    this._storedActionHookDelayProperties = this._actionHookDelayProcessor.properties;
+  }
+
+  popActionHookDelayProperties() {
+    if (this._storedActionHookDelayProperties) {
+      this._actionHookDelayProcessor.init(this._storedActionHookDelayProperties);
+      this._storedActionHookDelayProperties = null;
+      return true;
+    }
+    return false;
+  }
+
+
   hasGlobalSttPunctuation() {
     return this._globalSttPunctuation !== undefined;
   }
@@ -814,7 +871,8 @@ class CallSession extends Emitter {
             writeAlerts({
               alert_type: AlertType.TTS_FAILURE,
               account_sid: this.accountSid,
-              vendor
+              vendor,
+              target_sid: this.callSid
             }).catch((err) => this.logger.error({err}, 'Error writing tts alert'));
           }
         }
@@ -860,6 +918,7 @@ class CallSession extends Emitter {
             speech_credential_sid: credential.speech_credential_sid,
             api_key: credential.api_key,
             deepgram_stt_uri: credential.deepgram_stt_uri,
+            deepgram_tts_uri: credential.deepgram_tts_uri,
             deepgram_stt_use_tls: credential.deepgram_stt_use_tls
           };
         }
@@ -937,7 +996,8 @@ class CallSession extends Emitter {
         writeAlerts({
           alert_type: AlertType.STT_NOT_PROVISIONED,
           account_sid: this.accountSid,
-          vendor
+          vendor,
+          target_sid: this.callSid
         }).catch((err) => this.logger.error({err}, 'Error writing tts alert'));
       }
     }
@@ -961,7 +1021,6 @@ class CallSession extends Emitter {
       task.on('VerbHookSpanWaitForEnd', ({span}) => {
         this.verbHookSpan = span;
       });
-      task.on('ActionHookDelayActionOptions', this._onActionHookDelayActions.bind(this));
       try {
         const resources = await this._evaluatePreconditions(task);
         let skip = false;
@@ -1007,6 +1066,10 @@ class CallSession extends Emitter {
       ) {
         try {
           await this._awaitCommandsOrHangup();
+
+          //await this.clearOrRestoreActionHookDelayProcessor();
+
+          //TODO: remove filler noise code and simply create as action hook delay
           if (this._isPlayingFillerNoise) {
             this._isPlayingFillerNoise = false;
             this.ep.api('uuid_break', this.ep.uuid)
@@ -1237,9 +1300,8 @@ class CallSession extends Emitter {
       this.currentTask.kill(this);
     }
     this._endVerbHookSpan();
-    // clear all delay action hook timeout if there is
-    this._clearActionHookNoResponseGiveUpTimer();
-    this._clearActionHookNoResponseTimer();
+
+    await this.clearOrRestoreActionHookDelayProcessor();
   }
 
   /**
@@ -1745,7 +1807,8 @@ Duration=${duration} `
       await writeAlerts({
         alert_type: AlertType.WEBHOOK_CONNECTION_FAILURE,
         account_sid: this.accountSid,
-        detail: `Session:reconnect error ${err}`
+        detail: `Session:reconnect error ${err}`,
+        url: this.application.call_hook.url,
       });
     } catch (error) {
       this.logger.error({error}, 'Error writing WEBHOOK_CONNECTION_FAILURE alert');
@@ -1753,7 +1816,7 @@ Duration=${duration} `
     this._jambonzHangup();
   }
 
-  _onCommand({msgid, command, call_sid, queueCommand, data}) {
+  async _onCommand({msgid, command, call_sid, queueCommand, data}) {
     this.logger.info({msgid, command, queueCommand, data}, 'CallSession:_onCommand - received command');
     let resolution;
     switch (command) {
@@ -1778,9 +1841,9 @@ Duration=${duration} `
           }
           resolution = {reason: 'received command, new tasks', queue: queueCommand, command};
           resolution.command = listTaskNames(t);
+
           // clear all delay action hook timeout if there is
-          this._clearActionHookNoResponseGiveUpTimer();
-          this._clearActionHookNoResponseTimer();
+          await this.clearOrRestoreActionHookDelayProcessor();
         }
         else this._lccCallHook(data);
         break;
@@ -2006,6 +2069,12 @@ Duration=${duration} `
       this.logger.error('CallSession:replaceEndpoint cannot be called without stable dlg');
       return;
     }
+    // When this call kicked out from conference, session need to replace endpoint
+    // but this.ms might be undefined/null at this case.
+    this.ms = this.ms || this.getMS();
+    // Destroy previous ep if it's still running.
+    if (this.ep?.connected) this.ep.destroy();
+
     this.ep = await this.ms.createEndpoint({remoteSdp: this.dlg.remote.sdp});
     this._configMsEndpoint();
 
@@ -2040,8 +2109,7 @@ Duration=${duration} `
     this.rootSpan && this.rootSpan.end();
     // close all background tasks
     this.backgroundTaskManager.stopAll();
-    this._clearActionHookNoResponseGiveUpTimer();
-    this._clearActionHookNoResponseTimer();
+    this.clearOrRestoreActionHookDelayProcessor().catch((err) => {});
   }
 
   /**
@@ -2450,6 +2518,16 @@ Duration=${duration} `
       this.logger.info('_awaitCommandsOrHangup - waiting...');
       this.wakeupResolver = resolve;
 
+      if (this._actionHookDelayProcessor) {
+        this._actionHookDelayProcessor.start();
+      }
+
+      /**
+       * TODO: filler noise can be handled as an ActionHookDelayProcessor -
+       * it's just one specific scenario for action hook delay -
+       * remove the code below and simply implement filler noise as an action hook delay
+       */
+
       /* start filler noise if configured while we wait for new commands */
       if (this.fillerNoise?.url && this.ep?.connected && !this.ep2) {
         this.logger.debug('CallSession:_awaitCommandsOrHangup - playing filler noise');
@@ -2494,81 +2572,6 @@ Duration=${duration} `
       this.verbHookSpan = null;
     }
   }
-  // actionHook delay actions
-  _onActionHookDelayActions(options) {
-    this._actionHookDelayRetryCount = 0;
-    this._startActionHookNoResponseTimer(options);
-    this._startActionHookNoResponseGiveUpTimer(options);
-  }
-
-  _startActionHookNoResponseTimer(options) {
-    this._clearActionHookNoResponseTimer();
-    this._actionHookDelayResolved = false;
-    if (options.noResponseTimeoutMs) {
-      this.logger.debug(`CallSession:_startActionHookNoResponseTimer ${options.noResponseTimeoutMs}`);
-      this._actionHookNoResponseTimer = setTimeout(() => {
-        if (this._actionHookDelayRetryCount >= options.retries) {
-          this._jambonzHangup();
-        }
-        const verb = options.actions[this._actionHookDelayRetryCount % options.actions.length];
-        // Inject verb to main stack
-        const t = normalizeJambones(this.logger, [verb])
-          .map((tdata) => makeTask(this.logger, tdata));
-        if (t.length) {
-          t[0].on('playDone', (err) => {
-            if (err) this.logger.error({err}, `Call-Session:exec Error delay action, play ${verb}`);
-            if (!this._actionHookDelayResolved) {
-              this._startActionHookNoResponseTimer(options);
-            }
-          });
-        }
-        this.tasks.push(...t);
-        if (this.wakeupResolver) {
-          this.wakeupResolver({reason: 'actionHook no response, applied delay actions', verb});
-          this.wakeupResolver = null;
-        }
-
-        this.logger.debug(`CallSession:_startActionHookNoResponseTimer, executing verb ${JSON.stringify(verb)}`);
-
-        this._actionHookDelayRetryCount++;
-      }, options.noResponseTimeoutMs);
-    }
-  }
-
-  _clearActionHookNoResponseTimer() {
-    if (this._actionHookNoResponseTimer) {
-      // Action Hook delay is solved.
-      this._actionHookDelayResolved = true;
-      clearTimeout(this._actionHookNoResponseTimer);
-      // if delay action is enabled
-      // and bot has responded with list of new verbs
-      // Only kill current running play task.
-      //https://github.com/jambonz/jambonz-feature-server/issues/710
-      if (this.currentTask?.name === TaskName.Play) {
-        this.currentTask.kill(this);
-      }
-    }
-    this._actionHookNoResponseTimer = null;
-  }
-
-  _startActionHookNoResponseGiveUpTimer(options) {
-    this._clearActionHookNoResponseGiveUpTimer();
-    if (options.noResponseGiveUpTimeoutMs) {
-      this.logger.debug(`CallSession:_startActionHookNoResponseGiveUpTimer ${options.noResponseGiveUpTimeoutMs}`);
-      this._actionHookNoResponseGiveUpTimer = setTimeout(() => {
-        this.logger.debug('CallSession:_startActionHookNoResponseGiveUpTimer Timeout');
-        this._jambonzHangup();
-        this._actionHookNoResponseGiveUpTimer = null;
-      }, options.noResponseGiveUpTimeoutMs);
-    }
-  }
-
-  _clearActionHookNoResponseGiveUpTimer() {
-    if (this._actionHookNoResponseGiveUpTimer) {
-      clearTimeout(this._actionHookNoResponseGiveUpTimer);
-    }
-    this._actionHookNoResponseGiveUpTimer = null;
-  }
 }
 
 module.exports = CallSession;

lib/session/inbound-call-session.js

@@ -71,7 +71,7 @@ class InboundCallSession extends CallSession {
   }
 
   _jambonzHangup() {
-    this._hangup();
+    this.dlg?.destroy();
   }
 
   _hangup(terminatedBy = 'jambonz') {

lib/session/rest-call-session.js

@@ -1,6 +1,9 @@
 const CallSession = require('./call-session');
 const {CallStatus} = require('../utils/constants');
 const moment = require('moment');
+const {parseUri} = require('drachtio-srf');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+const makeTask = require('../tasks/make_task');
 
 /**
  * @classdesc Subclass of CallSession.  This represents a CallSession that is
@@ -42,9 +45,63 @@ class RestCallSession extends CallSession {
   setDialog(dlg) {
     this.dlg = dlg;
     dlg.on('destroy', this._callerHungup.bind(this));
+    dlg.on('refer', this._onRefer.bind(this));
+    dlg.on('modify', this._onReinvite.bind(this));
     this.wrapDialog(dlg);
   }
 
+  /**
+   * global referHook
+   */
+
+  set referHook(hook) {
+    this._referHook = hook;
+  }
+
+  /**
+   * This is invoked when the called party sends REFER to Jambonz.
+   */
+  async _onRefer(req, res) {
+    if (this._referHook) {
+      try {
+        const to = parseUri(req.getParsedHeader('Refer-To').uri);
+        const by = parseUri(req.getParsedHeader('Referred-By').uri);
+        const b3 = this.b3;
+        const httpHeaders = b3 && {b3};
+        const json = await this.requestor.request('verb:hook', this._referHook, {
+          ...(this.callInfo.toJSON()),
+          refer_details: {
+            sip_refer_to: req.get('Refer-To'),
+            sip_referred_by: req.get('Referred-By'),
+            sip_user_agent: req.get('User-Agent'),
+            refer_to_user: to.scheme === 'tel' ? to.number : to.user,
+            referred_by_user: by.scheme === 'tel' ? by.number : by.user,
+            referring_call_sid: this.callSid,
+            referred_call_sid: null,
+          }
+        }, httpHeaders);
+
+        if (json && Array.isArray(json)) {
+          const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+          if (tasks && tasks.length > 0) {
+            this.logger.info('RestCallSession:handleRefer received REFER, get new tasks');
+            this.replaceApplication(tasks);
+            if (this.wakeupResolver) {
+              this.wakeupResolver({reason: 'RestCallSession: referHook new taks'});
+              this.wakeupResolver = null;
+            }
+          }
+        }
+        res.send(202);
+        this.logger.info('RestCallSession:handleRefer - sent 202 Accepted');
+      } catch (err) {
+        this.logger.error({err}, 'RestCallSession:handleRefer - error while asking referHook');
+        res.send(err.statusCode || 501);
+      }
+    } else {
+      res.send(501);
+    }
+  }
   /**
    * This is invoked when the called party hangs up, in order to calculate the call duration.
    */
@@ -56,7 +113,7 @@ class RestCallSession extends CallSession {
     this._hangup();
   }
 
-  _hangup(terminatedBy = 'jamboz') {
+  _hangup(terminatedBy = 'jambonz') {
     if (this.restDialTask) {
       this.restDialTask.turnOffAmd();
     }

lib/tasks/conference.js

@@ -6,6 +6,7 @@ const { normalizeJambones } = require('@jambonz/verb-specifications');
 const makeTask = require('./make_task');
 const bent = require('bent');
 const assert = require('assert');
+const HttpRequestor = require('../utils/http-requestor');
 const WAIT = 'wait';
 const JOIN = 'join';
 const START = 'start';
@@ -117,7 +118,9 @@ class Conference extends Task {
     this.emitter.emit('kill');
     await this._doFinalMemberCheck(cs);
     if (this.ep && this.ep.connected) {
-      this.ep.conn.removeAllListeners('esl::event::CUSTOM::*');
+      // drachtio-fsmrf override esl::event::CUSTOM to conference join listerner, After finish the conference
+      // the application need to reset the esl::event::CUSTOM for another use on the same endpoint
+      this.ep.resetEslCustomEvent();
       this.ep.api(`conference ${this.confName} kick ${this.memberId}`)
         .catch((err) => this.logger.info({err}, 'Error kicking participant'));
     }
@@ -134,15 +137,10 @@ class Conference extends Task {
    * @param {SipDialog} dlg
    */
   async _init(cs, dlg) {
-    const friendlyName = this.confName;
     const {createHash, retrieveHash} = cs.srf.locals.dbHelpers;
+    this.friendlyName = this.confName;
     this.confName = `conf:${cs.accountSid}:${this.confName}`;
 
-    this.statusParams = Object.assign({
-      conferenceSid: this.confName,
-      friendlyName
-    }, cs.callInfo);
-
     // check if conference is in progress
     const obj = await retrieveHash(this.confName);
     if (obj) {
@@ -350,7 +348,9 @@ class Conference extends Task {
       Object.assign(opts, {flags: {
         ...(this.endConferenceOnExit && {endconf: true}),
         ...(this.startConferenceOnEnter && {moderator: true}),
-        ...((this.joinMuted || this.speakOnlyTo) && {joinMuted: true}),
+        //https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Modules/mod_conference_3965534/
+        // mute |	Enter conference muted
+        ...((this.joinMuted || this.speakOnlyTo) && {mute: true}),
       }});
 
       /**
@@ -490,7 +490,7 @@ class Conference extends Task {
   }
 
   async doConferenceParticipantAction(cs, opts) {
-    const {action, tag} = opts;
+    const {action, tag, wait_hook } = opts;
 
     switch (action) {
       case 'tag':
@@ -506,7 +506,10 @@ class Conference extends Task {
         await this.clearCoachMode();
         break;
       case 'hold':
-        this.doConferenceHold(cs, {conf_hold_status: 'hold'});
+        this.doConferenceHold(cs, {
+          conf_hold_status: 'hold',
+          ...(wait_hook && {wait_hook})
+        });
         break;
       case 'unhold':
         this.doConferenceHold(cs, {conf_hold_status: 'unhold'});
@@ -517,6 +520,9 @@ class Conference extends Task {
       case 'unmute':
         this.doConferenceMute(cs, {conf_mute_status: 'unmute'});
         break;
+      case 'kick':
+        this.kickMember(cs);
+        break;
       default:
         this.logger.info(`Conference:doConferenceParticipantAction - unhandled action ${action}`);
         break;
@@ -540,6 +546,13 @@ class Conference extends Task {
     } while (!this.killed && this.conf_hold_status === 'hold');
   }
 
+  /**
+   * mute or unmute side of the call
+   */
+  mute(callSid, doMute) {
+    this.doConferenceMute(this.callSession, {conf_mute_status: doMute});
+  }
+
   /**
    * Add ourselves to the waitlist of sessions to be notified once
    * the conference starts
@@ -569,7 +582,7 @@ class Conference extends Task {
   _normalizeHook(cs, hook) {
     if (typeof hook === 'object') return hook;
     const url = hook.startsWith('/') ?
-      `${cs.application.requestor.baseUrl}${hook}` :
+      `${cs.application.requestor instanceof HttpRequestor ? cs.application.requestor.baseUrl : ''}${hook}` :
       hook;
 
     return { url } ;
@@ -598,7 +611,7 @@ class Conference extends Task {
      * when we hang up as the last member, the current member count = 1
      * when we are kicked out of the call when the moderator leaves, the member count = 0
      */
-    if (this.participantCount === 0) {
+    if (this.participantCount === 0 || this.endConferenceOnExit) {
       const {deleteKey} = cs.srf.locals.dbHelpers;
       try {
         this._notifyConferenceEvent(cs, 'end');
@@ -606,7 +619,8 @@ class Conference extends Task {
         this.logger.info(`conf ${this.confName} deprovisioned: ${removed ? 'success' : 'failure'}`);
       }
       catch (err) {
-        this.logger.error(err, `Error deprovisioning conference ${this.confName}`);
+        this.logger.error(err, `Error deprovisioning conference ${this.confName},
+          might be the conference already cleaned by another moderator`);
       }
     }
   }
@@ -683,8 +697,24 @@ class Conference extends Task {
       if (!params.time) params.time = (new Date()).toISOString();
       if (!params.members && typeof this.participantCount === 'number') params.members = this.participantCount;
       cs.application.requestor
-        .request('verb:hook', this.statusHook, Object.assign(params, this.statusParams, httpHeaders))
-        .catch((err) => this.logger.info(err, 'Conference:notifyConferenceEvent - error'));
+        .request(
+          'verb:hook',
+          this.statusHook,
+          Object.assign(
+            params,
+            Object.assign(
+              {
+                conferenceSid: this.confName,
+                friendlyName: this.friendlyName,
+              },
+              cs.callInfo.toJSON()
+            ),
+            httpHeaders
+          )
+        )
+        .catch((err) =>
+          this.logger.info(err, 'Conference:notifyConferenceEvent - error')
+        );
     }
   }
 
@@ -824,6 +854,16 @@ class Conference extends Task {
     }
   }
 
+  async kickMember(cs) {
+    assert(cs.isInConference);
+    try {
+      await this.ep.api('conference', [this.confName, 'kick', this.memberId]);
+      this.logger.info(`Conference:kickMember: kick ${this.memberId} out of conference ${this.confName}`);
+    } catch (err) {
+      this.logger.error({err}, `Error kicking member out of conference for ${this.memberId}`);
+    }
+  }
+
 }
 
 module.exports = Conference;

lib/tasks/config.js

@@ -141,9 +141,8 @@ class TaskConfig extends Task {
       cs.speechSynthesisVendor = this.synthesizer.vendor !== 'default'
         ? this.synthesizer.vendor
         : cs.speechSynthesisVendor;
-      cs.speechSynthesisLabel = this.synthesizer.label !== 'default'
-        ? this.synthesizer.label
-        : cs.speechSynthesisLabel;
+      cs.speechSynthesisLabel = this.synthesizer.label === 'default'
+        ? cs.speechSynthesisLabel : this.synthesizer.label;
       cs.speechSynthesisLanguage = this.synthesizer.language !== 'default'
         ?  this.synthesizer.language
         : cs.speechSynthesisLanguage;
@@ -155,15 +154,16 @@ class TaskConfig extends Task {
       cs.fallbackSpeechSynthesisVendor = this.synthesizer.fallbackVendor !== 'default'
         ? this.synthesizer.fallbackVendor
         : cs.fallbackSpeechSynthesisVendor;
-      cs.fallbackSpeechSynthesisLabel = this.synthesizer.fallbackLabel !== 'default'
-        ? this.synthesizer.fallbackLabel
-        : cs.fallbackSpeechSynthesisLabel;
+      cs.fallbackSpeechSynthesisLabel = this.synthesizer.fallbackLabel === 'default'
+        ? cs.fallbackSpeechSynthesisLabel : this.synthesizer.fallbackLabel;
       cs.fallbackSpeechSynthesisLanguage = this.synthesizer.fallbackLanguage !== 'default'
         ?  this.synthesizer.fallbackLanguage
         : cs.fallbackSpeechSynthesisLanguage;
       cs.fallbackSpeechSynthesisVoice = this.synthesizer.fallbackVoice !== 'default'
         ? this.synthesizer.fallbackVoice
         : cs.fallbackSpeechSynthesisVoice;
+      // new vendor is set, reset fallback vendor
+      cs.hasFallbackTts = false;
       this.logger.info({synthesizer: this.synthesizer}, 'Config: updated synthesizer');
     }
     if (this.hasRecognizer) {
@@ -171,9 +171,8 @@ class TaskConfig extends Task {
       cs.speechRecognizerVendor = this.recognizer.vendor !== 'default'
         ? this.recognizer.vendor
         : cs.speechRecognizerVendor;
-      cs.speechRecognizerLabel = this.recognizer.label !== 'default'
-        ? this.recognizer.label
-        : cs.speechRecognizerLabel;
+      cs.speechRecognizerLabel = this.recognizer.label === 'default'
+        ? cs.speechRecognizerLabel : this.recognizer.label;
       cs.speechRecognizerLanguage = this.recognizer.language !== 'default'
         ? this.recognizer.language
         : cs.speechRecognizerLanguage;
@@ -182,9 +181,9 @@ class TaskConfig extends Task {
       cs.fallbackSpeechRecognizerVendor = this.recognizer.fallbackVendor !== 'default'
         ? this.recognizer.fallbackVendor
         : cs.fallbackSpeechRecognizerVendor;
-      cs.fallbackSpeechRecognizerLabel = this.recognizer.fallbackLabel !== 'default'
-        ? this.recognizer.fallbackLabel
-        : cs.fallbackSpeechRecognizerLabel;
+      cs.fallbackSpeechRecognizerLabel = this.recognizer.fallbackLabel === 'default' ?
+        cs.fallbackSpeechRecognizerLabel :
+        this.recognizer.fallbackLabel;
       cs.fallbackSpeechRecognizerLanguage = this.recognizer.fallbackLanguage !== 'default'
         ? this.recognizer.fallbackLanguage
         : cs.fallbackSpeechRecognizerLanguage;
@@ -208,6 +207,8 @@ class TaskConfig extends Task {
       if ('punctuation' in this.recognizer) {
         cs.globalSttPunctuation = this.recognizer.punctuation;
       }
+      // new vendor is set, reset fallback vendor
+      cs.hasFallbackAsr = false;
       this.logger.info({
         recognizer: this.recognizer,
         isContinuousAsr: cs.isContinuousAsr
@@ -248,12 +249,14 @@ class TaskConfig extends Task {
     }
     if (this.hasTranscribe) {
       if (this.transcribe.enable) {
-        this.transcribeOpts.recognizer = this.hasRecognizer ?
-          this.recognizer :
-          {
-            vendor: cs.speechRecognizerVendor,
-            language: cs.speechRecognizerLanguage
-          };
+        if (!this.transcribeOpts.recognizer) {
+          this.transcribeOpts.recognizer = this.hasRecognizer ?
+            this.recognizer :
+            {
+              vendor: cs.speechRecognizerVendor,
+              language: cs.speechRecognizerLanguage
+            };
+        }
         this.logger.debug(this.transcribeOpts, 'Config: enabling transcribe');
         cs.startBackgroundTask('transcribe', this.transcribeOpts);
       } else {
@@ -262,11 +265,7 @@ class TaskConfig extends Task {
       }
     }
     if (Object.keys(this.actionHookDelayAction).length !== 0) {
-      cs.actionHookDelayEnabled = this.actionHookDelayAction.enabled || false;
-      cs.actionHookNoResponseTimeout = this.actionHookDelayAction.noResponseTimeout || 0;
-      cs.actionHookNoResponseGiveUpTimeout = this.actionHookDelayAction.noResponseGiveUpTimeout || 0;
-      cs.actionHookDelayRetries = this.actionHookDelayAction.retries || 1;
-      cs.actionHookDelayActions = this.actionHookDelayAction.actions || [];
+      cs.actionHookDelayProperties = this.actionHookDelayAction;
     }
     if (this.data.sipRequestWithinDialogHook) {
       cs.sipRequestWithinDialogHook = this.data.sipRequestWithinDialogHook;

lib/tasks/gather.js

@@ -117,6 +117,7 @@ class TaskGather extends SttTask {
     }
     if (this.sayTask) s += ',with nested say task';
     if (this.playTask) s += ',with nested play task';
+    if (this.actionHookDelayAction) s += ',with actionHookDelayAction';
     s += '}';
     return s;
   }
@@ -163,31 +164,24 @@ class TaskGather extends SttTask {
       this.interim = true;
       this.logger.debug('Gather:exec - early hints match enabled');
     }
-    // actionHook delay
-    this._hookDelayEn = cs.actionHookDelayEnabled || !!this.actionHookDelayAction;
 
-    this._hookDelayActions = this.actionHookDelayAction?.actions || cs.actionHookDelayActions || [];
-
-    // Only enable NoResponseTimeout if there is _hookDelayActions
-    this._hookNoResponseTimeout = (this._hookDelayActions?.length ?
-      (this.actionHookDelayAction?.noResponseTimeout || cs.actionHookNoResponseTimeout || 0)
-      : 0) * 1000;
-
-    this._hookNoResponseGiveUpTimeout = (this.actionHookDelayAction?.noResponseGiveUpTimeout ||
-      cs.actionHookNoResponseGiveUpTimeout || 0) * 1000;
-
-    this._hookDelayRetries = this.actionHookDelayAction?.retries || cs.actionHookDelayRetries || 1;
-    this._hookDelayRetryCount = 0;
-    this.hookDelayActionOpts = {
-      enabled: this._hookDelayEn,
-      actions: this._hookDelayActions,
-      noResponseTimeoutMs: this._hookNoResponseTimeout,
-      noResponseGiveUpTimeoutMs: this._hookNoResponseGiveUpTimeout,
-      retries: this._hookDelayRetries
-    };
+    // if we have actionHook delay, and the session does as well, stash the session config
+    if (this.actionHookDelayAction) {
+      if (cs.actionHookDelayProcessor) {
+        this.logger.debug('Gather:exec - stashing session-level ahd proprerties');
+        cs.stashActionHookDelayProperties();
+      }
+      cs.actionHookDelayProperties = this.actionHookDelayAction;
+    }
 
     this._startVad();
 
+    const startDtmfListener = () => {
+      if (this.input.includes('digits') || this.dtmfBargein || this.asrDtmfTerminationDigit) {
+        ep.on('dtmf', this._onDtmf.bind(this, cs, ep));
+      }
+    };
+
     const startListening = async(cs, ep) => {
       this._startTimer();
       if (this.isContinuousAsr && 0 === this.timeout) this._startAsrTimer();
@@ -211,6 +205,9 @@ class TaskGather extends SttTask {
         const {span, ctx} = this.startChildSpan(`nested:${this.sayTask.summary}`);
         const process = () => {
           this.logger.debug('Gather: nested say task completed');
+          if (!this.listenDuringPrompt) {
+            startDtmfListener();
+          }
           this._stopVad();
           if (!this.killed) {
             startListening(cs, ep);
@@ -238,6 +235,9 @@ class TaskGather extends SttTask {
         const {span, ctx} = this.startChildSpan(`nested:${this.playTask.summary}`);
         const process = () => {
           this.logger.debug('Gather: nested play task completed');
+          if (!this.listenDuringPrompt) {
+            startDtmfListener();
+          }
           this._stopVad();
           if (!this.killed) {
             startListening(cs, ep);
@@ -281,8 +281,8 @@ class TaskGather extends SttTask {
         }
       }
 
-      if (this.input.includes('digits') || this.dtmfBargein || this.asrDtmfTerminationDigit) {
-        ep.on('dtmf', this._onDtmf.bind(this, cs, ep));
+      if (this.listenDuringPrompt) {
+        startDtmfListener();
       }
 
       await this.awaitTaskDone();
@@ -296,7 +296,6 @@ class TaskGather extends SttTask {
   kill(cs) {
     super.kill(cs);
     this._killAudio(cs);
-    this._killActionHookDelayAction();
     this._clearFillerNoiseTimer();
     this.ep.removeAllListeners('dtmf');
     clearTimeout(this.interDigitTimer);
@@ -323,6 +322,9 @@ class TaskGather extends SttTask {
     clearTimeout(this.interDigitTimer);
     let resolved = false;
     if (this.dtmfBargein) {
+      if (!this.playComplete) {
+        this.notifyStatus({event: 'dtmf-bargein-detected', ...evt});
+      }
       this._killAudio(cs);
       this.emit('dtmf', evt);
     }
@@ -544,7 +546,8 @@ class TaskGather extends SttTask {
         account_sid: this.cs.accountSid,
         alert_type: AlertType.STT_FAILURE,
         vendor: this.vendor,
-        detail: err.message
+        detail: err.message,
+        target_sid: this.cs.callSid
       });
     }).catch((err) => this.logger.info({err}, 'Error generating alert for tts failure'));
   }
@@ -583,7 +586,10 @@ class TaskGather extends SttTask {
   }
 
   _clearAsrTimer() {
-    if (this._asrTimer) clearTimeout(this._asrTimer);
+    if (this._asrTimer) {
+      this.logger.debug('_clearAsrTimer: asrTimer cleared');
+      clearTimeout(this._asrTimer);
+    }
     this._asrTimer = null;
   }
 
@@ -592,98 +598,6 @@ class TaskGather extends SttTask {
     this.cs.hangup();
   }
 
-  _actionHookDelaySayAction(verb) {
-    delete verb.verb;
-    this.logger.debug(`_actionHookDelaySayAction ${verb}`);
-    this._actionHookDelaySayTask = makeTask(this.logger, {say: verb}, this);
-    const {span, ctx} = this.startChildSpan(`actionHookDelayAction:${this._actionHookDelaySayTask.summary}`);
-    this._actionHookDelaySayTask.span = span;
-    this._actionHookDelaySayTask.ctx = ctx;
-    this._actionHookDelaySayTask.exec(this.cs, {ep: this.ep});
-    this._actionHookDelaySayTask.on('playDone', (err) => {
-      this._actionHookDelaySayTask = null;
-      span.end();
-      if (err) this.logger.error({err}, 'Gather:actionHookDelay Error playing tts');
-    });
-  }
-
-  _killActionHookDelayAction() {
-    if (this._actionHookDelaySayTask && !this._actionHookDelaySayTask.killed) {
-      this._actionHookDelaySayTask.removeAllListeners('playDone');
-      this._actionHookDelaySayTask.kill(this.cs);
-      this._actionHookDelaySayTask.span.end();
-      this._actionHookDelaySayTask = null;
-    }
-
-    if (this._actionHookDelayPlayTask && !this._actionHookDelayPlayTask.killed) {
-      this._actionHookDelayPlayTask.removeAllListeners('playDone');
-      this._actionHookDelayPlayTask.kill(this.cs);
-      this._actionHookDelayPlayTask.span.end();
-      this._actionHookDelayPlayTask = null;
-    }
-  }
-
-  _actionHookDelayPlayAction(verb) {
-    delete verb.verb;
-    this.logger.debug(`_actionHookDelayPlayAction ${verb}`);
-    this._actionHookDelayPlayTask = makeTask(this.logger, {play: verb}, this);
-    const {span, ctx} = this.startChildSpan(`actionHookDelayAction:${this._actionHookDelayPlayTask.summary}`);
-    this._actionHookDelayPlayTask.span = span;
-    this._actionHookDelayPlayTask.ctx = ctx;
-    this._actionHookDelayPlayTask.exec(this.cs, {ep: this.ep});
-    this._actionHookDelayPlayTask.on('playDone', (err) => {
-      this._actionHookDelayPlayTask = null;
-      span.end();
-      if (err) this.logger.error({err}, 'Gather:actionHookDelay Error playing tts');
-    });
-
-  }
-
-  _startActionHookNoResponseTimer() {
-    assert(this._hookNoResponseTimeout > 0);
-    this._clearActionHookNoResponseTimer();
-    this.logger.debug('startActionHookNoResponseTimer');
-    this._actionHookNoResponseTimer = setTimeout(() => {
-      if (this._hookDelayRetryCount >= this._hookDelayRetries) {
-        this._hangupCall();
-        return;
-      }
-      const verb = this._hookDelayActions[this._hookDelayRetryCount % this._hookDelayActions.length];
-      if (verb.verb === 'say') {
-        this._actionHookDelaySayAction(verb);
-      } else if (verb.verb === 'play') {
-        this._actionHookDelayPlayAction(verb);
-      }
-      this._hookDelayRetryCount++;
-      this._startActionHookNoResponseTimer();
-
-    }, this._hookNoResponseTimeout);
-
-  }
-
-  _clearActionHookNoResponseTimer() {
-    if (this._actionHookNoResponseTimer) {
-      clearTimeout(this._actionHookNoResponseTimer);
-    }
-    this._actionHookNoResponseTimer = null;
-  }
-
-  _startActionHookNoResponseGiveUpTimer() {
-    assert(this._hookNoResponseGiveUpTimeout > 0);
-    this._clearActionHookNoResponseGiveUpTimer();
-    this.logger.debug('startActionHookNoResponseGiveUpTimer');
-    this._actionHookNoResponseGiveUpTimer = setTimeout(() => {
-      this._hangupCall();
-    }, this._hookNoResponseGiveUpTimeout);
-  }
-
-  _clearActionHookNoResponseGiveUpTimer() {
-    if (this._actionHookNoResponseGiveUpTimer) {
-      clearTimeout(this._actionHookNoResponseGiveUpTimer);
-    }
-    this._actionHookNoResponseGiveUpTimer = null;
-  }
-
   _startFastRecognitionTimer(evt) {
     assert(this.fastRecognitionTimeout > 0);
     this._clearFastRecognitionTimer();
@@ -789,6 +703,7 @@ class TaskGather extends SttTask {
       this.playTask.kill(cs);
       this.playTask = null;
     }
+    this.playComplete = true;
   }
 
   _onTranscription(cs, ep, evt, fsEvent) {
@@ -826,6 +741,16 @@ class TaskGather extends SttTask {
       this.logger.info({evt}, 'TaskGather:_onTranscription - got empty transcript, continue listening');
       return;
     }
+    const confidence = evt.alternatives[0].confidence;
+    const minConfidence = this.data.recognizer?.minConfidence;
+    this.logger.debug({evt},
+      `TaskGather:_onTranscription - confidence (${confidence}), minConfidence (${minConfidence})`);
+    if (confidence && minConfidence && confidence < minConfidence) {
+      this.logger.info({evt},
+        'TaskGather:_onTranscription - Transcript confidence ' +
+        `(${confidence}) < minConfidence (${minConfidence})`);
+      return this._resolve('stt-low-confidence', evt);
+    }
 
     /* fast path: our first partial transcript exactly matches an early hint */
     if (this.earlyHintsMatch && evt.is_final === false && this.partialTranscriptsCount++ === 0) {
@@ -892,6 +817,8 @@ class TaskGather extends SttTask {
         if (!['soniox', 'aws', 'microsoft', 'deepgram'].includes(this.vendor)) this._startTranscribing(ep);
       }
       else {
+        /* this was removed to fix https://github.com/jambonz/jambonz-feature-server/issues/783 */
+        /*
         if (this.bargein && (words + bufferedWords) < this.minBargeinWordCount) {
           this.logger.debug({evt, words, bufferedWords},
             'TaskGather:_onTranscription - final transcript but < min barge words');
@@ -900,25 +827,26 @@ class TaskGather extends SttTask {
           return;
         }
         else {
-          if (this.vendor === 'soniox') {
-            /* compile transcripts into one */
-            this._sonioxTranscripts.push(evt.vendor.finalWords);
-            evt = this.compileSonioxTranscripts(this._sonioxTranscripts, 1, this.language);
-            this._sonioxTranscripts = [];
-          }
-          else if (this.vendor === 'deepgram') {
-            /* compile transcripts into one */
-            if (!emptyTranscript) this._bufferedTranscripts.push(evt);
-
-            /* deepgram can send an empty and final transcript; only if we have any buffered should we resolve */
-            if (this._bufferedTranscripts.length === 0) return;
-            evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language, this.vendor);
-            this._bufferedTranscripts = [];
-          }
-
-          /* here is where we return a final transcript */
-          this._resolve('speech', evt);
+        */
+        if (this.vendor === 'soniox') {
+          /* compile transcripts into one */
+          this._sonioxTranscripts.push(evt.vendor.finalWords);
+          evt = this.compileSonioxTranscripts(this._sonioxTranscripts, 1, this.language);
+          this._sonioxTranscripts = [];
         }
+        else if (this.vendor === 'deepgram') {
+          /* compile transcripts into one */
+          if (!emptyTranscript) this._bufferedTranscripts.push(evt);
+
+          /* deepgram can send an empty and final transcript; only if we have any buffered should we resolve */
+          if (this._bufferedTranscripts.length === 0) return;
+          evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language, this.vendor);
+          this._bufferedTranscripts = [];
+        }
+
+        /* here is where we return a final transcript */
+        this._resolve('speech', evt);
+        /*}*/
       }
     }
     else {
@@ -939,6 +867,7 @@ class TaskGather extends SttTask {
           if (!this.playComplete) {
             this.logger.debug({transcript: evt.alternatives[0].transcript}, 'killing audio due to speech');
             this.emit('vad');
+            this.notifyStatus({event: 'speech-bargein-detected', ...evt});
           }
           this._killAudio(cs);
         }
@@ -953,15 +882,18 @@ class TaskGather extends SttTask {
           this.cs.callInfo, httpHeaders));
       }
       if (this.vendor === 'soniox') {
-        this._clearTimer();
         if (evt.vendor.finalWords.length) {
           this.logger.debug({evt}, 'TaskGather:_onTranscription - buffering soniox transcript');
           this._sonioxTranscripts.push(evt.vendor.finalWords);
         }
       }
-
-      /* restart asr timer if we get a partial transcript */
-      if (this.isContinuousAsr) this._startAsrTimer();
+      // If transcription received, reset timeout timer.
+      if (this._timeoutTimer) {
+        this._startTimer();
+      }
+      /* restart asr timer if we get a partial transcript (only if the asr timer is already running) */
+      /* note: https://github.com/jambonz/jambonz-feature-server/issues/866 */
+      if (this.isContinuousAsr && this._asrTimer) this._startAsrTimer();
     }
   }
   _onEndOfUtterance(cs, ep) {
@@ -1043,6 +975,7 @@ class TaskGather extends SttTask {
       alert_type: AlertType.STT_FAILURE,
       message: `Custom speech vendor ${this.vendor} error: ${evt.error}`,
       vendor: this.vendor,
+      target_sid: cs.callSid
     }).catch((err) => this.logger.info({err}, 'Error generating alert for jambonz custom connection failure'));
     if (!(await this._startFallback(cs, ep, evt))) {
       this.notifyTaskDone();
@@ -1101,7 +1034,10 @@ class TaskGather extends SttTask {
           this.logger.error({err}, 'Error stopping transcription');
         });
     }
-    if (this.resolved) return;
+    if (this.resolved) {
+      this.logger.debug('TaskGather:_resolve - already resolved');
+      return;
+    }
 
     this.resolved = true;
     // If bargin is false and ws application return ack to verb:hook
@@ -1112,6 +1048,8 @@ class TaskGather extends SttTask {
     clearTimeout(this.interDigitTimer);
     this._clearTimer();
     this._clearFastRecognitionTimer();
+    this._clearAsrTimer();
+    this._clearFinalAsrTimer();
 
     this.span.setAttributes({
       channel: 1,
@@ -1125,15 +1063,13 @@ class TaskGather extends SttTask {
       return;
     }
 
-    // Enabled action Hook delay timer to applied actions
-    if (this._hookNoResponseTimeout > 0) {
-      this._startActionHookNoResponseTimer();
-    }
-
-    if (this._hookNoResponseGiveUpTimeout > 0) {
-      this._startActionHookNoResponseGiveUpTimer();
+    // action hook delay
+    if (this.cs.actionHookDelayProcessor) {
+      this.logger.debug('TaskGather:_resolve - actionHookDelayProcessor exists - starting it');
+      this.cs.actionHookDelayProcessor.start();
     }
 
+    // TODO: remove and implement as actionHookDelay
     if (this.hasFillerNoise && (reason.startsWith('dtmf') || reason.startsWith('speech'))) {
       if (this.fillerNoiseStartDelaySecs > 0) {
         this._startFillerNoiseTimer();
@@ -1144,40 +1080,63 @@ class TaskGather extends SttTask {
       }
     }
 
+    let returnedVerbs = false;
     try {
       if (reason.startsWith('dtmf')) {
         if (this.parentTask) this.parentTask.emit('dtmf', evt);
         else {
           this.emit('dtmf', evt);
-          await this.performAction({digits: this.digitBuffer, reason: 'dtmfDetected'});
+          returnedVerbs = await this.performAction({digits: this.digitBuffer, reason: 'dtmfDetected'});
         }
       }
       else if (reason.startsWith('speech')) {
         if (this.parentTask) this.parentTask.emit('transcription', evt);
         else {
           this.emit('transcription', evt);
-          await this.performAction({speech: evt, reason: 'speechDetected'});
+          this.logger.debug('TaskGather:_resolve - invoking performAction');
+          returnedVerbs = await this.performAction({speech: evt, reason: 'speechDetected'});
+          this.logger.debug({returnedVerbs}, 'TaskGather:_resolve - back from performAction');
         }
       }
       else if (reason.startsWith('timeout')) {
         if (this.parentTask) this.parentTask.emit('timeout', evt);
         else {
           this.emit('timeout', evt);
-          await this.performAction({reason: 'timeout'});
+          returnedVerbs = await this.performAction({reason: 'timeout'});
         }
       }
       else if (reason.startsWith('stt-error')) {
         if (this.parentTask) this.parentTask.emit('stt-error', evt);
         else {
           this.emit('stt-error', evt);
-          await this.performAction({reason: 'error', details: evt.error});
+          returnedVerbs = await this.performAction({reason: 'error', details: evt.error});
+        }
+      } else if (reason.startsWith('stt-low-confidence')) {
+        if (this.parentTask) this.parentTask.emit('stt-low-confidence', evt);
+        else {
+          this.emit('stt-low-confidence', evt);
+          returnedVerbs = await this.performAction({reason: 'stt-low-confidence'});
         }
       }
     } catch (err) {  /*already logged error*/ }
 
-    // Gather got response from hook, cancel all delay timers if there is any
-    this._clearActionHookNoResponseTimer();
-    this._clearActionHookNoResponseGiveUpTimer();
+    // Gather got response from hook, cancel actionHookDelay processing
+    this.logger.debug('TaskGather:_resolve - checking ahd');
+    if (this.cs.actionHookDelayProcessor) {
+      if (returnedVerbs) {
+        this.logger.debug('TaskGather:_resolve - got response from action hook, cancelling actionHookDelay');
+        await this.cs.actionHookDelayProcessor.stop();
+        if (this.actionHookDelayAction && !this.cs.popActionHookDelayProperties()) {
+          // no session level ahd was running when this task started, so clear it
+          this.cs.clearActionHookDelayProcessor();
+          this.logger.debug('TaskGather:_resolve - clear ahd');
+        }
+      }
+      else {
+        this.logger.debug('TaskGather:_resolve - no response from action hook, continue actionHookDelay');
+      }
+    }
+
     this._clearFillerNoiseTimer();
 
     this.notifyTaskDone();

lib/tasks/rest_dial.js

@@ -17,6 +17,7 @@ class TaskRestDial extends Task {
     this.call_hook = this.data.call_hook;
     this.timeout = this.data.timeout || 60;
     this.sipRequestWithinDialogHook = this.data.sipRequestWithinDialogHook;
+    this.referHook = this.data.referHook;
 
     this.on('connect', this._onConnect.bind(this));
     this.on('callStatus', this._onCallStatus.bind(this));
@@ -38,9 +39,9 @@ class TaskRestDial extends Task {
 
     if (this.data.amd) {
       this.startAmd = cs.startAmd;
-      this.stopAmd = cs.stopAmd;
       this.on('amd', this._onAmdEvent.bind(this, cs));
     }
+    this.stopAmd = cs.stopAmd;
 
     this._setCallTimer();
     await this.awaitTaskDone();
@@ -64,6 +65,7 @@ class TaskRestDial extends Task {
     this.canCancel = false;
     const cs = this.callSession;
     cs.setDialog(dlg);
+    cs.referHook = this.referHook;
     this.logger.debug('TaskRestDial:_onConnect - call connected');
     if (this.sipRequestWithinDialogHook) this._initSipRequestWithinDialogHandler(cs, dlg);
     try {

lib/tasks/say.js

@@ -61,150 +61,11 @@ class TaskSay extends TtsTask {
     }
   }
 
-  async _synthesizeWithSpecificVendor(cs, ep, {vendor, language, voice, label, preCache = false}) {
-    const {srf, accountSid:account_sid} = cs;
-    const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, srf);
-    const {writeAlerts, AlertType, stats} = srf.locals;
-    const {synthAudio} = srf.locals.dbHelpers;
-    const engine = this.synthesizer.engine || 'standard';
-    const salt = cs.callSid;
-
-    let credentials = cs.getSpeechCredentials(vendor, 'tts', label);
-    /* parse Nuance voices into name and model */
-    let model;
-    if (vendor === 'nuance' && voice) {
-      const arr = /([A-Za-z-]*)\s+-\s+(enhanced|standard)/.exec(voice);
-      if (arr) {
-        voice = arr[1];
-        model = arr[2];
-      }
-    } else if (vendor === 'deepgram') {
-      model = voice;
-    }
-
-    /* allow for microsoft custom region voice and api_key to be specified as an override */
-    if (vendor === 'microsoft' && this.options.deploymentId) {
-      credentials = credentials || {};
-      credentials.use_custom_tts = true;
-      credentials.custom_tts_endpoint = this.options.deploymentId;
-      credentials.api_key = this.options.apiKey || credentials.apiKey;
-      credentials.region = this.options.region || credentials.region;
-      voice = this.options.voice || voice;
-    } else if (vendor === 'elevenlabs') {
-      credentials = credentials || {};
-      credentials.model_id = this.options.model_id || credentials.model_id;
-      credentials.voice_settings = this.options.voice_settings || {};
-      credentials.optimize_streaming_latency = this.options.optimize_streaming_latency
-      || credentials.optimize_streaming_latency;
-      voice = this.options.voice_id || voice;
-    }
-
-    ep.set({
-      tts_engine: vendor.startsWith('custom:') ? 'custom' : vendor,
-      tts_voice: voice,
-      cache_speech_handles: !cs.currentTtsVendor || cs.currentTtsVendor === vendor ? 1 : 0,
-    }).catch((err) => this.logger.info({err}, 'Error setting tts_engine on endpoint'));
-    // set the current vendor on the call session
-    // If vendor is changed from the previous one, then reset the cache_speech_handles flag
-    cs.currentTtsVendor = vendor;
-
-    if (!preCache) this.logger.info({vendor, language, voice, model}, 'TaskSay:exec');
-    try {
-      if (!credentials) {
-        writeAlerts({
-          account_sid,
-          alert_type: AlertType.TTS_NOT_PROVISIONED,
-          vendor
-        }).catch((err) => this.logger.info({err}, 'Error generating alert for no tts'));
-        throw new Error('no provisioned speech credentials for TTS');
-      }
-      // synthesize all of the text elements
-      let lastUpdated = false;
-
-      /* produce an audio segment from the provided text */
-      const generateAudio = async(text) => {
-        if (this.killed) return;
-        if (text.startsWith('silence_stream://')) return text;
-
-        /* otel: trace time for tts */
-        if (!preCache)  {
-          const {span} = this.startChildSpan('tts-generation', {
-            'tts.vendor': vendor,
-            'tts.language': language,
-            'tts.voice': voice
-          });
-          this.otelSpan = span;
-        }
-        try {
-          const {filePath, servedFromCache, rtt} = await synthAudio(stats, {
-            account_sid,
-            text,
-            vendor,
-            language,
-            voice,
-            engine,
-            model,
-            salt,
-            credentials,
-            options: this.options,
-            disableTtsCache : this.disableTtsCache,
-            preCache
-          });
-          if (!filePath.startsWith('say:')) {
-            this.logger.debug(`file ${filePath}, served from cache ${servedFromCache}`);
-            if (filePath) cs.trackTmpFile(filePath);
-            if (this.otelSpan) {
-              this.otelSpan.setAttributes({'tts.cached': servedFromCache});
-              this.otelSpan.end();
-              this.otelSpan = null;
-            }
-            if (!servedFromCache && !lastUpdated) {
-              lastUpdated = true;
-              updateSpeechCredentialLastUsed(credentials.speech_credential_sid).catch(() => {/* logged error */});
-            }
-            if (!servedFromCache && rtt && !preCache) {
-              this.notifyStatus({
-                event: 'synthesized-audio',
-                vendor,
-                language,
-                characters: text.length,
-                elapsedTime: rtt
-              });
-            }
-          }
-          else {
-            this.logger.debug('a streaming tts api will be used');
-            const modifiedPath = filePath.replace('say:{', `say:{session-uuid=${ep.uuid},`);
-            return modifiedPath;
-          }
-          return filePath;
-        } catch (err) {
-          this.logger.info({err}, 'Error synthesizing tts');
-          if (this.otelSpan) this.otelSpan.end();
-          writeAlerts({
-            account_sid: cs.accountSid,
-            alert_type: AlertType.TTS_FAILURE,
-            vendor,
-            detail: err.message
-          }).catch((err) => this.logger.info({err}, 'Error generating alert for tts failure'));
-          throw err;
-        }
-      };
-
-      const arr = this.text.map((t) => (this._validateURL(t) ? t : generateAudio(t)));
-      return (await Promise.all(arr)).filter((fp) => fp && fp.length);
-    } catch (err) {
-      this.logger.info(err, 'TaskSay:exec error');
-      throw err;
-    }
-
-  }
-
   async exec(cs, {ep}) {
-    const {srf, accountSid:account_sid} = cs;
+    const {srf, accountSid:account_sid, callSid:target_sid} = cs;
     const {writeAlerts, AlertType} = srf.locals;
     const {addFileToCache} = srf.locals.dbHelpers;
-    const engine = this.synthesizer.engine || 'standard';
+    const engine = this.synthesizer.engine || cs.synthesizer?.engine || 'neural';
 
     await super.exec(cs);
     this.ep = ep;
@@ -218,9 +79,10 @@ class TaskSay extends TtsTask {
     let voice =  this.synthesizer.voice && this.synthesizer.voice !== 'default' ?
       this.synthesizer.voice :
       cs.speechSynthesisVoice;
-    let label = this.synthesizer.label && this.synthesizer.label !== 'default' ?
-      this.synthesizer.label :
-      cs.speechSynthesisLabel;
+    // label can be null/empty in synthesizer config, just use application level label if it's default
+    let label = this.synthesizer.label === 'default' ?
+      cs.speechSynthesisLabel :
+      this.synthesizer.label;
 
     const fallbackVendor = this.synthesizer.fallbackVendor && this.synthesizer.fallbackVendor !== 'default' ?
       this.synthesizer.fallbackVendor :
@@ -231,9 +93,10 @@ class TaskSay extends TtsTask {
     const fallbackVoice =  this.synthesizer.fallbackVoice && this.synthesizer.fallbackVoice !== 'default' ?
       this.synthesizer.fallbackVoice :
       cs.fallbackSpeechSynthesisVoice;
-    const fallbackLabel = this.synthesizer.fallbackLabel && this.synthesizer.fallbackLabel !== 'default' ?
-      this.synthesizer.fallbackLabel :
-      cs.fallbackSpeechSynthesisLabel;
+    // label can be null/empty in synthesizer config, just use application level label if it's default
+    const fallbackLabel = this.synthesizer.fallbackLabel === 'default' ?
+      cs.fallbackSpeechSynthesisLabel :
+      this.synthesizer.fallbackLabel;
 
     if (cs.hasFallbackTts) {
       vendor = fallbackVendor;
@@ -278,22 +141,25 @@ class TaskSay extends TtsTask {
           await this.playToConfMember(ep, memberId, confName, confUuid, filepath[segment]);
         }
         else {
-          if (filepath[segment].startsWith('say:{')) {
+          const isStreaming = filepath[segment].startsWith('say:{');
+          if (isStreaming) {
             const arr = /^say:\{.*\}\s*(.*)$/.exec(filepath[segment]);
             if (arr) this.logger.debug(`Say:exec sending streaming tts request: ${arr[1].substring(0, 64)}..`);
           }
-          else this.logger.debug(`Say:exec sending  ${filepath[segment].substring(0, 64)}`);
+          else this.logger.debug(`Say:exec sending ${filepath[segment].substring(0, 64)}`);
           ep.once('playback-start', (evt) => {
-            this.logger.debug({evt}, 'got playback-start');
+            this.logger.debug({evt}, 'Say got playback-start');
             if (this.otelSpan) {
               this._addStreamingTtsAttributes(this.otelSpan, evt);
               this.otelSpan.end();
               this.otelSpan = null;
-              if (evt.variable_tts_cache_filename) cs.trackTmpFile(evt.variable_tts_cache_filename);
+              if (evt.variable_tts_cache_filename) {
+                cs.trackTmpFile(evt.variable_tts_cache_filename);
+              }
             }
           });
           ep.once('playback-stop', (evt) => {
-            this.logger.debug({evt}, 'got playback-stop');
+            this.logger.debug({evt}, 'Say got playback-stop');
             if (evt.variable_tts_error) {
               writeAlerts({
                 account_sid,
@@ -302,16 +168,28 @@ class TaskSay extends TtsTask {
                 detail: evt.variable_tts_error
               }).catch((err) => this.logger.info({err}, 'Error generating alert for no tts'));
             }
-            if (evt.variable_tts_cache_filename) {
-              const text = parseTextFromSayString(this.text[segment]);
-              addFileToCache(evt.variable_tts_cache_filename, {
-                account_sid,
-                vendor,
-                language,
-                voice,
-                engine,
-                text
-              }).catch((err) => this.logger.info({err}, 'Error adding file to cache'));
+            else {
+              this.logger.debug({evt}, 'Say got playback-stop');
+              if (evt.variable_tts_error) {
+                writeAlerts({
+                  account_sid,
+                  alert_type: AlertType.TTS_FAILURE,
+                  vendor,
+                  detail: evt.variable_tts_error,
+                  target_sid
+                }).catch((err) => this.logger.info({err}, 'Error generating alert for no tts'));
+              }
+              if (evt.variable_tts_cache_filename && !this.killed) {
+                const text = parseTextFromSayString(this.text[segment]);
+                addFileToCache(evt.variable_tts_cache_filename, {
+                  account_sid,
+                  vendor,
+                  language,
+                  voice,
+                  engine,
+                  text
+                }).catch((err) => this.logger.info({err}, 'Error adding file to cache'));
+              }
             }
             if (this._playResolve) {
               evt.variable_tts_error ? this._playReject(new Error(evt.variable_tts_error)) : this._playResolve();
@@ -322,7 +200,8 @@ class TaskSay extends TtsTask {
             this._playResolve = resolve;
             this._playReject = reject;
           });
-          await ep.play(filepath[segment]);
+          const r = await ep.play(filepath[segment]);
+          this.logger.debug({r}, 'Say:exec play result');
           try {
             // wait for playback-stop event received to confirm if the playback is successful
             await this._playPromise;
@@ -367,7 +246,10 @@ class TaskSay extends TtsTask {
       this.ep.removeAllListeners('playback-start');
       this.ep.removeAllListeners('playback-stop');
       // if we are waiting for playback-stop event, resolve the promise
-      if (this._playResolve) this._playResolve();
+      if (this._playResolve) {
+        this._playResolve();
+        this._playResolve = null;
+      }
     }
   }
 

lib/tasks/stt-task.js

@@ -33,7 +33,8 @@ class SttTask extends Task {
       //fallback
       this.fallbackVendor = recognizer.fallbackVendor || 'default';
       this.fallbackLanguage = recognizer.fallbackLanguage || 'default';
-      this.fallbackLabel = recognizer.fallbackLabel || 'default';
+      // label can be empty and should not have default value.
+      this.fallbackLabel = recognizer.fallbackLabel;
 
       /* let credentials be supplied in the recognizer object at runtime */
       this.sttCredentials = setSpeechCredentialsAtRuntime(recognizer);
@@ -81,7 +82,8 @@ class SttTask extends Task {
       this.language = cs.speechRecognizerLanguage;
       if (this.data.recognizer) this.data.recognizer.language = this.language;
     }
-    if ('default' === this.label || !this.label) {
+    // label can be empty, should not assign application level label
+    if ('default' === this.label) {
       this.label = cs.speechRecognizerLabel;
       if (this.data.recognizer) this.data.recognizer.label = this.label;
     }
@@ -94,7 +96,8 @@ class SttTask extends Task {
       this.fallbackLanguage = cs.fallbackSpeechRecognizerLanguage;
       if (this.data.recognizer) this.data.recognizer.fallbackLanguage = this.fallbackLanguage;
     }
-    if ('default' === this.fallbackLabel || !this.fallbackLabel) {
+    // label can be empty, should not assign application level label
+    if ('default' === this.fallbackLabel) {
       this.fallbackLabel = cs.fallbackSpeechRecognizerLabel;
       if (this.data.recognizer) this.data.recognizer.fallbackLabel = this.fallbackLabel;
     }
@@ -175,7 +178,8 @@ class SttTask extends Task {
       writeAlerts({
         account_sid: cs.accountSid,
         alert_type: AlertType.STT_NOT_PROVISIONED,
-        vendor
+        vendor,
+        target_sid: cs.callSid
       }).catch((err) => this.logger.info({err}, 'Error generating alert for no stt'));
       this.notifyTaskDone();
       throw new Error(`No speech-to-text service credentials for ${vendor} have been configured`);
@@ -196,8 +200,12 @@ class SttTask extends Task {
       credentials = {...credentials, access_token, stt_region};
     } else if (['aws', 'polly'].includes(vendor) && credentials.roleArn) {
       /* get aws access token */
-      const {roleArn} = credentials;
-      const {accessKeyId, secretAccessKey, sessionToken, servedFromCache} = await getAwsAuthToken(roleArn);
+      const {roleArn, region} = credentials;
+      const {accessKeyId, secretAccessKey, sessionToken, servedFromCache} =
+        await getAwsAuthToken({
+          region,
+          roleArn
+        });
       this.logger.debug({roleArn}, `got aws access token ${servedFromCache ? 'from cache' : ''}`);
       credentials = {...credentials, accessKeyId, secretAccessKey, sessionToken};
     } else if (vendor === 'verbio' && credentials.client_id && credentials.client_secret) {
@@ -302,6 +310,7 @@ class SttTask extends Task {
       message: 'STT failure reported by vendor',
       detail: evt.error,
       vendor: this.vendor,
+      target_sid: cs.callSid
     }).catch((err) => this.logger.info({err}, `Error generating alert for ${this.vendor} connection failure`));
   }
 
@@ -314,6 +323,7 @@ class SttTask extends Task {
       alert_type: AlertType.STT_FAILURE,
       message: `Failed connecting to ${this.vendor} speech recognizer: ${reason}`,
       vendor: this.vendor,
+      target_sid: cs.callSid
     }).catch((err) => this.logger.info({err}, `Error generating alert for ${this.vendor} connection failure`));
   }
 }

lib/tasks/task.js

@@ -45,6 +45,10 @@ class Task extends Emitter {
     return this.name;
   }
 
+  set disableTracing(val) {
+    this._disableTracing = val;
+  }
+
   toJSON() {
     return this.data;
   }
@@ -177,15 +181,16 @@ class Task extends Emitter {
           // If actionHook delay action is configured, and ws application have not responded yet any verb for actionHook
           // We have to transfer the task to call-session to await on next ws command verbs, and also run action Hook
           // delay actions
-          if (this.hookDelayActionOpts) {
-            this.emit('ActionHookDelayActionOptions', this.hookDelayActionOpts);
-          }
+          //if (this.hookDelayActionOpts) {
+          //  this.emit('ActionHookDelayActionOptions', this.hookDelayActionOpts);
+          //}
         }
         if (expectResponse && json && Array.isArray(json)) {
           const makeTask = require('./make_task');
           const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
           if (tasks && tasks.length > 0) {
             this.callSession.replaceApplication(tasks);
+            return true;
           }
         }
       } catch (err) {
@@ -193,6 +198,7 @@ class Task extends Emitter {
         span.end();
         throw err;
       }
+      return false;
     }
   }
 
@@ -272,6 +278,7 @@ class Task extends Emitter {
     delete obj.requestor;
     delete obj.notifier;
     obj.tasks =  cs.getRemainingTaskData();
+    obj.callInfo = cs.callInfo.toJSON();
     if (opts && obj.tasks.length > 0) {
       const key = Object.keys(obj.tasks[0])[0];
       Object.assign(obj.tasks[0][key], {_: opts});

lib/tasks/transcribe.js

@@ -215,7 +215,7 @@ class TaskTranscribe extends SttTask {
           this._onVendorConnectFailure.bind(this, cs, ep, channel));
 
         /* if app sets deepgramOptions.utteranceEndMs they essentially want continuous asr */
-        if (opts.DEEPGRAM_SPEECH_UTTERANCE_END_MS) this.isContinuousAsr = true;
+        //if (opts.DEEPGRAM_SPEECH_UTTERANCE_END_MS) this.isContinuousAsr = true;
 
         break;
       case 'soniox':
@@ -339,6 +339,12 @@ class TaskTranscribe extends SttTask {
 
     if (this.vendor === 'deepgram' && evt.type === 'UtteranceEnd') {
       /* we will only get this when we have set utterance_end_ms */
+
+      /* DH: send a speech event when we get UtteranceEnd if they want interim events */
+      if (this.interim) {
+        this.logger.debug('Gather:_onTranscription - got UtteranceEnd event from deepgram, sending speech event');
+        this._resolve(channel, evt);
+      }
       if (bufferedTranscripts.length === 0) {
         this.logger.debug('Gather:_onTranscription - got UtteranceEnd event from deepgram but no buffered transcripts');
       }
@@ -423,9 +429,13 @@ class TaskTranscribe extends SttTask {
         /* here is where we return a final transcript */
         this.logger.debug({evt}, 'TaskTranscribe:_onTranscription - sending final transcript');
         this._resolve(channel, evt);
+
         /* some STT engines will keep listening after a final response, so no need to restart */
-        if (!['soniox', 'aws', 'microsoft', 'deepgram', 'google']
-          .includes(this.vendor)) this._startTranscribing(cs, ep, channel);
+        if (!['soniox', 'aws', 'microsoft', 'deepgram', 'google'].includes(this.vendor) &&
+          !this.vendor.startsWith('custom:')) {
+          this.logger.debug('TaskTranscribe:_onTranscription - restarting transcribe');
+          this._startTranscribing(cs, ep, channel);
+        }
       }
     }
     else {
@@ -448,26 +458,31 @@ class TaskTranscribe extends SttTask {
   }
 
   async _resolve(channel, evt) {
-    /* we've got a transcript, so end the otel child span for this channel */
-    if (this.childSpan[channel - 1] && this.childSpan[channel - 1].span) {
-      this.childSpan[channel - 1].span.setAttributes({
-        channel,
-        'stt.resolve': 'transcript',
-        'stt.result': JSON.stringify(evt)
-      });
-      this.childSpan[channel - 1].span.end();
+    if (evt.is_final) {
+      /* we've got a final transcript, so end the otel child span for this channel */
+      if (this.childSpan[channel - 1] && this.childSpan[channel - 1].span) {
+        this.childSpan[channel - 1].span.setAttributes({
+          channel,
+          'stt.resolve': 'transcript',
+          'stt.result': JSON.stringify(evt)
+        });
+        this.childSpan[channel - 1].span.end();
+      }
     }
 
     if (this.transcriptionHook) {
       const b3 = this.getTracingPropagation();
       const httpHeaders = b3 && {b3};
+      const payload = {
+        ...this.cs.callInfo,
+        ...httpHeaders,
+        ...(evt.alternatives && {speech: evt}),
+        ...(evt.type && {speechEvent: evt})
+      };
       try {
-        const json = await this.cs.requestor.request('verb:hook', this.transcriptionHook, {
-          ...this.cs.callInfo,
-          ...httpHeaders,
-          speech: evt
-        });
-        this.logger.info({json}, 'sent transcriptionHook');
+        this.logger.debug({payload}, 'sending transcriptionHook');
+        const json = await this.cs.requestor.request('verb:hook', this.transcriptionHook, payload);
+        this.logger.info({json}, 'completed transcriptionHook');
         if (json && Array.isArray(json) && !this.parentTask) {
           const makeTask = require('./make_task');
           const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
@@ -488,7 +503,7 @@ class TaskTranscribe extends SttTask {
       this._clearTimer();
       this.notifyTaskDone();
     }
-    else {
+    else if (evt.is_final) {
       /* start another child span for this channel */
       const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
       this.childSpan[channel - 1] = {span, ctx};
@@ -590,6 +605,7 @@ class TaskTranscribe extends SttTask {
       alert_type: AlertType.STT_FAILURE,
       message: `Custom speech vendor ${this.vendor} error: ${evt.error}`,
       vendor: this.vendor,
+      target_sid: cs.callSid
     }).catch((err) => this.logger.info({err}, 'Error generating alert for jambonz custom connection failure'));
     if (!(await this._startFallback(cs, _ep, evt))) {
       this.notifyTaskDone();

lib/tasks/tts-task.js

@@ -17,21 +17,31 @@ class TtsTask extends Task {
 
   async exec(cs) {
     super.exec(cs);
+    if (cs.synthesizer) {
+      this.options = {...cs.synthesizer.options, ...this.options};
+      this.data.synthesizer = this.data.synthesizer || {};
+      for (const k in cs.synthesizer) {
+        const newValue = this.data.synthesizer && this.data.synthesizer[k] !== undefined ?
+          this.data.synthesizer[k] :
+          cs.synthesizer[k];
+
+        if (Array.isArray(newValue)) {
+          this.data.synthesizer[k] = [...(this.data.synthesizer[k] || []), ...cs.synthesizer[k]];
+        } else if (typeof newValue === 'object' && newValue !== null) {
+          this.data.synthesizer[k] = { ...(this.data.synthesizer[k] || {}), ...cs.synthesizer[k] };
+        } else {
+          this.data.synthesizer[k] = newValue;
+        }
+      }
+    }
   }
 
-  async _synthesizeWithSpecificVendor(cs, ep, {
-    vendor,
-    language,
-    voice,
-    label,
-    disableTtsStreaming,
-    preCache
-  }) {
+  async _synthesizeWithSpecificVendor(cs, ep, {vendor, language, voice, label, preCache = false}) {
     const {srf, accountSid:account_sid} = cs;
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, srf);
     const {writeAlerts, AlertType, stats} = srf.locals;
     const {synthAudio} = srf.locals.dbHelpers;
-    const engine = this.synthesizer.engine || 'standard';
+    const engine = this.synthesizer.engine || cs.synthesizer?.engine || 'neural';
     const salt = cs.callSid;
 
     let credentials = cs.getSpeechCredentials(vendor, 'tts', label);
@@ -65,23 +75,23 @@ class TtsTask extends Task {
     }
 
     ep.set({
-      tts_engine: vendor,
+      tts_engine: vendor.startsWith('custom:') ? 'custom' : vendor,
       tts_voice: voice,
-      cache_speech_handles: 1,
-    }).catch((err) => this.logger.info({err}, `${this.name}: Error setting tts_engine on endpoint`));
+      cache_speech_handles: !cs.currentTtsVendor || cs.currentTtsVendor === vendor ? 1 : 0,
+    }).catch((err) => this.logger.info({err}, 'Error setting tts_engine on endpoint'));
+    // set the current vendor on the call session
+    // If vendor is changed from the previous one, then reset the cache_speech_handles flag
+    cs.currentTtsVendor = vendor;
 
-    if (!preCache) this.logger.info({vendor, language, voice, model}, `${this.name}:exec`);
+    if (!preCache && !this._disableTracing) this.logger.info({vendor, language, voice, model}, 'TaskSay:exec');
     try {
       if (!credentials) {
         writeAlerts({
           account_sid,
           alert_type: AlertType.TTS_NOT_PROVISIONED,
-          vendor
+          vendor,
+          target_sid: cs.callSid
         }).catch((err) => this.logger.info({err}, 'Error generating alert for no tts'));
-        this.notifyError({
-          msg: 'TTS error',
-          details:`No speech credentials provisioned for selected vendor ${vendor}`
-        });
         throw new Error('no provisioned speech credentials for TTS');
       }
       // synthesize all of the text elements
@@ -93,7 +103,7 @@ class TtsTask extends Task {
         if (text.startsWith('silence_stream://')) return text;
 
         /* otel: trace time for tts */
-        if (!preCache && !this.parentTask)  {
+        if (!preCache && !this._disableTracing)  {
           const {span} = this.startChildSpan('tts-generation', {
             'tts.vendor': vendor,
             'tts.language': language,
@@ -114,11 +124,10 @@ class TtsTask extends Task {
             credentials,
             options: this.options,
             disableTtsCache : this.disableTtsCache,
-            disableTtsStreaming,
-            preCache
+            renderForCaching: preCache
           });
           if (!filePath.startsWith('say:')) {
-            this.logger.debug(`file ${filePath}, served from cache ${servedFromCache}`);
+            this.logger.debug(`Say: file ${filePath}, served from cache ${servedFromCache}`);
             if (filePath) cs.trackTmpFile(filePath);
             if (this.otelSpan) {
               this.otelSpan.setAttributes({'tts.cached': servedFromCache});
@@ -129,7 +138,7 @@ class TtsTask extends Task {
               lastUpdated = true;
               updateSpeechCredentialLastUsed(credentials.speech_credential_sid).catch(() => {/* logged error */});
             }
-            if (!servedFromCache && rtt && !preCache) {
+            if (!servedFromCache && rtt && !preCache  && !this._disableTracing) {
               this.notifyStatus({
                 event: 'synthesized-audio',
                 vendor,
@@ -140,7 +149,7 @@ class TtsTask extends Task {
             }
           }
           else {
-            this.logger.debug('a streaming tts api will be used');
+            this.logger.debug('Say: a streaming tts api will be used');
             const modifiedPath = filePath.replace('say:{', `say:{session-uuid=${ep.uuid},`);
             return modifiedPath;
           }
@@ -152,9 +161,9 @@ class TtsTask extends Task {
             account_sid: cs.accountSid,
             alert_type: AlertType.TTS_FAILURE,
             vendor,
-            detail: err.message
+            detail: err.message,
+            target_sid: cs.callSid
           }).catch((err) => this.logger.info({err}, 'Error generating alert for tts failure'));
-          this.notifyError({msg: 'TTS error', details: err.message || err});
           throw err;
         }
       };
@@ -165,6 +174,7 @@ class TtsTask extends Task {
       this.logger.info(err, 'TaskSay:exec error');
       throw err;
     }
+
   }
 
   _validateURL(urlString) {

lib/utils/action-hook-delay.js

@@ -0,0 +1,168 @@
+const makeTask = require('../tasks/make_task');
+const Emitter = require('events');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+const {TaskName} = require('../utils/constants');
+const assert = require('assert');
+
+/**
+ * ActionHookDelayProcessor
+ * @extends Emitter
+ *
+ * @param {Object} logger - logger instance
+ * @param {Object} opts - options
+ * @param {Object} cs - call session
+ * @param {Object} ep - endpoint
+ *
+ * @emits {Event} 'giveup' - when associated giveup timer expires
+ *
+ * Ref:https://www.jambonz.org/docs/supporting-articles/handling-action-hook-delays/
+ */
+class ActionHookDelayProcessor extends Emitter {
+  constructor(logger, opts, cs) {
+    super();
+    this.logger = logger;
+    this.cs = cs;
+    this._active = false;
+
+    const enabled = this.init(opts);
+    if (enabled && (!this.actions || !Array.isArray(this.actions) || this.actions.length === 0)) {
+      throw new Error('ActionHookDelayProcessor: no actions specified');
+    }
+    else if (enabled && this.actions.some((a) => !a.verb || ![TaskName.Say, TaskName.Play].includes(a.verb))) {
+      throw new Error(`ActionHookDelayProcessor: invalid actions specified: ${JSON.stringify(this.actions)}`);
+    }
+  }
+
+  get properties() {
+    return {
+      actions: this.actions,
+      retries: this.retries,
+      noResponseTimeout: this.noResponseTimeout,
+      noResponseGiveUpTimeout: this.noResponseGiveUpTimeout
+    };
+  }
+
+  get ep() {
+    return this.cs.ep;
+  }
+
+  init(opts) {
+    this.logger.debug({opts}, 'ActionHookDelayProcessor#init');
+
+    this.actions = opts.actions;
+    this.retries = opts.retries || 0;
+    this.noResponseTimeout = opts.noResponseTimeout || 0;
+    this.noResponseGiveUpTimeout = opts.noResponseGiveUpTimeout;
+
+    // return false if these options actually disable the ahdp
+    return ('enable' in opts && opts.enable === true) ||
+      ('enabled' in opts && opts.enabled === true) ||
+      (!('enable' in opts) && !('enabled' in opts));
+  }
+
+  start() {
+    this.logger.debug('ActionHookDelayProcessor#start');
+    if (this._active) {
+      this.logger.debug('ActionHookDelayProcessor#start: already started due to prior gather which is continuing');
+      return;
+    }
+    assert(!this._noResponseTimer);
+    this._active = true;
+    this._retryCount = 0;
+    const timeoutMs =  this.noResponseTimeout === 0 ? 1 : this.noResponseTimeout * 1000;
+    this._noResponseTimer = setTimeout(this._onNoResponseTimer.bind(this), timeoutMs);
+
+    if (this.noResponseGiveUpTimeout > 0) {
+      const timeoutMs = this.noResponseGiveUpTimeout * 1000;
+      this._noResponseGiveUpTimer = setTimeout(this._onNoResponseGiveUpTimer.bind(this), timeoutMs);
+    }
+  }
+
+  async stop() {
+    this._active = false;
+
+    if (this._noResponseTimer) {
+      clearTimeout(this._noResponseTimer);
+      this._noResponseTimer = null;
+    }
+    if (this._noResponseGiveUpTimer) {
+      clearTimeout(this._noResponseGiveUpTimer);
+      this._noResponseGiveUpTimer = null;
+    }
+    if (this._taskInProgress) {
+      this.logger.debug(`ActionHookDelayProcessor#stop: stopping ${this._taskInProgress.name}`);
+
+      this._sayResolver = () => {
+        this.logger.debug('ActionHookDelayProcessor#stop: play/say is done, continue on..');
+        //this._taskInProgress.kill(this.cs);
+        this._taskInProgress = null;
+      };
+
+      /* we let Say finish, but interrupt Play */
+      if (TaskName.Play === this._taskInProgress.name) {
+        await this._taskInProgress.kill(this.cs);
+      }
+      return new Promise((resolve) => this._sayResolver = resolve);
+    }
+    this.logger.debug('ActionHookDelayProcessor#stop returning');
+  }
+
+  _onNoResponseTimer() {
+    this.logger.debug('ActionHookDelayProcessor#_onNoResponseTimer');
+    this._noResponseTimer = null;
+
+    /* get the next play or say action */
+    const verb = this.actions[this._retryCount % this.actions.length];
+
+    const t = normalizeJambones(this.logger, [verb]);
+    this.logger.debug({verb}, 'ActionHookDelayProcessor#_onNoResponseTimer: starting action');
+    try {
+      this._taskInProgress = makeTask(this.logger, t[0]);
+      this._taskInProgress.disableTracing = true;
+      this._taskInProgress.exec(this.cs, {ep: this.ep});
+    } catch (err) {
+      this.logger.info(err, 'ActionHookDelayProcessor#_onNoResponseTimer: error starting action');
+      this._taskInProgress = null;
+      return;
+    }
+
+    this.ep.once('playback-start', (evt) => {
+      this.logger.debug({evt}, 'got playback-start');
+      if (!this._active) {
+        this.logger.info({evt}, 'ActionHookDelayProcessor#_onNoResponseTimer: killing audio immediately');
+        this.ep.api('uuid_break', this.ep.uuid)
+          .catch((err) => this.logger.info(err,
+            'ActionHookDelayProcessor#_onNoResponseTimer Error killing audio'));
+      }
+    });
+
+    this.ep.once('playback-stop', (evt) => {
+      this._taskInProgress = null;
+      if (this._sayResolver) {
+        /* we were waiting for the play to finish before continuing to next task */
+        this.logger.debug({evt}, 'ActionHookDelayProcessor#_onNoResponseTimer got playback-stop');
+        this._sayResolver();
+        this._sayResolver = null;
+      }
+      else {
+        /* possibly start the no response timer again */
+        if (this._active && this.retries > 0 && this._retryCount < this.retries && this.noResponseTimeout > 0) {
+          this.logger.debug({evt}, 'ActionHookDelayProcessor#_onNoResponseTimer: playback-stop on play/say action');
+          const timeoutMs = this.noResponseTimeout * 1000;
+          this._noResponseTimer = setTimeout(this._onNoResponseTimer.bind(this), timeoutMs);
+        }
+      }
+    });
+
+    this._retryCount++;
+  }
+
+  _onNoResponseGiveUpTimer() {
+    this._active = false;
+    this.logger.info('ActionHookDelayProcessor#_onNoResponseGiveUpTimer');
+    this.stop().catch((err) => {});
+    this.emit('giveup');
+  }
+}
+
+module.exports = ActionHookDelayProcessor;

lib/utils/amd-utils.js

@@ -210,7 +210,8 @@ module.exports = (logger) => {
         account_sid: cs.accountSid,
         alert_type: AlertType.STT_FAILURE,
         vendor: vendor,
-        detail: err.message
+        detail: err.message,
+        target_sid: cs.callSid
       });
     }).catch((err) => logger.info({err}, 'Error generating alert for tts failure'));
 
@@ -245,7 +246,10 @@ module.exports = (logger) => {
     const amd = ep.amd = new Amd(logger, cs, opts);
     const {vendor, language} = amd;
     let sttCredentials = amd.sttCredentials;
-    const hints = voicemailHints[language] || [];
+    // hints from configuration might be too long for specific language and vendor that make transcribe freeswitch
+    // modules cannot connect to the vendor. hints is used in next step to validate if the transcription
+    // matchs voice mail hints.
+    const hints = [];
 
     if (vendor === 'nuance' && sttCredentials.client_id) {
       /* get nuance access token */

lib/utils/background-task-manager.js

@@ -117,6 +117,7 @@ class BackgroundTaskManager extends Emitter {
           this._taskCompleted('bargeIn', task);
           if (task.sticky && !this.cs.callGone && !this.cs._stopping) {
             this.logger.info('BackgroundTaskManager:_initBargeIn: restarting background bargeIn');
+            this._bargeInHandled = false;
             this.newTask('bargeIn', opts, true);
           }
           return;
@@ -186,6 +187,8 @@ class BackgroundTaskManager extends Emitter {
   }
 
   _bargeInTaskCompleted(evt) {
+    if (this._bargeInHandled) return;
+    this._bargeInHandled = true;
     this.logger.debug({evt},
       'BackgroundTaskManager:_bargeInTaskCompleted on event from background bargeIn, emitting bargein-done event');
     this.emit('bargeIn-done', evt);

lib/utils/db-utils.js

@@ -77,6 +77,7 @@ const speechMapper = (cred) => {
       const o = JSON.parse(decrypt(credential));
       obj.api_key = o.api_key;
       obj.deepgram_stt_uri = o.deepgram_stt_uri;
+      obj.deepgram_tts_uri = o.deepgram_tts_uri;
       obj.deepgram_stt_use_tls = o.deepgram_stt_use_tls;
     }
     else if ('soniox' === obj.vendor) {

lib/utils/install-srf-locals.js

@@ -12,6 +12,7 @@ const {
   JAMBONES_TIME_SERIES_HOST,
   JAMBONES_ESL_LISTEN_ADDRESS,
   PORT,
+  HTTP_IP,
   NODE_ENV,
 } = require('../config');
 const Registrar = require('@jambonz/mw-registrar');
@@ -193,7 +194,8 @@ function installSrfLocals(srf, logger) {
 
   let localIp;
   try {
-    localIp = ip.address();
+    // Either use the configured IP address or call ip.address() to find it
+    localIp = HTTP_IP || ip.address();
   } catch (err) {
     logger.error({err}, 'installSrfLocals - error detecting local ipv4 address');
   }

lib/utils/place-outdial.js

@@ -441,7 +441,7 @@ class SingleDialer extends Emitter {
     });
     app.requestor.request('session:adulting', '/adulting', {
       ...cs.callInfo.toJSON(),
-      parentCallInfo: this.parentCallInfo
+      parentCallInfo: this.parentCallInfo.toJSON()
     }).catch((err) => {
       newLogger.error({err}, 'doAdulting: error sending adulting request');
     });

lib/utils/transcription-utils.js

@@ -45,7 +45,8 @@ const stickyVars = {
     'DEEPGRAM_SPEECH_ENDPOINTING',
     'DEEPGRAM_SPEECH_UTTERANCE_END_MS',
     'DEEPGRAM_SPEECH_VAD_TURNOFF',
-    'DEEPGRAM_SPEECH_TAG'
+    'DEEPGRAM_SPEECH_TAG',
+    'DEEPGRAM_SPEECH_MODEL_VERSION'
   ],
   aws: [
     'AWS_VOCABULARY_NAME',
@@ -141,7 +142,6 @@ const optimalDeepramModels = {
   tr: ['nova-2', 'nova-2'],
   uk: ['nova-2', 'nova-2']
 };
-
 const selectDefaultDeepgramModel = (task, language) => {
   if (language in optimalDeepramModels) {
     const [gather, transcribe] = optimalDeepramModels[language];
@@ -150,6 +150,24 @@ const selectDefaultDeepgramModel = (task, language) => {
   return 'base';
 };
 
+const optimalGoogleModels = {
+  'v1' : {
+    'en-IN':['telephony', 'latest_long']
+  },
+  'v2' : {
+    'en-IN':['telephony', 'long']
+  }
+};
+const selectDefaultGoogleModel = (task, language, version) => {
+  const useV2 = version === 'v2';
+  if (language in optimalGoogleModels[version]) {
+    const [gather, transcribe] = optimalGoogleModels[version][language];
+    return task.name === TaskName.Gather ? gather : transcribe;
+  }
+  return task.name === TaskName.Gather ?
+    (useV2 ? 'telephony_short' : 'command_and_search') :
+    (useV2 ? 'long' : 'latest_long');
+};
 const consolidateTranscripts = (bufferedTranscripts, channel, language, vendor) => {
   if (bufferedTranscripts.length === 1) return bufferedTranscripts[0];
   let totalConfidence = 0;
@@ -316,8 +334,10 @@ const normalizeIbm = (evt, channel, language) => {
 
 const normalizeGoogle = (evt, channel, language) => {
   const copy = JSON.parse(JSON.stringify(evt));
+  const language_code = evt.language_code || language;
+
   return {
-    language_code: language,
+    language_code: language_code,
     channel_tag: channel,
     is_final: evt.is_final,
     alternatives: [evt.alternatives[0]],
@@ -376,6 +396,20 @@ const normalizeNuance = (evt, channel, language) => {
   };
 };
 
+const normalizeVerbio = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.is_final,
+    alternatives: evt.alternatives,
+    vendor: {
+      name: 'verbio',
+      evt: copy
+    }
+  };
+};
+
 const normalizeMicrosoft = (evt, channel, language, punctuation = true) => {
   const copy = JSON.parse(JSON.stringify(evt));
   const nbest = evt.NBest;
@@ -463,6 +497,8 @@ module.exports = (logger) => {
         return normalizeCobalt(evt, channel, language);
       case 'assemblyai':
         return normalizeAssemblyAi(evt, channel, language, shortUtterance);
+      case 'verbio':
+        return normalizeVerbio(evt, channel, language);
       default:
         if (vendor.startsWith('custom:')) {
           return normalizeCustom(evt, channel, language, vendor);
@@ -478,9 +514,9 @@ module.exports = (logger) => {
 
     if ('google' === vendor) {
       const useV2 = rOpts.googleOptions?.serviceVersion === 'v2';
-      const model = task.name === TaskName.Gather ?
-        (useV2 ? 'telephony_short' : 'command_and_search') :
-        (useV2 ? 'long' : 'latest_long');
+      const version = useV2 ? 'v2' : 'v1';
+      let {model} = rOpts;
+      model = model || selectDefaultGoogleModel(task, language, version);
       opts = {
         ...opts,
         ...(sttCredentials && {GOOGLE_APPLICATION_CREDENTIALS: JSON.stringify(sttCredentials.credentials)}),
@@ -574,6 +610,8 @@ module.exports = (logger) => {
           {AZURE_SPEECH_SEGMENTATION_SILENCE_TIMEOUT_MS: azureOptions.speechSegmentationSilenceTimeoutMs}),
         ...(azureOptions.languageIdMode &&
           {AZURE_LANGUAGE_ID_MODE: azureOptions.languageIdMode}),
+        ...(azureOptions.postProcessing &&
+          {AZURE_POST_PROCESSING_OPTION: azureOptions.postProcessing}),
         ...(sttCredentials && {
           ...(sttCredentials.api_key && {AZURE_SUBSCRIPTION_KEY: sttCredentials.api_key}),
           ...(sttCredentials.region && {AZURE_REGION: sttCredentials.region}),
@@ -689,7 +727,9 @@ module.exports = (logger) => {
         ...(deepgramOptions.vadTurnoff) &&
           {DEEPGRAM_SPEECH_VAD_TURNOFF: deepgramOptions.vadTurnoff},
         ...(deepgramOptions.tag) &&
-          {DEEPGRAM_SPEECH_TAG: deepgramOptions.tag}
+          {DEEPGRAM_SPEECH_TAG: deepgramOptions.tag},
+        ...(deepgramOptions.version) &&
+          {DEEPGRAM_SPEECH_MODEL_VERSION: deepgramOptions.version}
       };
     }
     else if ('soniox' === vendor) {
@@ -817,6 +857,7 @@ module.exports = (logger) => {
       };
     } else if (vendor.startsWith('custom:')) {
       let {options = {}} = rOpts;
+      const {sampleRate} = rOpts.customOptions || {};
       const {auth_token, custom_stt_url} = sttCredentials;
       options = {
         ...options,
@@ -824,14 +865,15 @@ module.exports = (logger) => {
         {hints: rOpts.hints}),
         ...(rOpts.hints?.length > 0 && typeof rOpts.hints[0] === 'object' &&
         {hints: JSON.stringify(rOpts.hints)}),
-        ...(typeof rOpts.hintsBoost === 'number' && {hintsBoost: rOpts.hintsBoost})
+        ...(typeof rOpts.hintsBoost === 'number' && {hintsBoost: rOpts.hintsBoost}),
+        ...(task.cs?.callSid && {callSid: task.cs.callSid})
       };
-
       opts = {
         ...opts,
         ...(auth_token && {JAMBONZ_STT_API_KEY: auth_token}),
         JAMBONZ_STT_URL: custom_stt_url,
         ...(Object.keys(options).length > 0 && {JAMBONZ_STT_OPTIONS: JSON.stringify(options)}),
+        ...(sampleRate && {JAMBONZ_STT_SAMPLING: sampleRate})
       };
     }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "main": "app.js",
   "engines": {
     "node": ">= 18.x"
@@ -27,14 +27,14 @@
   "dependencies": {
     "@aws-sdk/client-auto-scaling": "^3.549.0",
     "@aws-sdk/client-sns": "^3.549.0",
-    "@jambonz/db-helpers": "^0.9.3",
+    "@jambonz/db-helpers": "^0.9.6",
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "^0.2.7",
     "@jambonz/realtimedb-helpers": "^0.8.8",
-    "@jambonz/speech-utils": "^0.1.3",
+    "@jambonz/speech-utils": "^0.1.15",
     "@jambonz/stats-collector": "^0.1.10",
-    "@jambonz/time-series": "^0.2.8",
-    "@jambonz/verb-specifications": "^0.0.72",
+    "@jambonz/time-series": "^0.2.9",
+    "@jambonz/verb-specifications": "^0.0.76",
     "@opentelemetry/api": "^1.8.0",
     "@opentelemetry/exporter-jaeger": "^1.23.0",
     "@opentelemetry/exporter-trace-otlp-http": "^0.50.0",
@@ -47,7 +47,7 @@
     "bent": "^7.3.12",
     "debug": "^4.3.4",
     "deepcopy": "^2.1.0",
-    "drachtio-fsmrf": "^3.0.43",
+    "drachtio-fsmrf": "^3.0.45",
     "drachtio-srf": "^4.5.35",
     "express": "^4.19.2",
     "express-validator": "^7.0.1",
@@ -61,10 +61,10 @@
     "short-uuid": "^5.1.0",
     "sinon": "^17.0.1",
     "to-snake-case": "^1.0.0",
-    "undici": "^6.15.0",
+    "undici": "^6.19.4",
     "uuid-random": "^1.3.2",
     "verify-aws-sns-signature": "^0.1.0",
-    "ws": "^8.17.0",
+    "ws": "^8.18.0",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {

test/docker-compose-testbed.yaml

@@ -57,7 +57,7 @@ services:
         condition: service_healthy
 
   freeswitch:
-    image: drachtio/drachtio-freeswitch-mrf:0.7.3
+    image: drachtio/drachtio-freeswitch-mrf:latest
     restart: always
     command: freeswitch --rtp-range-start 20000 --rtp-range-end 20100
     environment: