minor logging

* initial WIP to remove freeswitch from media path when not recording or transcribing dial calls

* implement release-media and anchor-media operations

* mute/unmute now handled by rtpengine

* Dial: dtmf detection now based on SIP INFO events from sbcs and rtpengine

* add reason to gather action, bugfixes for transcribe and say

.eslintrc.json

@@ -8,7 +8,7 @@
       "jsx": false,
       "modules": false
     },
-    "ecmaVersion": 2018
+    "ecmaVersion": 2020
   },
   "plugins": ["promise"],
   "rules": {

Dockerfile

@@ -1,16 +1,10 @@
-FROM node:alpine as builder
-RUN apk update && apk add --no-cache python make g++
+FROM node:16
 WORKDIR /opt/app/
 COPY package.json ./
 RUN npm install
 RUN npm prune
-
-FROM node:alpine as app
-WORKDIR /opt/app
 COPY . /opt/app
-COPY --from=builder /opt/app/node_modules ./node_modules
-
 ARG NODE_ENV
 ENV NODE_ENV $NODE_ENV
 
-CMD [ "npm", "start" ]
+CMD [ "npm", "start" ]

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

@@ -57,6 +57,11 @@ router.post('/', async(req, res) => {
       case 'user':
         uri = `sip:${target.name}`;
         to = target.name;
+        if (target.overrideTo) {
+          Object.assign(opts.headers, {
+            'X-Override-To': target.overrideTo
+          });
+        }
         break;
       case 'sip':
         uri = target.sipUri;
@@ -105,8 +110,11 @@ router.post('/', async(req, res) => {
 
     /* now launch the outdial */
     try {
-      const dlg = await srf.createUAC(uri, opts, {
+      const dlg = await srf.createUAC(uri, {...opts,  followRedirects: true, keepUriOnRedirect: true}, {
         cbRequest: (err, inviteReq) => {
+          /* in case of 302 redirect, this gets called twice, ignore the second */
+          if (res.headersSent) return;
+
           if (err) {
             logger.error(err, 'createCall Error creating call');
             res.status(500).send('Call Failure');

lib/middleware.js

@@ -45,7 +45,7 @@ module.exports = function(srf, logger) {
         // TODO: alert
         return res.send(503, {headers: {'X-Reason': 'Account exists but is inactive'}});
       }
-      logger.debug({accountInfo: req.locals.accountInfo}, `retrieved account info for ${account_sid}`);
+      logger.debug({accountInfo: req.locals?.accountInfo?.account}, `retrieved account info for ${account_sid}`);
       next();
     } catch (err) {
       logger.info({err}, `Error retrieving account details for account ${account_sid}`);
@@ -137,7 +137,9 @@ module.exports = function(srf, logger) {
       const obj = Object.assign({}, app);
       delete obj.requestor;
       delete obj.notifier;
-      logger.info({app: obj}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
+      // eslint-disable-next-line no-unused-vars
+      const {call_hook, call_status_hook, ...appInfo} = obj;  // mask sensitive data like user/pass on webhook
+      logger.info({app: appInfo}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
       req.locals.callInfo = new CallInfo({req, app, direction: CallDirection.Inbound});
       next();
     } catch (err) {
@@ -167,7 +169,7 @@ module.exports = function(srf, logger) {
       if (0 === app.tasks.length) throw new Error('no application provided');
       next();
     } catch (err) {
-      logger.info(`Error retrieving or parsing application: ${err.message}`);
+      logger.info({err}, `Error retrieving or parsing application: ${err.message}`);
       res.send(480, {headers: {'X-Reason': err.message}});
     }
   }

lib/session/adulting-call-session.js

@@ -8,13 +8,14 @@ const CallSession = require('./call-session');
 
  */
 class AdultingCallSession extends CallSession {
-  constructor({logger, application, singleDialer, tasks, callInfo}) {
+  constructor({logger, application, singleDialer, tasks, callInfo, accountInfo}) {
     super({
       logger,
       application,
       srf: singleDialer.dlg.srf,
       tasks,
-      callInfo
+      callInfo,
+      accountInfo
     });
     this.sd = singleDialer;
 

lib/session/call-session.js

@@ -1,15 +1,22 @@
 const Emitter = require('events');
 const fs = require('fs');
-const {CallDirection, TaskPreconditions, CallStatus, TaskName} = require('../utils/constants');
+const {CallDirection, TaskPreconditions, CallStatus, TaskName, KillReason} = require('../utils/constants');
 const moment = require('moment');
 const assert = require('assert');
 const sessionTracker = require('./session-tracker');
 const makeTask = require('../tasks/make_task');
 const normalizeJambones = require('../utils/normalize-jambones');
 const listTaskNames = require('../utils/summarize-tasks');
+const Requestor = require('../utils/requestor');
 const BADPRECONDITIONS = 'preconditions not met';
 const CALLER_CANCELLED_ERR_MSG = 'Response not sent due to unknown transaction';
 
+const sqlRetrieveQueueEventHook = `SELECT * FROM webhooks 
+WHERE webhook_sid = 
+(
+  SELECT queue_event_hook_sid FROM accounts where account_sid = ?
+)`;
+
 /**
  * @classdesc Represents the execution context for a call.
  * It holds the resources, such as the sip dialog and media server endpoint
@@ -27,7 +34,7 @@ class CallSession extends Emitter {
    * @param {array} opts.tasks - tasks we are to execute
    * @param {callInfo} opts.callInfo - information about the call
    */
-  constructor({logger, application, srf, tasks, callInfo, accountInfo}) {
+  constructor({logger, application, srf, tasks, callInfo, accountInfo, memberId, confName, confUuid}) {
     super();
     this.logger = logger;
     this.application = application;
@@ -35,6 +42,9 @@ class CallSession extends Emitter {
     this.callInfo = callInfo;
     this.accountInfo = accountInfo;
     this.tasks = tasks;
+    this.memberId = memberId;
+    this.confName = confName;
+    this.confUuid = confUuid;
     this.taskIdx = 0;
     this.stackIdx = 0;
     this.callGone = false;
@@ -49,6 +59,8 @@ class CallSession extends Emitter {
     if (!this.isConfirmCallSession && !this.isSmsCallSession && !this.isAdultingCallSession) {
       sessionTracker.add(this.callSid, this);
     }
+
+    this._pool = srf.locals.dbHelpers.pool;
   }
 
   /**
@@ -183,13 +195,37 @@ class CallSession extends Emitter {
     return this.constructor.name === 'SmsCallSession';
   }
 
+  get webhook_secret() {
+    return this.accountInfo?.account?.webhook_secret;
+  }
+
+  get isInConference() {
+    return this.memberId && this.confName && this.confUuid;
+  }
+
+  setConferenceDetails(memberId, confName, confUuid) {
+    assert(!this.memberId && !this.confName && !this.confUuid);
+    assert (memberId && confName && confUuid);
+
+    this.logger.debug(`session is now in conference ${confName}:${memberId} - uuid ${confUuid}`);
+    this.memberId = memberId;
+    this.confName = confName;
+    this.confUuid = confUuid;
+  }
+
+  clearConferenceDetails() {
+    this.logger.debug(`session has now left conference ${this.confName}:${this.memberId}`);
+    this.memberId = null;
+    this.confName = null;
+    this.confUuid = null;
+  }
+
   /**
    * Check for speech credentials for the specified vendor
    * @param {*} vendor - google or aws
    */
   getSpeechCredentials(vendor, type) {
     const {writeAlerts, AlertType} = this.srf.locals;
-    this.logger.debug({vendor, type, speech: this.accountInfo.speech}, `searching for speech for vendor ${vendor}`);
     if (this.accountInfo.speech && this.accountInfo.speech.length > 0) {
       const credential = this.accountInfo.speech.find((s) => s.vendor === vendor);
       if (credential && (
@@ -221,6 +257,13 @@ class CallSession extends Emitter {
             region: process.env.AWS_REGION || credential.aws_region
           };
         }
+        else if ('microsoft' === vendor) {
+          return {
+            speech_credential_sid: credential.speech_credential_sid,
+            api_key: credential.api_key,
+            region: credential.region
+          };
+        }
       }
       else {
         writeAlerts({
@@ -327,7 +370,7 @@ class CallSession extends Emitter {
    */
   _lccCallStatus(opts) {
     if (opts.call_status === CallStatus.Completed && this.dlg) {
-      this.logger.info('CallSession:updateCall hanging up call due to request from api');
+      this.logger.info('CallSession:_lccCallStatus hanging up call due to request from api');
       this._callerHungup();
     }
     else if (opts.call_status === CallStatus.NoAnswer) {
@@ -355,13 +398,13 @@ class CallSession extends Emitter {
   async _lccCallHook(opts) {
     const webhooks = [];
     let sd;
-    if (opts.call_hook) webhooks.push(this.requestor.request(opts.call_hook, this.callInfo));
+    if (opts.call_hook) webhooks.push(this.requestor.request(opts.call_hook, this.callInfo.toJSON()));
     if (opts.child_call_hook) {
       /* child call hook only allowed from a connected Dial state */
       const task = this.currentTask;
       sd = task.sd;
       if (task && TaskName.Dial === task.name && sd) {
-        webhooks.push(this.requestor.request(opts.child_call_hook, sd.callInfo));
+        webhooks.push(this.requestor.request(opts.child_call_hook, sd.callInfo.toJSON()));
       }
     }
     const [tasks1, tasks2] = await Promise.all(webhooks);
@@ -376,7 +419,7 @@ class CallSession extends Emitter {
       const {parentLogger} = this.srf.locals;
       const childLogger = parentLogger.child({callId: this.callId, callSid: sd.callSid});
       const t = normalizeJambones(childLogger, childTasks).map((tdata) => makeTask(childLogger, tdata));
-      childLogger.info({tasks: listTaskNames(t)}, 'CallSession:updateCall new task list for child call');
+      childLogger.info({tasks: listTaskNames(t)}, 'CallSession:_lccCallHook new task list for child call');
       const cs = await sd.doAdulting({
         logger: childLogger,
         application: this.application,
@@ -388,12 +431,12 @@ class CallSession extends Emitter {
     }
     if (tasks) {
       const t = normalizeJambones(this.logger, tasks).map((tdata) => makeTask(this.logger, tdata));
-      this.logger.info({tasks: listTaskNames(t)}, 'CallSession:updateCall new task list');
+      this.logger.info({tasks: listTaskNames(t)}, 'CallSession:_lccCallHook new task list');
       this.replaceApplication(t);
     }
     else {
       /* we started a new app on the child leg, but nothing given for parent so hang him up */
-      this.currentTask.kill();
+      this.currentTask.kill(this);
     }
   }
 
@@ -405,23 +448,39 @@ class CallSession extends Emitter {
   async _lccListenStatus(opts) {
     const task = this.currentTask;
     if (!task || ![TaskName.Dial, TaskName.Listen].includes(task.name)) {
-      return this.logger.info(`CallSession:updateCall - invalid listen_status in task ${task.name}`);
+      return this.logger.info(`CallSession:_lccListenStatus - invalid listen_status in task ${task.name}`);
     }
     const listenTask = task.name === TaskName.Listen ? task : task.listenTask;
     if (!listenTask) {
-      return this.logger.info('CallSession:updateCall - invalid listen_status: Dial does not have a listen');
+      return this.logger.info('CallSession:_lccListenStatus - invalid listen_status: Dial does not have a listen');
     }
     listenTask.updateListen(opts.listen_status);
   }
 
   async _lccMuteStatus(callSid, mute) {
-    // this whole thing requires us to be in a Dial verb
+    // this whole thing requires us to be in a Dial or Conference verb
     const task = this.currentTask;
-    if (!task || TaskName.Dial !== task.name) {
-      return this.logger.info('CallSession:_lccMute - invalid command as dial is not active');
+    if (!task || ![TaskName.Dial, TaskName.Conference].includes(task.name)) {
+      return this.logger.info('CallSession:_lccMuteStatus - invalid: neither dial nor conference are not active');
     }
-    // now do the whisper
-    task.mute(callSid, mute).catch((err) => this.logger.error(err, 'CallSession:_lccMute'));
+    // now do the mute/unmute
+    task.mute(callSid, mute).catch((err) => this.logger.error(err, 'CallSession:_lccMuteStatus'));
+  }
+
+  async _lccConfHoldStatus(callSid, opts) {
+    const task = this.currentTask;
+    if (!task || TaskName.Conference !== task.name || !this.isInConference) {
+      return this.logger.info('CallSession:_lccConfHoldStatus - invalid command as call is not in conference');
+    }
+    task.doConferenceHold(this, opts);
+  }
+
+  async _lccConfMuteStatus(callSid, opts) {
+    const task = this.currentTask;
+    if (!task || TaskName.Conference !== task.name || !this.isInConference) {
+      return this.logger.info('CallSession:_lccConfHoldStatus - invalid command as call is not in conference');
+    }
+    task.doConferenceMuteNonModerators(this, opts);
   }
 
   /**
@@ -441,7 +500,7 @@ class CallSession extends Emitter {
     // allow user to provide a url object, a url string, an array of tasks, or a single task
     if (typeof whisper === 'string' || (typeof whisper === 'object' && whisper.url)) {
       // retrieve a url
-      const json = await this.requestor(opts.call_hook, this.callInfo);
+      const json = await this.requestor(opts.call_hook, this.callInfo.toJSON());
       tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
     }
     else if (Array.isArray(whisper)) {
@@ -472,20 +531,6 @@ class CallSession extends Emitter {
     task.whisper(tasks, callSid).catch((err) => this.logger.error(err, 'CallSession:_lccWhisper'));
   }
 
-  /**
-   * perform live call control -- mute or unmute an endpoint
-   * @param {array} opts - array of play or say tasks
-   */
-  async _lccMute(callSid, mute) {
-
-    // this whole thing requires us to be in a Dial verb
-    const task = this.currentTask;
-    if (!task || TaskName.Dial !== task.name) {
-      return this.logger.info('CallSession:_lccMute - not possible since we are not in a dial');
-    }
-
-    task.mute(callSid, mute).catch((err) => this.logger.error(err, 'CallSession:_lccMute'));
-  }
 
   /**
    * perform live call control
@@ -507,6 +552,12 @@ class CallSession extends Emitter {
     else if (opts.mute_status) {
       await this._lccMuteStatus(callSid, opts.mute_status === 'mute');
     }
+    else if (opts.conf_hold_status) {
+      await this._lccConfHoldStatus(callSid, opts);
+    }
+    else if (opts.conf_mute_status) {
+      await this._lccConfMuteStatus(callSid, opts);
+    }
 
     // whisper may be the only thing we are asked to do, or it may that
     // we are doing a whisper after having muted, paused reccording etc..
@@ -530,7 +581,7 @@ class CallSession extends Emitter {
     this.logger.info({tasks: listTaskNames(tasks)},
       `CallSession:replaceApplication reset with ${tasks.length} new tasks, stack depth is ${this.stackIdx}`);
     if (this.currentTask) {
-      this.currentTask.kill();
+      this.currentTask.kill(this, KillReason.Replaced);
       this.currentTask = null;
     }
   }
@@ -539,7 +590,7 @@ class CallSession extends Emitter {
     if (this.isConfirmCallSession) this.logger.debug('CallSession:kill (ConfirmSession)');
     else this.logger.info('CallSession:kill');
     if (this.currentTask) {
-      this.currentTask.kill();
+      this.currentTask.kill(this);
       this.currentTask = null;
     }
     this.tasks = [];
@@ -759,6 +810,42 @@ class CallSession extends Emitter {
     return {ms: this.ms, ep: this.ep};
   }
 
+  /**
+   * If account was queue event webhook, send notification
+   * @param {*} obj - data to notify
+   */
+  async performQueueWebhook(obj) {
+    if (typeof this.queueEventHookRequestor === 'undefined') {
+      const pp = this._pool.promise();
+      try {
+        this.logger.info({accountSid: this.accountSid}, 'performQueueWebhook: looking up account');
+        const [r] = await pp.query(sqlRetrieveQueueEventHook, this.accountSid);
+        if (0 === r.length) {
+          this.logger.info({accountSid: this.accountSid}, 'performQueueWebhook: no webhook provisioned');
+          this.queueEventHookRequestor = null;
+        }
+        else {
+          this.logger.info({accountSid: this.accountSid, webhook: r[0]}, 'performQueueWebhook: webhook found');
+          this.queueEventHookRequestor = new Requestor(this.logger, this.accountSid,
+            r[0], this.webhook_secret);
+          this.queueEventHook = r[0];
+        }
+      } catch (err) {
+        this.logger.error({err, accountSid: this.accountSid}, 'Error retrieving event hook');
+        this.queueEventHookRequestor = null;
+      }
+    }
+    if (null === this.queueEventHookRequestor) return;
+
+    /* send webhook */
+    const params =  {...obj, ...this.callInfo.toJSON()};
+    this.logger.info({accountSid: this.accountSid, params}, 'performQueueWebhook: sending webhook');
+    this.queueEventHookRequestor.request(this.queueEventHook, params)
+      .catch((err) => {
+        this.logger.info({err, accountSid: this.accountSid, obj}, 'Error sending queue notification event');
+      });
+  }
+
   /**
    * A conference that the current task is waiting on has just started
    * @param {*} opts
@@ -846,6 +933,28 @@ class CallSession extends Emitter {
     };
   }
 
+  async releaseMediaToSBC(remoteSdp) {
+    assert(this.dlg && this.dlg.connected && this.ep && typeof remoteSdp === 'string');
+    await this.dlg.modify(remoteSdp, {
+      headers: {
+        'X-Reason': 'release-media'
+      }
+    });
+    this.ep.destroy()
+      .then(() => this.ep = null)
+      .catch((err) => this.logger.error({err}, 'CallSession:releaseMediaToSBC: Error destroying endpoint'));
+  }
+
+  async reAnchorMedia() {
+    assert(this.dlg && this.dlg.connected && !this.ep);
+    this.ep = await this.ms.createEndpoint({remoteSdp: this.dlg.remote.sdp});
+    await this.dlg.modify(this.ep.local.sdp, {
+      headers: {
+        'X-Reason': 'anchor-media'
+      }
+    });
+  }
+
   /**
    * Called any time call status changes.  This method both invokes the
    * call_status_hook callback as well as updates the realtime database
@@ -865,14 +974,14 @@ class CallSession extends Emitter {
     this.callInfo.updateCallStatus(callStatus, sipStatus);
     if (typeof duration === 'number') this.callInfo.duration = duration;
     try {
-      this.notifier.request(this.call_status_hook, this.callInfo);
+      this.notifier.request(this.call_status_hook, this.callInfo.toJSON());
     } catch (err) {
       this.logger.info(err, `CallSession:_notifyCallStatusChange error sending ${callStatus} ${sipStatus}`);
     }
 
     // update calls db
     //this.logger.debug(`updating redis with ${JSON.stringify(this.callInfo)}`);
-    this.updateCallStatus(Object.assign({}, this.callInfo), this.serviceUrl)
+    this.updateCallStatus(Object.assign({}, this.callInfo.toJSON()), this.serviceUrl)
       .catch((err) => this.logger.error(err, 'redis error'));
   }
 }

lib/session/confirm-call-session.js

@@ -8,14 +8,17 @@ const CallSession = require('./call-session');
 
  */
 class ConfirmCallSession extends CallSession {
-  constructor({logger, application, dlg, ep, tasks, callInfo}) {
+  constructor({logger, application, dlg, ep, tasks, callInfo, accountInfo, memberId, confName}) {
     super({
       logger,
       application,
       srf: dlg.srf,
       callSid: dlg.callSid,
       tasks,
-      callInfo
+      callInfo,
+      accountInfo,
+      memberId,
+      confName
     });
     this.dlg = dlg;
     this.ep = ep;

lib/tasks/conference.js

@@ -10,6 +10,7 @@ const WAIT = 'wait';
 const JOIN = 'join';
 const START = 'start';
 
+
 function confNoMatch(str) {
   return str.match(/^No active conferences/) || str.match(/Conference.*not found/);
 }
@@ -27,7 +28,8 @@ function camelize(str) {
 
 function unhandled(logger, cs, evt) {
   this.participantCount = parseInt(evt.getHeader('Conference-Size'));
-  logger.debug({evt}, `unhandled conference event: ${evt.getHeader('Action')}`) ;
+  // logger.debug({evt}, `unhandled conference event: ${evt.getHeader('Action')}`) ;
+  logger.debug(`unhandled conference event: ${evt.getHeader('Action')}`) ;
 }
 
 function capitalize(s) {
@@ -45,10 +47,10 @@ class Conference extends Task {
 
     this.confName = this.data.name;
     [
-      'beep', 'startConferenceOnEnter', 'endConferenceOnExit',
+      'beep', 'startConferenceOnEnter', 'endConferenceOnExit', 'joinMuted',
       'maxParticipants', 'waitHook', 'statusHook', 'endHook', 'enterHook'
     ].forEach((attr) => this[attr] = this.data[attr]);
-
+    this.record = this.data.record || {};
     this.statusEvents = [];
     if (this.statusHook) {
       ['start', 'end', 'join', 'leave', 'start-talking', 'stop-talking'].forEach((e) => {
@@ -67,6 +69,9 @@ class Conference extends Task {
 
   get name() { return TaskName.Conference; }
 
+  get shouldRecord() { return this.record.path; }
+  get isRecording() { return this.recordingInProgress; }
+
   async exec(cs, ep) {
     await super.exec(cs);
     this.ep = ep;
@@ -213,6 +218,7 @@ class Conference extends Task {
             this._playSession.kill();
             this._playSession = null;
           }
+          cs.clearConferenceDetails();
           resolve();
         });
 
@@ -330,15 +336,30 @@ class Conference extends Task {
 
     const opts = {};
     if (this.endConferenceOnExit) Object.assign(opts, {flags: {endconf: true}});
+    if (this.startConferenceOnEnter) Object.assign(opts, {flags: {moderator: true}});
+    if (this.joinMuted) Object.assign(opts, {flags: {mute: true}});
+
     try {
       const {memberId, confUuid} = await this.ep.join(this.confName, opts);
       this.logger.debug({memberId, confUuid}, `Conference:_joinConference: successfully joined ${this.confName}`);
       this.memberId = memberId;
       this.confUuid = confUuid;
+
+      cs.setConferenceDetails(memberId, this.confName, confUuid);
       const response = await this.ep.api('conference', [this.confName, 'get', 'count']);
       if (response.body && /\d+/.test(response.body)) this.participantCount = parseInt(response.body);
       this._notifyConferenceEvent(cs, 'join');
 
+      // start recording if requested and we just started the conference
+      if (startConf && this.shouldRecord) {
+        this.logger.info(`recording conference to ${this.record.path}`);
+        try {
+          await this.ep.api(`conference ${this.confName} record ${this.record.path}`);
+        } catch (err) {
+          this.logger.info({err}, 'Conference:_joinConference - failed to start recording');
+        }
+      }
+
       // listen for conference events
       this.ep.filter('Conference-Unique-ID', this.confUuid);
       this.ep.conn.on('esl::event::CUSTOM::*', this.__onConferenceEvent.bind(this, cs)) ;
@@ -356,7 +377,7 @@ class Conference extends Task {
     }
 
     if (typeof this.maxParticipants === 'number' && this.maxParticipants > 1) {
-      this.endpoint.api('conference', `${this.confName} set max_members ${this.maxParticipants}`)
+      this.ep.api('conference', `${this.confName} set max_members ${this.maxParticipants}`)
         .catch((err) => this.logger.error(err, `Error setting max participants to ${this.maxParticipants}`));
     }
   }
@@ -371,9 +392,70 @@ class Conference extends Task {
    */
   notifyStartConference(cs, opts) {
     this.logger.info({opts}, `Conference:notifyStartConference: conference ${this.confName} has now started`);
+    this.conferenceStartTime = new Date();
     this.emitter.emit('join', opts);
   }
 
+  async doConferenceMuteNonModerators(cs, opts) {
+    const mute = opts.conf_mute_status === 'mute';
+    assert (cs.isInConference);
+
+    this.logger.info(`Conference:doConferenceMuteNonModerators ${mute ? 'muting' : 'unmuting'} non-moderators`);
+    this.ep.api(`conference ${this.confName} ${mute ? 'mute' : 'unmute'} non_moderator`)
+      .catch((err) => this.logger.info({err}, 'Error muting or unmuting non_moderators'));
+
+    if (this.conf_hold_status !== 'hold' && this._playSession) {
+      this._playSession.kill();
+      this._playSession = null;
+    }
+  }
+
+  async doConferenceHold(cs, opts) {
+    assert (cs.isInConference);
+
+    const {conf_hold_status, wait_hook} = opts;
+    let hookOnly = true;
+
+    if (this.conf_hold_status !== conf_hold_status) {
+      hookOnly = false;
+      this.conf_hold_status = conf_hold_status;
+      const hold = conf_hold_status === 'hold';
+
+      this.ep.api(`conference ${this.confName} ${hold ? 'mute' : 'unmute'} ${this.memberId}`)
+        .catch((err) => this.logger.info({err}, 'Error muting or unmuting participant'));
+      this.ep.api(`conference ${this.confName} ${hold ? 'deaf' : 'undeaf'} ${this.memberId}`)
+        .catch((err) => this.logger.info({err}, 'Error deafing or undeafing participant'));
+    }
+
+    if (hookOnly && this._playSession) {
+      this._playSession.kill();
+      this._playSession = null;
+    }
+    if (wait_hook && this.conf_hold_status === 'hold') {
+      const {dlg} = cs;
+      this._doWaitHookWhileOnHold(cs, dlg, wait_hook);
+    }
+    else if (this.conf_hold_status !== 'hold' && this._playSession) {
+      this._playSession.kill();
+      this._playSession = null;
+    }
+  }
+
+  async _doWaitHookWhileOnHold(cs, dlg, wait_hook) {
+    do {
+      try {
+        const tasks = await this._playHook(cs, dlg, wait_hook);
+        if (0 === tasks.length) break;
+      } catch (err) {
+        if (!this.killed) {
+          this.logger.info(err, `Conference:_doWait: failed retrieving wait_hook for ${this.confName}`);
+        }
+        this._playSession = null;
+        break;
+      }
+    } while (!this.killed && !this.conf_hold_status === 'hold');
+  }
+
   /**
    * Add ourselves to the waitlist of sessions to be notified once
    * the conference starts
@@ -448,22 +530,25 @@ class Conference extends Task {
   async _playHook(cs, dlg, hook, allowed = [TaskName.Play, TaskName.Say, TaskName.Pause]) {
     assert(!this._playSession);
     const json = await cs.application.requestor.request(hook, cs.callInfo);
+    const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
 
-    const allowedTasks = json.filter((task) => allowed.includes(task.verb));
-    if (json.length !== allowedTasks.length) {
-      this.logger.debug({json, allowedTasks}, 'unsupported task');
-      throw new Error(`unsupported verb in dial conference wait/enterHook: only ${JSON.stringify(allowed)}`);
+    const allowedTasks = tasks.filter((t) => allowed.includes(t.name));
+    if (tasks.length !== allowedTasks.length) {
+      this.logger.debug({tasks, allowedTasks}, 'unsupported task');
+      throw new Error(`unsupported verb in conference waitHook: only ${JSON.stringify(allowed)}`);
     }
-    this.logger.debug(`Conference:_playHook: executing ${json.length} tasks`);
+    this.logger.debug(`Conference:_playHook: executing ${tasks.length} tasks`);
 
-    if (json.length > 0) {
-      const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+    if (tasks.length > 0) {
       this._playSession = new ConfirmCallSession({
         logger: this.logger,
         application: cs.application,
         dlg,
         ep: cs.ep,
         callInfo: cs.callInfo,
+        accountInfo: cs.accountInfo,
+        memberId: this.memberId,
+        confName: this.confName,
         tasks
       });
       await this._playSession.exec();
@@ -484,6 +569,7 @@ class Conference extends Task {
   }
 
   async replaceEndpointAndEnd(cs) {
+    cs.clearConferenceDetails();
     if (this.replaced) return;
     this.replaced = true;
     try {
@@ -514,9 +600,6 @@ class Conference extends Task {
       const functionName = `_on${capitalize(camelize(action))}`;
       (Conference.prototype[functionName] || unhandled).bind(this, this.logger, cs, evt)() ;
     }
-    else {
-      this.logger.debug(`Conference#__onConferenceEvent: got unhandled custom event: ${eventName}`) ;
-    }
   }
 
   // conference event handlers

lib/tasks/dequeue.js

@@ -110,7 +110,8 @@ class TaskDequeue extends Task {
           event: 'dequeue',
           dequeueSipAddress: cs.srf.locals.localSipAddress,
           epUuid: ep.uuid,
-          notifyUrl: getUrl(cs)
+          notifyUrl: getUrl(cs),
+          dequeuer: cs.callInfo.toJSON()
         });
         this.logger.info(`TaskDequeue:_dequeueUrl successfully sent POST to ${url}`);
         bridgeTimer = setTimeout(() => reject(new Error('bridge timeout')), 20000);

lib/tasks/dial.js

@@ -1,6 +1,13 @@
 const Task = require('./task');
 const makeTask = require('./make_task');
-const {CallStatus, CallDirection, TaskName, TaskPreconditions, MAX_SIMRINGS} = require('../utils/constants');
+const {
+  CallStatus,
+  CallDirection,
+  TaskName,
+  TaskPreconditions,
+  MAX_SIMRINGS,
+  KillReason
+} = require('../utils/constants');
 const assert = require('assert');
 const placeCall = require('../utils/place-outdial');
 const sessionTracker = require('../session/session-tracker');
@@ -123,6 +130,10 @@ class TaskDial extends Task {
 
   get name() { return TaskName.Dial; }
 
+  get canReleaseMedia() {
+    return !process.env.ANCHOR_MEDIA_ALWAYS && !this.listenTask && !this.transcribeTask;
+  }
+
   async exec(cs) {
     await super.exec(cs);
     try {
@@ -135,22 +146,27 @@ class TaskDial extends Task {
           this.epOther.play(this.dialMusic).catch((err) => {});
         }
       }
-      if (this.epOther) this._installDtmfDetection(cs, this.epOther, this.parentDtmfCollector);
       await this._attemptCalls(cs);
       await this.awaitTaskDone();
-      await this.performAction(this.results);
-      if (this.epOther) this._removeDtmfDetection(cs, this.epOther);
-      this._removeDtmfDetection(cs, this.ep);
+      this.logger.debug({callSid: this.cs.callSid}, 'Dial:exec task is done, sending actionHook if any');
+      await this.performAction(this.results, this.killReason !== KillReason.Replaced);
+      this._removeDtmfDetection(cs.dlg);
+      this._removeDtmfDetection(this.dlg);
     } catch (err) {
       this.logger.error({err}, 'TaskDial:exec terminating with error');
       this.kill(cs);
     }
   }
 
-  async kill(cs) {
+  async kill(cs, reason) {
     super.kill(cs);
-    if (this.epOther) this._removeDtmfDetection(this.cs, this.epOther);
-    this._removeDtmfDetection(this.cs, this.ep);
+    this.killReason = reason || KillReason.Hangup;
+    if (this.timerMaxCallDuration) {
+      clearTimeout(this.timerMaxCallDuration);
+      this.timerMaxCallDuration = null;
+    }
+    this._removeDtmfDetection(cs.dlg);
+    this._removeDtmfDetection(this.dlg);
     this._killOutdials();
     if (this.sd) {
       this.sd.kill();
@@ -159,7 +175,6 @@ class TaskDial extends Task {
     if (this.callSid) sessionTracker.remove(this.callSid);
     if (this.listenTask) await this.listenTask.kill(cs);
     if (this.transcribeTask) await this.transcribeTask.kill(cs);
-    if (this.timerMaxCallDuration) clearTimeout(this.timerMaxCallDuration);
     this.notifyTaskDone();
   }
 
@@ -168,9 +183,14 @@ class TaskDial extends Task {
    * @param {*} tasks - array of play/say tasks to execute
    */
   async whisper(tasks, callSid) {
-    if (!this.epOther || !this.ep) return this.logger.info('Dial:whisper: no paired endpoint found');
     try {
       const cs = this.callSession;
+      if (!this.ep && !this.epOther) {
+        await this.reAnchorMedia(this.callSession, this.sd);
+      }
+
+      if (!this.epOther || !this.ep) return this.logger.info('Dial:whisper: no paired endpoint found');
+
       this.logger.debug('Dial:whisper unbridging endpoints');
       await this.epOther.unbridge();
       this.logger.debug('Dial:whisper executing tasks');
@@ -179,7 +199,12 @@ class TaskDial extends Task {
         await task.exec(cs, callSid === this.callSid ? this.ep : this.epOther);
       }
       this.logger.debug('Dial:whisper tasks complete');
-      if (!cs.callGone && this.epOther) this.epOther.bridge(this.ep);
+      if (!cs.callGone && this.epOther) {
+
+        /* if we can release the media back to the SBC, do so now */
+        if (this.canReleaseMedia) this._releaseMedia(cs, this.sd);
+        else this.epOther.bridge(this.ep);
+      }
     } catch (err) {
       this.logger.error(err, 'Dial:whisper error');
     }
@@ -189,14 +214,19 @@ class TaskDial extends Task {
    * mute or unmute one side of the call
    */
   async mute(callSid, doMute) {
-    if (!this.epOther || !this.ep) return this.logger.info('Dial:mute: no paired endpoint found');
+    const parentCall = callSid !== this.callSid;
+    const dlg = parentCall ? this.callSession.dlg : this.dlg;
+    const hdr = `${doMute ? 'mute' : 'unmute'} call leg`;
     try {
-      const parentCall = callSid !== this.callSid;
-      const ep = parentCall ? this.epOther : this.ep;
-      await ep[doMute ? 'mute' : 'unmute']();
-      this.logger.debug(`Dial:mute ${doMute ? 'muted' : 'unmuted'} ${parentCall ? 'parentCall' : 'childCall'}`);
+      /* let rtpengine do the mute / unmute */
+      await dlg.request({
+        method: 'INFO',
+        headers: {
+          'X-Reason': hdr
+        }
+      });
     } catch (err) {
-      this.logger.error(err, 'Dial:mute error');
+      this.logger.info({err}, `Dial:mute - ${hdr} error`);
     }
   }
 
@@ -208,35 +238,39 @@ class TaskDial extends Task {
     this.dials.clear();
   }
 
-  _installDtmfDetection(cs, ep, dtmfDetector) {
-    if (ep && this.dtmfHook && !ep.dtmfDetector) {
-      ep.dtmfDetector = dtmfDetector;
-      ep.on('dtmf', this._onDtmf.bind(this, cs, ep));
-    }
+  _installDtmfDetection(cs, dlg) {
+    dlg.on('info', this._onInfo.bind(this, cs, dlg));
   }
-  _removeDtmfDetection(cs, ep) {
-    if (ep) {
-      delete ep.dtmfDetector;
-      ep.removeAllListeners('dtmf');
-    }
+  _removeDtmfDetection(dlg) {
+    dlg && dlg.removeAllListeners('info');
   }
 
-  _onDtmf(cs, ep, evt) {
-    if (ep.dtmfDetector) {
-      const match = ep.dtmfDetector.keyPress(evt.dtmf);
-      if (match) {
-        this.logger.debug({callSid: this.cs.callSid}, `Dial:_onDtmf triggered dtmf match: ${match}`);
-        const requestor = ep.dtmfDetector === this.parentDtmfCollector ?
-          cs.requestor :
-          (this.sd ? this.sd.requestor : null);
-        if (!requestor) {
-          this.logger.info(`Dial:_onDtmf got digits on B leg after adulting: ${evt.dtmf}`);
-        }
-        else {
-          requestor.request(this.dtmfHook, {dtmf: match, ...cs.callInfo})
-            .catch((err) => this.logger.info(err, 'Dial:_onDtmf - error'));
-        }
-      }
+  _onInfo(cs, dlg, req, res) {
+    res.send(200);
+    if (req.get('Content-Type') !== 'application/dtmf-relay') return;
+
+    const dtmfDetector = dlg === cs.dlg ? this.parentDtmfCollector : this.childDtmfCollector;
+    if (!dtmfDetector) return;
+    let requestor, callSid, callInfo;
+    if (dtmfDetector === this.parentDtmfCollector) {
+      requestor = cs.requestor;
+      callSid = cs.callSid;
+      callInfo = cs.callInfo;
+    }
+    else {
+      requestor = this.sd?.requestor;
+      callSid = this.sd?.callSid;
+      callInfo = this.sd?.callInfo;
+    }
+    if (!requestor) return;
+    const arr = /Signal=([0-9#*])/.exec(req.body);
+    if (!arr) return;
+    const key = arr[1];
+    const match = dtmfDetector.keyPress(key);
+    if (match) {
+      this.logger.info({callSid}, `Dial:_onInfo triggered dtmf match: ${match}`);
+      requestor.request(this.dtmfHook, {dtmf: match, ...callInfo.toJSON()})
+        .catch((err) => this.logger.info(err, 'Dial:_onDtmf - error'));
     }
   }
 
@@ -246,7 +280,7 @@ class TaskDial extends Task {
     debug(`Dial:__initializeInbound allocated ep for incoming call: ${ep.uuid}`);
 
     /* send outbound legs back to the same SBC (to support static IP feature) */
-    if (!this.proxy) this.proxy = `${cs.req.source_address}:${cs.req.source_port};transport=tcp`;
+    if (!this.proxy) this.proxy = `${cs.req.source_address}:${cs.req.source_port}`;
 
     if (this.dialMusic) {
       // play dial music to caller while we outdial
@@ -313,7 +347,8 @@ class TaskDial extends Task {
           sbcAddress,
           target: t,
           opts,
-          callInfo: cs.callInfo
+          callInfo: cs.callInfo,
+          accountInfo: cs.accountInfo
         });
         this.dials.set(sd.callSid, sd);
 
@@ -357,9 +392,13 @@ class TaskDial extends Task {
                 break;
             }
           })
-          .on('accept', () => {
+          .on('accept', async() => {
             this.logger.debug(`Dial:_attemptCalls - we have a winner: ${sd.callSid}`);
-            this._connectSingleDial(cs, sd);
+            try {
+              await this._connectSingleDial(cs, sd);
+            } catch (err) {
+              this.logger.info({err}, 'Dial:_attemptCalls - Error calling _connectSingleDial ');
+            }
           })
           .on('decline', () => {
             this.logger.debug(`Dial:_attemptCalls - declined: ${sd.callSid}`);
@@ -385,8 +424,8 @@ class TaskDial extends Task {
     });
   }
 
-  _connectSingleDial(cs, sd) {
-    if (!this.bridged) {
+  async _connectSingleDial(cs, sd) {
+    if (!this.bridged && !this.canReleaseMedia) {
       this.logger.debug('Dial:_connectSingleDial bridging endpoints');
       if (this.epOther) {
         this.epOther.api('uuid_break', this.epOther.uuid);
@@ -396,7 +435,7 @@ class TaskDial extends Task {
     }
 
     // ding! ding! ding! we have a winner
-    this._selectSingleDial(cs, sd);
+    await this._selectSingleDial(cs, sd);
     this._killOutdials();       // NB: order is important
   }
 
@@ -409,7 +448,7 @@ class TaskDial extends Task {
    * - launch any nested tasks
    * - and establish a handler to clean up if the called party hangs up
    */
-  _selectSingleDial(cs, sd) {
+  async _selectSingleDial(cs, sd) {
     debug(`Dial:_selectSingleDial ep for outbound call: ${sd.ep.uuid}`);
     this.dials.delete(sd.callSid);
 
@@ -417,12 +456,12 @@ class TaskDial extends Task {
     this.callSid = sd.callSid;
     if (this.earlyMedia) {
       debug('Dial:_selectSingleDial propagating answer supervision on A leg now that B is connected');
-      cs.propagateAnswer();
+      await cs.propagateAnswer();
     }
     if (this.timeLimit) {
       this.timerMaxCallDuration = setTimeout(() => {
         this.logger.info(`Dial:_selectSingleDial tearing down call as it has reached ${this.timeLimit}s`);
-        this.ep.unbridge();
+        this.ep && this.ep.unbridge();
         this.kill(cs);
       }, this.timeLimit * 1000);
     }
@@ -432,8 +471,11 @@ class TaskDial extends Task {
       if (this.dlg) {
         this.logger.debug('Dial:_selectSingleDial called party hungup, ending dial operation');
         sessionTracker.remove(this.callSid);
-        if (this.timerMaxCallDuration) clearTimeout(this.timerMaxCallDuration);
-        this.ep.unbridge();
+        if (this.timerMaxCallDuration) {
+          clearTimeout(this.timerMaxCallDuration);
+          this.timerMaxCallDuration = null;
+        }
+        this.ep && this.ep.unbridge();
         this.kill(cs);
       }
     });
@@ -444,10 +486,14 @@ class TaskDial extends Task {
       dialCallSid: sd.callSid,
     });
 
-    if (this.childDtmfCollector) this._installDtmfDetection(cs, this.ep, this.childDtmfCollector);
+    if (this.parentDtmfCollector) this._installDtmfDetection(cs, cs.dlg);
+    if (this.childDtmfCollector) this._installDtmfDetection(cs, this.dlg);
 
     if (this.transcribeTask) this.transcribeTask.exec(cs, this.ep);
     if (this.listenTask) this.listenTask.exec(cs, this.ep);
+
+    /* if we can release the media back to the SBC, do so now */
+    if (this.canReleaseMedia) this._releaseMedia(cs, sd);
   }
 
   _bridgeEarlyMedia(sd) {
@@ -459,6 +505,33 @@ class TaskDial extends Task {
     }
   }
 
+  /**
+   * Release the media from freeswitch
+   * @param {*} cs
+   * @param {*} sd
+   */
+  async _releaseMedia(cs, sd) {
+    assert(cs.ep && sd.ep);
+
+    try {
+      this.logger.info('Dial:_releaseMedia - releasing media from freewitch');
+      const aLegSdp = cs.ep.remote.sdp;
+      const bLegSdp = sd.ep.remote.sdp;
+      await Promise.all[sd.releaseMediaToSBC(aLegSdp), cs.releaseMediaToSBC(bLegSdp)];
+      this.epOther = null;
+      this.logger.info('Dial:_releaseMedia - successfully released media from freewitch');
+    } catch (err) {
+      this.logger.info({err}, 'Dial:_releaseMedia error');
+    }
+  }
+
+  async reAnchorMedia(cs, sd) {
+    if (cs.ep && sd.ep) return;
+
+    this.logger.info('Dial:reAnchorMedia - re-anchoring media to freewitch');
+    await Promise.all([sd.reAnchorMedia(), cs.reAnchorMedia()]);
+    this.epOther = cs.ep;
+  }
 }
 
 module.exports = TaskDial;

lib/tasks/dialogflow/index.js

@@ -9,10 +9,22 @@ class Dialogflow extends Task {
   constructor(logger, opts) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
-
     this.credentials = this.data.credentials;
-    if (this.data.environment) this.project = `${this.data.project}:${this.data.environment}`;
-    else this.project = this.data.project;
+
+    /* set project id with environment and region (optionally) */
+    if (this.data.environment && this.data.region) {
+      this.project = `${this.data.project}:${this.data.environment}:${this.data.region}`;
+    }
+    else if (this.data.environment) {
+      this.project = `${this.data.project}:${this.data.environment}`;
+    }
+    else if (this.data.region) {
+      this.project = `${this.data.project}::${this.data.region}`;
+    }
+    else {
+      this.project = this.data.project;
+    }
+
     this.lang = this.data.lang || 'en-US';
     this.welcomeEvent = this.data.welcomeEvent || '';
     if (this.welcomeEvent.length && this.data.welcomeEventParams && typeof this.data.welcomeEventParams === 'object') {
@@ -198,6 +210,7 @@ class Dialogflow extends Task {
     /* if we are using tts and a message was provided, play it out */
     if (this.vendor && intent.fulfillmentText && intent.fulfillmentText.length > 0) {
       const {srf} = cs;
+      const {stats} = srf.locals;
       const {synthAudio} = srf.locals.dbHelpers;
       this.waitingForPlayStart = false;
 
@@ -217,7 +230,7 @@ class Dialogflow extends Task {
           credentials: this.ttsCredentials
         };
         this.logger.debug({obj}, 'Dialogflow:_onIntent - playing message via tts');
-        const {filePath, servedFromCache} = await synthAudio(obj);
+        const {filePath, servedFromCache} = await synthAudio(stats, obj);
         if (filePath) cs.trackTmpFile(filePath);
         if (!this.ttsCredentials && !servedFromCache) cs.billForTts(intent.fulfillmentText.length);
 

lib/tasks/enqueue.js

@@ -3,7 +3,7 @@ const Emitter = require('events');
 const ConfirmCallSession = require('../session/confirm-call-session');
 const normalizeJambones = require('../utils/normalize-jambones');
 const makeTask = require('./make_task');
-const {TaskName, TaskPreconditions, QueueResults} = require('../utils/constants');
+const {TaskName, TaskPreconditions, QueueResults, KillReason} = require('../utils/constants');
 const bent = require('bent');
 const assert = require('assert');
 
@@ -61,10 +61,11 @@ class TaskEnqueue extends Task {
     }
   }
 
-  async kill(cs) {
+  async kill(cs, reason) {
     super.kill(cs);
-    this.logger.info(`TaskEnqueue:kill ${this.queueName}`);
-    this.emitter.emit('kill');
+    this.killReason = reason || KillReason.Hangup;
+    this.logger.info(`TaskEnqueue:kill ${this.queueName} with reason ${this.killReason}`);
+    this.emitter.emit('kill', reason || KillReason.Hangup);
     this.notifyTaskDone();
   }
 
@@ -76,11 +77,22 @@ class TaskEnqueue extends Task {
     const members = await pushBack(this.queueName, url);
     this.logger.info(`TaskEnqueue:_addToQueue: added to queue, length now ${members}`);
     this.notifyUrl = url;
+
+    /* invoke account-level webhook for queue event notifications */
+    try {
+      cs.performQueueWebhook({
+        event: 'join',
+        queue: this.data.name,
+        length: members,
+        joinTime: this.waitStartTime
+      });
+    } catch (err) {}
   }
 
-  async _removeFromQueue(cs, dlg) {
-    const {removeFromList} = cs.srf.locals.dbHelpers;
-    return await removeFromList(this.queueName, getUrl(cs));
+  async _removeFromQueue(cs) {
+    const {removeFromList, lengthOfList} = cs.srf.locals.dbHelpers;
+    await removeFromList(this.queueName, getUrl(cs));
+    return await lengthOfList(this.queueName);
   }
 
   async performAction() {
@@ -89,7 +101,7 @@ class TaskEnqueue extends Task {
       queueTime: getElapsedTime(this.waitStartTime),
       queueResult: this.state
     };
-    await super.performAction(params);
+    await super.performAction(params, this.killReason !== KillReason.Replaced);
   }
 
   /**
@@ -104,13 +116,28 @@ class TaskEnqueue extends Task {
           this.bridgeDetails = opts;
           this.logger.info({bridgeDetails: this.bridgeDetails}, `time to dequeue from ${this.queueName}`);
           if (this._playSession) {
+            this._leave = false;
             this._playSession.kill();
             this._playSession = null;
           }
           resolve(this._doBridge(cs, dlg, ep));
         })
-        .once('kill', () => {
-          this._removeFromQueue(cs);
+        .once('kill', async() => {
+
+          /* invoke account-level webhook for queue event notifications */
+          if (!this.dequeued) {
+            try {
+              const members = await this._removeFromQueue(cs);
+              cs.performQueueWebhook({
+                event: 'leave',
+                queue: this.data.name,
+                length: members,
+                leaveReason: 'abandoned',
+                leaveTime: Date.now()
+              });
+            } catch (err) {}
+          }
+
           if (this._playSession) {
             this.logger.debug('killing waitUrl');
             this._playSession.kill();
@@ -209,14 +236,16 @@ class TaskEnqueue extends Task {
         });
 
         // resolve when either side hangs up
+        this.state = QueueResults.Bridged;
         this.emitter
           .on('hangup', () => {
             this.logger.info('TaskEnqueue:_bridgeLocal ending with hangup from dequeue party');
             ep.unbridge().catch((err) => {});
             resolve();
           })
-          .on('kill', () => {
-            this.logger.info('TaskEnqueue:_bridgeLocal ending with hangup from enqeue party');
+          .on('kill', (reason) => {
+            this.killReason = reason;
+            this.logger.info(`TaskEnqueue:_bridgeLocal ending with ${this.killReason}`);
             ep.unbridge().catch((err) => {});
 
             // notify partner that we dropped
@@ -242,12 +271,26 @@ class TaskEnqueue extends Task {
    * @param {string} opts.epUuid uuid of the endpoint we need to bridge to
    * @param {string} opts.dequeueSipAddress ip:port of the feature server hosting the other call
    */
-  notifyQueueEvent(cs, opts) {
+  async notifyQueueEvent(cs, opts) {
     if (opts.event === 'dequeue') {
       if (this.bridgeNow) return;
       this.logger.info({opts}, `TaskEnqueue:notifyDequeueEvent: leaving ${this.queueName} because someone wants me`);
       assert(opts.dequeueSipAddress && opts.epUuid && opts.notifyUrl);
       this.emitter.emit('dequeue', opts);
+
+      try {
+        const {lengthOfList} = cs.srf.locals.dbHelpers;
+        const members = await lengthOfList(this.queueName);
+        this.dequeued = true;
+        cs.performQueueWebhook({
+          event: 'leave',
+          queue: this.data.name,
+          length: Math.max(members - 1, 0),
+          leaveReason: 'dequeued',
+          leaveTime: Date.now(),
+          dequeuer: opts.dequeuer
+        });
+      } catch (err) {}
     }
     else if (opts.event === 'hangup') {
       this.emitter.emit('hangup');
@@ -277,7 +320,7 @@ class TaskEnqueue extends Task {
     const json = await cs.application.requestor.request(hook, params);
     const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
 
-    const allowedTasks = tasks.filter((t) => allowed.includes(t.verb));
+    const allowedTasks = tasks.filter((t) => allowed.includes(t.name));
     if (tasks.length !== allowedTasks.length) {
       this.logger.debug({tasks, allowedTasks}, 'unsupported task');
       throw new Error(`unsupported verb in enqueue waitHook: only ${JSON.stringify(allowed)}`);
@@ -286,10 +329,9 @@ class TaskEnqueue extends Task {
 
     // check for 'leave' verb and only execute tasks up till then
     const tasksToRun = [];
-    let leave = false;
     for (const o of tasks) {
-      if (o.verb === TaskName.Leave) {
-        leave = true;
+      if (o.name === TaskName.Leave) {
+        this._leave = true;
         this.logger.info('waitHook returned a leave task');
         break;
       }
@@ -304,12 +346,13 @@ class TaskEnqueue extends Task {
         dlg,
         ep: cs.ep,
         callInfo: cs.callInfo,
-        tasksToRun
+        accountInfo: cs.accountInfo,
+        tasks: tasksToRun
       });
       await this._playSession.exec();
       this._playSession = null;
     }
-    if (leave) {
+    if (this._leave) {
       this.state = QueueResults.Leave;
       this.kill(cs);
     }

lib/tasks/gather.js

@@ -10,7 +10,7 @@ const makeTask = require('./make_task');
 const assert = require('assert');
 
 class TaskGather extends Task {
-  constructor(logger, opts) {
+  constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
 
@@ -40,10 +40,14 @@ class TaskGather extends Task {
 
     if (this.say) this.sayTask = makeTask(this.logger, {say: this.say}, this);
     if (this.play) this.playTask = makeTask(this.logger, {play: this.play}, this);
+
+    this.parentTask = parentTask;
   }
 
   get name() { return TaskName.Gather; }
 
+  get needsStt() { return this.input.includes('speech'); }
+
   get earlyMedia() {
     return (this.sayTask && this.sayTask.earlyMedia) ||
       (this.playTask && this.playTask.earlyMedia);
@@ -57,7 +61,7 @@ class TaskGather extends Task {
     if ('default' === this.vendor || !this.vendor) this.vendor = cs.speechRecognizerVendor;
     if ('default' === this.language || !this.language) this.language = cs.speechRecognizerLanguage;
     this.sttCredentials = cs.getSpeechCredentials(this.vendor, 'stt');
-    if (!this.sttCredentials) {
+    if (this.needsStt && !this.sttCredentials) {
       const {writeAlerts, AlertType} = cs.srf.locals;
       this.logger.info(`TaskGather:exec - ERROR stt using ${this.vendor} requested but not creds supplied`);
       writeAlerts({
@@ -92,7 +96,7 @@ class TaskGather extends Task {
       }
 
       if (this.input.includes('digits')) {
-        ep.on('dtmf', this._onDtmf.bind(this, ep));
+        ep.on('dtmf', this._onDtmf.bind(this, cs, ep));
       }
 
       await this.awaitTaskDone();
@@ -106,19 +110,19 @@ class TaskGather extends Task {
 
   kill(cs) {
     super.kill(cs);
-    this._killAudio();
+    this._killAudio(cs);
     this.ep.removeAllListeners('dtmf');
     this._resolve('killed');
   }
 
-  _onDtmf(ep, evt) {
+  _onDtmf(cs, ep, evt) {
     this.logger.debug(evt, 'TaskGather:_onDtmf');
     if (evt.dtmf === this.finishOnKey) this._resolve('dtmf-terminator-key');
     else {
       this.digitBuffer += evt.dtmf;
       if (this.digitBuffer.length === this.numDigits) this._resolve('dtmf-num-digits');
     }
-    this._killAudio();
+    this._killAudio(cs);
   }
 
   async _initSpeech(cs, ep) {
@@ -154,7 +158,6 @@ class TaskGather extends Task {
       });
       ep.addCustomEventListener(AwsTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
     }
-    this.logger.debug({vars: opts}, 'setting freeswitch vars');
     await ep.set(opts)
       .catch((err) => this.logger.info(err, 'Error setting channel variables'));
 
@@ -190,14 +193,16 @@ class TaskGather extends Task {
     }
   }
 
-  _killAudio() {
+  _killAudio(cs) {
     if (this.sayTask && !this.sayTask.killed) {
       this.sayTask.removeAllListeners('playDone');
-      this.sayTask.kill();
+      this.sayTask.kill(cs);
+      this.sayTask = null;
     }
     if (this.playTask && !this.playTask.killed) {
       this.playTask.removeAllListeners('playDone');
-      this.playTask.kill();
+      this.playTask.kill(cs);
+      this.playTask = null;
     }
   }
 
@@ -232,10 +237,15 @@ class TaskGather extends Task {
 
     this._clearTimer();
     if (reason.startsWith('dtmf')) {
-      await this.performAction({digits: this.digitBuffer});
+      await this.performAction({digits: this.digitBuffer, reason: 'dtmfDetected'});
     }
     else if (reason.startsWith('speech')) {
-      await this.performAction({speech: evt});
+      if (this.parentTask) this.parentTask.emit('transcription', evt);
+      else await this.performAction({speech: evt, reason: 'speechDetected'});
+    }
+    else if (reason.startsWith('timeout')) {
+      if (this.parentTask) this.parentTask.emit('timeout', evt);
+      else await this.performAction({reason: 'timeout'});
     }
     this.notifyTaskDone();
   }

lib/tasks/lex.js

@@ -182,12 +182,13 @@ class Lex extends Task {
       const type = messages[0].type;
       if (['PlainText', 'SSML'].includes(type) && msg) {
         const {srf} = cs;
+        const {stats} = srf.locals;
         const {synthAudio} = srf.locals.dbHelpers;
 
         try {
           this.logger.debug(`tts with ${this.vendor} ${this.voice}`);
           // eslint-disable-next-line no-unused-vars
-          const {filePath, servedFromCache} = await synthAudio({
+          const {filePath, servedFromCache} = await synthAudio(stats, {
             text: msg,
             vendor: this.vendor,
             language: this.language,

lib/tasks/listen.js

@@ -122,6 +122,11 @@ class TaskListen extends Task {
     if (this.finishOnKey || this.passDtmf) {
       ep.on('dtmf', this._dtmfHandler);
     }
+
+    /* support bi-directional audio */
+    ep.addCustomEventListener(ListenEvents.PlayAudio, this._onPlayAudio.bind(this, ep));
+    ep.addCustomEventListener(ListenEvents.KillAudio, this._onKillAudio.bind(this, ep));
+    ep.addCustomEventListener(ListenEvents.Disconnect, this._onDisconnect.bind(this, ep));
   }
 
   _removeListeners(ep) {
@@ -154,6 +159,29 @@ class TaskListen extends Task {
     this.logger.info(evt, 'TaskListen:_onConnectFailure');
     this.notifyTaskDone();
   }
+
+  async _onPlayAudio(ep, evt) {
+    this.logger.info(`received play_audio event: ${JSON.stringify(evt)}`);
+    try {
+      const results = await ep.play(evt.file);
+      this.logger.debug(`Finished playing file, result: ${JSON.stringify(results)}`);
+      ep.forkAudioSendText({type: 'playDone', data: Object.assign({id: evt.id}, results)});
+    }
+    catch (err) {
+      this.logger.error({err}, 'Error playing file');
+    }
+  }
+
+  _onKillAudio(ep) {
+    this.logger.info('received kill_audio event');
+    ep.api('uuid_break', ep.uuid);
+  }
+
+  _onDisconnect(ep, cs) {
+    this.logger.debug('_onDisconnect: TaskListen terminating task');
+    this.kill(cs);
+  }
+
   _onError(ep, evt) {
     this.logger.info(evt, 'TaskListen:_onError');
     this.notifyTaskDone();

lib/tasks/make_task.js

@@ -17,8 +17,10 @@ function makeTask(logger, obj, parent) {
     case TaskName.SipDecline:
       const TaskSipDecline = require('./sip_decline');
       return new TaskSipDecline(logger, data, parent);
+    case TaskName.SipRefer:
+      const TaskSipRefer = require('./sip_refer');
+      return new TaskSipRefer(logger, data, parent);
     case TaskName.Conference:
-      logger.debug({data}, 'Conference verb');
       const TaskConference = require('./conference');
       return new TaskConference(logger, data, parent);
     case TaskName.Dial:
@@ -48,6 +50,9 @@ function makeTask(logger, obj, parent) {
     case TaskName.Message:
       const TaskMessage = require('./message');
       return new TaskMessage(logger, data, parent);
+    case TaskName.Rasa:
+      const TaskRasa = require('./rasa');
+      return new TaskRasa(logger, data, parent);
     case TaskName.Say:
       const TaskSay = require('./say');
       return new TaskSay(logger, data, parent);

lib/tasks/message.js

@@ -1,6 +1,7 @@
 const Task = require('./task');
 const {TaskName, TaskPreconditions} = require('../utils/constants');
 const bent = require('bent');
+const { v4: uuidv4 } = require('uuid');
 
 class TaskMessage extends Task {
   constructor(logger, opts) {
@@ -8,13 +9,11 @@ class TaskMessage extends Task {
     this.preconditions = TaskPreconditions.None;
 
     this.payload = {
-      message_sid: this.data.message_sid,
-      provider: this.data.provider,
+      message_sid: this.data.message_sid || uuidv4(),
+      carrier: this.data.carrier,
       to: this.data.to,
       from: this.data.from,
-      cc: this.data.cc,
-      text: this.data.text,
-      media: this.data.media
+      text: this.data.text
     };
 
   }
@@ -28,16 +27,18 @@ class TaskMessage extends Task {
     const {srf, accountSid} = cs;
     const {res} = cs.callInfo;
     let payload = this.payload;
+    const actionParams = {message_sid: this.payload.message_sid};
+
     await super.exec(cs);
     try {
-      const {getSBC, getSmpp, dbHelpers} = srf.locals;
+      const {getSmpp, dbHelpers} = srf.locals;
       const {lookupSmppGateways} = dbHelpers;
 
-      this.logger.info(`looking up gateways for account_sid: ${accountSid}`);
+      this.logger.debug(`looking up gateways for account_sid: ${accountSid}`);
       const r = await lookupSmppGateways(accountSid);
       let gw, url, relativeUrl;
       if (r.length > 0) {
-        gw = r.find((o) => 1 === o.sg.outbound && (!this.payload.provider || o.vc.name === this.payload.provider));
+        gw = r.find((o) => 1 === o.sg.outbound && (!this.payload.carrier || o.vc.name === this.payload.carrier));
       }
       if (gw) {
         this.logger.info({gw, accountSid}, 'Message:exec - using smpp to send message');
@@ -50,37 +51,75 @@ class TaskMessage extends Task {
         };
       }
       else {
-        this.logger.info({gw, accountSid, provider: this.payload.provider},
+        //TMP: smpp only at the moment, need to add http back in
+        /*
+        this.logger.info({gw, accountSid, carrier: this.payload.carrier},
           'Message:exec - no smpp gateways found to send message');
         relativeUrl = 'v1/outboundSMS';
         const sbcAddress = getSBC();
         if (sbcAddress) url = `http://${sbcAddress}:3000/`;
-
-        //TMP: smpp only at the moment, need to add http back in
-        return res.sendStatus(404);
+        */
+        this.performAction({
+          ...actionParams,
+          message_status: 'no carriers'
+        }).catch((err) => {});
+        if (res) res.sendStatus(404);
+        return;
       }
       if (url) {
-        const post = bent(url, 'POST', 'json', 201);
+        const post = bent(url, 'POST', 'json', 201, 480);
         this.logger.info({payload, url}, 'Message:exec sending outbound SMS');
         const response = await post(relativeUrl, payload);
-        this.logger.info({response}, 'Successfully sent SMS');
-        if (cs.callInfo.res) {
-          this.logger.info('Message:exec sending 200 OK response to HTTP POST from api server');
-          res.status(200).json({
-            sid: cs.callInfo.messageSid,
-            providerResponse: response
-          });
+        const {smpp_err_code, carrier, message_id, message} = response;
+        if (smpp_err_code) {
+          this.logger.info({response}, 'SMPP error sending SMS');
+          this.performAction({
+            ...actionParams,
+            carrier,
+            carrier_message_id: message_id,
+            message_status: 'failure',
+            message_failure_reason: message
+          }).catch((err) => {});
+          if (res) {
+            res.status(480).json({
+              ...response,
+              sid: cs.callInfo.messageSid
+            });
+          }
+        }
+        else {
+          const {message_id, carrier} = response;
+          this.logger.info({response}, 'Successfully sent SMS');
+          this.performAction({
+            ...actionParams,
+            carrier,
+            carrier_message_id: message_id,
+            message_status: 'success',
+          }).catch((err) => {});
+          if (res) {
+            res.status(200).json({
+              sid: cs.callInfo.messageSid,
+              carrierResponse: response
+            });
+          }
         }
-
-        // TODO: action Hook
       }
       else {
-        this.logger.info('Message:exec - unable to send SMS as there are no available SMS gateways');
-        res.status(422).json({message: 'no configured SMS gateways'});
+        this.logger.info('Message:exec - unable to send SMS as SMPP is not configured on the system');
+        this.performAction({
+          ...actionParams,
+          message_status: 'smpp configuration error'
+        }).catch((err) => {});
+        if (res) res.status(404).json({message: 'no configured SMS gateways'});
       }
     } catch (err) {
-      this.logger.error(err, 'TaskMessage:exec - Error sending SMS');
-      res.status(422).json({message: 'no configured SMS gateways'});
+      this.logger.error(err, 'TaskMessage:exec - unexpected error sending SMS');
+      this.performAction({
+        ...actionParams,
+        message_status: 'system error',
+        message_failure_reason: err.message
+      });
+      if (res) res.status(422).json({message: 'no configured SMS gateways'});
     }
   }
 }

lib/tasks/play.js

@@ -17,8 +17,12 @@ class TaskPlay extends Task {
     await super.exec(cs);
     this.ep = ep;
     try {
-      while (!this.killed && this.loop--) {
-        await ep.play(this.url);
+      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep.connected) {
+        if (cs.isInConference) {
+          const {memberId, confName, confUuid} = cs;
+          await this.playToConfMember(this.ep, memberId, confName, confUuid, this.url);
+        }
+        else await ep.play(this.url);
       }
     } catch (err) {
       this.logger.info(err, `TaskPlay:exec - error playing ${this.url}`);
@@ -30,7 +34,13 @@ class TaskPlay extends Task {
     super.kill(cs);
     if (this.ep.connected && !this.playComplete) {
       this.logger.debug('TaskPlay:kill - killing audio');
-      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+      if (cs.isInConference) {
+        const {memberId, confName} = cs;
+        this.killPlayToConfMember(this.ep, memberId, confName);
+      }
+      else {
+        await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+      }
     }
   }
 }

lib/tasks/rasa.js

@@ -0,0 +1,156 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+const makeTask = require('./make_task');
+const bent = require('bent');
+
+class Rasa extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    this.prompt = this.data.prompt;
+    this.eventHook = this.data?.eventHook;
+    this.actionHook = this.data?.actionHook;
+    this.post = bent('POST', 'json', 200);
+  }
+
+  get name() { return TaskName.Rasa; }
+
+  get hasReportedFinalAction() {
+    return this.reportedFinalAction || this.isReplacingApplication;
+  }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+
+    this.ep = ep;
+    try {
+      /* set event handlers */
+      this.on('transcription', this._onTranscription.bind(this, cs, ep));
+      this.on('timeout', this._onTimeout.bind(this, cs, ep));
+
+      /* start the first gather */
+      this.gatherTask = this._makeGatherTask(this.prompt);
+      this.gatherTask.exec(cs, ep, this)
+        .catch((err) => this.logger.info({err}, 'Rasa gather task returned error'));
+
+      await this.awaitTaskDone();
+    } catch (err) {
+      this.logger.error({err}, 'Rasa error');
+      throw err;
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    this.logger.debug('Rasa:kill');
+
+    if (!this.hasReportedFinalAction) {
+      this.reportedFinalAction = true;
+      this.performAction({rasaResult: 'caller hungup'})
+        .catch((err) => this.logger.info({err}, 'rasa - error w/ action webook'));
+    }
+
+    if (this.ep.connected) {
+      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+    }
+    this.removeAllListeners();
+    this.notifyTaskDone();
+  }
+
+  _makeGatherTask(prompt) {
+    let opts = {
+      input: ['speech'],
+      timeout: this.data.timeout || 10,
+      recognizer: this.data.recognizer || {
+        vendor: 'default',
+        language: 'default'
+      }
+    };
+    if (prompt) {
+      const sayOpts = this.data.tts ?
+        {text: prompt, synthesizer: this.data.tts} :
+        {text: prompt};
+
+      opts = {
+        ...opts,
+        say: sayOpts
+      };
+    }
+    //this.logger.debug({opts}, 'constructing a nested gather object');
+    const gather = makeTask(this.logger, {gather: opts}, this);
+    return gather;
+  }
+
+  async _onTranscription(cs, ep, evt) {
+    //this.logger.debug({evt}, `Rasa: got transcription for callSid ${cs.callSid}`);
+    const utterance = evt.alternatives[0].transcript;
+
+    if (this.eventHook) {
+      this.performHook(cs, this.eventHook, {event: 'userMessage', message: utterance})
+        .then((redirected) => {
+          if (redirected) {
+            this.logger.info('Rasa_onTranscription: event handler for user message redirected us to new webhook');
+            this.reportedFinalAction = true;
+            this.performAction({rasaResult: 'redirect'}, false);
+            if (this.gatherTask) this.gatherTask.kill(cs);
+          }
+          return;
+        })
+        .catch(({err}) => {
+          this.logger.info({err}, 'Rasa_onTranscription: error sending event hook');
+        });
+    }
+
+    try {
+      const payload = {
+        sender: cs.callSid,
+        message: utterance
+      };
+      this.logger.debug({payload}, 'Rasa:_onTranscription - sending payload to Rasa');
+      const response = await this.post(this.data.url, payload);
+      this.logger.debug({response}, 'Rasa:_onTranscription - got response from Rasa');
+      const botUtterance = Array.isArray(response) ?
+        response.reduce((prev, current) => {
+          return current.text ? `${prev} ${current.text}` : '';
+        }, '') :
+        null;
+      if (botUtterance) {
+        this.logger.debug({botUtterance}, 'Rasa:_onTranscription: got user utterance');
+        this.gatherTask = this._makeGatherTask(botUtterance);
+        this.gatherTask.exec(cs, ep, this)
+          .catch((err) => this.logger.info({err}, 'Rasa gather task returned error'));
+        if (this.eventHook) {
+          this.performHook(cs, this.eventHook, {event: 'botMessage', message: response})
+            .then((redirected) => {
+              if (redirected) {
+                this.logger.info('Rasa_onTranscription: event handler for bot message redirected us to new webhook');
+                this.reportedFinalAction = true;
+                this.performAction({rasaResult: 'redirect'}, false);
+                if (this.gatherTask) this.gatherTask.kill(cs);
+              }
+              return;
+            })
+            .catch(({err}) => {
+              this.logger.info({err}, 'Rasa_onTranscription: error sending event hook');
+            });
+        }
+      }
+    } catch (err) {
+      this.logger.error({err}, 'Rasa_onTranscription: Error sending user utterance to Rasa - ending task');
+      this.performAction({rasaResult: 'webhookError'});
+      this.reportedFinalAction = true;
+      this.notifyTaskDone();
+    }
+  }
+  _onTimeout(cs, ep, evt) {
+    this.logger.debug({evt}, 'Rasa: got timeout');
+    if (!this.hasReportedFinalAction) this.performAction({rasaResult: 'timeout'});
+    this.reportedFinalAction = true;
+    this.notifyTaskDone();
+  }
+
+
+}
+
+module.exports = Rasa;

lib/tasks/say.js

@@ -19,14 +19,17 @@ class TaskSay extends Task {
 
     const {srf} = cs;
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, srf);
-    const {writeAlerts, AlertType} = srf.locals;
+    const {writeAlerts, AlertType, stats} = srf.locals;
     const {synthAudio} = srf.locals.dbHelpers;
-    const vendor = this.synthesizer.vendor || cs.speechSynthesisVendor;
-    const language = this.synthesizer.language || cs.speechSynthesisLanguage;
-    const voice = this.synthesizer.voice || cs.speechSynthesisVoice;
+    const hasVerbLevelTts = this.synthesizer.vendor && this.synthesizer.vendor !== 'default';
+    const vendor = hasVerbLevelTts ? this.synthesizer.vendor : cs.speechSynthesisVendor ;
+    const language = hasVerbLevelTts ? this.synthesizer.language : cs.speechSynthesisLanguage ;
+    const voice = hasVerbLevelTts ? this.synthesizer.voice : cs.speechSynthesisVoice ;
+
     const salt = cs.callSid;
     const credentials = cs.getSpeechCredentials(vendor, 'tts');
 
+    this.logger.info({language, voice}, `Task:say - using vendor: ${vendor}`);
     this.ep = ep;
     try {
       if (!credentials) {
@@ -40,7 +43,7 @@ class TaskSay extends Task {
       // synthesize all of the text elements
       let lastUpdated = false;
       const filepath = (await Promise.all(this.text.map(async(text) => {
-        const {filePath, servedFromCache} = await synthAudio({
+        const {filePath, servedFromCache} = await synthAudio(stats, {
           text,
           vendor,
           language,
@@ -68,10 +71,14 @@ class TaskSay extends Task {
 
       this.logger.debug({filepath}, 'synthesized files for tts');
 
-      while (!this.killed && this.loop-- && this.ep.connected) {
+      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep.connected) {
         let segment = 0;
         do {
-          await ep.play(filepath[segment]);
+          if (cs.isInConference) {
+            const {memberId, confName, confUuid} = cs;
+            await this.playToConfMember(this.ep, memberId, confName, confUuid, filepath[segment]);
+          }
+          else await ep.play(filepath[segment]);
         } while (!this.killed && ++segment < filepath.length);
       }
     } catch (err) {
@@ -84,7 +91,13 @@ class TaskSay extends Task {
     super.kill(cs);
     if (this.ep.connected) {
       this.logger.debug('TaskSay:kill - killing audio');
-      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+      if (cs.isInConference) {
+        const {memberId, confName} = cs;
+        this.killPlayToConfMember(this.ep, memberId, confName);
+      }
+      else {
+        this.ep.api('uuid_break', this.ep.uuid);
+      }
     }
   }
 }

lib/tasks/sip_refer.js

@@ -0,0 +1,101 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+const {parseUri} = require('drachtio-srf');
+
+/**
+ * sends a sip REFER to transfer the existing call
+ */
+class TaskSipRefer extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.StableCall;
+
+    this.referTo = this.data.referTo;
+    this.referredBy = this.data.referredBy;
+    this.headers = this.data.headers || {};
+    this.eventHook = this.data.eventHook;
+  }
+
+  get name() { return TaskName.SipRefer; }
+
+  async exec(cs) {
+    super.exec(cs);
+    const {dlg} = cs;
+    const {referTo, referredBy} = this._normalizeReferHeaders(cs, dlg);
+
+    try {
+      this.notifyHandler = this._handleNotify.bind(this, cs, dlg);
+      dlg.on('notify', this.notifyHandler);
+      const response = await dlg.request({
+        method: 'REFER',
+        headers: {
+          ...this.headers,
+          'Refer-To': referTo,
+          'Referred-By': referredBy
+        }
+      });
+      this.referStatus = response.status;
+      this.logger.info(`TaskSipRefer:exec - received ${this.referStatus} to REFER`);
+
+      /* if we fail, fall through to next verb.  If success, we should get BYE from far end */
+      if (this.referStatus === 202) {
+        await this.awaitTaskDone();
+      }
+      else await this.performAction({refer_status: this.referStatus});
+    } catch (err) {
+      this.logger.info({err}, 'TaskSipRefer:exec - error sending REFER');
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    const {dlg} = cs;
+    dlg.off('notify', this.notifyHandler);
+  }
+
+  async _handleNotify(cs, dlg, req, res) {
+    res.send(200);
+
+    const contentType = req.get('Content-Type');
+    this.logger.debug({body: req.body}, `TaskSipRefer:_handleNotify got ${contentType}`);
+
+    if (contentType === 'message/sipfrag') {
+      const arr = /SIP\/2\.0\s+(\d+)/.exec(req.body);
+      if (arr) {
+        const status = arr[1];
+        this.logger.debug(`TaskSipRefer:_handleNotify: call got status ${status}`);
+        if (this.eventHook) {
+          await cs.requestor.request(this.eventHook, {event: 'transfer-status', call_status: status});
+        }
+        if (status >= 200) {
+          await this.performAction({refer_status: 202, final_referred_call_status: status});
+          this.notifyTaskDone();
+        }
+      }
+    }
+  }
+
+  _normalizeReferHeaders(cs, dlg) {
+    let {referTo, referredBy} = this;
+
+    /* get IP address of the SBC to use as hostname if needed */
+    const {host} = parseUri(dlg.remote.uri);
+
+    if (!referTo.startsWith('<') && !referTo.startsWith('sip') && !referTo.startsWith('"')) {
+      /* they may have only provided a phone number/user */
+      referTo = `sip:${referTo}@${host}`;
+    }
+    if (!referredBy) {
+      /* default */
+      referredBy = cs.req?.callingNumber || dlg.local.uri;
+      this.logger.info({referredBy}, 'setting referredby');
+    }
+    if (!referredBy.startsWith('<') && !referredBy.startsWith('sip') && !referredBy.startsWith('"')) {
+      /* they may have only provided a phone number/user */
+      referredBy = `sip:${referredBy}@${host}`;
+    }
+    return {referTo, referredBy};
+  }
+}
+
+module.exports = TaskSipRefer;

lib/tasks/specs.json

@@ -9,6 +9,18 @@
       "status"
     ]
   },
+  "sip:refer": {
+    "properties": {
+      "referTo": "string",
+      "referredBy": "string",
+      "headers": "object",
+      "actionHook": "object|string",
+      "eventHook": "object|string"
+    },
+    "required": [
+      "referTo"
+    ]
+  },
   "dequeue": {
     "properties": {
       "name": "string",
@@ -46,7 +58,7 @@
   "play": {
     "properties": {
       "url": "string",
-      "loop": "number",
+      "loop": "number|string",
       "earlyMedia": "boolean"
     },
     "required": [
@@ -56,7 +68,7 @@
   "say": {
     "properties": {
       "text": "string|array",
-      "loop": "number",
+      "loop": "number|string",
       "synthesizer": "#synthesizer",
       "earlyMedia": "boolean"
     },
@@ -78,7 +90,6 @@
       "say": "#say"
     },
     "required": [
-      "actionHook"
     ]
   },
   "conference": {
@@ -88,11 +99,13 @@
       "startConferenceOnEnter": "boolean",
       "endConferenceOnExit": "boolean",
       "maxParticipants": "number",
+      "joinMuted": "boolean",
       "actionHook": "object|string",
       "waitHook": "object|string",
       "statusEvents": "array",
       "statusHook": "object|string",
-      "enterHook": "object|string"
+      "enterHook": "object|string",
+      "record": "#record"
     },
     "required": [
       "name"
@@ -124,6 +137,10 @@
       "credentials": "object|string",
       "project": "string",
       "environment": "string",
+      "region": {
+        "type": "string",
+        "enum": ["europe-west1", "europe-west2", "australia-southeast1", "asia-northeast1"]
+      },
       "lang": "string",
       "actionHook": "object|string",
       "eventHook": "object|string",
@@ -224,6 +241,27 @@
       "length"
     ]
   },
+  "rasa": {
+    "properties": {
+      "url": "string",
+      "recognizer": "#recognizer",
+      "tts": "#synthesizer",
+      "prompt": "string",
+      "actionHook": "object|string",
+      "eventHook": "object|string"
+    },
+    "required": [
+      "url"
+    ]
+  },
+  "record": {
+    "properties": {
+      "path": "string"
+    },
+    "required": [
+      "path"
+    ]
+  },
   "redirect": {
     "properties": {
       "actionHook": "object|string"

lib/tasks/task.js

@@ -23,6 +23,9 @@ class Task extends Emitter {
 
     this._killInProgress = false;
     this._completionPromise = new Promise((resolve) => this._completionResolver = resolve);
+
+    /* used when we play a prompt to a member in conference */
+    this._confPlayCompletionPromise = new Promise((resolve) => this._confPlayCompletionResolver = resolve);
   }
 
   /**
@@ -77,6 +80,21 @@ class Task extends Emitter {
     return this._completionPromise;
   }
 
+  /**
+   * when a play to conference member completes
+   */
+  notifyConfPlayDone() {
+    this._confPlayCompletionResolver();
+  }
+
+  /**
+   * when a subclass task has launched various async activities and is now simply waiting
+   * for them to complete it should call this method to block until that happens
+   */
+  awaitConfPlayDone() {
+    return this._confPlayCompletionPromise;
+  }
+
   /**
    * provided as a convenience for tasks, this simply calls CallSession#normalizeUrl
    */
@@ -99,6 +117,62 @@ class Task extends Emitter {
     }
   }
 
+  async performHook(cs, hook, results) {
+    const json = await cs.requestor.request(hook, results);
+    if (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.redirect(cs, tasks);
+        return true;
+      }
+    }
+    return false;
+  }
+
+  redirect(cs, tasks) {
+    this.logger.info({tasks: tasks}, `${this.name} replacing application with ${tasks.length} tasks`);
+    this.isReplacingApplication = true;
+    cs.replaceApplication(tasks);
+  }
+
+  async playToConfMember(ep, memberId, confName, confUuid, filepath) {
+    try {
+      this.logger.debug(`Task:playToConfMember - playing ${filepath} to ${confName}:${memberId}`);
+
+      // listen for conference events
+      const handler = this.__onConferenceEvent.bind(this);
+      ep.conn.on('esl::event::CUSTOM::*', handler) ;
+      const response = await ep.api(`conference ${confName} play ${filepath} ${memberId}`);
+      this.logger.debug({response}, 'Task:playToConfMember - api call returned');
+      await this.awaitConfPlayDone();
+      ep.conn.removeListener('esl::event::CUSTOM::*', handler);
+    } catch (err) {
+      this.logger.error({err}, `Task:playToConfMember - error playing ${filepath} to ${confName}:${memberId}`);
+    }
+  }
+
+  async killPlayToConfMember(ep, memberId, confName) {
+    try {
+      this.logger.debug(`Task:killPlayToConfMember - killing audio to ${confName}:${memberId}`);
+      const response = await ep.api(`conference ${confName} stop ${memberId}`);
+      this.logger.debug({response}, 'Task:killPlayToConfMember - api call returned');
+    } catch (err) {
+      this.logger.error({err}, `Task:killPlayToConfMember - error killing audio to ${confName}:${memberId}`);
+    }
+  }
+
+  __onConferenceEvent(evt) {
+    const eventName = evt.getHeader('Event-Subclass') ;
+    if (eventName === 'conference::maintenance') {
+      const action = evt.getHeader('Action') ;
+      if (action === 'play-file-member-done') {
+        this.logger.debug('done playing file to conf member');
+        this.notifyConfPlayDone();
+      }
+    }
+  }
+
   async transferCallToFeatureServer(cs, sipAddress, opts) {
     const uuid = uuidv4();
     const {addKey} = cs.srf.locals.dbHelpers;

lib/tasks/transcribe.js

@@ -91,7 +91,7 @@ class TaskTranscribe extends Task {
     ep.addCustomEventListener(GoogleTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
     ep.addCustomEventListener(GoogleTranscriptionEvents.NoAudioDetected, this._onNoAudio.bind(this, cs, ep));
     ep.addCustomEventListener(GoogleTranscriptionEvents.MaxDurationExceeded,
-      this._onMaxDurationExceeded.bind(this, ep));
+      this._onMaxDurationExceeded.bind(this, cs, ep));
     ep.addCustomEventListener(AwsTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
     ep.addCustomEventListener(AwsTranscriptionEvents.NoAudioDetected, this._onNoAudio.bind(this, cs, ep));
     ep.addCustomEventListener(AwsTranscriptionEvents.MaxDurationExceeded,

lib/utils/constants.json

@@ -14,9 +14,11 @@
     "Message": "message",
     "Pause": "pause",
     "Play": "play",
+    "Rasa": "rasa",
     "Redirect": "redirect",
     "RestDial": "rest:dial",
     "SipDecline": "sip:decline",
+    "SipRefer": "sip:refer",
     "SipNotify": "sip:notify",
     "SipRedirect": "sip:redirect",
     "Say": "say",
@@ -92,6 +94,10 @@
     "Hangup": "hangup",
     "Timeout": "timeout"
   },
+  "KillReason": {
+    "Hangup": "hangup",
+    "Replaced": "replaced"
+  },
   "MAX_SIMRINGS": 10,
   "BONG_TONE": "tone_stream://v=-7;%(100,0,941.0,1477.0);v=-7;>=2;+=.1;%(1400,0,350,440)"
 }

lib/utils/db-utils.js

@@ -21,6 +21,11 @@ const speechMapper = (cred) => {
     obj.access_key_id = o.access_key_id;
     obj.secret_access_key = o.secret_access_key;
   }
+  else if ('microsoft' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    obj.api_key = o.api_key;
+    obj.region = o.region;
+  }
   return obj;
 };
 
@@ -37,7 +42,8 @@ module.exports = (logger, srf) => {
     /* search at the service provider level if we don't find it at the account level */
     const haveGoogle = speech.find((s) => s.vendor === 'google');
     const haveAws = speech.find((s) => s.vendor === 'aws');
-    if (!haveGoogle || !haveAws) {
+    const haveMicrosoft = speech.find((s) => s.vendor === 'microsoft');
+    if (!haveGoogle || !haveAws || !haveMicrosoft) {
       const [r3] = await pp.query(sqlSpeechCredentialsForSP, account_sid);
       if (r3.length) {
         if (!haveGoogle) {
@@ -48,6 +54,10 @@ module.exports = (logger, srf) => {
           const aws = r3.find((s) => s.vendor === 'aws');
           if (aws) speech.push(speechMapper(aws));
         }
+        if (!haveMicrosoft) {
+          const ms = r3.find((s) => s.vendor === 'microsoft');
+          if (ms) speech.push(speechMapper(ms));
+        }
       }
     }
 

lib/utils/encrypt-decrypt.js

@@ -1,5 +1,5 @@
 const crypto = require('crypto');
-const algorithm = 'aes-256-ctr';
+const algorithm = 'aes-256-cbc';
 const iv = crypto.randomBytes(16);
 const secretKey = crypto.createHash('sha256')
   .update(String(process.env.JWT_SECRET))

lib/utils/install-srf-locals.js

@@ -135,6 +135,7 @@ function installSrfLocals(srf, logger) {
     retrieveSet,
     addToSet,
     removeFromSet,
+    monitorSet,
     pushBack,
     popFront,
     removeFromList,
@@ -178,6 +179,7 @@ function installSrfLocals(srf, logger) {
       retrieveSet,
       addToSet,
       removeFromSet,
+      monitorSet,
       pushBack,
       popFront,
       removeFromList,

lib/utils/place-outdial.js

@@ -17,7 +17,7 @@ const moment = require('moment');
 const { v4: uuidv4 } = require('uuid');
 
 class SingleDialer extends Emitter {
-  constructor({logger, sbcAddress, target, opts, application, callInfo}) {
+  constructor({logger, sbcAddress, target, opts, application, callInfo, accountInfo}) {
     super();
     assert(target.type);
 
@@ -31,6 +31,8 @@ class SingleDialer extends Emitter {
     this.bindings = logger.bindings();
 
     this.parentCallInfo = callInfo;
+    this.accountInfo = accountInfo;
+
     this.callGone = false;
 
     this.callSid = uuidv4();
@@ -62,6 +64,7 @@ class SingleDialer extends Emitter {
     opts = opts || {};
     opts.headers = opts.headers || {};
     opts.headers = {...opts.headers, 'X-Call-Sid': this.callSid};
+    this.ms = ms;
     let uri, to;
     try {
       switch (this.target.type) {
@@ -85,6 +88,12 @@ class SingleDialer extends Emitter {
           uri = `sip:${this.target.name}`;
           to = this.target.name;
 
+          if (this.target.overrideTo) {
+            Object.assign(opts.headers, {
+              'X-Override-To': this.target.overrideTo
+            });
+          }
+
           // need to send to the SBC registered on
           const reg = await registrar.query(aor);
           if (reg) {
@@ -181,12 +190,21 @@ class SingleDialer extends Emitter {
       this.logger.debug(`SingleDialer:exec call connected: ${this.callSid}`);
       const connectTime = this.dlg.connectTime = moment();
 
+      /* race condition: we were killed just as call was answered */
+      if (this.killed) {
+        this.logger.info(`SingleDialer:exec race condition - we were killed as call connected: ${this.callSid}`);
+        const duration = moment().diff(connectTime, 'seconds');
+        this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
+        if (this.ep) this.ep.destroy();
+        return;
+      }
+
       this.dlg
         .on('destroy', () => {
           const duration = moment().diff(connectTime, 'seconds');
           this.logger.debug('SingleDialer:exec called party hung up');
           this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-          this.ep.destroy();
+          this.ep && this.ep.destroy();
         })
         .on('refresh', () => this.logger.info('SingleDialer:exec - dialog refreshed by uas'))
         .on('modify', async(req, res) => {
@@ -246,7 +264,7 @@ class SingleDialer extends Emitter {
   async _executeApp(confirmHook) {
     try {
       // retrieve set of tasks
-      const tasks = await this.requestor.request(confirmHook, this.callInfo);
+      const tasks = await this.requestor.request(confirmHook, this.callInfo.toJSON());
 
       // verify it contains only allowed verbs
       const allowedTasks = tasks.filter((task) => {
@@ -284,20 +302,48 @@ class SingleDialer extends Emitter {
     this.logger = logger;
     this.adulting = true;
     this.emit('adulting');
-    await this.ep.unbridge()
-      .catch((err) => this.logger.info({err}, 'SingleDialer:doAdulting - failed to unbridge ep'));
-    this.ep.play('silence_stream://1000');
+    if (this.ep) {
+      await this.ep.unbridge()
+        .catch((err) => this.logger.info({err}, 'SingleDialer:doAdulting - failed to unbridge ep'));
+      this.ep.play('silence_stream://1000');
+    }
+    else {
+      await this.reAnchorMedia();
+    }
     const cs = new AdultingCallSession({
       logger: this.logger,
       singleDialer: this,
       application,
       callInfo: this.callInfo,
+      accountInfo: this.accountInfo,
       tasks
     });
     cs.exec();
     return cs;
   }
 
+  async releaseMediaToSBC(remoteSdp) {
+    assert(this.dlg && this.dlg.connected && this.ep && typeof remoteSdp === 'string');
+    await this.dlg.modify(remoteSdp, {
+      headers: {
+        'X-Reason': 'release-media'
+      }
+    });
+    this.ep.destroy()
+      .then(() => this.ep = null)
+      .catch((err) => this.logger.error({err}, 'SingleDialer:releaseMediaToSBC: Error destroying endpoint'));
+  }
+
+  async reAnchorMedia() {
+    assert(this.dlg && this.dlg.connected && !this.ep);
+    this.ep = await this.ms.createEndpoint({remoteSdp: this.dlg.remote.sdp});
+    await this.dlg.modify(this.ep.local.sdp, {
+      headers: {
+        'X-Reason': 'anchor-media'
+      }
+    });
+  }
+
   _notifyCallStatusChange({callStatus, sipStatus, duration}) {
     assert((typeof duration === 'number' && callStatus === CallStatus.Completed) ||
       (!duration && callStatus !== CallStatus.Completed),
@@ -320,9 +366,9 @@ class SingleDialer extends Emitter {
   }
 }
 
-function placeOutdial({logger, srf, ms, sbcAddress, target, opts, application, callInfo}) {
+function placeOutdial({logger, srf, ms, sbcAddress, target, opts, application, callInfo, accountInfo}) {
   const myOpts = deepcopy(opts);
-  const sd = new SingleDialer({logger, sbcAddress, target, myOpts, application, callInfo});
+  const sd = new SingleDialer({logger, sbcAddress, target, myOpts, application, callInfo, accountInfo});
   sd.exec(srf, ms, myOpts);
   return sd;
 }

lib/utils/requestor.js

@@ -100,15 +100,15 @@ class Requestor {
 
     assert.ok(url, 'Requestor:request url was not provided');
     assert.ok, (['GET', 'POST'].includes(method), `Requestor:request method must be 'GET' or 'POST' not ${method}`);
-
-    this.logger.debug({hook, payload}, `Requestor:request ${method} ${url}`);
+    const {url: urlInfo = hook, method: methodInfo = 'POST'} = hook;  // mask user/pass
+    this.logger.debug({url: urlInfo, method: methodInfo, payload}, `Requestor:request ${method} ${url}`);
     const startAt = process.hrtime();
 
     let buf;
     try {
       const sigHeader = generateSigHeader(payload, this.secret);
       const headers = {...sigHeader, ...this.authHeader};
-      this.logger.info({url, headers}, 'send webhook');
+      //this.logger.info({url, headers}, 'send webhook');
       buf = isRelativeUrl(url) ?
         await this.post(url, payload, headers) :
         await bent(method, 'buffer', 200, 201, 202)(url, payload, headers);

lib/utils/sbc-pinger.js

@@ -7,13 +7,15 @@ const debug = require('debug')('jambonz:feature-server');
 module.exports = (logger) => {
   logger = logger || noopLogger;
   let idxSbc = 0;
+  let sbcs = [];
 
-  assert.ok(process.env.JAMBONES_SBCS, 'missing JAMBONES_SBCS env var');
-  const sbcs = process.env.JAMBONES_SBCS
-    .split(',')
-    .map((sbc) => sbc.trim());
-  assert.ok(sbcs.length, 'JAMBONES_SBCS env var is empty or misconfigured');
-  logger.info({sbcs}, 'SBC inventory');
+  if (process.env.JAMBONES_SBCS) {
+    sbcs = process.env.JAMBONES_SBCS
+      .split(',')
+      .map((sbc) => sbc.trim());
+    assert.ok(sbcs.length, 'JAMBONES_SBCS env var is empty or misconfigured');
+    logger.info({sbcs}, 'SBC inventory');
+  }
 
   // listen for SNS lifecycle changes
   let lifecycleEmitter = new Emitter();
@@ -96,8 +98,19 @@ module.exports = (logger) => {
   }, 20000);
 
   // initial ping once we are up
-  setTimeout(() => {
+  setTimeout(async() => {
     const {srf} = require('../..');
+
+    // if SBCs are auto-scaling, monitor them as they come and go
+    if (!process.env.JAMBONES_SBCS) {
+      const {monitorSet} = srf.locals.dbHelpers;
+      const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-sip`;
+      await monitorSet(setName, 10, (members) => {
+        sbcs = members;
+        logger.info(`sbc-pinger: SBC roster has changed, list of active SBCs is now ${sbcs}`);
+      });
+    }
+
     pingProxies(srf);
   }, 1000);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "0.3.1",
+  "version": "0.6.7-rc5",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -26,9 +26,9 @@
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
-    "@jambonz/db-helpers": "^0.6.13",
+    "@jambonz/db-helpers": "^0.6.14",
     "@jambonz/mw-registrar": "^0.2.1",
-    "@jambonz/realtimedb-helpers": "^0.4.1",
+    "@jambonz/realtimedb-helpers": "^0.4.9",
     "@jambonz/stats-collector": "^0.1.5",
     "@jambonz/time-series": "^0.1.5",
     "aws-sdk": "^2.846.0",
@@ -37,7 +37,7 @@
     "debug": "^4.3.1",
     "deepcopy": "^2.1.0",
     "drachtio-fsmrf": "^2.0.7",
-    "drachtio-srf": "^4.4.50",
+    "drachtio-srf": "^4.4.55",
     "express": "^4.17.1",
     "ip": "^1.1.5",
     "moment": "^2.29.1",

test/db/create-and-populate-schema.sql

@@ -587,7 +587,8 @@ DROP TABLE IF EXISTS `speech_credentials`;
 /*!50503 SET character_set_client = utf8mb4 */;
 CREATE TABLE `speech_credentials` (
   `speech_credential_sid` char(36) NOT NULL,
-  `account_sid` char(36) NOT NULL,
+ `service_provider_sid` CHAR(36),
+ `account_sid` char(36) NOT NULL,
   `vendor` varchar(255) NOT NULL,
   `credential` VARCHAR(8192) NOT NULL,
   `use_for_tts` tinyint(1) DEFAULT '1',
@@ -611,7 +612,7 @@ CREATE TABLE `speech_credentials` (
 
 LOCK TABLES `speech_credentials` WRITE;
 /*!40000 ALTER TABLE `speech_credentials` DISABLE KEYS */;
-INSERT INTO `speech_credentials` VALUES ('2add163c-34f2-45c6-a016-f955d218ffb6','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','google','credential-goes-here',1,1,NULL,'2021-04-03 15:42:10',1,1),('84154212-5c99-4c94-8993-bc2a46288daa','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','aws','credential-goes-here',0,0,NULL,NULL,NULL,NULL);
+INSERT INTO `speech_credentials` VALUES ('2add163c-34f2-45c6-a016-f955d218ffb6',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','google','credential-goes-here',1,1,NULL,'2021-04-03 15:42:10',1,1),('84154212-5c99-4c94-8993-bc2a46288daa',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','aws','credential-goes-here',0,0,NULL,NULL,NULL,NULL);
 /*!40000 ALTER TABLE `speech_credentials` ENABLE KEYS */;
 UNLOCK TABLES;
 

test/db/jambones-sql.sql

@@ -20,12 +20,16 @@ DROP TABLE IF EXISTS lcr_routes;
 
 DROP TABLE IF EXISTS predefined_sip_gateways;
 
+DROP TABLE IF EXISTS predefined_smpp_gateways;
+
 DROP TABLE IF EXISTS predefined_carriers;
 
 DROP TABLE IF EXISTS account_offers;
 
 DROP TABLE IF EXISTS products;
 
+DROP TABLE IF EXISTS schema_version;
+
 DROP TABLE IF EXISTS api_keys;
 
 DROP TABLE IF EXISTS sbc_addresses;
@@ -148,6 +152,20 @@ predefined_carrier_sid CHAR(36) NOT NULL,
 PRIMARY KEY (predefined_sip_gateway_sid)
 );
 
+CREATE TABLE predefined_smpp_gateways
+(
+predefined_smpp_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway. ',
+port INTEGER NOT NULL DEFAULT 2775 COMMENT 'smpp signaling port',
+inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound SMS from the gateway',
+outbound BOOLEAN NOT NULL COMMENT 'i',
+netmask INTEGER NOT NULL DEFAULT 32,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+use_tls BOOLEAN DEFAULT 0,
+predefined_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (predefined_smpp_gateway_sid)
+);
+
 CREATE TABLE products
 (
 product_sid CHAR(36) NOT NULL UNIQUE ,
@@ -174,6 +192,11 @@ stripe_product_id VARCHAR(56) NOT NULL,
 PRIMARY KEY (account_offer_sid)
 );
 
+CREATE TABLE schema_version
+(
+version VARCHAR(16)
+);
+
 CREATE TABLE api_keys
 (
 api_key_sid CHAR(36) NOT NULL UNIQUE ,
@@ -420,6 +443,10 @@ CREATE INDEX predefined_sip_gateway_sid_idx ON predefined_sip_gateways (predefin
 CREATE INDEX predefined_carrier_sid_idx ON predefined_sip_gateways (predefined_carrier_sid);
 ALTER TABLE predefined_sip_gateways ADD FOREIGN KEY predefined_carrier_sid_idxfk (predefined_carrier_sid) REFERENCES predefined_carriers (predefined_carrier_sid);
 
+CREATE INDEX predefined_smpp_gateway_sid_idx ON predefined_smpp_gateways (predefined_smpp_gateway_sid);
+CREATE INDEX predefined_carrier_sid_idx ON predefined_smpp_gateways (predefined_carrier_sid);
+ALTER TABLE predefined_smpp_gateways ADD FOREIGN KEY predefined_carrier_sid_idxfk_1 (predefined_carrier_sid) REFERENCES predefined_carriers (predefined_carrier_sid);
+
 CREATE INDEX product_sid_idx ON products (product_sid);
 CREATE INDEX account_product_sid_idx ON account_products (account_product_sid);
 CREATE INDEX account_subscription_sid_idx ON account_products (account_subscription_sid);
@@ -545,4 +572,4 @@ ALTER TABLE accounts ADD FOREIGN KEY queue_event_hook_sid_idxfk (queue_event_hoo
 
 ALTER TABLE accounts ADD FOREIGN KEY device_calling_application_sid_idxfk (device_calling_application_sid) REFERENCES applications (application_sid);
 
-SET FOREIGN_KEY_CHECKS=1;
+SET FOREIGN_KEY_CHECKS=0;