0.7.2 version

* JAMBONES_NETWORK_CIDR not needed for K8S

* fix bug setting fsUUID in K8S scenario

* bugfix: dial music was not stopped when a dial verb times out (#56)

.eslintrc.json

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

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - run: npm ci
+      - run: npm run jslint
+      - run: docker pull drachtio/sipp
+      - run: npm test
+        env:
+          GCP_JSON_KEY: ${{ secrets.GCP_JSON_KEY }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}

.github/workflows/docker-publish.yml

@@ -0,0 +1,51 @@
+name: Docker
+
+on:
+  push:
+    # Publish `main` as Docker `latest` image.
+    branches:
+      - main
+
+    # Publish `v1.2.3` tags as releases.
+    tags:
+      - v*
+
+env:
+  IMAGE_NAME: feature-server
+
+jobs:
+  push:
+
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build image
+        run: docker build . --file Dockerfile --tag $IMAGE_NAME
+
+      - name: Log into registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Push image
+        run: |
+          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
+
+          # Change all uppercase to lowercase
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "main" ] && VERSION=latest
+
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

.gitignore

@@ -37,4 +37,7 @@ node_modules
 
 examples/*
 
-ecosystem.config.js
+ecosystem.config.js
+.vscode
+test/credentials/*.json
+run-tests.sh

.travis.yml

@@ -1,6 +0,0 @@
-sudo: required
-language: node_js
-node_js:
-  - "lts/*"
-script:
-  - npm test

Dockerfile

@@ -1,13 +1,10 @@
-FROM node:lts-alpine
-
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
-
+FROM node:17.4-slim
+WORKDIR /opt/app/
+COPY package.json ./
+RUN npm install
+RUN npm prune
+COPY . /opt/app
 ARG NODE_ENV
 ENV NODE_ENV $NODE_ENV
 
-COPY package.json /usr/src/app/
-RUN npm install
-COPY . /usr/src/app
-
-CMD [ "npm", "start" ]
+CMD [ "npm", "start" ]

LICENSE

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

README.md

@@ -1,78 +1,86 @@
-# jambones-feature-server [![Build Status](https://secure.travis-ci.org/jambonz/jambones-feature-server.png)](http://travis-ci.org/jambonz/jambones-feature-server)
+# jambones-feature-server ![Build Status](https://github.com/jambonz/jambonz-feature-server/workflows/CI/badge.svg)
 
 This application implements the core feature server of the jambones platform.
 
 ## Configuration
 
-Configuration is provided via the [npmjs config](https://www.npmjs.com/package/config) package.  The following elements make up the configuration for the application:
-##### drachtio server location
-```
-{
-  "drachtio": {
-    "port": 3001,
-    "secret": "cymru"
-  },
-```
-the `drachtio` object specifies the port to listen on for tcp connections from drachtio servers as well as the shared secret that is used to authenticate to the server.
+Configuration is provided via environment variables:
 
-> Note: either inbound or [outbound connections](https://drachtio.org/docs#outbound-connections) may be used, depending on the configuration supplied.  In production, it is the intent to use outbound connections for easier centralization and clustering of application logic.
+| variable | meaning | required?|
+|----------|----------|---------|
+|AWS_ACCESS_KEY_ID| aws access key id, used for TTS/STT as well SNS notifications|no|
+|AWS_REGION| aws region| no|
+|AWS_SECRET_ACCESS_KEY| aws secret access key, used per above|no|
+|AWS_SNS_TOPIC_ARM| aws sns topic arn that scale-in lifecycle notifications will be published to|no|
+|DRACHTIO_HOST| ip address of drachtio server (typically '127.0.0.1')|yes|
+|DRACHTIO_PORT| listening port of drachtio server for control connections (typically 9022)|yes|
+|DRACHTIO_SECRET| shared secret|yes|
+|ENABLE_METRICS| if 1, metrics will be generated|no|
+|GOOGLE_APPLICATION_CREDENTIALS| path to gcp service key file|yes|
+|HTTP_PORT| tcp port to listen on for API requests from jambonz-api-server|yes|
+|JAMBONES_FREESWITCH| IP:port:secret for Freeswitch server (e.g. '127.0.0.1:8021:JambonzR0ck$'|yes|
+|JAMBONES_LOGLEVEL| log level for application, 'info' or 'debug'|no|
+|JAMBONES_MYSQL_HOST| mysql host|yes|
+|JAMBONES_MYSQL_USER| mysql username|yes|
+|JAMBONES_MYSQL_PASSWORD|  mysql password|yes|
+|JAMBONES_MYSQL_DATABASE| mysql data|yes|
+|JAMBONES_MYSQL_CONNECTION_LIMIT| mysql connection limit |no|
+|JAMBONES_NETWORK_CIDR| CIDR of private network that feature server is running in (e.g. '172.31.0.0/16')|yes|
+|JAMBONES_REDIS_HOST| redis host|yes|
+|JAMBONES_REDIS_PORT|redis port|yes|
+|JAMBONES_SBCS| list of IP addresses (on the internal network) of SBCs, comma-separated|yes|
+|STATS_HOST| ip address of metrics host (usually '127.0.0.1' since telegraf is installed locally|no|
+|STATS_PORT| listening port for metrics host|no|
+|STATS_PROTOCOL| 'tcp' or 'udp'|no|
+|STATS_TELEGRAF| if 1, metrics will be generated in telegraf format|no|
 
-##### freeswitch location
-```
-  "freeswitch: {
-    "address": "127.0.0.1",
-    "port": 8021,
-    "secret": "ClueCon"
-  },
-```
-the `freeswitch` property specifies the location of the freeswitch server to use for media handling.  
-
-##### application log level
-```
-  "logging": {
-    "level": "info"
-  }
-```
-##### mysql server location
-Login credentials for the mysql server databas.
-```
-  "mysql": {
-    "host": "127.0.0.1",
-    "user": "jambones",
-    "password": "jambones",
-    "database": "jambones"
-  }
-```
-##### redis server location
-Login credentials for the redis server databas.
-```
-  "redis": {
-    "host": "127.0.0.1",
-    "port": 6379
-  }
-```
-
-##### port to listen on for HTTP API requests
-The HTTP listen port can be set by the `HTTP_PORT` environment variable, but it not set the default port will be taken from the configuration file.
-
-```
-  "defaultHttpPort": 3000,
-```
-
-##### REST-initiated outdials
-When an outdial is triggered via the REST API, the application needs to select a drachtio sip server to generate the INVITE, and it needs to know the IP addresses of the SBC(s) to send the outbound call through.  Both are provided as arrays in the configuration file, and if more than one is supplied they will be used in a round-robin fashion.
-
-```
-  "outdials": {
-    "drachtio": [
-      {
-        "host": "127.0.0.1",
-        "port": 9022,
-        "secret": "cymru"
-      }
-    ],
-    "sbc": ["127.0.0.1:5060"]
-  }
+### running under pm2
+Typically, this application runs under [pm2](https://pm2.io) using an [ecosystem.config.js](https://pm2.keymetrics.io/docs/usage/application-declaration/) file similar to this:
+```js
+module.exports = {
+  apps : [
+  {
+    name: 'jambonz-feature-server',
+    cwd: '/home/admin/apps/jambonz-feature-server',
+    script: 'app.js',
+    instance_var: 'INSTANCE_ID',
+    out_file: '/home/admin/.pm2/logs/jambonz-feature-server.log',
+    err_file: '/home/admin/.pm2/logs/jambonz-feature-server.log',
+    exec_mode: 'fork',
+    instances: 1,
+    autorestart: true,
+    watch: false,
+    max_memory_restart: '1G',
+    env: {
+      NODE_ENV: 'production',
+      GOOGLE_APPLICATION_CREDENTIALS: '/home/admin/credentials/gcp.json',
+      AWS_ACCESS_KEY_ID: 'XXXXXXXXXXXX',
+      AWS_SECRET_ACCESS_KEY: 'YYYYYYYYYYYYYYYYYYYYY',
+      AWS_REGION: 'us-west-1',
+      ENABLE_METRICS: 1,
+      STATS_HOST: '127.0.0.1',
+      STATS_PORT: 8125,
+      STATS_PROTOCOL: 'tcp',
+      STATS_TELEGRAF: 1,
+      AWS_SNS_TOPIC_ARM: 'arn:aws:sns:us-west-1:xxxxxxxxxxx:terraform-20201107200347128600000002',
+      JAMBONES_NETWORK_CIDR: '172.31.0.0/16',
+      JAMBONES_MYSQL_HOST: 'aurora-cluster-jambonz.cluster-yyyyyyyyyyy.us-west-1.rds.amazonaws.com',
+      JAMBONES_MYSQL_USER: 'admin',
+      JAMBONES_MYSQL_PASSWORD: 'foobarbz',
+      JAMBONES_MYSQL_DATABASE: 'jambones',
+      JAMBONES_MYSQL_CONNECTION_LIMIT: 10,
+      JAMBONES_REDIS_HOST: 'jambonz.zzzzzzz.0001.usw1.cache.amazonaws.com',
+      JAMBONES_REDIS_PORT: 6379,
+      JAMBONES_LOGLEVEL: 'debug',
+      HTTP_PORT: 3000,
+      DRACHTIO_HOST: '127.0.0.1',
+      DRACHTIO_PORT: 9022,
+      DRACHTIO_SECRET: 'sharedsecret',
+      JAMBONES_SBCS: '172.31.32.10',
+      JAMBONES_FREESWITCH: '127.0.0.1:8021:sharedsecret'
+    }
+  }]
+};
 ```
 
 #### Running the test suite

app.js

@@ -7,20 +7,23 @@ assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACH
 assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
 assert.ok(process.env.JAMBONES_FREESWITCH, 'missing JAMBONES_FREESWITCH env var');
 assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
-assert.ok(process.env.JAMBONES_NETWORK_CIDR, 'missing JAMBONES_SUBNET env var');
+assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_SUBNET env var');
 
 const Srf = require('drachtio-srf');
 const srf = new Srf();
 const PORT = process.env.HTTP_PORT || 3000;
-const opts = Object.assign({
-  timestamp: () => {return `, "time": "${new Date().toISOString()}"`;}
-}, {level: process.env.JAMBONES_LOGLEVEL || 'info'});
+const opts = {
+  timestamp: () => {return `, "time": "${new Date().toISOString()}"`;},
+  level: process.env.JAMBONES_LOGLEVEL || 'info'
+};
 const logger = require('pino')(opts);
+const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./lib/utils/constants');
 const installSrfLocals = require('./lib/utils/install-srf-locals');
 installSrfLocals(srf, logger);
 
 const {
   initLocals,
+  getAccountDetails,
   normalizeNumbers,
   retrieveApplication,
   invokeWebCallback
@@ -29,7 +32,11 @@ const {
 // HTTP
 const express = require('express');
 const app = express();
-app.locals.logger = logger;
+Object.assign(app.locals, {
+  logger,
+  srf
+});
+
 const httpRoutes = require('./lib/http-routes');
 
 const InboundCallSession = require('./lib/session/inbound-call-session');
@@ -37,7 +44,9 @@ const InboundCallSession = require('./lib/session/inbound-call-session');
 if (process.env.DRACHTIO_HOST) {
   srf.connect({host: process.env.DRACHTIO_HOST, port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET });
   srf.on('connect', (err, hp) => {
-    logger.info(`connected to drachtio listening on ${hp}`);
+    const arr = /^(.*)\/(.*)$/.exec(hp.split(',').pop());
+    srf.locals.localSipAddress = `${arr[2]}`;
+    logger.info(`connected to drachtio listening on ${hp}, local sip address is ${srf.locals.localSipAddress}`);
   });
 }
 else {
@@ -50,7 +59,13 @@ if (process.env.NODE_ENV === 'test') {
   });
 }
 
-srf.use('invite', [initLocals, normalizeNumbers, retrieveApplication, invokeWebCallback]);
+srf.use('invite', [
+  initLocals,
+  getAccountDetails,
+  normalizeNumbers,
+  retrieveApplication,
+  invokeWebCallback
+]);
 
 srf.invite((req, res) => {
   const session = new InboundCallSession(req, res);
@@ -65,13 +80,45 @@ app.use((err, req, res, next) => {
   logger.error(err, 'burped error');
   res.status(err.status || 500).json({msg: err.message});
 });
-app.listen(PORT);
+const httpServer = app.listen(PORT);
 
 logger.info(`listening for HTTP requests on port ${PORT}, serviceUrl is ${srf.locals.serviceUrl}`);
 
-const sessionTracker = require('./lib/session/session-tracker');
+const sessionTracker = srf.locals.sessionTracker = require('./lib/session/session-tracker');
+sessionTracker.on('idle', () => {
+  if (srf.locals.lifecycleEmitter.operationalState === LifeCycleEvents.ScaleIn) {
+    logger.info('scale-in complete now that calls have dried up');
+    srf.locals.lifecycleEmitter.scaleIn();
+  }
+});
+
+const getCount = () => sessionTracker.count;
+const healthCheck = require('@jambonz/http-health-check');
+healthCheck({app, logger, path: '/', fn: getCount});
+
 setInterval(() => {
   srf.locals.stats.gauge('fs.sip.calls.count', sessionTracker.count);
 }, 5000);
 
-module.exports = {srf, logger};
+const disconnect = () => {
+  return new Promise ((resolve) => {
+    httpServer.on('close', resolve);
+    httpServer.close();
+    srf.disconnect();
+    srf.locals.mediaservers.forEach((ms) => ms.disconnect());
+  });
+};
+
+process.on('SIGUSR2', handle);
+process.on('SIGTERM', handle);
+
+function handle(signal) {
+  const {removeFromSet} = srf.locals.dbHelpers;
+  const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
+  logger.info(`got signal ${signal}, removing ${srf.locals.localSipAddress} from set ${setName}`);
+  removeFromSet(setName, srf.locals.localSipAddress);
+  removeFromSet(FS_UUID_SET_NAME, srf.locals.fsUUID);
+  srf.locals.disabled = true;
+}
+
+module.exports = {srf, logger, disconnect};

bin/k8s-pre-stop-hook.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const bent = require('bent');
+const getJSON = bent('json');
+const PORT = process.env.HTTP_PORT || 3000;
+
+const sleep = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+(async function() {
+
+  try {
+    do {
+      const obj = await getJSON(`http://127.0.0.1:${PORT}/`);
+      const {calls} = obj;
+      if (calls === 0) {
+        console.log('no calls on the system, we can exit');
+        process.exit(0);
+      }
+      else {
+        console.log(`waiting for ${calls} to exit..`);
+      }
+      await sleep(10000);
+    } while (1);
+  } catch (err) {
+    console.error(err, 'Error querying health endpoint');
+    process.exit(-1);
+  }
+})();

config/default.json.example

@@ -1,35 +0,0 @@
-{
-  "drachtio": {
-    "port": 3010,
-    "secret": "cymru"
-  },
-  "freeswitch": {
-    "address": "127.0.0.1",
-    "port": 8021,
-    "secret": "ClueCon"
-  },
-  "logging": {
-    "level": "info"
-  },
-  "mysql": {
-    "host": "localhost",
-    "user": "jambones",
-    "password": "jambones",
-    "database": "jambones"
-  },
-  "redis": {
-    "host": "127.0.0.1",
-    "port": 6379
-  },
-  "defaultHttpPort": 3000,
-  "outdials": {
-    "drachtio": [
-      {
-        "host": "127.0.0.1",
-        "port": 9022,
-        "secret": "cymru"
-      }
-    ],
-    "sbc": ["127.0.0.1:5060"]
-  }
-}

config/local-test.json

@@ -1,16 +0,0 @@
-{
-  "drachtio": {
-    "host": "127.0.0.1",
-    "port": 9060,
-    "secret": "cymru"
-  },
-  "logging": {
-    "level": "debug"
-  },
-  "mysql": {
-    "host": "localhost",
-    "user": "jambones_test",
-    "password": "jambones_test",
-    "database": "jambones_test"
-  }
-}

lib/http-routes/api/conference.js

@@ -0,0 +1,41 @@
+const router = require('express').Router();
+const sysError = require('./error');
+const sessionTracker = require('../../session/session-tracker');
+const {TaskName} = require('../../utils/constants.json');
+const {DbErrorUnprocessableRequest} = require('../utils/errors');
+
+/**
+ * validate the call state
+ */
+function retrieveCallSession(callSid, opts) {
+  const cs = sessionTracker.get(callSid);
+  if (cs) {
+    const task = cs.currentTask;
+    if (!task || task.name != TaskName.Conference) {
+      throw new DbErrorUnprocessableRequest(`conference api failure: indicated call is not waiting: ${task.name}`);
+    }
+  }
+  return cs;
+}
+
+/**
+ * notify a waiting session that a conference has started
+ */
+router.post('/:callSid', async(req, res) => {
+  const logger = req.app.locals.logger;
+  const callSid = req.params.callSid;
+  logger.debug({body: req.body}, 'got conference request');
+  try {
+    const cs = retrieveCallSession(callSid, req.body);
+    if (!cs) {
+      logger.info(`conference: callSid not found ${callSid}`);
+      return res.sendStatus(404);
+    }
+    res.status(202).end();
+    cs.notifyConferenceEvent(req.body);
+  } catch (err) {
+    sysError(logger, res, err);
+  }
+});
+
+module.exports = router;

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

@@ -3,42 +3,65 @@ const makeTask = require('../../tasks/make_task');
 const RestCallSession = require('../../session/rest-call-session');
 const CallInfo = require('../../session/call-info');
 const {CallDirection, CallStatus} = require('../../utils/constants');
+const { v4: uuidv4 } = require('uuid');
 const SipError = require('drachtio-srf').SipError;
 const sysError = require('./error');
 const Requestor = require('../../utils/requestor');
-
-/**
- * Retrieve a connection to a drachtio server, lazily creating when first called
- */
-function getSrfForOutdial(logger) {
-  const {srf} = require('../../../');
-  const {getSrf} = srf.locals;
-  const srfForOutdial = getSrf();
-  if (!srfForOutdial) throw new Error('no available feature servers for outbound call creation');
-  return srfForOutdial;
-}
+const dbUtils = require('../../utils/db-utils');
 
 router.post('/', async(req, res) => {
-  const logger = req.app.locals.logger;
+  const {logger} = req.app.locals;
+
   logger.debug({body: req.body}, 'got createCall request');
   try {
     let uri, cs, to;
     const restDial = makeTask(logger, {'rest:dial': req.body});
-    const srf = getSrfForOutdial(logger);
+    const {srf} = require('../../..');
+    const {lookupAccountDetails} = dbUtils(logger, srf);
     const {getSBC, getFreeswitch} = srf.locals;
     const sbcAddress = getSBC();
     if (!sbcAddress) throw new Error('no available SBCs for outbound call creation');
     const target = restDial.to;
-    const opts = { callingNumber: restDial.from };
+    const opts = {
+      callingNumber: restDial.from,
+      headers: req.body.headers || {}
+    };
+
+
+    const {lookupTeamsByAccount, lookupAccountBySid} = srf.locals.dbHelpers;
+    const account = await lookupAccountBySid(req.body.account_sid);
+    const accountInfo = await lookupAccountDetails(req.body.account_sid);
+    const callSid = uuidv4();
+
+    opts.headers = {
+      ...opts.headers,
+      'X-Call-Sid': callSid,
+      'X-Account-Sid': req.body.account_sid
+    };
 
     switch (target.type) {
       case 'phone':
+      case 'teams':
         uri = `sip:${target.number}@${sbcAddress}`;
         to = target.number;
+        if ('teams' === target.type) {
+          const obj = await lookupTeamsByAccount(req.body.account_sid);
+          if (!obj) throw new Error('dial to ms teams not allowed; account must first be configured with teams info');
+          Object.assign(opts.headers, {
+            'X-MS-Teams-FQDN': obj.ms_teams_fqdn,
+            'X-MS-Teams-Tenant-FQDN': target.tenant || obj.tenant_fqdn
+          });
+          if (target.vmail === true) uri = `${uri};opaque=app:voicemail`;
+        }
         break;
       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;
@@ -79,20 +102,25 @@ router.post('/', async(req, res) => {
      * attach our requestor and notifier objects
      * these will be used for all http requests we make during this call
      */
-    app.requestor = new Requestor(logger, app.call_hook);
-    if (app.call_status_hook) app.notifier = new Requestor(logger, app.call_status_hook);
+    app.requestor = new Requestor(logger, account.account_sid, app.call_hook, account.webhook_secret);
+    if (app.call_status_hook) {
+      app.notifier = new Requestor(logger, account.account_sid, app.call_status_hook, account.webhook_secret);
+    }
     else app.notifier = {request: () => {}};
 
     /* 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');
-            ep.destroy();
+            return;
           }
-          /* ok our outbound NVITE is in flight */
+          /* ok our outbound INVITE is in flight */
 
           const tasks = [restDial];
           const callInfo = new CallInfo({
@@ -100,10 +128,11 @@ router.post('/', async(req, res) => {
             req: inviteReq,
             to,
             tag: app.tag,
+            callSid,
             accountSid: req.body.account_sid,
             applicationSid: app.application_sid
           });
-          cs = new RestCallSession({logger, application: app, srf, req: inviteReq, ep, tasks, callInfo});
+          cs = new RestCallSession({logger, application: app, srf, req: inviteReq, ep, tasks, callInfo, accountInfo});
           cs.exec(req);
 
           res.status(201).json({sid: cs.callSid});
@@ -131,12 +160,14 @@ router.post('/', async(req, res) => {
       if (err instanceof SipError) {
         if ([486, 603].includes(err.status)) callStatus = CallStatus.Busy;
         else if (487 === err.status) callStatus = CallStatus.NoAnswer;
-        sipLogger.info(`REST outdial failed with ${err.status}`);
-        cs.emit('callStatusChange', {callStatus, sipStatus: err.status});
+        if (sipLogger) sipLogger.info(`REST outdial failed with ${err.status}`);
+        else console.log(`REST outdial failed with ${err.status}`);
+        if (cs) cs.emit('callStatusChange', {callStatus, sipStatus: err.status});
       }
       else {
-        cs.emit('callStatusChange', {callStatus, sipStatus: 500});
-        sipLogger.error({err}, 'REST outdial failed');
+        if (cs) cs.emit('callStatusChange', {callStatus, sipStatus: 500});
+        if (sipLogger) sipLogger.error({err}, 'REST outdial failed');
+        else console.error(err);
       }
       ep.destroy();
     }

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

@@ -0,0 +1,38 @@
+const router = require('express').Router();
+const CallInfo = require('../../session/call-info');
+const {CallDirection} = require('../../utils/constants');
+const SmsSession = require('../../session/sms-call-session');
+const normalizeJambones = require('../../utils/normalize-jambones');
+const makeTask = require('../../tasks/make_task');
+
+router.post('/:sid', async(req, res) => {
+  const {logger} = req.app.locals;
+  const {srf} = req.app.locals;
+  const {message_sid, account_sid} = req.body;
+
+  logger.debug({body: req.body}, 'got createMessage request');
+
+  const data = [{
+    verb: 'message',
+    ...req.body
+  }];
+  delete data[0].message_sid;
+
+  try {
+    const tasks = normalizeJambones(logger, data)
+      .map((tdata) => makeTask(logger, tdata));
+
+    const callInfo = new CallInfo({
+      direction: CallDirection.None,
+      messageSid: message_sid,
+      accountSid: account_sid,
+      res
+    });
+    const cs = new SmsSession({logger, srf, tasks, callInfo});
+    cs.exec();
+  } catch (err) {
+    logger.error({err, body: req.body}, 'OutboundSMS: error launching SmsCallSession');
+  }
+});
+
+module.exports = router;

lib/http-routes/api/dequeue.js

@@ -0,0 +1,41 @@
+const router = require('express').Router();
+const sysError = require('./error');
+const sessionTracker = require('../../session/session-tracker');
+const {TaskName} = require('../../utils/constants.json');
+const {DbErrorUnprocessableRequest} = require('../utils/errors');
+
+/**
+ * validate the call state
+ */
+function retrieveCallSession(callSid, opts) {
+  const cs = sessionTracker.get(callSid);
+  if (cs) {
+    const task = cs.currentTask;
+    if (!task || task.name != TaskName.Dequeue) {
+      throw new DbErrorUnprocessableRequest(`dequeue api failure: indicated call is not queued: ${task.name}`);
+    }
+  }
+  return cs;
+}
+
+/**
+ * notify a session in a dequeue verb of an event
+ */
+router.post('/:callSid', async(req, res) => {
+  const logger = req.app.locals.logger;
+  const callSid = req.params.callSid;
+  logger.debug({body: req.body}, 'got dequeue event');
+  try {
+    const cs = retrieveCallSession(callSid, req.body);
+    if (!cs) {
+      logger.info(`dequeue: callSid not found ${callSid}`);
+      return res.sendStatus(404);
+    }
+    res.status(202).end();
+    cs.notifyDequeueEvent(req.body);
+  } catch (err) {
+    sysError(logger, res, err);
+  }
+});
+
+module.exports = router;

lib/http-routes/api/enqueue.js

@@ -0,0 +1,43 @@
+const router = require('express').Router();
+const sysError = require('./error');
+const sessionTracker = require('../../session/session-tracker');
+const {TaskName} = require('../../utils/constants.json');
+const {DbErrorUnprocessableRequest} = require('../utils/errors');
+
+/**
+ * validate the call state
+ */
+function retrieveCallSession(logger, callSid, opts) {
+  logger.debug(`retrieving session for callSid ${callSid}`);
+  const cs = sessionTracker.get(callSid);
+  if (cs) {
+    const task = cs.currentTask;
+    if (!task || task.name != TaskName.Enqueue) {
+      logger.debug({cs}, 'found call session but not in Enqueue task??');
+      throw new DbErrorUnprocessableRequest(`enqueue api failure: indicated call is not queued: ${task.name}`);
+    }
+  }
+  return cs;
+}
+
+/**
+ * notify a waiting session that a queue event has occurred
+ */
+router.post('/:callSid', async(req, res) => {
+  const logger = req.app.locals.logger;
+  const callSid = req.params.callSid;
+  logger.debug({callSid, body: req.body}, 'got enqueue event');
+  try {
+    const cs = retrieveCallSession(logger, callSid, req.body);
+    if (!cs) {
+      logger.info(`enqueue: callSid not found ${callSid}`);
+      return res.sendStatus(404);
+    }
+    res.status(202).end();
+    cs.notifyEnqueueEvent(req.body);
+  } catch (err) {
+    sysError(logger, res, err);
+  }
+});
+
+module.exports = router;

lib/http-routes/api/index.js

@@ -2,9 +2,11 @@ const api = require('express').Router();
 
 api.use('/createCall', require('./create-call'));
 api.use('/updateCall', require('./update-call'));
+api.use('/conference', require('./conference'));
+api.use('/dequeue', require('./dequeue'));
+api.use('/enqueue', require('./enqueue'));
 
-// health checks
-api.get('/', (req, res) => res.sendStatus(200));
-api.get('/health', (req, res) => res.sendStatus(200));
+api.use('/messaging', require('./messaging'));            // inbound SMS
+api.use('/createMessage', require('./create-message'));   // outbound SMS (REST)
 
 module.exports = api;

lib/http-routes/api/messaging.js

@@ -0,0 +1,74 @@
+const router = require('express').Router();
+const Requestor = require('../../utils/requestor');
+const CallInfo = require('../../session/call-info');
+const {CallDirection} = require('../../utils/constants');
+const SmsSession = require('../../session/sms-call-session');
+const normalizeJambones = require('../../utils/normalize-jambones');
+const {TaskPreconditions} = require('../../utils/constants');
+const makeTask = require('../../tasks/make_task');
+
+router.post('/:partner', async(req, res) => {
+  const {logger} = req.app.locals;
+
+  logger.debug({body: req.body}, `got incomingSms request from partner ${req.params.partner}`);
+
+  let tasks;
+  const {srf} = require('../../..');
+  const {lookupAccountBySid} = srf.locals.dbHelpers;
+  const app = req.body.app;
+  const account = await lookupAccountBySid(app.accountSid);
+  const hook = app.messaging_hook;
+  const requestor = new Requestor(logger, account.account_sid, hook, account.webhook_secret);
+  const payload = {
+    carrier: req.params.partner,
+    messageSid: app.messageSid,
+    accountSid: app.accountSid,
+    applicationSid: app.applicationSid,
+    from: req.body.from,
+    to: req.body.to,
+    cc: req.body.cc,
+    text: req.body.text,
+    media: req.body.media
+  };
+  res.status(200).json({sid: req.body.messageSid});
+
+  try {
+    tasks = await requestor.request(hook, payload);
+    logger.info({tasks}, 'response from incoming SMS webhook');
+  } catch (err) {
+    logger.error({err, hook}, 'Error sending incoming SMS message');
+    return;
+  }
+
+
+  // process any verbs in response
+  if (Array.isArray(tasks) && tasks.length) {
+    const {srf} = req.app.locals;
+
+    app.requestor = requestor;
+    app.notifier = {request: () => {}};
+
+    try {
+      tasks = normalizeJambones(logger, tasks)
+        .map((tdata) => makeTask(logger, tdata))
+        .filter((t) => t.preconditions === TaskPreconditions.None);
+
+      if (0 === tasks.length) {
+        logger.info('inboundSMS: after removing invalid verbs there are no tasks left to execute');
+        return;
+      }
+      const callInfo = new CallInfo({
+        direction: CallDirection.None,
+        messageSid: app.messageSid,
+        accountSid: app.accountSid,
+        applicationSid: app.applicationSid
+      });
+      const cs = new SmsSession({logger, srf, application: app, tasks, callInfo});
+      cs.exec();
+    } catch (err) {
+      logger.error({err, tasks}, 'InboundSMS: error launching SmsCallSession');
+    }
+  }
+});
+
+module.exports = router;

lib/http-routes/index.js

@@ -1,16 +1,23 @@
 const express = require('express');
 const api = require('./api');
 const routes = express.Router();
+const sessionTracker = require('../session/session-tracker');
+
+const readiness = (req, res) => {
+  const logger = req.app.locals.logger;
+  const {count} = sessionTracker;
+  const {srf} = require('../..');
+  const {getFreeswitch} = srf.locals;
+  if (getFreeswitch()) {
+    return res.status(200).json({calls: count});
+  }
+  logger.info('responding to /health check with failure as freeswitch is not up');
+  res.sendStatus(480);
+};
 
 routes.use('/v1', api);
 
-// health checks
-routes.get('/', (req, res) => {
-  res.sendStatus(200);
-});
-
-routes.get('/health', (req, res) => {
-  res.sendStatus(200);
-});
+// health check
+routes.get('/health', readiness);
 
 module.exports = routes;

lib/middleware.js

@@ -1,15 +1,23 @@
-const uuidv4 = require('uuid/v4');
+const { v4: uuidv4 } = require('uuid');
 const {CallDirection} = require('./utils/constants');
 const CallInfo = require('./session/call-info');
 const Requestor = require('./utils/requestor');
 const makeTask = require('./tasks/make_task');
-const normalizeJamones = require('./utils/normalize-jamones');
+const parseUri = require('drachtio-srf').parseUri;
+const normalizeJambones = require('./utils/normalize-jambones');
+const dbUtils = require('./utils/db-utils');
 
 module.exports = function(srf, logger) {
-  const {lookupAppByPhoneNumber, lookupAppBySid, lookupAppByRealm}  = srf.locals.dbHelpers;
-
+  const {
+    lookupAppByPhoneNumber,
+    lookupAppByRegex,
+    lookupAppBySid,
+    lookupAppByRealm,
+    lookupAppByTeamsTenant
+  }  = srf.locals.dbHelpers;
+  const {lookupAccountDetails} = dbUtils(logger, srf);
   function initLocals(req, res, next) {
-    const callSid = uuidv4();
+    const callSid = req.has('X-Retain-Call-Sid') ? req.get('X-Retain-Call-Sid') : uuidv4();
     req.locals = {
       callSid,
       logger: logger.child({callId: req.get('Call-ID'), callSid})
@@ -20,10 +28,37 @@ module.exports = function(srf, logger) {
       req.locals.application_sid = application_sid;
     }
     if (req.has('X-Authenticated-User')) req.locals.originatingUser = req.get('X-Authenticated-User');
+    if (req.has('X-MS-Teams-Tenant-FQDN')) req.locals.msTeamsTenant = req.get('X-MS-Teams-Tenant-FQDN');
 
     next();
   }
 
+  /**
+   * retrieve account information for the incoming call
+   */
+  async function getAccountDetails(req, res, next) {
+
+    if (!req.has('X-Account-Sid')) {
+      logger.info('getAccountDetails - rejecting call due to missing X-Account-Sid header');
+      return res.send(500);
+    }
+    const account_sid = req.locals.account_sid = req.get('X-Account-Sid');
+
+    try {
+      req.locals.accountInfo = await lookupAccountDetails(account_sid);
+      if (!req.locals.accountInfo.account.is_active) {
+        logger.info(`Account is inactive or suspended ${account_sid}`);
+        // TODO: alert
+        return res.send(503, {headers: {'X-Reason': 'Account exists but is inactive'}});
+      }
+      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}`);
+      res.send(503, {headers: {'X-Reason': `No Account exists for sid ${account_sid}`}});
+    }
+  }
+
   /**
    * Within the system, we deal with E.164 numbers _without_ the leading '+
    */
@@ -50,6 +85,7 @@ module.exports = function(srf, logger) {
    */
   async function retrieveApplication(req, res, next) {
     const logger = req.locals.logger;
+    const {accountInfo, account_sid} = req.locals;
     try {
       let app;
       if (req.locals.application_sid) app = await lookupAppBySid(req.locals.application_sid);
@@ -63,7 +99,35 @@ module.exports = function(srf, logger) {
 
         }
       }
-      else app = await lookupAppByPhoneNumber(req.locals.calledNumber);
+      else if (req.locals.msTeamsTenant) {
+        app = await lookupAppByTeamsTenant(req.locals.msTeamsTenant);
+        if (app) logger.debug({app}, `retrieved app for ms teams tenant ${req.locals.msTeamsTenant}`);
+      }
+      else {
+        const uri = parseUri(req.uri);
+        const arr = /context-(.*)/.exec(uri.user);
+        if (arr) {
+          // this is a transfer from another feature server
+          const {retrieveKey, deleteKey} = srf.locals.dbHelpers;
+          try {
+            const obj = JSON.parse(await retrieveKey(arr[1]));
+            logger.info({obj}, 'retrieved application and tasks for a transferred call from realtimedb');
+            app = Object.assign(obj, {transferredCall: true});
+            deleteKey(arr[1]).catch(() => {});
+          } catch (err) {
+            logger.error(err, `Error retrieving transferred call app for ${arr[1]}`);
+          }
+        }
+        else {
+          const voip_carrier_sid = req.get('X-Voip-Carrier-Sid');
+          app = await lookupAppByPhoneNumber(req.locals.calledNumber, voip_carrier_sid);
+
+          if (!app) {
+            /* lookup by call_routes.regex */
+            app = await lookupAppByRegex(req.locals.calledNumber, account_sid);
+          }
+        }
+      }
 
       if (!app || !app.call_hook || !app.call_hook.url) {
         logger.info(`rejecting call to ${req.locals.calledNumber}: no application or webhook url`);
@@ -78,15 +142,18 @@ module.exports = function(srf, logger) {
       * create a requestor that we will use for all http requests we make during the call.
       * also create a notifier for call status events (if not needed, its a no-op).
       */
-      app.requestor = new Requestor(logger, app.call_hook);
-      if (app.call_status_hook) app.notifier = new Requestor(logger, app.call_status_hook);
+      app.requestor = new Requestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
+      if (app.call_status_hook) app.notifier = new Requestor(logger, account_sid, app.call_status_hook,
+        accountInfo.account.webhook_secret);
       else app.notifier = {request: () => {}};
 
       req.locals.application = app;
       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) {
@@ -102,21 +169,28 @@ module.exports = function(srf, logger) {
     const logger = req.locals.logger;
     const app = req.locals.application;
     try {
+
+      if (app.tasks) {
+        app.tasks = normalizeJambones(logger, app.tasks).map((tdata) => makeTask(logger, tdata));
+        if (0 === app.tasks.length) throw new Error('no application provided');
+        return next();
+      }
       /* retrieve the application to execute for this inbound call */
       const params = Object.assign(app.call_hook.method === 'POST' ? {sip: req.msg} : {},
         req.locals.callInfo);
       const json = await app.requestor.request(app.call_hook, params);
-      app.tasks = normalizeJamones(logger, json).map((tdata) => makeTask(logger, tdata));
+      app.tasks = normalizeJambones(logger, json).map((tdata) => makeTask(logger, tdata));
       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}});
     }
   }
 
   return {
     initLocals,
+    getAccountDetails,
     normalizeNumbers,
     retrieveApplication,
     invokeWebCallback

lib/session/adulting-call-session.js

@@ -0,0 +1,44 @@
+const CallSession = require('./call-session');
+
+/**
+ * @classdesc Subclass of CallSession.  Represents a CallSession
+ * that was initially a child call leg; i.e. established via a Dial verb.
+ * Now it is all grown up and filling out its own CallSession.  Yoo-hoo!
+ * @extends CallSession
+
+ */
+class AdultingCallSession extends CallSession {
+  constructor({logger, application, singleDialer, tasks, callInfo, accountInfo}) {
+    super({
+      logger,
+      application,
+      srf: singleDialer.dlg.srf,
+      tasks,
+      callInfo,
+      accountInfo
+    });
+    this.sd = singleDialer;
+
+    this.sd.dlg.on('destroy', () => {
+      this.logger.info('AdultingCallSession: called party hung up');
+      this._callReleased();
+    });
+    this.sd.emit('adulting');
+  }
+
+  get dlg() {
+    return this.sd.dlg;
+  }
+
+  get ep() {
+    return this.sd.ep;
+  }
+
+  get callSid() {
+    return this.callInfo.callSid;
+  }
+
+
+}
+
+module.exports = AdultingCallSession;

lib/session/call-info.js

@@ -1,5 +1,6 @@
 const {CallDirection, CallStatus} = require('../utils/constants');
-const uuidv4 = require('uuid/v4');
+const parseUri = require('drachtio-srf').parseUri;
+const { v4: uuidv4 } = require('uuid');
 
 /**
  * @classdesc Represents the common information for all calls
@@ -7,16 +8,22 @@ const uuidv4 = require('uuid/v4');
  */
 class CallInfo {
   constructor(opts) {
+    let from ;
     this.direction = opts.direction;
+    if (opts.req) {
+      const u = opts.req.getParsedHeader('from');
+      const uri = parseUri(u.uri);
+      from = uri.user;
+      this.callerName = u.name || '';
+    }
     if (this.direction === CallDirection.Inbound) {
       // inbound call
       const {app, req} = opts;
       this.callSid = req.locals.callSid,
       this.accountSid = app.account_sid,
       this.applicationSid = app.application_sid;
-      this.from = req.callingNumber;
+      this.from = from || req.callingNumber;
       this.to = req.calledNumber;
-      this.callerName = this.from.name || req.callingNumber;
       this.callId = req.get('Call-ID');
       this.sipStatus = 100;
       this.callStatus = CallStatus.Trying;
@@ -30,23 +37,31 @@ class CallInfo {
       this.parentCallSid = parentCallInfo.callSid;
       this.accountSid = parentCallInfo.accountSid;
       this.applicationSid = parentCallInfo.applicationSid;
-      this.from = req.callingNumber;
+      this.from = from || req.callingNumber;
       this.to = to;
       this.callerId = this.from.name || req.callingNumber;
       this.callId = req.get('Call-ID');
       this.callStatus = CallStatus.Trying,
       this.sipStatus = 100;
     }
+    else if (this.direction === CallDirection.None) {
+      // outbound SMS
+      const {messageSid, accountSid, applicationSid, res} = opts;
+      this.messageSid = messageSid;
+      this.accountSid = accountSid;
+      this.applicationSid = applicationSid;
+      this.res = res;
+    }
     else {
       // outbound call triggered by REST
-      const {req, accountSid, applicationSid, to, tag} = opts;
-      this.callSid = uuidv4();
+      const {req, callSid, accountSid, applicationSid, to, tag} = opts;
+      this.callSid = callSid;
       this.accountSid = accountSid;
       this.applicationSid = applicationSid;
       this.callStatus = CallStatus.Trying,
       this.callId = req.get('Call-ID');
       this.sipStatus = 100;
-      this.from = req.callingNumber;
+      this.from = from || req.callingNumber;
       this.to = to;
       if (tag) this._customerData = tag;
     }

lib/session/call-session.js

@@ -1,12 +1,21 @@
 const Emitter = require('events');
-const {CallDirection, TaskPreconditions, CallStatus, TaskName} = require('../utils/constants');
+const fs = require('fs');
+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 normalizeJamones = require('../utils/normalize-jamones');
+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.
@@ -25,22 +34,33 @@ 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}) {
+  constructor({logger, application, srf, tasks, callInfo, accountInfo, memberId, confName, confUuid}) {
     super();
     this.logger = logger;
     this.application = application;
     this.srf = srf;
     this.callInfo = callInfo;
+    this.accountInfo = accountInfo;
     this.tasks = tasks;
-
-    this.updateCallStatus = srf.locals.dbHelpers.updateCallStatus;
-    this.serviceUrl = srf.locals.serviceUrl;
-
+    this.memberId = memberId;
+    this.confName = confName;
+    this.confUuid = confUuid;
     this.taskIdx = 0;
     this.stackIdx = 0;
     this.callGone = false;
 
-    sessionTracker.add(this.callSid, this);
+    this.tmpFiles = new Set();
+
+    if (!this.isSmsCallSession) {
+      this.updateCallStatus = srf.locals.dbHelpers.updateCallStatus;
+      this.serviceUrl = srf.locals.serviceUrl;
+    }
+
+    if (!this.isConfirmCallSession && !this.isSmsCallSession && !this.isAdultingCallSession) {
+      sessionTracker.add(this.callSid, this);
+    }
+
+    this._pool = srf.locals.dbHelpers.pool;
   }
 
   /**
@@ -61,7 +81,7 @@ class CallSession extends Emitter {
    * SIP call-id for the call
    */
   get callId() {
-    return this.callInfo.direction;
+    return this.callInfo.callId;
   }
 
   /**
@@ -99,6 +119,12 @@ class CallSession extends Emitter {
   get speechSynthesisVoice() {
     return this.application.speech_synthesis_voice;
   }
+  /**
+   * default language to use for speech synthesis if not provided in the app
+   */
+  get speechSynthesisLanguage() {
+    return this.application.speech_synthesis_language;
+  }
 
   /**
    * default vendor to use for speech recognition if not provided in the app
@@ -134,6 +160,127 @@ class CallSession extends Emitter {
     return this.direction === CallDirection.Inbound && this.res.finalResponseSent;
   }
 
+  /**
+   * returns the account sid
+   */
+  get accountSid() {
+    return this.callInfo.accountSid;
+  }
+
+  /**
+   * returns true if this session was transferred from another server
+   */
+  get isTransferredCall() {
+    return this.application.transferredCall === true;
+  }
+
+  /**
+   * returns true if this session is a ConfirmCallSession
+   */
+  get isAdultingCallSession() {
+    return this.constructor.name === 'AdultingCallSession';
+  }
+
+  /**
+   * returns true if this session is a ConfirmCallSession
+   */
+  get isConfirmCallSession() {
+    return this.constructor.name === 'ConfirmCallSession';
+  }
+
+  /**
+   * returns true if this session is a SmsCallSession
+   */
+  get isSmsCallSession() {
+    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;
+    if (this.accountInfo.speech && this.accountInfo.speech.length > 0) {
+      const credential = this.accountInfo.speech.find((s) => s.vendor === vendor);
+      if (credential && (
+        (type === 'tts' && credential.use_for_tts) ||
+        (type === 'stt' && credential.use_for_stt)
+      )) {
+        if ('google' === vendor) {
+          try {
+            const cred = JSON.parse(credential.service_key.replace(/\n/g, '\\n'));
+            return {
+              speech_credential_sid: credential.speech_credential_sid,
+              credentials: cred
+            };
+          } catch (err) {
+            const sid = this.accountInfo.account.account_sid;
+            this.logger.info({err}, `malformed google service_key provisioned for account ${sid}`);
+            writeAlerts({
+              alert_type: AlertType.TTS_FAILURE,
+              account_sid: this.accountSid,
+              vendor
+            }).catch((err) => this.logger.error({err}, 'Error writing tts alert'));
+          }
+        }
+        else if (['aws', 'polly'].includes(vendor)) {
+          return {
+            speech_credential_sid: credential.speech_credential_sid,
+            accessKeyId: credential.access_key_id,
+            secretAccessKey: credential.secret_access_key,
+            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 if ('wellsaid' === vendor) {
+          return {
+            speech_credential_sid: credential.speech_credential_sid,
+            api_key: credential.api_key
+          };
+        }
+      }
+      else {
+        writeAlerts({
+          alert_type: AlertType.STT_NOT_PROVISIONED,
+          account_sid: this.accountSid,
+          vendor
+        }).catch((err) => this.logger.error({err}, 'Error writing tts alert'));
+      }
+    }
+  }
+
   /**
    * execute the tasks in the CallSession.  The tasks are executed in sequence until
    * they complete, or the caller hangs up.
@@ -169,7 +316,13 @@ class CallSession extends Emitter {
     this._onTasksDone();
     this._clearResources();
 
-    sessionTracker.remove(this.callSid);
+    if (!this.isConfirmCallSession && !this.isSmsCallSession) sessionTracker.remove(this.callSid);
+  }
+
+  trackTmpFile(path) {
+    // TODO: don't add if its already in the list (should we make it a set?)
+    this.logger.debug(`adding tmp file to track ${path}`);
+    this.tmpFiles.add(path);
   }
 
   normalizeUrl(url, method, auth) {
@@ -211,7 +364,7 @@ class CallSession extends Emitter {
     this.logger.debug('CallSession:_callReleased - caller hung up');
     this.callGone = true;
     if (this.currentTask) {
-      this.currentTask.kill();
+      this.currentTask.kill(this);
       this.currentTask = null;
     }
   }
@@ -223,7 +376,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) {
@@ -249,10 +402,47 @@ class CallSession extends Emitter {
    * @param {object} [opts.call_hook] - new call_status_hook
    */
   async _lccCallHook(opts) {
-    const tasks = await this.requestor.request(opts.call_hook, this.callInfo);
-    if (tasks && tasks.length > 0) {
-      this.logger.info({tasks: listTaskNames(tasks)}, 'CallSession:updateCall new task list');
-      this.replaceApplication(normalizeJamones(this.logger, tasks).map((tdata) => makeTask(this.logger, tdata)));
+    const webhooks = [];
+    let sd;
+    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.toJSON()));
+      }
+    }
+    const [tasks1, tasks2] = await Promise.all(webhooks);
+    let tasks, childTasks;
+    if (opts.call_hook) {
+      tasks = tasks1;
+      if (opts.child_call_hook) childTasks = tasks2;
+    }
+    else childTasks = tasks1;
+
+    if (childTasks) {
+      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:_lccCallHook new task list for child call');
+      const cs = await sd.doAdulting({
+        logger: childLogger,
+        application: this.application,
+        tasks: t
+      });
+
+      /* need to update the callSid of the child with its own (new) AdultingCallSession */
+      sessionTracker.add(cs.callSid, cs);
+    }
+    if (tasks) {
+      const t = normalizeJambones(this.logger, tasks).map((tdata) => makeTask(this.logger, tdata));
+      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);
     }
   }
 
@@ -264,23 +454,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);
   }
 
   /**
@@ -293,23 +499,23 @@ class CallSession extends Emitter {
 
     // 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:_lccWhisper - invalid command since we are not in a dial');
+    if (!task || ![TaskName.Dial, TaskName.Listen].includes(task.name)) {
+      return this.logger.info('CallSession:_lccWhisper - invalid command since we are not in a dial or listen');
     }
 
     // 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);
-      tasks = normalizeJamones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+      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)) {
       // an inline array of tasks
-      tasks = normalizeJamones(this.logger, whisper).map((tdata) => makeTask(this.logger, tdata));
+      tasks = normalizeJambones(this.logger, whisper).map((tdata) => makeTask(this.logger, tdata));
     }
     else if (typeof whisper === 'object') {
       // a single task
-      tasks = normalizeJamones(this.logger, [whisper]).map((tdata) => makeTask(this.logger, tdata));
+      tasks = normalizeJambones(this.logger, [whisper]).map((tdata) => makeTask(this.logger, tdata));
     }
     else {
       this.logger.info({opts}, 'CallSession:_lccWhisper invalid options were provided');
@@ -331,20 +537,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
@@ -357,7 +549,7 @@ class CallSession extends Emitter {
     if (opts.call_status) {
       return this._lccCallStatus(opts);
     }
-    if (opts.call_hook) {
+    if (opts.call_hook || opts.child_call_hook) {
       return await this._lccCallHook(opts);
     }
     if (opts.listen_status) {
@@ -366,6 +558,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..
@@ -389,10 +587,22 @@ 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;
     }
   }
+
+  kill() {
+    if (this.isConfirmCallSession) this.logger.debug('CallSession:kill (ConfirmSession)');
+    else this.logger.info('CallSession:kill');
+    if (this.currentTask) {
+      this.currentTask.kill(this);
+      this.currentTask = null;
+    }
+    this.tasks = [];
+    this.taskIdx = 0;
+  }
+
   _evaluatePreconditions(task) {
     switch (task.preconditions) {
       case TaskPreconditions.None:
@@ -413,23 +623,14 @@ class CallSession extends Emitter {
    * @param {Task} task - task to be executed
    */
   async _evalEndpointPrecondition(task) {
+    this.logger.debug('CallSession:_evalEndpointPrecondition');
     if (this.callGone) new Error(`${BADPRECONDITIONS}: call gone`);
 
-    const answerCall = async() => {
-      const uas = await this.srf.createUAS(this.req, this.res, {localSdp: this.ep.local.sdp});
-      uas.on('destroy', this._callerHungup.bind(this));
-      uas.callSid = this.callSid;
-      uas.connectTime = moment();
-      this.dlg = uas;
-      this.emit('callStatusChange', {sipStatus: 200, callStatus: CallStatus.InProgress});
-      this.logger.debug('CallSession:_evalEndpointPrecondition - answered call');
-    };
-
     if (this.ep) {
-      if (!task.earlyMedia || this.dlg) return this.ep;
+      if (task.earlyMedia === true || this.dlg) return this.ep;
 
       // we are going from an early media connection to answer
-      await answerCall();
+      await this.propagateAnswer();
       return this.ep;
     }
 
@@ -437,15 +638,26 @@ class CallSession extends Emitter {
     try {
       if (!this.ms) this.ms = this.getMS();
       const ep = await this.ms.createEndpoint({remoteSdp: this.req.body});
-      ep.cs = this;
+      //ep.cs = this;
       this.ep = ep;
+      ep.set({
+        hangup_after_bridge: false,
+        park_after_bridge: true
+      }).catch((err) => this.logger.error({err}, 'Error setting park_after_bridge'));
+
+      this.logger.debug(`allocated endpoint ${ep.uuid}`);
+
+      this.ep.on('destroy', () => {
+        this.logger.debug(`endpoint was destroyed!! ${this.ep.uuid}`);
+      });
 
       if (this.direction === CallDirection.Inbound) {
         if (task.earlyMedia && !this.req.finalResponseSent) {
           this.res.send(183, {body: ep.local.sdp});
           return ep;
         }
-        answerCall();
+        this.logger.debug('propogating answer');
+        await this.propagateAnswer();
       }
       else {
         // outbound call TODO
@@ -453,8 +665,15 @@ class CallSession extends Emitter {
 
       return ep;
     } catch (err) {
-      this.logger.error(err, `Error attempting to allocate endpoint for for task ${task.name}`);
-      throw new Error(`${BADPRECONDITIONS}: unable to allocate endpoint`);
+      if (err === CALLER_CANCELLED_ERR_MSG) {
+        this.logger.error(err, 'caller canceled quickly before we could respond, ending call');
+        this._notifyCallStatusChange({callStatus: CallStatus.NoAnswer, sipStatus: 487});
+        this._callReleased();
+      }
+      else {
+        this.logger.error(err, `Error attempting to allocate endpoint for for task ${task.name}`);
+        throw new Error(`${BADPRECONDITIONS}: unable to allocate endpoint`);
+      }
     }
   }
 
@@ -481,17 +700,45 @@ class CallSession extends Emitter {
     return {req: this.req, res: this.res};
   }
 
+  /**
+   * Discard the current endpoint and allocate a new one, connecting the dialog to it.
+   * This is used, for instance, from the Conference verb when a caller has been
+   * kicked out of conference when a moderator leaves -- the endpoint is destroyed
+   * as well, but the app may want to continue on with other actions
+   */
+  async replaceEndpoint() {
+    if (!this.dlg) {
+      this.logger.error('CallSession:replaceEndpoint cannot be called without stable dlg');
+      return;
+    }
+    this.ep = await this.ms.createEndpoint({remoteSdp: this.dlg.remote.sdp});
+    await this.ep.set('hangup_after_bridge', false);
+
+    await this.dlg.modify(this.ep.local.sdp);
+    this.logger.debug('CallSession:replaceEndpoint completed');
+    return this.ep;
+  }
+
   /**
    * Hang up the call and free the media endpoint
    */
-  async _clearResources() {
+  _clearResources() {
     for (const resource of [this.dlg, this.ep]) {
-      try {
-        if (resource && resource.connected) await resource.destroy();
-      } catch (err) {
-        this.logger.error(err, 'CallSession:_clearResources error');
-      }
+      if (resource && resource.connected) resource.destroy();
     }
+    this.dlg = null;
+    this.ep = null;
+
+    // remove any temporary tts files that were created (audio is still cached in redis)
+    for (const path of this.tmpFiles) {
+      fs.unlink(path, (err) => {
+        if (err) {
+          return this.logger.error(err, `CallSession:_clearResources Error deleting tmp file ${path}`);
+        }
+        this.logger.debug(`CallSession:_clearResources successfully deleted ${path}`);
+      });
+    }
+    this.tmpFiles.clear();
   }
 
   /**
@@ -508,11 +755,55 @@ class CallSession extends Emitter {
   getMS() {
     if (!this.ms) {
       this.ms = this.srf.locals.getFreeswitch();
-      if (!this.ms) throw new Error('no available freeswitch');
+      if (!this.ms) {
+        this._mediaServerFailure = true;
+        throw new Error('no available freeswitch');
+      }
     }
     return this.ms;
   }
 
+  /**
+   * Answer the call, if it has not already been answered.
+   *
+   * NB: This should be the one and only place we generate 200 OK to incoming INVITEs
+   */
+  async propagateAnswer() {
+    if (!this.dlg) {
+      assert(this.ep);
+      this.dlg = await this.srf.createUAS(this.req, this.res, {localSdp: this.ep.local.sdp});
+      this.logger.debug('answered call');
+      this.dlg.on('destroy', this._callerHungup.bind(this));
+      this.wrapDialog(this.dlg);
+      this.dlg.callSid = this.callSid;
+      this.emit('callStatusChange', {sipStatus: 200, callStatus: CallStatus.InProgress});
+
+      this.dlg.on('modify', this._onReinvite.bind(this));
+
+      this.logger.debug(`CallSession:propagateAnswer - answered callSid ${this.callSid}`);
+    }
+  }
+
+  async _onReinvite(req, res) {
+    try {
+      if (this.ep) {
+        const newSdp = await this.ep.modify(req.body);
+        res.send(200, {body: newSdp});
+        this.logger.info({offer: req.body, answer: newSdp}, 'handling reINVITE');
+      }
+      else if (this.currentTask && this.currentTask.name === TaskName.Dial) {
+        this.logger.info('handling reINVITE after media has been released');
+        await this.currentTask.handleReinviteAfterMediaReleased(req, res);
+      }
+      else {
+        this.logger.info('got reINVITE but no endpoint and media has not been released');
+        res.send(488);
+      }
+    } catch (err) {
+      this.logger.error(err, 'Error handling reinvite');
+    }
+  }
+
   /**
    * create and endpoint if we don't have one; otherwise simply return
    * the current media server and endpoint that are associated with this call
@@ -528,10 +819,163 @@ class CallSession extends Emitter {
     }
     if (!this.ep) {
       this.ep = await this.ms.createEndpoint({remoteSdp: this.req.body});
+      await this.ep.set('hangup_after_bridge', false);
     }
     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
+   */
+  notifyConferenceEvent(opts) {
+    if (this.currentTask && typeof this.currentTask.notifyStartConference === 'function') {
+      this.currentTask.notifyStartConference(this, opts);
+    }
+  }
+
+  /**
+   * Notify a session in an Enqueue task of an event
+   * @param {*} opts
+   */
+  notifyEnqueueEvent(opts) {
+    if (this.currentTask && typeof this.currentTask.notifyQueueEvent === 'function') {
+      this.currentTask.notifyQueueEvent(this, opts);
+    }
+  }
+
+  /**
+   * Notify a session in a Dequeue task of an event
+   * @param {*} opts
+   */
+  notifyDequeueEvent(opts) {
+    if (this.currentTask && typeof this.currentTask.notifyQueueEvent === 'function') {
+      this.currentTask.notifyQueueEvent(this, opts);
+    }
+  }
+
+  /**
+   * Transfer the call to another feature server
+   * @param {uri} sip uri to refer the call to
+   */
+  async referCall(referTo) {
+    assert (this.hasStableDialog);
+
+    const res = await this.dlg.request({
+      method: 'REFER',
+      headers: {
+        'Refer-To': referTo,
+        'Referred-By': `sip:${this.srf.locals.localSipAddress}`,
+        'X-Retain-Call-Sid': this.callSid
+      }
+    });
+    if ([200, 202].includes(res.status)) {
+      this.tasks = [];
+      this.taskIdx = 0;
+      this.callMoved = true;
+      return true;
+    }
+    return false;
+  }
+
+  getRemainingTaskData() {
+    const tasks = [...this.tasks];
+    tasks.unshift(this.currentTask);
+    const remainingTasks = [];
+    for (const task of tasks) {
+      const o = {};
+      o[task.name] = task.toJSON();
+      remainingTasks.push(o);
+    }
+    return remainingTasks;
+  }
+
+  /**
+   * Call this whenever we answer the A leg, creating a dialog
+   * It wraps the 'destroy' method such that if we hang up the A leg
+   * (e.g. via 'hangup' verb) we emit a callStatusChange event
+   * @param {SipDialog} dlg
+   */
+  wrapDialog(dlg) {
+    dlg.connectTime = moment();
+    const origDestroy = dlg.destroy.bind(dlg);
+    dlg.destroy = () => {
+      if (dlg.connected) {
+        dlg.connected = false;
+        dlg.destroy = origDestroy;
+        const duration = moment().diff(this.dlg.connectTime, 'seconds');
+        this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
+        this.logger.debug('CallSession: call terminated by jambones');
+        origDestroy();
+      }
+    };
+  }
+
+  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'
+      }
+    });
+  }
+
+  async handleReinviteAfterMediaReleased(req, res) {
+    assert(this.dlg && this.dlg.connected && !this.ep);
+    const sdp = await this.dlg.modify(req.body);
+    this.logger.info({sdp}, 'CallSession:handleReinviteAfterMediaReleased - reinvite to A leg returned sdp');
+    res.send(200, {body: sdp});
+  }
+
   /**
    * Called any time call status changes.  This method both invokes the
    * call_status_hook callback as well as updates the realtime database
@@ -542,6 +986,8 @@ class CallSession extends Emitter {
    * @param {number} [duration] - duration of a completed call, in seconds
    */
   _notifyCallStatusChange({callStatus, sipStatus, duration}) {
+    if (this.callMoved) return;
+
     assert((typeof duration === 'number' && callStatus === CallStatus.Completed) ||
       (!duration && callStatus !== CallStatus.Completed),
     'duration MUST be supplied when call completed AND ONLY when call completed');
@@ -549,14 +995,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/session/inbound-call-session.js

@@ -15,42 +15,39 @@ class InboundCallSession extends CallSession {
       srf: req.srf,
       application: req.locals.application,
       callInfo: req.locals.callInfo,
+      accountInfo: req.locals.accountInfo,
       tasks: req.locals.application.tasks
     });
     this.req = req;
     this.res = res;
 
-    req.on('cancel', this._callReleased.bind(this));
+    req.once('cancel', this._onCancel.bind(this));
 
     this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
     this._notifyCallStatusChange({callStatus: CallStatus.Trying, sipStatus: 100});
   }
 
-  _onTasksDone() {
-    if (!this.res.finalResponseSent) {
-      this.logger.info('InboundCallSession:_onTasksDone auto-generating non-success response to invite');
-      this.res.send(603);
-    }
-    else if (this.dlg && this.dlg.connected) {
-      assert(this.dlg.connectTime);
-      const duration = moment().diff(this.dlg.connectTime, 'seconds');
-      this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-      this.logger.debug('InboundCallSession:_onTasksDone hanging up call since all tasks are done');
-    }
+  _onCancel() {
+    this._notifyCallStatusChange({callStatus: CallStatus.NoAnswer, sipStatus: 487});
+    this._callReleased();
   }
 
-  /**
-   * Answer the call, if it has not already been answered.
-   */
-  async propagateAnswer() {
-    if (!this.dlg) {
-      assert(this.ep);
-      this.dlg = await this.srf.createUAS(this.req, this.res, {localSdp: this.ep.local.sdp});
-      this.dlg.connectTime = moment();
-      this.dlg.on('destroy', this._callerHungup.bind(this));
-      this.emit('callStatusChange', {sipStatus: 200, callStatus: CallStatus.InProgress});
-      this.logger.debug(`CallSession:propagateAnswer - answered callSid ${this.callSid}`);
+  _onTasksDone() {
+    if (!this.res.finalResponseSent) {
+      if (this._mediaServerFailure) {
+        this.logger.info('InboundCallSession:_onTasksDone generating 480 due to media server failure');
+        this.res.send(480, {
+          headers: {
+            'X-Reason': 'crankback: media server failure'
+          }
+        });
+      }
+      else {
+        this.logger.info('InboundCallSession:_onTasksDone auto-generating non-success response to invite');
+        this.res.send(603);
+      }
     }
+    this.req.removeAllListeners('cancel');
   }
 
   /**
@@ -62,6 +59,7 @@ class InboundCallSession extends CallSession {
     this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
     this.logger.debug('InboundCallSession: caller hung up');
     this._callReleased();
+    this.req.removeAllListeners('cancel');
   }
 }
 

lib/session/rest-call-session.js

@@ -8,14 +8,15 @@ const moment = require('moment');
  * @extends CallSession
  */
 class RestCallSession extends CallSession {
-  constructor({logger, application, srf, req, ep, tasks, callInfo}) {
+  constructor({logger, application, srf, req, ep, tasks, callInfo, accountInfo}) {
     super({
       logger,
       application,
       srf,
       callSid: callInfo.callSid,
       tasks,
-      callInfo
+      callInfo,
+      accountInfo
     });
     this.req = req;
     this.ep = ep;
@@ -31,7 +32,7 @@ class RestCallSession extends CallSession {
   setDialog(dlg) {
     this.dlg = dlg;
     dlg.on('destroy', this._callerHungup.bind(this));
-    dlg.connectTime = moment();
+    this.wrapDialog(dlg);
   }
 
   /**
@@ -40,7 +41,7 @@ class RestCallSession extends CallSession {
   _callerHungup() {
     const duration = moment().diff(this.dlg.connectTime, 'seconds');
     this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-    this.logger.debug('InboundCallSession: caller hung up');
+    this.logger.debug('RestCallSession: called party hung up');
     this._callReleased();
   }
 

lib/session/session-tracker.js

@@ -44,6 +44,7 @@ class SessionTracker extends Emitter {
     assert(callSid);
     this.sessions.delete(callSid);
     this.logger.info(`SessionTracker:remove callSid ${callSid}, we have ${this.sessions.size} being tracked`);
+    if (0 === this.sessions.size) this.emit('idle');
   }
 
   /**

lib/session/sms-call-session.js

@@ -0,0 +1,22 @@
+const CallSession = require('./call-session');
+
+/**
+ * @classdesc Subclass of CallSession.  Represents a CallSession
+ * that is established for the purpose of sending an outbound SMS
+ * @extends CallSession
+
+ */
+class SmsCallSession extends CallSession {
+  constructor({logger, application, srf, tasks, callInfo}) {
+    super({
+      logger,
+      application,
+      srf,
+      tasks,
+      callInfo
+    });
+  }
+
+}
+
+module.exports = SmsCallSession;

lib/tasks/cognigy.js

@@ -0,0 +1,248 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+const makeTask = require('./make_task');
+const { SocketClient } = require('@cognigy/socket-client');
+
+const parseGallery = (obj = {}) => {
+  const {_default} = obj;
+  if (_default) {
+    const {_gallery} = _default;
+    if (_gallery) return _gallery.fallbackText;
+  }
+};
+
+const parseQuickReplies = (obj) => {
+  const {_default} = obj;
+  if (_default) {
+    const {_quickReplies} = _default;
+    if (_quickReplies) return _quickReplies.text || _quickReplies.fallbackText;
+  }
+};
+
+const parseBotText = (evt) => {
+  const {text, data} = evt;
+  if (text) return text;
+
+  switch (data?.type) {
+    case 'quickReplies':
+      return parseQuickReplies(data?._cognigy);
+    case 'gallery':
+      return parseGallery(data?._cognigy);
+    default:
+      break;
+  }
+};
+
+class Cognigy extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    this.url = this.data.url;
+    this.token = this.data.token;
+    this.prompt = this.data.prompt;
+    this.eventHook = this.data?.eventHook;
+    this.actionHook = this.data?.actionHook;
+    this.data = this.data.data || {};
+    this.prompts = [];
+  }
+
+  get name() { return TaskName.Cognigy; }
+
+  get hasReportedFinalAction() {
+    return this.reportedFinalAction || this.isReplacingApplication;
+  }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+
+    this.ep = ep;
+    try {
+      /* set event handlers and start transcribing */
+      this.on('transcription', this._onTranscription.bind(this, cs, ep));
+      this.on('error', this._onError.bind(this, cs, ep));
+
+      this.transcribeTask = this._makeTranscribeTask();
+      this.transcribeTask.exec(cs, ep, this)
+        .catch((err) => {
+          this.logger.info({err}, 'Cognigy transcribe task returned error');
+          this.notifyTaskDone();
+        });
+      if (this.prompt) {
+        this.sayTask = this._makeSayTask(this.prompt);
+        this.sayTask.exec(cs, ep, this)
+          .catch((err) => {
+            this.logger.info({err}, 'Cognigy say task returned error');
+            this.notifyTaskDone();
+          });
+      }
+
+      /* connect to the bot and send initial data */
+      this.client = new SocketClient(
+        this.url,
+        this.token,
+        {
+          sessionId: cs.callSid,
+          channel: 'jambonz',
+          forceWebsockets: true,
+          reconnection: true,
+          settings: {
+            enableTypingIndicator: false
+          }
+        }
+      );
+      this.client.on('output', this._onBotUtterance.bind(this, cs, ep));
+      this.client.on('typingStatus', this._onBotTypingStatus.bind(this, cs, ep));
+      this.client.on('error', this._onBotError.bind(this, cs, ep));
+      this.client.on('finalPing', this._onBotFinalPing.bind(this, cs, ep));
+      await this.client.connect();
+      this.client.sendMessage('', {...this.data, ...cs.callInfo});
+
+      await this.awaitTaskDone();
+    } catch (err) {
+      this.logger.error({err}, 'Cognigy error');
+      throw err;
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    this.logger.debug('Cognigy:kill');
+
+    this.removeAllListeners();
+    this.transcribeTask && this.transcribeTask.kill();
+
+    this.client.removeAllListeners();
+    if (this.client && this.client.connected) this.client.disconnect();
+
+    if (!this.hasReportedFinalAction) {
+      this.reportedFinalAction = true;
+      this.performAction({cognigyResult: 'caller hungup'})
+        .catch((err) => this.logger.info({err}, 'cognigy - 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.notifyTaskDone();
+  }
+
+  _makeTranscribeTask() {
+    const opts = {
+      recognizer: this.data.recognizer || {
+        vendor: 'default',
+        language: 'default',
+        outputFormat: 'detailed'
+      }
+    };
+    this.logger.debug({opts}, 'constructing a nested transcribe object');
+    const transcribe = makeTask(this.logger, {transcribe: opts}, this);
+    return transcribe;
+  }
+
+  _makeSayTask(text) {
+    const opts = {
+      text,
+      synthesizer: this.data.synthesizer ||
+      {
+        vendor: 'default',
+        language: 'default',
+        voice: 'default'
+      }
+    };
+    this.logger.debug({opts}, 'constructing a nested say object');
+    const say = makeTask(this.logger, {say: opts}, this);
+    return say;
+  }
+
+  async _onBotError(cs, ep, evt) {
+    this.logger.info({evt}, 'Cognigy:_onBotError');
+    this.performAction({cognigyResult: 'botError', message: evt.message });
+    this.reportedFinalAction = true;
+    this.notifyTaskDone();
+  }
+
+  async _onBotTypingStatus(cs, ep, evt) {
+    this.logger.info({evt}, 'Cognigy:_onBotTypingStatus');
+  }
+  async _onBotFinalPing(cs, ep) {
+    this.logger.info('Cognigy:_onBotFinalPing');
+    if (this.prompts.length) {
+      const text = this.prompts.join('.');
+      this.prompts = [];
+      if (text && !this.killed) {
+        this.sayTask = this._makeSayTask(text);
+        this.sayTask.exec(cs, ep, this)
+          .catch((err) => {
+            this.logger.info({err}, 'Cognigy say task returned error');
+            this.notifyTaskDone();
+          });
+      }
+    }
+  }
+
+  async _onBotUtterance(cs, ep, evt) {
+    this.logger.debug({evt}, 'Cognigy:_onBotUtterance');
+
+    if (this.eventHook) {
+      this.performHook(cs, this.eventHook, {event: 'botMessage', message: evt})
+        .then((redirected) => {
+          if (redirected) {
+            this.logger.info('Cognigy_onTranscription: event handler for bot message redirected us to new webhook');
+            this.reportedFinalAction = true;
+            this.performAction({cognigyResult: 'redirect'}, false);
+          }
+          return;
+        })
+        .catch(({err}) => {
+          this.logger.info({err}, 'Cognigy_onTranscription: error sending event hook');
+        });
+    }
+    const text = parseBotText(evt);
+    this.prompts.push(text);
+  }
+
+  async _onTranscription(cs, ep, evt) {
+    this.logger.debug({evt}, `Cognigy: 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('Cognigy_onTranscription: event handler for user message redirected us to new webhook');
+            this.reportedFinalAction = true;
+            this.performAction({cognigyResult: 'redirect'}, false);
+            if (this.transcribeTask) this.transcribeTask.kill(cs);
+          }
+          return;
+        })
+        .catch(({err}) => {
+          this.logger.info({err}, 'Cognigy_onTranscription: error sending event hook');
+        });
+    }
+
+    /* send the user utterance to the bot */
+    try {
+      if (this.client && this.client.connected) {
+        this.client.sendMessage(utterance);
+      }
+      else {
+        this.logger.info('Cognigy_onTranscription - not sending user utterance as bot is disconnected');
+      }
+    } catch (err) {
+      this.logger.error({err}, 'Cognigy_onTranscription: Error sending user utterance to Cognigy - ending task');
+      this.performAction({cognigyResult: 'socketError'});
+      this.reportedFinalAction = true;
+      this.notifyTaskDone();
+    }
+  }
+  _onError(cs, ep, err) {
+    this.logger.debug({err}, 'Cognigy: got error');
+    if (!this.hasReportedFinalAction) this.performAction({cognigyResult: 'error', err});
+    this.reportedFinalAction = true;
+    this.notifyTaskDone();
+  }
+}
+
+module.exports = Cognigy;

lib/tasks/conference.js

@@ -0,0 +1,641 @@
+const Task = require('./task');
+const Emitter = require('events');
+const ConfirmCallSession = require('../session/confirm-call-session');
+const {TaskName, TaskPreconditions, BONG_TONE} = require('../utils/constants');
+const normalizeJambones = require('../utils/normalize-jambones');
+const makeTask = require('./make_task');
+const bent = require('bent');
+const assert = require('assert');
+const WAIT = 'wait';
+const JOIN = 'join';
+const START = 'start';
+
+
+function confNoMatch(str) {
+  return str.match(/^No active conferences/) || str.match(/Conference.*not found/);
+}
+function getWaitListName(confName) {
+  return `${confName}:waitlist`;
+}
+
+function camelize(str) {
+  return str.replace(/(?:^\w|[A-Z]|\b\w)/g, function(word, index) {
+    return index === 0 ? word.toLowerCase() : word.toUpperCase();
+  })
+    .replace(/\s+/g, '')
+    .replace(/-/g, '');
+}
+
+function unhandled(logger, cs, evt) {
+  this.participantCount = parseInt(evt.getHeader('Conference-Size'));
+  // logger.debug({evt}, `unhandled conference event: ${evt.getHeader('Action')}`) ;
+  logger.debug(`unhandled conference event: ${evt.getHeader('Action')}`) ;
+}
+
+function capitalize(s) {
+  if (typeof s !== 'string') return '';
+  return s.charAt(0).toUpperCase() + s.slice(1);
+}
+
+class Conference extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.logger = logger;
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    if (!this.data.name) throw new Error('conference name required');
+
+    this.confName = this.data.name;
+    [
+      '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) => {
+        if ((this.data.statusEvents || []).includes(e)) this.statusEvents.push(e);
+      });
+    }
+
+    this.emitter = new Emitter();
+    this.results = {};
+
+    // transferred from another server in order to bridge to a local caller?
+    if (this.data._ && this.data._.connectTime) {
+      this.connectTime = this.data._.connectTime;
+    }
+  }
+
+  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;
+    const dlg = cs.dlg;
+
+    // reset answer time if we were transferred from another feature server
+    if (this.connectTime) dlg.connectTime = this.connectTime;
+
+
+    this.ep.on('destroy', this._kicked.bind(this, cs, dlg));
+
+    try {
+      await this._init(cs, dlg);
+      switch (this.action) {
+        case JOIN:
+          await this._doJoin(cs, dlg);
+          break;
+        case WAIT:
+          await this._doWait(cs, dlg);
+          break;
+        case START:
+          await this._doStart(cs, dlg);
+          break;
+      }
+      await this.awaitTaskDone();
+
+      this.logger.debug(`Conference:exec - conference ${this.confName} is over`);
+      if (this.callMoved !== false) await this.performAction(this.results);
+    } catch (err) {
+      this.logger.info(err, `TaskConference:exec - error in conference ${this.confName}`);
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    this.logger.info(`Conference:kill ${this.confName}`);
+    this.emitter.emit('kill');
+    await this._doFinalMemberCheck(cs);
+    if (this.ep && this.ep.connected) this.ep.conn.removeAllListeners('esl::event::CUSTOM::*') ;
+    this.notifyTaskDone();
+  }
+
+  /**
+   * Determine which of three states we are in:
+   * (1) Conference already exists -- we should JOIN
+   * (2) Conference does not exist, and we should START it
+   * (3) Conference does not exist, and we must WAIT for moderator
+   * @param {CallSession} cs
+   * @param {SipDialog} dlg
+   */
+  async _init(cs, dlg) {
+    const friendlyName = this.confName;
+    const {createHash, retrieveHash} = cs.srf.locals.dbHelpers;
+    this.confName = `conf:${cs.accountSid}:${this.confName}`;
+
+    this.statusParams = Object.assign({
+      conferenceSid: this.confName,
+      friendlyName
+    }, cs.callInfo);
+
+    // check if conference is in progress
+    const obj = await retrieveHash(this.confName);
+    if (obj) {
+      this.logger.info({obj}, `Conference:_init conference ${this.confName} is already started`);
+      this.joinDetails = { conferenceSipAddress: obj.sipAddress};
+      this.conferenceStartTime = new Date(parseInt(obj.startTime));
+      this.statusEvents = obj.statusEvents ? JSON.parse(obj.statusEvents) : [];
+      this.statusHook = obj.statusHook ? JSON.parse(obj.statusHook) : null;
+      this.action = JOIN;
+    }
+    else {
+      if (this.startConferenceOnEnter === false) {
+        this.logger.info(`Conference:_init conference ${this.confName} does not exist, wait for moderator`);
+        this.action = WAIT;
+      }
+      else {
+        this.logger.info(`Conference:_init conference ${this.confName} does not exist, provision it now..`);
+        const obj = {
+          sipAddress: cs.srf.locals.localSipAddress,
+          startTime: Date.now()
+        };
+        if (this.statusEvents.length > 0 && this.statusHook) {
+          Object.assign(obj, {
+            statusEvents: JSON.stringify(this.statusEvents),
+            statusHook: JSON.stringify(this._normalizeHook(cs, this.statusHook))
+          });
+        }
+        const added = await createHash(this.confName, obj);
+        if (added) {
+          this.logger.info(`Conference:_init conference ${this.confName} successfully provisioned`);
+          this.conferenceStartTime = new Date(obj.startTime);
+          this.action = START;
+        }
+        else {
+          this.logger.info(`Conference:_init conference ${this.confName} provision failed..someone beat me to it?`);
+          const obj = await retrieveHash(this.confName);
+          if (null === obj) {
+            this.logger.error(`Conference:_init conference ${this.confName} provision failed again...exiting`);
+            throw new Error('Failed to join conference');
+          }
+          this.joinDetails = { conferenceSipAddress: obj.sipAddress};
+          this.conferenceStartTime = new Date(obj.startTime);
+          this.statusEvents = obj.statusEvents ? JSON.parse(obj.statusEvents) : [];
+          this.statusHook = obj.statusHook ? JSON.parse(obj.statusHook) : null;
+          this.action = JOIN;
+        }
+      }
+    }
+  }
+
+  /**
+   * Wait for entry to a conference, which means
+   * - add ourselves to the waiting list for the conference,
+   * - if provided, continually invoke waitHook to play or say something (pause allowed as well)
+   * - wait for an event indicating the conference has started (or caller hangs up).
+   *
+   * Returns a Promise that is resolved when:
+   * a. caller hangs up while waiting, or
+   * b. conference starts, participant joins the conference
+   * @param {CallSession} cs
+   * @param {SipDialog} dlg
+   */
+  async _doWait(cs, dlg) {
+    await this._addToWaitList(cs);
+
+    return new Promise(async(resolve, reject) => {
+      this.emitter
+        .once('join', (opts) => {
+          this.joinDetails = opts;
+          this.logger.info({opts}, `time to join conference ${this.confName}`);
+          if (this._playSession) {
+            this._playSession.kill();
+            this._playSession = null;
+          }
+
+          // return a Promise that resolves at the end of the conference for this caller
+          this.emitter.removeAllListeners();
+          resolve(this._doJoin(cs, dlg));
+        })
+        .once('kill', () => {
+          this._removeFromWaitList(cs);
+          if (this._playSession) {
+            this.logger.debug('killing waitUrl');
+            this._playSession.kill();
+            this._playSession = null;
+          }
+          cs.clearConferenceDetails();
+          resolve();
+        });
+
+      if (this.waitHook) {
+        do {
+          try {
+            await this.ep.play('silence_stream://750');
+            const tasks = await this._playHook(cs, dlg, this.waitHook);
+            if (0 === tasks.length) break;
+          } catch (err) {
+            if (!this.joinDetails && !this.killed) {
+              this.logger.info(err, `Conference:_doWait: failed retrieving waitHook for ${this.confName}`);
+            }
+            this._playSession = null;
+            break;
+          }
+        } while (!this.killed && !this.joinDetails);
+      }
+    });
+  }
+
+  /**
+   * Join a conference that has already been started.
+   * The conference may be homed on this feature server, or another one -
+   * in the latter case, move the call to the other server via REFER
+   * @param {CallSession} cs
+   * @param {SipDialog} dlg
+   */
+  async _doJoin(cs, dlg) {
+    assert(this.joinDetails.conferenceSipAddress);
+    if (cs.srf.locals.localSipAddress !== this.joinDetails.conferenceSipAddress  && !cs.isTransferredCall) {
+      this.logger.info({
+        localServer: cs.srf.locals.localSipAddress,
+        confServer: this.joinDetails.conferenceSipAddress
+      }, `Conference:_doJoin: conference ${this.confName} is hosted elsewhere`);
+      const success = await this.transferCallToFeatureServer(cs, this.joinDetails.conferenceSipAddress, {
+        connectTime: dlg.connectTime.valueOf()
+      });
+
+      /**
+       * If the REFER succeeded, we will get a BYE from the SBC
+       * which will trigger kill and the end of the execution of the CallSession
+       * which is what we want - so do nothing and let that happen.
+       * If on the other hand, the REFER failed then we are in a bad state
+       * and need to end the conference task with a failure indication and
+       * allow the application to continue on
+       */
+      if (success) {
+        this.logger.info(`Conference:_doJoin: REFER of ${this.confName} succeeded`);
+        return;
+      }
+      this.notifyTaskDone();
+      return;
+    }
+    this.logger.info(`Conference:_doJoin: conference ${this.confName} is hosted locally`);
+    await this._joinConference(cs, dlg, false);
+  }
+
+  /**
+   * Start a conference and notify anyone on the waiting list
+   * @param {CallSession} cs
+   * @param {SipDialog} dlg
+   */
+  async _doStart(cs, dlg) {
+    await this._joinConference(cs, dlg, true);
+
+    // notify waiting list members
+    try {
+      const {retrieveSet, deleteKey} = cs.srf.locals.dbHelpers;
+      const setName = getWaitListName(this.confName);
+      const members = await retrieveSet(setName);
+      if (Array.isArray(members) && members.length > 0) {
+        this.logger.info({members}, `Conference:doStart - notifying waiting list for ${this.confName}`);
+        for (const url of members) {
+          try {
+            await bent('POST', 202)(url, {event: 'start', conferenceSipAddress: cs.srf.locals.localSipAddress});
+          } catch (err) {
+            this.logger.info(err, `Failed notifying ${url} to join ${this.confName}`);
+          }
+        }
+        // now clear the waiting list
+        deleteKey(setName);
+      }
+    } catch (err) {
+      this.logger.error(err, 'Conference:_doStart - error notifying wait list');
+    }
+  }
+
+  async _joinConference(cs, dlg, startConf) {
+    if (startConf) {
+      // conference should not exist - check but continue in either case
+      const result = await cs.getMS().api(`conference ${this.confName} list count`);
+      const notFound = typeof result === 'string' && confNoMatch(result);
+      if (!notFound) {
+        this.logger.info({result},
+          `Conference:_joinConference: asked to start ${this.confName} but it unexpectedly exists`);
+      }
+      else {
+        this.participantCount = 0;
+      }
+      this._notifyConferenceEvent(cs, 'start');
+    }
+
+    if (this.enterHook) {
+      try {
+        await this._playHook(cs, dlg, this.enterHook);
+        if (!dlg.connected) {
+          this.logger.debug('Conference:_doJoin: caller hung up during entry prompt');
+          return;
+        }
+      } catch (err) {
+        this.logger.error(err, `Error playing enterHook to caller for conference ${this.confName}`);
+      }
+    }
+
+    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)) ;
+
+      // optionally play beep to conference on entry
+      if (this.beep === true) {
+        this.ep.api('conference',
+          [this.confName, 'play', BONG_TONE])
+          .catch((err) => {});
+      }
+
+    } catch (err) {
+      this.logger.error(err, `Failed to join conference ${this.confName}`);
+      throw err;
+    }
+
+    if (typeof this.maxParticipants === 'number' && this.maxParticipants > 1) {
+      this.ep.api('conference', `${this.confName} set max_members ${this.maxParticipants}`)
+        .catch((err) => this.logger.error(err, `Error setting max participants to ${this.maxParticipants}`));
+    }
+  }
+
+  /**
+   * The conference we have been waiting for has started.
+   * It may be on this server or a different one, and we are
+   * given instructions how to find it and connect.
+   * @param {Object} opts
+   * @param {string} opts.confName name of the conference
+   * @param {string} opts.conferenceSipAddress ip:port of the feature server hosting the conference
+   */
+  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
+   * @param {CallSession} cs
+   */
+  async _addToWaitList(cs) {
+    const {addToSet} = cs.srf.locals.dbHelpers;
+    const setName = getWaitListName(this.confName);
+    const url = `${cs.srf.locals.serviceUrl}/v1/conference/${cs.callSid}`;
+    const added = await addToSet(setName, url);
+    if (added !== 1) throw new Error(`failed adding to the waitlist for conference ${this.confName}: ${added}`);
+    this.logger.debug(`successfully added to the waiting list for conference ${this.confName}`);
+  }
+
+  async _removeFromWaitList(cs) {
+    const {removeFromSet} = cs.srf.locals.dbHelpers;
+    const setName = getWaitListName(this.confName);
+    const url = `${cs.srf.locals.serviceUrl}/v1/conference/${cs.callSid}`;
+    try {
+      const count = await removeFromSet(setName, url);
+      this.logger.debug(`Conference:_removeFromWaitList removed ${count} from waiting list`);
+    } catch (err) {
+      this.logger.info(err, 'Error removing from waiting list');
+    }
+  }
+
+  _normalizeHook(cs, hook) {
+    if (typeof hook === 'object') return hook;
+    const url = hook.startsWith('/') ?
+      `${cs.application.requestor.baseUrl}${hook}` :
+      hook;
+
+    return { url } ;
+  }
+
+  /**
+   * If we are the last one leaving the conference - turn out the lights.
+   * Remove the conference info from the realtime database.
+   * @param {*} cs
+   */
+  async _doFinalMemberCheck(cs) {
+    if (!this.memberId) return; // never actually joined
+
+    this.logger.debug(`Conference:_doFinalMemberCheck leaving ${this.confName} member count: ${this.participantCount}`);
+    try {
+      const response = await this.ep.api('conference', [this.confName, 'get', 'count']);
+      if (response.body && confNoMatch(response.body)) this.participantCount = 0;
+      else if (response.body && /^\d+$/.test(response.body)) this.participantCount = parseInt(response.body) - 1;
+      this.logger.debug({response}, `Conference:_doFinalMemberCheck conference count ${this.participantCount}`);
+    } catch (err) {
+      this.logger.info({err}, 'Conference:_doFinalMemberCheck error retrieving count (we were probably kicked');
+    }
+    await this._notifyConferenceEvent(cs, 'leave');
+
+    /**
+     * when we hang up as the last member, the current member count = 1
+     * when we are kicked out of the call when the moderator leaves, the member count = 0
+     */
+    if (this.participantCount === 0) {
+      const {deleteKey} = cs.srf.locals.dbHelpers;
+      try {
+        this._notifyConferenceEvent(cs, 'end');
+        const removed = await deleteKey(this.confName);
+        this.logger.info(`conf ${this.confName} deprovisioned: ${removed ? 'success' : 'failure'}`);
+      }
+      catch (err) {
+        this.logger.error(err, `Error deprovisioning conference ${this.confName}`);
+      }
+    }
+  }
+
+  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 = 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 ${tasks.length} tasks`);
+
+    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();
+      this._playSession = null;
+    }
+    return json;
+  }
+
+  /**
+   * This event triggered when we are bounced from conference when moderator leaves.
+   * Get a new endpoint up and running in case the app wants to go on (e.g post-call survey)
+   * @param {*} cs CallSession
+   * @param {*} dlg SipDialog
+   */
+  _kicked(cs, dlg) {
+    this.logger.info(`Conference:kicked - I was dropped from conference ${this.confName}, task is complete`);
+    this.replaceEndpointAndEnd(cs);
+  }
+
+  async replaceEndpointAndEnd(cs) {
+    cs.clearConferenceDetails();
+    if (this.replaced) return;
+    this.replaced = true;
+    try {
+      this.ep = await cs.replaceEndpoint();
+    } catch (err) {
+      this.logger.error(err, 'Conference:replaceEndpointAndEnd failed');
+    }
+    this.kill(cs);
+  }
+
+  _notifyConferenceEvent(cs, eventName, params = {}) {
+    if (this.statusEvents.includes(eventName)) {
+      params.event = eventName;
+      params.duration = (Date.now() - this.conferenceStartTime.getTime()) / 1000;
+      if (!params.time) params.time = (new Date()).toISOString();
+      if (!params.members && typeof this.participantCount === 'number') params.members = this.participantCount;
+      cs.application.requestor.request(this.statusHook, Object.assign(params, this.statusParams))
+        .catch((err) => this.logger.info(err, 'Conference:notifyConferenceEvent - error'));
+    }
+  }
+
+  __onConferenceEvent(cs, evt) {
+    const eventName = evt.getHeader('Event-Subclass') ;
+    if (eventName === 'conference::maintenance') {
+      const action = evt.getHeader('Action') ;
+
+      //invoke a handler for this action, if we have defined one
+      const functionName = `_on${capitalize(camelize(action))}`;
+      (Conference.prototype[functionName] || unhandled).bind(this, this.logger, cs, evt)() ;
+    }
+  }
+
+  // conference event handlers
+  _onDelMember(logger, cs, evt) {
+    const memberId = parseInt(evt.getHeader('Member-ID')) ;
+    this.participantCount = parseInt(evt.getHeader('Conference-Size'));
+    if (memberId === this.memberId) {
+      this.logger.info(`Conference:_onDelMember - I was dropped from conference ${this.confName}, task is complete`);
+      this.replaceEndpointAndEnd(cs);
+    }
+  }
+
+  _onStartTalking(logger, cs, evt) {
+    const memberId = parseInt(evt.getHeader('Member-ID')) ;
+    const size = this.participantCount = parseInt(evt.getHeader('Conference-Size'));
+    if (memberId === this.memberId) {
+      const time = new Date(evt.getHeader('Event-Date-Timestamp') / 1000).toISOString();
+      this._notifyConferenceEvent(cs, 'start-talking', {
+        time,
+        members: size
+      });
+    }
+  }
+
+  _onStopTalking(logger, cs, evt) {
+    const memberId = parseInt(evt.getHeader('Member-ID')) ;
+    const size = this.participantCount = parseInt(evt.getHeader('Conference-Size'));
+    if (memberId === this.memberId) {
+      const time = new Date(evt.getHeader('Event-Date-Timestamp') / 1000).toISOString();
+      this._notifyConferenceEvent(cs, 'stop-talking', {
+        time,
+        members: size
+      });
+    }
+  }
+
+}
+
+module.exports = Conference;

lib/tasks/dequeue.js

@@ -0,0 +1,151 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions, DequeueResults, BONG_TONE} = require('../utils/constants');
+const Emitter = require('events');
+const bent = require('bent');
+const assert = require('assert');
+
+const sleepFor = (ms) => new Promise((resolve) => setTimeout(() => resolve(), ms));
+
+const getUrl = (cs) => `${cs.srf.locals.serviceUrl}/v1/dequeue/${cs.callSid}`;
+
+class TaskDequeue extends Task {
+  constructor(logger, opts, parentTask) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    this.queueName = this.data.name;
+    this.timeout = this.data.timeout || 0;
+    this.beep = this.data.beep === true;
+
+    this.emitter = new Emitter();
+    this.state = DequeueResults.Timeout;
+  }
+
+  get name() { return TaskName.Dequeue; }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+    this.ep = ep;
+    this.queueName = `queue:${cs.accountSid}:${this.queueName}`;
+
+    const url = await this._getMemberFromQueue(cs);
+    if (!url) this.performAction({dequeueResult: 'timeout'}).catch((err) => {});
+    else {
+      try {
+        await this._dequeueUrl(cs, ep, url);
+        this.performAction({dequeueResult: 'complete'}).catch((err) => {});
+      } catch (err) {
+        this.emitter.removeAllListeners();
+        this.performAction({dequeueResult: 'hangup'}).catch((err) => {});
+      }
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    if (this.state === DequeueResults.Bridged) {
+      this.logger.info(`TaskDequeue:kill - notifying partner we are going away ${this.partnerUrl}`);
+      bent('POST', 202)(this.partnerUrl, {event: 'hangup'}).catch((err) => {
+        this.logger.info(err, 'TaskDequeue:kill error notifying partner of hangup');
+      });
+    }
+    this.emitter.emit('kill');
+  }
+
+  _getMemberFromQueue(cs) {
+    const {popFront} = cs.srf.locals.dbHelpers;
+
+    return new Promise(async(resolve) => {
+      let timer;
+      let timedout = false, found = false;
+      if (this.timeout > 0) {
+        timer = setTimeout(() => {
+          this.logger.info(`TaskDequeue:_getMemberFromQueue timed out after ${this.timeout}s`);
+          timedout = true;
+          resolve();
+        }, this.timeout * 1000);
+      }
+
+      await sleepFor(1000); // to avoid clipping if we dial and immediately connect
+
+      do {
+        try {
+          const url = await popFront(this.queueName);
+          if (url) {
+            found = true;
+            clearTimeout(timer);
+            this.logger.info(`TaskDequeue:_getMemberFromQueue popped ${url} from queue ${this.queueName}`);
+            resolve(url);
+          }
+        } catch (err) {
+          this.logger.debug({err}, 'TaskDequeue:_getMemberFromQueue error popFront');
+        }
+        await sleepFor(5000);
+      } while (!this.killed && !timedout && !found);
+    });
+  }
+
+  _dequeueUrl(cs, ep, url) {
+    this.partnerUrl = url;
+
+    return new Promise(async(resolve, reject) => {
+      let bridgeTimer;
+      this.emitter
+        .on('bridged', () => {
+          clearTimeout(bridgeTimer);
+          this.state = DequeueResults.Bridged;
+        })
+        .on('hangup', () => {
+          this.logger.info('TaskDequeue:_dequeueUrl hangup from partner');
+          resolve();
+        })
+        .on('kill', () => {
+          resolve();
+        });
+
+      // now notify partner to bridge to me
+      try {
+        // TODO: if we have a confirmHook, retrieve the app and pass it on
+        await bent('POST', 202)(url, {
+          event: 'dequeue',
+          dequeueSipAddress: cs.srf.locals.localSipAddress,
+          epUuid: ep.uuid,
+          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);
+      } catch (err) {
+        this.logger.info({err, url}, `TaskDequeue:_dequeueUrl error dequeueing from ${this.queueName}, try again`);
+        reject(new Error('bridge failure'));
+      }
+    });
+  }
+
+  async notifyQueueEvent(cs, opts) {
+    if (opts.event === 'ready') {
+      assert(opts.notifyUrl && opts.epUuid);
+      this.partnerUrl = opts.notifyUrl;
+      this.logger.info({opts}, `TaskDequeue:notifyDequeueEvent: about to bridge member from ${this.queueName}`);
+
+      if (this.beep) {
+        this.logger.debug({opts}, `TaskDequeue:notifyDequeueEvent: playing beep tone ${this.queueName}`);
+        await this.ep.play(BONG_TONE).catch((err) => {
+          this.logger.error(err, 'TaskDequeue:notifyDequeueEvent error playing beep');
+        });
+      }
+      await this.ep.bridge(opts.epUuid);
+      this.emitter.emit('bridged');
+      this.logger.info({opts}, `TaskDequeue:notifyDequeueEvent: successfully bridged member from ${this.queueName}`);
+    }
+    else if (opts.event === 'hangup') {
+      this.emitter.emit('hangup');
+    }
+    else {
+      this.logger.error({opts}, 'TaskDequeue:notifyDequeueEvent - unsupported event/payload');
+    }
+  }
+
+}
+
+module.exports = TaskDequeue;

lib/tasks/dial.js

@@ -1,10 +1,18 @@
 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');
 const DtmfCollector = require('../utils/dtmf-collector');
+const dbUtils = require('../utils/db-utils');
 const debug = require('debug')('jambonz:feature-server');
 
 function parseDtmfOptions(logger, dtmfCapture) {
@@ -37,11 +45,13 @@ function compareTasks(t1, t2) {
   if (t1.type !== t2.type) return false;
   switch (t1.type) {
     case 'phone':
-      return t1.number === t1.number;
+      return t1.number === t2.number;
     case 'user':
-      return t2.name === t1.name;
+      return t1.name === t2.name;
+    case 'teams':
+      return t1.number === t2.number;
     case 'sip':
-      return t2.sipUri === t1.sipUri;
+      return t1.sipUri === t2.sipUri;
   }
 }
 
@@ -82,6 +92,7 @@ class TaskDial extends Task {
     this.confirmHook = this.data.confirmHook;
     this.confirmMethod = this.data.confirmMethod;
     this.dtmfHook = this.data.dtmfHook;
+    this.proxy = this.data.proxy;
 
     if (this.dtmfHook) {
       const {parentDtmfCollector, childDtmfCollector} = parseDtmfOptions(logger, this.data.dtmfCapture || {});
@@ -110,45 +121,69 @@ class TaskDial extends Task {
   }
 
   get ep() {
+    /**
+     * Note:
+     *        this.ep is the B leg-facing endpoint
+     *        this.epOther is the A leg-facing endpoint
+     */
     if (this.sd) return this.sd.ep;
   }
 
   get name() { return TaskName.Dial; }
 
+  get canReleaseMedia() {
+    return !process.env.ANCHOR_MEDIA_ALWAYS && !this.listenTask && !this.transcribeTask;
+  }
+
   async exec(cs) {
-    super.exec(cs);
+    await super.exec(cs);
     try {
       if (cs.direction === CallDirection.Inbound) {
         await this._initializeInbound(cs);
       }
       else {
         this.epOther = cs.ep;
+        if (this.dialMusic && this.epOther && this.epOther.connected) {
+          this.epOther.play(this.dialMusic).catch((err) => {});
+        }
       }
-      this._installDtmfDetection(cs, this.epOther, this.parentDtmfCollector);
       await this._attemptCalls(cs);
       await this.awaitTaskDone();
-      await this.performAction(this.results);
-      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();
+      this.kill(cs);
     }
   }
 
-  async kill() {
-    super.kill();
-    this._removeDtmfDetection(this.cs, this.epOther);
-    this._removeDtmfDetection(this.cs, this.ep);
+  async kill(cs, reason) {
+    super.kill(cs);
+    if (this.dialMusic && this.epOther) {
+      this.epOther.api('uuid_break', this.epOther.uuid)
+        .catch((err) => this.logger.info(err, 'Error killing dialMusic'));
+    }
+    this.killReason = reason || KillReason.Hangup;
+    if (this.timerMaxCallDuration) {
+      clearTimeout(this.timerMaxCallDuration);
+      this.timerMaxCallDuration = null;
+    }
+    if (this.timerRing) {
+      clearTimeout(this.timerRing);
+      this.timerRing = null;
+    }
+    this._removeDtmfDetection(cs.dlg);
+    this._removeDtmfDetection(this.dlg);
     this._killOutdials();
     if (this.sd) {
       this.sd.kill();
       this.sd = null;
     }
     if (this.callSid) sessionTracker.remove(this.callSid);
-    if (this.listenTask) await this.listenTask.kill();
-    if (this.transcribeTask) await this.transcribeTask.kill();
-    if (this.timerMaxCallDuration) clearTimeout(this.timerMaxCallDuration);
+    if (this.listenTask) await this.listenTask.kill(cs);
+    if (this.transcribeTask) await this.transcribeTask.kill(cs);
     this.notifyTaskDone();
   }
 
@@ -157,9 +192,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');
@@ -168,7 +208,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.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');
     }
@@ -178,46 +223,71 @@ 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`);
     }
   }
 
+  _removeHandlers(sd) {
+    sd.removeAllListeners('accept');
+    sd.removeAllListeners('decline');
+    sd.removeAllListeners('adulting');
+    sd.removeAllListeners('callStatusChange');
+    sd.removeAllListeners('callCreateFail');
+  }
+
   _killOutdials() {
     for (const [callSid, sd] of Array.from(this.dials)) {
       this.logger.debug(`Dial:_killOutdials killing callSid ${callSid}`);
       sd.kill().catch((err) => this.logger.info(err, `Dial:_killOutdials Error killing ${callSid}`));
+      this._removeHandlers(sd);
     }
     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.removeListener('dtmf', this._onDtmf.bind(this, cs, ep));
-    }
+  _removeDtmfDetection(dlg) {
+    dlg && dlg.removeAllListeners('info');
   }
 
-  _onDtmf(cs, ep, evt) {
-    const match = ep.dtmfDetector.keyPress(evt.dtmf);
-    const requestor = ep.dtmfDetector === this.parentDtmfCollector ?
-      cs.requestor :
-      this.sd.requestor;
+  _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.debug(`parentCall triggered dtmf match: ${match}`);
-      requestor.request(this.dtmfHook, Object.assign({dtmf: match}, cs.callInfo))
+      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'));
     }
   }
@@ -227,6 +297,9 @@ class TaskDial extends Task {
     this.epOther = ep;
     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}`;
+
     if (this.dialMusic) {
       // play dial music to caller while we outdial
       ep.play(this.dialMusic).catch((err) => {
@@ -238,37 +311,61 @@ class TaskDial extends Task {
   async _attemptCalls(cs) {
     const {req, srf} = cs;
     const {getSBC} = srf.locals;
-    const sbcAddress = getSBC();
+    const {lookupTeamsByAccount, lookupAccountBySid} = srf.locals.dbHelpers;
+    const {lookupCarrier} = dbUtils(this.logger, cs.srf);
+    const sbcAddress = this.proxy || getSBC();
+    const teamsInfo = {};
+    let fqdn;
 
-    /*
-    if (CallDirection.Inbound === cs.direction) {
-      const contact = req.getParsedHeader('Contact');
-      const uri = parseUri(contact[0].uri);
-      this.logger.debug({contact}, 'outdialing with contact');
-      sbcAddress = `${uri.host}:${uri.port || 5060}`;
-      //sbcAddress = `${req.source_address}:${req.source_port}`;
-    }
-    else {
-      sbcAddress = getSBC();
-    }
-    */
     if (!sbcAddress) throw new Error('no SBC found for outbound call');
     const opts = {
       headers: req && req.has('X-CID') ? Object.assign(this.headers, {'X-CID': req.get('X-CID')}) : this.headers,
       proxy: `sip:${sbcAddress}`,
       callingNumber: this.callerId || req.callingNumber
     };
+    opts.headers = {
+      ...opts.headers,
+      'X-Account-Sid': cs.accountSid
+    };
+
+    const t = this.target.find((t) => t.type === 'teams');
+    if (t) {
+      const obj = await lookupTeamsByAccount(cs.accountSid);
+      if (!obj) throw new Error('dial to ms teams not allowed; account must first be configured with teams info');
+      Object.assign(teamsInfo, {tenant_fqdn: t.tenant || obj.tenant_fqdn, ms_teams_fqdn: obj.ms_teams_fqdn});
+    }
 
     const ms = await cs.getMS();
-    const timerRing = setTimeout(() => {
+    this.timerRing = setTimeout(() => {
       this.logger.info(`Dial:_attemptCall: ring no answer timer ${this.timeout}s exceeded`);
+      this.timerRing = null;
       this._killOutdials();
     }, this.timeout * 1000);
 
-    this.target.forEach((t) => {
+    this.target.forEach(async(t) => {
       try {
         t.url = t.url || this.confirmUrl;
         t.method = t.method || this.confirmMethod || 'POST';
+        if (t.type === 'teams') t.teamsInfo = teamsInfo;
+        if (t.type === 'user' && !t.name.includes('@') && !fqdn) {
+          const user = t.name;
+          try {
+            const {sip_realm} = await lookupAccountBySid(cs.accountSid);
+            if (sip_realm) {
+              t.name = `${user}@${sip_realm}`;
+              this.logger.debug(`appending sip realm ${sip_realm} to dial target user ${user}`);
+            }
+          } catch (err) {
+            this.logger.error({err}, 'Error looking up account by sid');
+          }
+        }
+        if (t.type === 'phone' && t.trunk) {
+          const voip_carrier_sid = await lookupCarrier(cs.accountSid, t.trunk);
+          this.logger.info(`Dial:_attemptCalls: selected ${voip_carrier_sid} for requested carrier: ${t.trunk})`);
+          if (voip_carrier_sid) {
+            opts.headers['X-Requested-Carrier-Sid'] = voip_carrier_sid;
+          }
+        }
         const sd = placeCall({
           logger: this.logger,
           application: cs.application,
@@ -277,7 +374,8 @@ class TaskDial extends Task {
           sbcAddress,
           target: t,
           opts,
-          callInfo: cs.callInfo
+          callInfo: cs.callInfo,
+          accountInfo: cs.accountInfo
         });
         this.dials.set(sd.callSid, sd);
 
@@ -286,13 +384,14 @@ class TaskDial extends Task {
             this.dials.delete(sd.callSid);
             if (this.dials.size === 0 && !this.sd) {
               this.logger.debug('Dial:_attemptCalls - all calls failed after call create err, ending task');
-              this.kill();
+              this.kill(cs);
             }
           })
           .on('callStatusChange', (obj) => {
             if (this.results.dialCallStatus !== CallStatus.Completed) {
               Object.assign(this.results, {
                 dialCallStatus: obj.callStatus,
+                dialSipStatus: obj.sipStatus,
                 dialCallSid: sd.callSid,
               });
             }
@@ -306,7 +405,8 @@ class TaskDial extends Task {
                 break;
               case CallStatus.InProgress:
                 this.logger.debug('Dial:_attemptCall -- call was answered');
-                clearTimeout(timerRing);
+                clearTimeout(this.timerRing);
+                this.timerRing = null;
                 break;
               case CallStatus.Failed:
               case CallStatus.Busy:
@@ -314,23 +414,45 @@ class TaskDial extends Task {
                 this.dials.delete(sd.callSid);
                 if (this.dials.size === 0 && !this.sd) {
                   this.logger.debug('Dial:_attemptCalls - all calls failed after call failure, ending task');
-                  clearTimeout(timerRing);
-                  this.kill();
+                  clearTimeout(this.timerRing);
+                  this.timerRing = null;
+                  this.kill(cs);
                 }
                 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}`);
             this.dials.delete(sd.callSid);
             if (this.dials.size === 0 && !this.sd) {
               this.logger.debug('Dial:_attemptCalls - all calls failed after decline, ending task');
-              this.kill();
+              this.kill(cs);
             }
+          })
+          .on('reinvite', (req, res) => {
+            try {
+              cs.handleReinviteAfterMediaReleased(req, res);
+            } catch (err) {
+              this.logger.error(err, 'Error in dial einvite from B leg');
+            }
+          })
+          .once('adulting', () => {
+            /* child call just adulted and got its own session */
+            this.logger.info('Dial:on_adulting: detaching child call leg');
+            if (this.ep) {
+              this.logger.debug(`Dial:on_adulting: removing dtmf from ${this.ep.uuid}`);
+              this.ep.removeAllListeners('dtmf');
+            }
+            this.sd = null;
+            this.callSid = null;
           });
       } catch (err) {
         this.logger.error(err, 'Dial:_attemptCalls');
@@ -338,19 +460,27 @@ 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');
-      this.epOther.api('uuid_break', this.epOther.uuid);
-      this.epOther.bridge(sd.ep);
+      if (this.epOther) {
+        this.epOther.api('uuid_break', this.epOther.uuid);
+        this.epOther.bridge(sd.ep);
+      }
       this.bridged = true;
     }
 
     // ding! ding! ding! we have a winner
-    this._selectSingleDial(cs, sd);
+    await this._selectSingleDial(cs, sd);
     this._killOutdials();       // NB: order is important
   }
 
+  _onMaxCallDuration(cs) {
+    this.logger.info(`Dial:_onMaxCallDuration tearing down call as it has reached ${this.timeLimit}s`);
+    this.ep && this.ep.unbridge();
+    this.kill(cs);
+  }
+
   /**
    * We now have a call leg produced by the Dial action, so
    * - hangup any simrings in progress
@@ -360,7 +490,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);
 
@@ -368,43 +498,83 @@ 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.kill();
-      }, this.timeLimit * 1000);
+      this.timerMaxCallDuration = setTimeout(this._onMaxCallDuration.bind(this, cs), this.timeLimit * 1000);
     }
     sessionTracker.add(this.callSid, cs);
     this.dlg.on('destroy', () => {
-      this.logger.debug('Dial:_selectSingleDial called party hungup, ending dial operation');
-      sessionTracker.remove(this.callSid);
-      if (this.timerMaxCallDuration) clearTimeout(this.timerMaxCallDuration);
-      this.ep.unbridge();
-      this.kill();
+      /* if our child is adulting, he's own his own now.. */
+      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.timerMaxCallDuration = null;
+        }
+        this.ep && this.ep.unbridge();
+        this.kill(cs);
+      }
     });
 
     Object.assign(this.results, {
       dialCallStatus: CallStatus.Completed,
+      dialSipStatus: 200,
       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) {
     if (this.epOther && !this.bridged) {
       this.epOther.api('uuid_break', this.epOther.uuid);
+      this.logger.debug('Dial:_bridgeEarlyMedia: bridging early media');
       this.epOther.bridge(sd.ep);
       this.bridged = true;
     }
   }
 
+  /**
+   * Release the media from freeswitch
+   * @param {*} cs
+   * @param {*} sd
+   */
+  async _releaseMedia(cs, sd) {
+    assert(cs.ep && sd.ep);
+
+    try {
+      const aLegSdp = cs.ep.remote.sdp;
+      const bLegSdp = sd.dlg.remote.sdp;
+      await Promise.all[sd.releaseMediaToSBC(aLegSdp, cs.ep.local.sdp), 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;
+  }
+
+  async handleReinviteAfterMediaReleased(req, res) {
+    const sdp = await this.dlg.modify(req.body);
+    this.logger.info({sdp}, 'Dial:handleReinviteAfterMediaReleased - sent reinvite to B leg');
+    res.send(200, {body: sdp});
+  }
 }
 
 module.exports = TaskDial;

lib/tasks/dialogflow/digit-buffer.js

@@ -0,0 +1,70 @@
+const Emitter = require('events');
+
+/**
+ * A dtmf collector
+ * @class
+ */
+class DigitBuffer extends Emitter {
+  /**
+   * Creates a DigitBuffer
+   * @param {*} logger - a pino logger
+   * @param {*} opts - dtmf collection instructions
+   */
+  constructor(logger, opts) {
+    super();
+    this.logger = logger;
+    this.minDigits = opts.min || 1;
+    this.maxDigits = opts.max || 99;
+    this.termDigit = opts.term;
+    this.interdigitTimeout = opts.idt || 8000;
+    this.template = opts.template;
+    this.buffer = '';
+    this.logger.debug(`digitbuffer min: ${this.minDigits} max: ${this.maxDigits} term digit: ${this.termDigit}`);
+  }
+
+  /**
+   * process a received dtmf digit
+   * @param {String} a single digit entered by the caller
+   */
+  process(digit) {
+    this.logger.debug(`digitbuffer process: ${digit}`);
+    if (digit === this.termDigit) return this._fulfill();
+    this.buffer += digit;
+    if (this.buffer.length === this.maxDigits) return this._fulfill();
+    if (this.buffer.length >= this.minDigits) this._startInterDigitTimer();
+    this.logger.debug(`digitbuffer buffer: ${this.buffer}`);
+  }
+
+  /**
+   * clear the digit buffer
+   */
+  flush() {
+    if (this.idtimer) clearTimeout(this.idtimer);
+    this.buffer = '';
+  }
+
+  _fulfill() {
+    this.logger.debug(`digit buffer fulfilled with ${this.buffer}`);
+    if (this.template && this.template.includes('${digits}')) {
+      const text = this.template.replace('${digits}', this.buffer);
+      this.logger.info(`reporting dtmf as ${text}`);
+      this.emit('fulfilled', text);
+    }
+    else {
+      this.emit('fulfilled', this.buffer);
+    }
+    this.flush();
+  }
+
+  _startInterDigitTimer() {
+    if (this.idtimer) clearTimeout(this.idtimer);
+    this.idtimer = setTimeout(this._onInterDigitTimeout.bind(this), this.interdigitTimeout);
+  }
+
+  _onInterDigitTimeout() {
+    this.logger.debug('digit buffer timeout');
+    this._fulfill();
+  }
+}
+
+module.exports = DigitBuffer;

lib/tasks/dialogflow/index.js

@@ -0,0 +1,481 @@
+const Task = require('../task');
+const {TaskName, TaskPreconditions} = require('../../utils/constants');
+const Intent = require('./intent');
+const DigitBuffer = require('./digit-buffer');
+const Transcription = require('./transcription');
+const normalizeJambones = require('../../utils/normalize-jambones');
+
+class Dialogflow extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+    this.credentials = this.data.credentials;
+
+    /* 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') {
+      this.welcomeEventParams = this.data.welcomeEventParams;
+    }
+    if (this.data.noInputTimeout) this.noInputTimeout = this.data.noInputTimeout * 1000;
+    else this.noInputTimeout = 20000;
+    this.noInputEvent = this.data.noInputEvent || 'actions_intent_NO_INPUT';
+    this.passDtmfAsInputText = this.passDtmfAsInputText === true;
+    if (this.data.eventHook) this.eventHook = this.data.eventHook;
+    if (this.eventHook && Array.isArray(this.data.events)) {
+      this.events = this.data.events;
+    }
+    else if (this.eventHook) {
+      // send all events by default - except interim transcripts
+      this.events = [
+        'intent',
+        'transcription',
+        'dtmf',
+        'start-play',
+        'stop-play',
+        'no-input'
+      ];
+    }
+    else {
+      this.events = [];
+    }
+    if (this.data.actionHook) this.actionHook = this.data.actionHook;
+    if (this.data.thinkingMusic) this.thinkingMusic = this.data.thinkingMusic;
+    if (this.data.tts) {
+      this.vendor = this.data.tts.vendor || 'default';
+      this.language = this.data.tts.language || 'default';
+      this.voice = this.data.tts.voice || 'default';
+    }
+    this.bargein = this.data.bargein;
+  }
+
+  get name() { return TaskName.Dialogflow; }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+
+    try {
+      await this.init(cs, ep);
+
+      this.logger.debug(`starting dialogflow bot ${this.project}`);
+
+      // kick it off
+      const baseArgs = `${this.ep.uuid} ${this.project} ${this.lang} ${this.welcomeEvent}`;
+      if (this.welcomeEventParams) {
+        this.ep.api('dialogflow_start', `${baseArgs} '${JSON.stringify(this.welcomeEventParams)}'`);
+      }
+      else if (this.welcomeEvent.length) {
+        this.ep.api('dialogflow_start', baseArgs);
+      }
+      else {
+        this.ep.api('dialogflow_start', `${this.ep.uuid} ${this.project} ${this.lang}`);
+      }
+      this.logger.debug(`started dialogflow bot ${this.project}`);
+
+      await this.awaitTaskDone();
+    } catch (err) {
+      this.logger.error({err}, 'Dialogflow:exec error');
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    if (this.ep.connected) {
+      this.logger.debug('TaskDialogFlow:kill');
+      this.ep.removeCustomEventListener('dialogflow::intent');
+      this.ep.removeCustomEventListener('dialogflow::transcription');
+      this.ep.removeCustomEventListener('dialogflow::audio_provided');
+      this.ep.removeCustomEventListener('dialogflow::end_of_utterance');
+      this.ep.removeCustomEventListener('dialogflow::error');
+
+      this._clearNoinputTimer();
+
+      if (!this.reportedFinalAction) this.performAction({dialogflowResult: 'caller hungup'})
+        .catch((err) => this.logger.error({err}, 'dialogflow - error w/ action webook'));
+
+      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+    }
+    this.notifyTaskDone();
+  }
+
+  async init(cs, ep) {
+    this.ep = ep;
+    try {
+      if (this.vendor === 'default') {
+        this.vendor = cs.speechSynthesisVendor;
+        this.language = cs.speechSynthesisLanguage;
+        this.voice = cs.speechSynthesisVoice;
+      }
+      this.ttsCredentials = cs.getSpeechCredentials(this.vendor, 'tts');
+
+      this.ep.addCustomEventListener('dialogflow::intent', this._onIntent.bind(this, ep, cs));
+      this.ep.addCustomEventListener('dialogflow::transcription', this._onTranscription.bind(this, ep, cs));
+      this.ep.addCustomEventListener('dialogflow::audio_provided', this._onAudioProvided.bind(this, ep, cs));
+      this.ep.addCustomEventListener('dialogflow::end_of_utterance', this._onEndOfUtterance.bind(this, ep, cs));
+      this.ep.addCustomEventListener('dialogflow::error', this._onError.bind(this, ep, cs));
+
+      const obj = typeof this.credentials === 'string' ? JSON.parse(this.credentials) : this.credentials;
+      const creds = JSON.stringify(obj);
+      await this.ep.set('GOOGLE_APPLICATION_CREDENTIALS', creds);
+
+    } catch (err) {
+      this.logger.error({err}, 'Error setting credentials');
+      throw err;
+    }
+  }
+
+  /**
+   * An intent has been returned.  Since we are using SINGLE_UTTERANCE on the dialogflow side,
+   * we may get an empty intent, signified by the lack of a 'response_id' attribute.
+   * In such a case, we just start another StreamingIntentDetectionRequest.
+   * @param {*} ep -  media server endpoint
+   * @param {*} evt - event data
+   */
+  async _onIntent(ep, cs, evt) {
+    const intent = new Intent(this.logger, evt);
+
+    if (intent.isEmpty) {
+      /**
+       * An empty intent is returned in 3 conditions:
+       * 1. Our no-input timer fired
+       * 2. We collected dtmf that needs to be fed to dialogflow
+       * 3. A normal dialogflow timeout
+       */
+      if (this.noinput && this.greetingPlayed) {
+        this.logger.info('no input timer fired, reprompting..');
+        this.noinput = false;
+        ep.api('dialogflow_start', `${ep.uuid} ${this.project} ${this.lang} ${this.noInputEvent}`);
+      }
+      else if (this.dtmfEntry && this.greetingPlayed) {
+        this.logger.info('dtmf detected, reprompting..');
+        ep.api('dialogflow_start', `${ep.uuid} ${this.project} ${this.lang} none \'${this.dtmfEntry}\'`);
+        this.dtmfEntry = null;
+      }
+      else if (this.greetingPlayed) {
+        this.logger.info('starting another intent');
+        ep.api('dialogflow_start', `${ep.uuid} ${this.project} ${this.lang}`);
+      }
+      else {
+        this.logger.info('got empty intent');
+        ep.api('dialogflow_start', `${ep.uuid} ${this.project} ${this.lang}`);
+      }
+      return;
+    }
+
+    if (this.events.includes('intent')) {
+      this._performHook(cs, this.eventHook, {event: 'intent', data: evt});
+    }
+
+    // clear the no-input timer and the digit buffer
+    this._clearNoinputTimer();
+    if (this.digitBuffer) this.digitBuffer.flush();
+
+    /* hang up (or tranfer call) after playing next audio file? */
+    if (intent.saysEndInteraction) {
+      //  if 'end_interaction' is true, end the dialog after playing the final prompt
+      //  (or in 1 second if there is no final prompt)
+      this.hangupAfterPlayDone = true;
+      this.waitingForPlayStart = true;
+      setTimeout(() => {
+        if (this.waitingForPlayStart) {
+          this.logger.info('hanging up since intent was marked end interaction');
+          this.performAction({dialogflowResult: 'completed'});
+          this.notifyTaskDone();
+        }
+      }, 1000);
+    }
+
+    /* collect digits? */
+    else if (intent.saysCollectDtmf || this.enableDtmfAlways) {
+      const opts = Object.assign({
+        idt: this.opts.interDigitTimeout
+      }, intent.dtmfInstructions || {term: '#'});
+      this.digitBuffer = new DigitBuffer(this.logger, opts);
+      this.digitBuffer.once('fulfilled', this._onDtmfEntryComplete.bind(this, ep));
+    }
+
+    /* 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;
+
+      // start a new intent, (we want to continue to listen during the audio playback)
+      // _unless_ we are transferring or ending the session
+      if (!this.hangupAfterPlayDone) {
+        ep.api('dialogflow_start', `${ep.uuid} ${this.project} ${this.lang}`);
+      }
+
+      try {
+        const obj = {
+          text: intent.fulfillmentText,
+          vendor: this.vendor,
+          language: this.language,
+          voice: this.voice,
+          salt: cs.callSid,
+          credentials: this.ttsCredentials
+        };
+        this.logger.debug({obj}, 'Dialogflow:_onIntent - playing message via tts');
+        const {filePath, servedFromCache} = await synthAudio(stats, obj);
+        if (filePath) cs.trackTmpFile(filePath);
+        if (!this.ttsCredentials && !servedFromCache) cs.billForTts(intent.fulfillmentText.length);
+
+        if (this.playInProgress) {
+          await ep.api('uuid_break', ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+        }
+        this.playInProgress = true;
+        this.curentAudioFile = filePath;
+
+        this.logger.debug(`starting to play tts ${filePath}`);
+
+        if (this.events.includes('start-play')) {
+          this._performHook(cs, this.eventHook, {event: 'start-play', data: {path: filePath}});
+        }
+        await ep.play(filePath);
+        if (this.events.includes('stop-play')) {
+          this._performHook(cs, this.eventHook, {event: 'stop-play', data: {path: filePath}});
+        }
+        this.logger.debug(`finished ${filePath}`);
+
+        if (this.curentAudioFile === filePath) {
+          this.playInProgress = false;
+          if (this.queuedTasks) {
+            this.logger.debug('finished playing audio and we have queued tasks');
+            this._redirect(cs, this.queuedTasks);
+            return;
+          }
+        }
+        this.greetingPlayed = true;
+
+        if (this.hangupAfterPlayDone) {
+          this.logger.info('hanging up since intent was marked end interaction and we completed final prompt');
+          this.performAction({dialogflowResult: 'completed'});
+          this.notifyTaskDone();
+        }
+        else {
+          // every time we finish playing a prompt, start the no-input timer
+          this._startNoinputTimer(ep, cs);
+        }
+      } catch (err) {
+        this.logger.error({err}, 'Dialogflow:_onIntent - error playing tts');
+      }
+    }
+  }
+
+  /**
+   * A transcription - either interim or final - has been returned.
+   * If we are doing barge-in based on hotword detection, check for the hotword or phrase.
+   * If we are playing a filler sound, like typing, during the fullfillment phase, start that
+   * if this is a final transcript.
+   * @param {*} ep  -  media server endpoint
+   * @param {*} evt - event data
+   */
+  async _onTranscription(ep, cs, evt) {
+    const transcription = new Transcription(this.logger, evt);
+
+    if (this.events.includes('transcription') && transcription.isFinal) {
+      this._performHook(cs, this.eventHook, {event: 'transcription', data: evt});
+    }
+    else if (this.events.includes('interim-transcription') && !transcription.isFinal) {
+      this._performHook(cs, this.eventHook, {event: 'transcription', data: evt});
+    }
+
+    // if a final transcription, start a typing sound
+    if (this.thinkingSound > 0 && !transcription.isEmpty && transcription.isFinal &&
+      transcription.confidence > 0.8) {
+      ep.play(this.data.thinkingSound).catch((err) => this.logger.info(err, 'Error playing typing sound'));
+    }
+
+    // interrupt playback on speaking if bargein = true
+    if (this.bargein && this.playInProgress) {
+      this.logger.debug('terminating playback due to speech bargein');
+      this.playInProgress = false;
+      await ep.api('uuid_break', ep.uuid);
+    }
+  }
+
+  /**
+   * The caller has just finished speaking.  No action currently taken.
+   * @param {*} evt - event data
+   */
+  _onEndOfUtterance(cs, evt) {
+    if (this.events.includes('end-utterance')) {
+      this._performHook(cs, this.eventHook, {event: 'end-utterance'});
+    }
+  }
+
+  /**
+   * Dialogflow has returned an error of some kind.
+   * @param {*} evt - event data
+   */
+  _onError(ep, cs, evt) {
+    this.logger.error(`got error: ${JSON.stringify(evt)}`);
+  }
+
+  /**
+   * Audio has been received from dialogflow and written to a temporary disk file.
+   * Start playing the audio, after killing any filler sound that might be playing.
+   * When the audio completes, start the no-input timer.
+   * @param {*} ep -  media server endpoint
+   * @param {*} evt - event data
+   */
+  async _onAudioProvided(ep, cs, evt) {
+
+    if (this.vendor) return;
+
+    this.waitingForPlayStart = false;
+
+    // kill filler audio
+    await ep.api('uuid_break', ep.uuid);
+
+    // start a new intent, (we want to continue to listen during the audio playback)
+    // _unless_ we are transferring or ending the session
+    if (/*this.greetingPlayed &&*/ !this.hangupAfterPlayDone) {
+      ep.api('dialogflow_start', `${ep.uuid} ${this.project} ${this.lang}`);
+    }
+
+    this.playInProgress = true;
+    this.curentAudioFile = evt.path;
+
+    this.logger.info(`starting to play ${evt.path}`);
+    if (this.events.includes('start-play')) {
+      this._performHook(cs, this.eventHook, {event: 'start-play', data: {path: evt.path}});
+    }
+    await ep.play(evt.path);
+    if (this.events.includes('stop-play')) {
+      this._performHook(cs, this.eventHook, {event: 'stop-play', data: {path: evt.path}});
+    }
+    this.logger.info(`finished ${evt.path}, queued tasks: ${(this.queuedTasks || []).length}`);
+
+    if (this.curentAudioFile === evt.path) {
+      this.playInProgress = false;
+      if (this.queuedTasks) {
+        this.logger.debug('finished playing audio and we have queued tasks');
+        this._redirect(cs, this.queuedTasks);
+        this.queuedTasks.length = 0;
+        return;
+      }
+    }
+    /*
+    if (!this.inbound && !this.greetingPlayed) {
+      this.logger.info('finished greeting on outbound call, starting new intent');
+      this.ep.api('dialogflow_start', `${ep.uuid} ${this.project} ${this.lang}`);
+    }
+    */
+    this.greetingPlayed = true;
+
+    if (this.hangupAfterPlayDone) {
+      this.logger.info('hanging up since intent was marked end interaction and we completed final prompt');
+      this.performAction({dialogflowResult: 'completed'});
+      this.notifyTaskDone();
+    }
+    else {
+      // every time we finish playing a prompt, start the no-input timer
+      this._startNoinputTimer(ep, cs);
+    }
+  }
+
+  /**
+   * receive a dmtf entry from the caller.
+   * If we have active dtmf instructions, collect and process accordingly.
+   */
+  _onDtmf(ep, cs, evt) {
+    if (this.digitBuffer) this.digitBuffer.process(evt.dtmf);
+    if (this.events.includes('dtmf')) {
+      this._performHook(cs, this.eventHook, {event: 'dtmf', data: evt});
+    }
+  }
+
+  _onDtmfEntryComplete(ep, dtmfEntry) {
+    this.logger.info(`collected dtmf entry: ${dtmfEntry}`);
+    this.dtmfEntry = dtmfEntry;
+    this.digitBuffer = null;
+    // if a final transcription, start a typing sound
+    if (this.thinkingSound > 0) {
+      ep.play(this.thinkingSound).catch((err) => this.logger.info(err, 'Error playing typing sound'));
+    }
+
+    // kill the current dialogflow, which will result in us getting an immediate intent
+    ep.api('dialogflow_stop', `${ep.uuid}`)
+      .catch((err) => this.logger.info(`dialogflow_stop failed: ${err.message}`));
+  }
+
+  /**
+   * The user has not provided any input for some time.
+   * Set the 'noinput' member to true and kill the current dialogflow.
+   * This will result in us re-prompting with an event indicating no input.
+   * @param {*} ep
+   */
+  _onNoInput(ep, cs) {
+    this.noinput = true;
+
+    if (this.events.includes('no-input')) {
+      this._performHook(cs, this.eventHook,  {event: 'no-input'});
+    }
+
+    // kill the current dialogflow, which will result in us getting an immediate intent
+    ep.api('dialogflow_stop', `${ep.uuid}`)
+      .catch((err) => this.logger.info(`dialogflow_stop failed: ${err.message}`));
+  }
+
+  /**
+   * Stop the no-input timer, if it is running
+   */
+  _clearNoinputTimer() {
+    if (this.noinputTimer) {
+      clearTimeout(this.noinputTimer);
+      this.noinputTimer = null;
+    }
+  }
+
+  /**
+   * Start the no-input timer.  The duration is set in the configuration file.
+   * @param {*} ep
+   */
+  _startNoinputTimer(ep, cs) {
+    if (!this.noInputTimeout) return;
+    this._clearNoinputTimer();
+    this.noinputTimer = setTimeout(this._onNoInput.bind(this, ep, cs), this.noInputTimeout);
+  }
+
+  async _performHook(cs, hook, results = {}) {
+    const json = await this.cs.requestor.request(hook, {...results, ...cs.callInfo.toJSON()});
+    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) {
+        if (this.playInProgress) {
+          this.queuedTasks = tasks;
+          this.logger.info({tasks: tasks},
+            `${this.name} replacing application with ${tasks.length} tasks after play completes`);
+          return;
+        }
+        this._redirect(cs, tasks);
+      }
+    }
+  }
+
+  _redirect(cs, tasks) {
+    this.logger.info({tasks: tasks}, `${this.name} replacing application with ${tasks.length} tasks`);
+    this.performAction({dialogflowResult: 'redirect'}, false);
+    this.reportedFinalAction = true;
+    cs.replaceApplication(tasks);
+  }
+
+}
+
+module.exports = Dialogflow;

lib/tasks/dialogflow/intent.js

@@ -0,0 +1,89 @@
+class Intent {
+  constructor(logger, evt) {
+    this.logger = logger;
+    this.evt = evt;
+
+    this.logger.debug({evt}, 'intent');
+    this.dtmfRequest = checkIntentForDtmfEntry(logger, evt);
+  }
+
+  get isEmpty() {
+    return this.evt.response_id.length === 0;
+  }
+
+  get fulfillmentText() {
+    return this.evt.query_result.fulfillment_text;
+  }
+
+  get saysEndInteraction() {
+    return this.evt.query_result.intent.end_interaction ;
+  }
+
+  get saysCollectDtmf() {
+    return !!this.dtmfRequest;
+  }
+
+  get dtmfInstructions() {
+    return this.dtmfRequest;
+  }
+
+  get name() {
+    if (!this.isEmpty) return this.evt.query_result.intent.display_name;
+  }
+
+  toJSON() {
+    return {
+      name: this.name,
+      fulfillmentText: this.fulfillmentText
+    };
+  }
+
+}
+
+module.exports = Intent;
+
+/**
+ * Parse a returned intent for DTMF entry information
+ * i.e.
+ * allow-dtmf-x-y-z
+ * x = min number of digits
+ * y = optional, max number of digits
+ * z = optional, terminating character
+ * e.g.
+ * allow-dtmf-5 :     collect 5 digits
+ * allow-dtmf-1-4 :   collect between 1 to 4 (inclusive) digits
+ * allow-dtmf-1-4-# : collect 1-4 digits, terminating if '#' is entered
+ * @param {*} intent - dialogflow intent
+ */
+const checkIntentForDtmfEntry = (logger, intent) => {
+  const qr = intent.query_result;
+  if (!qr || !qr.fulfillment_messages || !qr.output_contexts) {
+    logger.info({f: qr.fulfillment_messages, o: qr.output_contexts}, 'no dtmfs');
+    return;
+  }
+
+  // check for custom payloads with a gather verb
+  const custom = qr.fulfillment_messages.find((f) => f.payload && f.payload.verb === 'gather');
+  if (custom && custom.payload && custom.payload.verb === 'gather') {
+    logger.info({custom}, 'found dtmf custom payload');
+    return {
+      max: custom.payload.numDigits,
+      term: custom.payload.finishOnKey,
+      template: custom.payload.responseTemplate
+    };
+  }
+
+  // check for an output context with a specific naming convention
+  const context = qr.output_contexts.find((oc) => oc.name.includes('/contexts/allow-dtmf-'));
+  if (context) {
+    const arr = /allow-dtmf-(\d+)(?:-(\d+))?(?:-(.*))?/.exec(context.name);
+    if (arr) {
+      logger.info({custom}, 'found dtmf output context');
+      return {
+        min: parseInt(arr[1]),
+        max: arr.length > 2 ? parseInt(arr[2]) : null,
+        term: arr.length > 3 ? arr[3] : null
+      };
+    }
+  }
+};

lib/tasks/dialogflow/transcription.js

@@ -0,0 +1,41 @@
+class Transcription {
+  constructor(logger, evt) {
+    this.logger = logger;
+
+    this.recognition_result = evt.recognition_result;
+  }
+
+  get isEmpty() {
+    return !this.recognition_result;
+  }
+
+  get isFinal() {
+    return this.recognition_result && this.recognition_result.is_final === true;
+  }
+
+  get confidence() {
+    if (!this.isEmpty) return this.recognition_result.confidence;
+  }
+
+  get text() {
+    if (!this.isEmpty) return this.recognition_result.transcript;
+  }
+
+  startsWith(str) {
+    return (this.text.toLowerCase() || '').startsWith(str.toLowerCase());
+  }
+
+  includes(str) {
+    return (this.text.toLowerCase() || '').includes(str.toLowerCase());
+  }
+
+  toJSON() {
+    return {
+      final: this.recognition_result.is_final === true,
+      text: this.text,
+      confidence: this.confidence
+    };
+  }
+}
+
+module.exports = Transcription;

lib/tasks/dtmf.js

@@ -0,0 +1,41 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+
+class TaskDtmf extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    this.dtmf = this.data.dtmf;
+    this.duration = this.data.duration || 500;
+  }
+
+  get name() { return TaskName.Dtmf; }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+    this.ep = ep;
+    try {
+      this.logger.info({data: this.data}, `sending dtmf ${this.dtmf}`);
+      await this.ep.execute('send_dtmf', `${this.dtmf}@${this.duration}`);
+      this.timer = setTimeout(this.notifyTaskDone.bind(this), this.dtmf.length * (this.duration + 250) + 750);
+      await this.awaitTaskDone();
+      this.logger.info({data: this.data}, `done sending dtmf ${this.dtmf}`);
+    } catch (err) {
+      this.logger.info(err, `TaskDtmf:exec - error playing ${this.dtmf}`);
+    }
+    this.emit('playDone');
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    if (this.ep.connected && !this.playComplete) {
+      this.logger.debug('TaskDtmf:kill - killing audio');
+      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+    }
+    clearTimeout(this.timer);
+    this.notifyTaskDone();
+  }
+}
+
+module.exports = TaskDtmf;

lib/tasks/enqueue.js

@@ -0,0 +1,363 @@
+const Task = require('./task');
+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, KillReason} = require('../utils/constants');
+const bent = require('bent');
+const assert = require('assert');
+
+const getUrl = (cs) => `${cs.srf.locals.serviceUrl}/v1/enqueue/${cs.callSid}`;
+
+const getElapsedTime = (from) => Math.floor((Date.now() - from) / 1000);
+
+class TaskEnqueue extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.logger = logger;
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    this.queueName = this.data.name;
+    this.waitHook = this.data.waitHook;
+
+    this.emitter = new Emitter();
+    this.state = QueueResults.Wait;
+
+    // transferred from another server in order to bridge to a local caller?
+    if (this.data._) {
+      this.bridgeNow = true;
+      this.bridgeDetails = {
+        epUid: this.data._.epUuid,
+        notifyUrl: this.data._.notifyUrl
+      };
+      this.waitStartTime = this.data._.waitStartTime;
+      this.connectTime = this.data._.connectTime;
+    }
+  }
+
+  get name() { return TaskName.Enqueue; }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+    const dlg = cs.dlg;
+    this.queueName = `queue:${cs.accountSid}:${this.queueName}`;
+
+    try {
+      if (!this.bridgeNow) {
+        await this._addToQueue(cs, dlg, ep);
+        await this._doWait(cs, dlg, ep);
+      }
+      else {
+        // update dialog's answer time to when it was answered on the previous server, not now
+        dlg.connectTime = this.connectTime;
+        await this._doBridge(cs, dlg, ep);
+      }
+      if (!this.callMoved) await this.performAction();
+      await this.awaitTaskDone();
+
+      this.logger.debug(`TaskEnqueue:exec - task done queue ${this.queueName}`);
+    } catch (err) {
+      this.logger.info(err, `TaskEnqueue:exec - error in enqueue ${this.queueName}`);
+    }
+  }
+
+  async kill(cs, reason) {
+    super.kill(cs);
+    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();
+  }
+
+  async _addToQueue(cs, dlg) {
+    const {pushBack} = cs.srf.locals.dbHelpers;
+    const url = getUrl(cs);
+    this.waitStartTime = Date.now();
+    this.logger.debug({queue: this.queueName, url}, 'pushing url onto queue');
+    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) {
+    const {removeFromList, lengthOfList} = cs.srf.locals.dbHelpers;
+    await removeFromList(this.queueName, getUrl(cs));
+    return await lengthOfList(this.queueName);
+  }
+
+  async performAction() {
+    const params = {
+      queueSid: this.queueName,
+      queueTime: getElapsedTime(this.waitStartTime),
+      queueResult: this.state
+    };
+    await super.performAction(params, this.killReason !== KillReason.Replaced);
+  }
+
+  /**
+   * Add ourselves to the queue with a url that can be invoked to tell us to dequeue
+   * @param {CallSession} cs
+   * @param {SipDialog} dlg
+   */
+  async _doWait(cs, dlg, ep) {
+    return new Promise(async(resolve, reject) => {
+      this.emitter
+        .once('dequeue', (opts) => {
+          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', 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();
+            this._playSession = null;
+          }
+          resolve();
+        });
+
+      if (this.waitHook && !this.killed) {
+        do {
+          try {
+            await ep.play('silence_stream://500');
+            const tasks = await this._playHook(cs, dlg, this.waitHook);
+            if (0 === tasks.length) break;
+          } catch (err) {
+            if (!this.bridgeDetails && !this.killed) {
+              this.logger.info(err, `TaskEnqueue:_doWait: failed retrieving waitHook for ${this.queueName}`);
+            }
+            this._playSession = null;
+            break;
+          }
+        } while (!this.killed && !this.bridgeDetails);
+      }
+    });
+
+  }
+
+  /**
+   * Bridge to another call.
+   * The call may be homed on this feature server, or another one -
+   * in the latter case, move the call to the other server via REFER
+   * Returns a promise that resolves:
+   * (a) When the call is transferred to the other feature server if the dequeue-er is not local, or
+   * (b) When either party hangs up the bridged call
+   * @param {CallSession} cs
+   * @param {SipDialog} dlg
+   */
+  async _doBridge(cs, dlg, ep) {
+    assert(this.bridgeNow || this.bridgeDetails.dequeueSipAddress);
+    if (!this.bridgeNow && cs.srf.locals.localSipAddress !== this.bridgeDetails.dequeueSipAddress) {
+      this.logger.info({
+        localServer: cs.srf.locals.localSipAddress,
+        otherServer: this.bridgeDetails.dequeueSipAddress
+      }, `TaskEnqueue:_doBridge: leg for queue ${this.queueName} is hosted elsewhere`);
+      const success = await this.transferCallToFeatureServer(cs, this.bridgeDetails.dequeueSipAddress, {
+        waitStartTime: this.waitStartTime,
+        epUuid: this.bridgeDetails.epUuid,
+        notifyUrl: this.bridgeDetails.notifyUrl,
+        connectTime: dlg.connectTime.valueOf()
+      });
+
+      /**
+       * If the REFER succeeded, we will get a BYE from the SBC
+       * which will trigger kill and the end of the execution of the CallSession
+       * which is what we want - so do nothing and let that happen.
+       * If on the other hand, the REFER failed then we are in a bad state
+       * and need to end the enqueue task with a failure indication and
+       * allow the application to continue on
+       */
+      if (success) {
+        this.logger.info(`TaskEnqueue:_doBridge: REFER of ${this.queueName} succeeded`);
+        return;
+      }
+      this.state = QueueResults.Error;
+      this.notifyTaskDone();
+      return;
+    }
+    this.logger.info(`TaskEnqueue:_doBridge: queue ${this.queueName} is hosted locally`);
+    await this._bridgeLocal(cs, dlg, ep);
+    this.notifyTaskDone();
+  }
+
+  _bridgeLocal(cs, dlg, ep) {
+    assert(this.bridgeDetails.notifyUrl);
+
+    return new Promise(async(resolve, reject) => {
+      try {
+
+        // notify partner we are ready to be bridged - giving him our possibly new url and endpoint
+        const notifyUrl = getUrl(cs);
+        const url = this.bridgeDetails.notifyUrl;
+
+        this.logger.debug('TaskEnqueue:_doBridge: ready to be bridged');
+        bent('POST', 202)(url, {
+          event: 'ready',
+          epUuid: ep.uuid,
+          notifyUrl
+        }).catch((err) => {
+          this.logger.info({err, url}, 'TaskEnqueue:_bridgeLocal error sending bridged event');
+          /**
+           * TODO: this probably means he dropped while we were connecting....
+           * should we put this call back to the front of the queue so he gets serviced (?)
+           */
+          this.state = QueueResults.Error;
+          reject(new Error('bridge failure'));
+        });
+
+        // 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', (reason) => {
+            this.killReason = reason;
+            this.logger.info(`TaskEnqueue:_bridgeLocal ending with ${this.killReason}`);
+            ep.unbridge().catch((err) => {});
+
+            // notify partner that we dropped
+            bent('POST', 202)(this.bridgeDetails.notifyUrl, {event: 'hangup'}).catch((err) => {
+              this.logger.info(err, 'TaskEnqueue:_bridgeLocal error sending hangup event to partner');
+            });
+            resolve();
+          });
+
+      } catch (err) {
+        this.state = QueueResults.Error;
+        this.logger.error(err, 'TaskEnqueue:_bridgeLocal error');
+        reject(err);
+      }
+    });
+  }
+
+  /**
+   * We are being dequeued and bridged to another call.
+   * It may be on this server or a different one, and we are
+   * given instructions how to find it and connect.
+   * @param {Object} opts
+   * @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
+   */
+  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');
+    }
+    else {
+      this.logger.error({opts}, 'TaskEnqueue:notifyDequeueEvent - unsupported event/payload');
+    }
+  }
+
+  async _playHook(cs, dlg, hook, allowed = [TaskName.Play, TaskName.Say, TaskName.Pause, TaskName.Leave]) {
+    const {lengthOfList, getListPosition} = cs.srf.locals.dbHelpers;
+
+    assert(!this._playSession);
+    if (this.killed) return [];
+
+    const params = {
+      queueSid: this.queueName,
+      queueTime: getElapsedTime(this.waitStartTime)
+    };
+    try {
+      const queueSize = await lengthOfList(this.queueName);
+      const queuePosition = await getListPosition(this.queueName, this.notifyUrl);
+      Object.assign(params, {queueSize, queuePosition});
+    } catch (err) {
+      this.logger.error({err}, `TaskEnqueue:_playHook error retrieving list info for queue ${this.queueName}`);
+    }
+    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.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)}`);
+    }
+    this.logger.debug(`TaskEnqueue:_playHook: executing ${tasks.length} tasks`);
+
+    // check for 'leave' verb and only execute tasks up till then
+    const tasksToRun = [];
+    for (const o of tasks) {
+      if (o.name === TaskName.Leave) {
+        this._leave = true;
+        this.logger.info('waitHook returned a leave task');
+        break;
+      }
+      tasksToRun.push(o);
+    }
+    const cloneTasks = [...tasksToRun];
+    if (this.killed) return [];
+    else if (tasksToRun.length > 0) {
+      this._playSession = new ConfirmCallSession({
+        logger: this.logger,
+        application: cs.application,
+        dlg,
+        ep: cs.ep,
+        callInfo: cs.callInfo,
+        accountInfo: cs.accountInfo,
+        tasks: tasksToRun
+      });
+      await this._playSession.exec();
+      this._playSession = null;
+    }
+    if (this._leave) {
+      this.state = QueueResults.Leave;
+      this.kill(cs);
+    }
+    return cloneTasks;
+  }
+}
+
+module.exports = TaskEnqueue;

lib/tasks/gather.js

@@ -1,24 +1,45 @@
 const Task = require('./task');
-const {TaskName, TaskPreconditions, TranscriptionEvents} = require('../utils/constants');
+const {
+  TaskName,
+  TaskPreconditions,
+  GoogleTranscriptionEvents,
+  AwsTranscriptionEvents,
+  AzureTranscriptionEvents
+} = require('../utils/constants');
+
 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;
 
     [
       'finishOnKey', 'hints', 'input', 'numDigits',
-      'partialResultHook', 'profanityFilter',
+      'partialResultHook',
       'speechTimeout', 'timeout', 'say', 'play'
     ].forEach((k) => this[k] = this.data[k]);
 
     this.timeout = (this.timeout || 5) * 1000;
     this.interim = this.partialResultCallback;
     if (this.data.recognizer) {
-      this.language = this.data.recognizer.language || 'en-US';
-      this.vendor = this.data.recognizer.vendor;
+      const recognizer = this.data.recognizer;
+      this.vendor = recognizer.vendor;
+      this.language = recognizer.language;
+      this.hints = recognizer.hints || [];
+      this.altLanguages = recognizer.altLanguages || [];
+
+      /* aws options */
+      this.vocabularyName = recognizer.vocabularyName;
+      this.vocabularyFilterName = recognizer.vocabularyFilterName;
+      this.filterMethod = recognizer.filterMethod;
+
+      /* microsoft options */
+      this.outputFormat = recognizer.outputFormat || 'simple';
+      this.profanityOption = recognizer.profanityOption || 'raw';
+      this.requestSnr = recognizer.requestSnr || false;
+      this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
     }
 
     this.digitBuffer = '';
@@ -26,18 +47,38 @@ 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);
   }
 
   async exec(cs, ep) {
-    super.exec(cs);
+    await super.exec(cs);
+    const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
+
     this.ep = ep;
+    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.needsStt && !this.sttCredentials) {
+      const {writeAlerts, AlertType} = cs.srf.locals;
+      this.logger.info(`TaskGather:exec - ERROR stt using ${this.vendor} requested but creds not supplied`);
+      writeAlerts({
+        account_sid: cs.accountSid,
+        alert_type: AlertType.STT_NOT_PROVISIONED,
+        vendor: this.vendor
+      }).catch((err) => this.logger.info({err}, 'Error generating alert for no stt'));
+
+      throw new Error(`no speech-to-text service credentials for ${this.vendor} have been configured`);
+    }
 
     try {
       if (this.sayTask) {
@@ -55,66 +96,123 @@ class TaskGather extends Task {
       else this._startTimer();
 
       if (this.input.includes('speech')) {
-        await this._initSpeech(ep);
+        await this._initSpeech(cs, ep);
         this._startTranscribing(ep);
+        updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid)
+          .catch(() => {/*already logged error */});
       }
 
       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();
     } catch (err) {
       this.logger.error(err, 'TaskGather:exec error');
     }
-    ep.removeCustomEventListener(TranscriptionEvents.Transcription);
-    ep.removeCustomEventListener(TranscriptionEvents.EndOfUtterance);
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.EndOfUtterance);
+    ep.removeCustomEventListener(AwsTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(AzureTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected);
   }
 
-  kill() {
-    super.kill();
-    this._killAudio();
+  kill(cs) {
+    super.kill(cs);
+    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(ep) {
-    const opts = {
-      GOOGLE_SPEECH_USE_ENHANCED: true,
-      GOOGLE_SPEECH_SINGLE_UTTERANCE: true,
-      GOOGLE_SPEECH_MODEL: 'command_and_search'
-    };
-    if (this.hints) {
-      Object.assign(opts, {'GOOGLE_SPEECH_HINTS': this.hints.join(',')});
+  async _initSpeech(cs, ep) {
+    const opts = {};
+
+    if ('google' === this.vendor) {
+      if (this.sttCredentials) opts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(this.sttCredentials.credentials);
+      Object.assign(opts, {
+        GOOGLE_SPEECH_USE_ENHANCED: true,
+        GOOGLE_SPEECH_SINGLE_UTTERANCE: true,
+        GOOGLE_SPEECH_MODEL: 'command_and_search'
+      });
+      if (this.hints && this.hints.length > 1) {
+        opts.GOOGLE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
+      }
+      if (this.altLanguages && this.altLanguages.length > 1) {
+        opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
+      }
+      if (this.profanityFilter === true) {
+        Object.assign(opts, {'GOOGLE_SPEECH_PROFANITY_FILTER': true});
+      }
+      ep.addCustomEventListener(GoogleTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+      ep.addCustomEventListener(GoogleTranscriptionEvents.EndOfUtterance, this._onEndOfUtterance.bind(this, cs, ep));
     }
-    if (this.profanityFilter === true) {
-      Object.assign(opts, {'GOOGLE_SPEECH_PROFANITY_FILTER': true});
+    else if (['aws', 'polly'].includes(this.vendor)) {
+      if (this.vocabularyName) opts.AWS_VOCABULARY_NAME = this.vocabularyName;
+      if (this.vocabularyFilterName) {
+        opts.AWS_VOCABULARY_NAME = this.vocabularyFilterName;
+        opts.AWS_VOCABULARY_FILTER_METHOD = this.filterMethod || 'mask';
+      }
+      if (this.sttCredentials) {
+        Object.assign(opts, {
+          AWS_ACCESS_KEY_ID: this.sttCredentials.accessKeyId,
+          AWS_SECRET_ACCESS_KEY: this.sttCredentials.secretAccessKey,
+          AWS_REGION: this.sttCredentials.region
+        });
+      }
+      ep.addCustomEventListener(AwsTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+    }
+    else if ('microsoft' === this.vendor) {
+      if (this.sttCredentials) {
+        Object.assign(opts, {
+          'AZURE_SUBSCRIPTION_KEY': this.sttCredentials.api_key,
+          'AZURE_REGION': this.sttCredentials.region
+        });
+      }
+      if (this.hints && this.hints.length > 1) {
+        opts.AZURE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
+      }
+      //if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
+      //if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
+      if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;
+      opts.AZURE_USE_OUTPUT_FORMAT_DETAILED = 1;
+
+      ep.addCustomEventListener(AzureTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+      ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected, this._onNoSpeechDetected.bind(this, cs, ep));
     }
-    this.logger.debug(`setting freeswitch vars ${JSON.stringify(opts)}`);
     await ep.set(opts)
-      .catch((err) => this.logger.info(err, 'Error set'));
-    ep.addCustomEventListener(TranscriptionEvents.Transcription, this._onTranscription.bind(this, ep));
-    ep.addCustomEventListener(TranscriptionEvents.EndOfUtterance, this._onEndOfUtterance.bind(this, ep));
+      .catch((err) => this.logger.info(err, 'Error setting channel variables'));
   }
 
   _startTranscribing(ep) {
     ep.startTranscription({
+      vendor: this.vendor,
+      locale: this.language,
       interim: this.partialResultCallback ? true : false,
-      language: this.language || this.callSession.speechRecognizerLanguage
-    }).catch((err) => this.logger.error(err, 'TaskGather:_startTranscribing error'));
+    }).catch((err) => {
+      const {writeAlerts, AlertType} = this.cs.srf.locals;
+      this.logger.error(err, 'TaskGather:_startTranscribing error');
+      writeAlerts({
+        account_sid: this.cs.accountSid,
+        alert_type: AlertType.STT_FAILURE,
+        vendor: this.vendor,
+        detail: err.message
+      });
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for tts failure'));
   }
 
   _startTimer() {
     assert(!this._timeoutTimer);
+    this.logger.debug(`Gather:_startTimer: timeout ${this.timeout}`);
     this._timeoutTimer = setTimeout(() => this._resolve('timeout'), this.timeout);
   }
 
@@ -125,18 +223,34 @@ 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;
     }
   }
 
-  _onTranscription(ep, evt) {
+  _onTranscription(cs, ep, evt) {
+    if ('aws' === this.vendor && Array.isArray(evt) && evt.length > 0) evt = evt[0];
+    if ('microsoft' === this.vendor) {
+      const nbest = evt.NBest;
+      const newEvent = {
+        is_final: evt.RecognitionStatus === 'Success',
+        alternatives: [
+          {
+            confidence: nbest[0].Confidence,
+            transcript: nbest[0].Display
+          }
+        ]
+      };
+      evt = newEvent;
+    }
     this.logger.debug(evt, 'TaskGather:_onTranscription');
     if (evt.is_final) this._resolve('speech', evt);
     else if (this.partialResultHook) {
@@ -144,20 +258,38 @@ class TaskGather extends Task {
         .catch((err) => this.logger.info(err, 'GatherTask:_onTranscription error'));
     }
   }
-  _onEndOfUtterance(ep, evt) {
-    this.logger.info(evt, 'TaskGather:_onEndOfUtterance');
-    this._startTranscribing(ep);
+  _onEndOfUtterance(cs, ep) {
+    this.logger.info('TaskGather:_onEndOfUtterance');
+    if (!this.resolved && !this.killed) {
+      this._startTranscribing(ep);
+    }
+  }
+
+  _onNoSpeechDetected(cs, ep) {
+    this._resolve('timeout');
   }
 
   async _resolve(reason, evt) {
+    if (this.resolved) return;
+    this.resolved = true;
     this.logger.debug(`TaskGather:resolve with reason ${reason}`);
 
+    if (this.ep && this.ep.connected) {
+      this.ep.stopTranscription({vendor: this.vendor})
+        .catch((err) => this.logger.error({err}, 'Error stopping transcription'));
+    }
+
     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/hangup.js

@@ -15,7 +15,7 @@ class TaskHangup extends Task {
    * Hangup the call
    */
   async exec(cs, dlg) {
-    super.exec(cs);
+    await super.exec(cs);
     try {
       await dlg.destroy({headers: this.headers});
     } catch (err) {

lib/tasks/leave.js

@@ -0,0 +1,22 @@
+const Task = require('./task');
+const {TaskName} = require('../utils/constants');
+
+class TaskLeave extends Task {
+  constructor(logger, opts, parentTask) {
+    super(logger, opts);
+  }
+
+  get name() { return TaskName.Leave; }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+    await this.awaitTaskDone();
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    this.notifyTaskDone();
+  }
+}
+
+module.exports = TaskLeave;

lib/tasks/lex.js

@@ -0,0 +1,306 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+const normalizeJambones = require('../utils/normalize-jambones');
+
+class Lex extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    if (this.data.credentials) {
+      this.awsAccessKeyId = this.data.credentials.accessKey;
+      this.awsSecretAccessKey = this.data.credentials.secretAccessKey;
+    }
+    this.bot = this.data.botId;
+    this.alias = this.data.botAlias;
+    this.region = this.data.region;
+    this.locale = this.data.locale || 'en_US';
+    this.intent = this.data.intent || {};
+    this.metadata = this.data.metadata;
+    this.welcomeMessage = this.data.welcomeMessage;
+    this.bargein = this.data.bargein || false;
+    this.passDtmf = this.data.passDtmf || false;
+    if (this.data.noInputTimeout) this.noInputTimeout = this.data.noInputTimeout * 1000;
+    if (this.data.tts) {
+      this.vendor = this.data.tts.vendor || 'default';
+      this.language = this.data.tts.language || 'default';
+      this.voice = this.data.tts.voice || 'default';
+    }
+
+    this.botName = `${this.bot}:${this.alias}:${this.region}`;
+    if (this.data.eventHook) this.eventHook = this.data.eventHook;
+    this.events = this.eventHook ?
+      [
+        'intent',
+        'transcription',
+        'dtmf',
+        'start-play',
+        'stop-play',
+        'play-interrupted',
+        'response-text'
+      ] : [];
+    if (this.data.actionHook) this.actionHook = this.data.actionHook;
+  }
+
+  get name() { return TaskName.Lex; }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+
+    try {
+      await this.init(cs, ep);
+
+      // kick it off
+      const obj = {};
+      let cmd = `${this.ep.uuid} ${this.bot} ${this.alias} ${this.region} ${this.locale} `;
+
+      if (this.metadata) Object.assign(obj, this.metadata);
+      if (this.intent.name) {
+        cmd += this.intent.name;
+        if (this.intent.slots) Object.assign(obj, {slots: this.intent.slots});
+      }
+
+      if (Object.keys(obj).length > 0) cmd += ` '${JSON.stringify(obj)}'`;
+
+      this.logger.debug({cmd}, `starting lex bot ${this.botName} with locale ${this.locale}`);
+      this.ep.api('aws_lex_start', cmd)
+        .catch((err) => {
+          this.logger.error({err}, `Error starting lex bot ${this.botName}`);
+          this.notifyTaskDone();
+        });
+
+      await this.awaitTaskDone();
+    } catch (err) {
+      this.logger.error({err}, 'Lex:exec error');
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    if (this.ep.connected) {
+      this.logger.debug('Lex:kill');
+      this.ep.removeCustomEventListener('lex::intent');
+      this.ep.removeCustomEventListener('lex::transcription');
+      this.ep.removeCustomEventListener('lex::audio_provided');
+      this.ep.removeCustomEventListener('lex::text_response');
+      this.ep.removeCustomEventListener('lex::playback_interruption');
+      this.ep.removeCustomEventListener('lex::error');
+      this.ep.removeAllListeners('dtmf');
+
+      this.performAction({lexResult: 'caller hungup'})
+        .catch((err) => this.logger.error({err}, 'lex - error w/ action webook'));
+
+      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+    }
+    this.notifyTaskDone();
+  }
+
+  async init(cs, ep) {
+    this.ep = ep;
+    try {
+      if (this.vendor === 'default') {
+        this.vendor = cs.speechSynthesisVendor;
+        this.language = cs.speechSynthesisLanguage;
+        this.voice = cs.speechSynthesisVoice;
+      }
+      this.ttsCredentials = cs.getSpeechCredentials(this.vendor, 'tts');
+
+      this.ep.addCustomEventListener('lex::intent', this._onIntent.bind(this, ep, cs));
+      this.ep.addCustomEventListener('lex::transcription', this._onTranscription.bind(this, ep, cs));
+      this.ep.addCustomEventListener('lex::audio_provided', this._onAudioProvided.bind(this, ep, cs));
+      this.ep.addCustomEventListener('lex::text_response', this._onTextResponse.bind(this, ep, cs));
+      this.ep.addCustomEventListener('lex::playback_interruption', this._onPlaybackInterruption.bind(this, ep, cs));
+      this.ep.addCustomEventListener('lex::error', this._onError.bind(this, ep, cs));
+      this.ep.on('dtmf', this._onDtmf.bind(this, ep, cs));
+
+      const channelVars = {};
+      if (this.bargein) {
+        Object.assign(channelVars, {'x-amz-lex:barge-in-enabled': 1});
+      }
+      if (this.noInputTimeout) {
+        Object.assign(channelVars, {'x-amz-lex:audio:start-timeout-ms': this.noInputTimeout});
+      }
+      if (this.awsAccessKeyId && this.awsSecretAccessKey) {
+        Object.assign(channelVars, {
+          AWS_ACCESS_KEY_ID: this.awsAccessKeyId,
+          AWS_SECRET_ACCESS_KEY: this.awsSecretAccessKey
+        });
+      }
+      if (this.vendor) Object.assign(channelVars, {LEX_USE_TTS: 1});
+      //if (this.intent.name) Object.assign(channelVars, {LEX_WELCOME_INTENT: this.intent});
+      if (this.welcomeMessage && this.welcomeMessage.length) {
+        Object.assign(channelVars, {LEX_WELCOME_MESSAGE: this.welcomeMessage});
+      }
+      if (Object.keys(channelVars).length) await this.ep.set(channelVars);
+
+    } catch (err) {
+      this.logger.error({err}, 'Error setting listeners');
+      throw err;
+    }
+  }
+
+  /**
+   * An intent has been returned.
+   * we may get an empty intent, signified by ...
+   * In such a case, we just restart the bot.
+   * @param {*} ep -  media server endpoint
+   * @param {*} evt - event data
+   */
+  _onIntent(ep, cs, evt) {
+    this.logger.debug({evt}, `got intent for ${this.botName}`);
+    if (this.events.includes('intent')) {
+      this._performHook(cs, this.eventHook, {event: 'intent', data: evt});
+    }
+  }
+
+  /**
+   * A transcription - either interim or final - has been returned.
+   * If we are doing barge-in based on hotword detection, check for the hotword or phrase.
+   * If we are playing a filler sound, like typing, during the fullfillment phase, start that
+   * if this is a final transcript.
+   * @param {*} ep  -  media server endpoint
+   * @param {*} evt - event data
+   */
+  _onTranscription(ep, cs, evt) {
+    this.logger.debug({evt}, `got transcription for ${this.botName}`);
+    if (this.events.includes('transcription')) {
+      this._performHook(cs, this.eventHook, {event: 'transcription', data: evt});
+    }
+  }
+
+  /**
+   * @param {*} evt - event data
+   */
+  async _onTextResponse(ep, cs, evt) {
+    this.logger.debug({evt}, `got text response for ${this.botName}`);
+    const messages = evt.messages;
+    if (this.events.includes('response-text')) {
+      this._performHook(cs, this.eventHook, {event: 'response-text', data: evt});
+    }
+    if (this.vendor && Array.isArray(messages) && messages.length) {
+      const msg = messages[0].msg;
+      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(stats, {
+            text: msg,
+            vendor: this.vendor,
+            language: this.language,
+            voice: this.voice,
+            salt: cs.callSid,
+            credentials: this.ttsCredentials
+          });
+          if (filePath) cs.trackTmpFile(filePath);
+
+          if (this.events.includes('start-play')) {
+            this._performHook(cs, this.eventHook, {event: 'start-play', data: {path: filePath}});
+          }
+          await ep.play(filePath);
+          if (this.events.includes('stop-play')) {
+            this._performHook(cs, this.eventHook, {event: 'stop-play', data: {path: filePath}});
+          }
+          this.logger.debug(`finished tts, sending play_done  ${this.vendor} ${this.voice}`);
+          this.ep.api('aws_lex_play_done', this.ep.uuid)
+            .catch((err) => {
+              this.logger.error({err}, `Error sending play_done ${this.botName}`);
+            });
+        } catch (err) {
+          this.logger.error({err}, 'Lex:_onTextResponse - error playing tts');
+        }
+      }
+    }
+  }
+
+  /**
+   * @param {*} evt - event data
+   */
+  _onPlaybackInterruption(ep, cs, evt) {
+    this.logger.debug({evt}, `got playback interruption for ${this.botName}`);
+    if (this.bargein) {
+      if (this.events.includes('play-interrupted')) {
+        this._performHook(cs, this.eventHook, {event: 'play-interrupted', data: {}});
+      }
+      this.ep.api('uuid_break', this.ep.uuid)
+        .catch((err) => this.logger.info(err, 'Lex::_onPlaybackInterruption - Error killing audio'));
+    }
+  }
+
+  /**
+   * Lex has returned an error of some kind.
+   * @param {*} evt - event data
+   */
+  _onError(ep, cs, evt) {
+    this.logger.error({evt}, `got error for bot ${this.botName}`);
+  }
+
+  /**
+   * Audio has been received from lex and written to a temporary disk file.
+   * Start playing the audio, after killing any filler sound that might be playing.
+   * When the audio completes, start the no-input timer.
+   * @param {*} ep -  media server endpoint
+   * @param {*} evt - event data
+   */
+  async _onAudioProvided(ep, cs, evt) {
+    if (this.vendor) return;
+
+    this.waitingForPlayStart = false;
+    this.logger.debug({evt}, `got audio file for bot ${this.botName}`);
+
+    try {
+      if (this.events.includes('start-play')) {
+        this._performHook(cs, this.eventHook, {event: 'start-play', data: {path: evt.path}});
+      }
+      await ep.play(evt.path);
+      if (this.events.includes('stop-play')) {
+        this._performHook(cs, this.eventHook, {event: 'stop-play', data: {path: evt.path}});
+      }
+      this.logger.debug({evt}, `done playing audio file for bot ${this.botName}`);
+      this.ep.api('aws_lex_play_done', this.ep.uuid)
+        .catch((err) => {
+          this.logger.error({err}, `Error sending play_done ${this.botName}`);
+        });
+    } catch (err) {
+      this.logger.error({err}, `Error playing file ${evt.path} for both ${this.botName}`);
+    }
+
+  }
+
+  /**
+   * receive a dmtf entry from the caller.
+   * If we have active dtmf instructions, collect and process accordingly.
+   */
+  _onDtmf(ep, cs, evt) {
+    this.logger.debug({evt}, 'Lex:_onDtmf');
+    if (this.events.includes('dtmf')) {
+      this._performHook(cs, this.eventHook, {event: 'dtmf', data: evt});
+    }
+    if (this.passDtmf) {
+      this.ep.api('aws_lex_dtmf', `${this.ep.uuid} ${evt.dtmf}`)
+        .catch((err) => {
+          this.logger.error({err}, `Error sending dtmf ${evt.dtmf} ${this.botName}`);
+        });
+    }
+  }
+
+  async _performHook(cs, hook, results) {
+    const json = await this.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.logger.info({tasks: tasks}, `${this.name} replacing application with ${tasks.length} tasks`);
+        this.performAction({lexResult: 'redirect'}, false);
+        cs.replaceApplication(tasks);
+      }
+    }
+  }
+
+}
+
+module.exports = Lex;

lib/tasks/listen.js

@@ -29,7 +29,7 @@ class TaskListen extends Task {
   get name() { return TaskName.Listen; }
 
   async exec(cs, ep) {
-    super.exec(cs);
+    await super.exec(cs);
     this.ep = ep;
 
     try {
@@ -50,8 +50,8 @@ class TaskListen extends Task {
     this._removeListeners(ep);
   }
 
-  async kill() {
-    super.kill();
+  async kill(cs) {
+    super.kill(cs);
     this.logger.debug(`TaskListen:kill endpoint connected? ${this.ep && this.ep.connected}`);
     this._clearTimer();
     if (this.ep && this.ep.connected) {
@@ -63,7 +63,8 @@ class TaskListen extends Task {
       const duration = moment().diff(this.recordStartTime, 'seconds');
       this.results.dialCallDuration = duration;
     }
-    if (this.transcribeTask) await this.transcribeTask.kill();
+    if (this.transcribeTask) await this.transcribeTask.kill(cs);
+    this.ep && this._removeListeners(this.ep);
     this.notifyTaskDone();
   }
 
@@ -110,7 +111,7 @@ class TaskListen extends Task {
     if (this.maxLength) {
       this._timer = setTimeout(() => {
         this.logger.debug(`TaskListen terminating task due to timeout of ${this.timeout}s reached`);
-        this.kill();
+        this.kill(cs);
       }, this.maxLength * 1000);
     }
   }
@@ -122,6 +123,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) {
@@ -131,6 +137,10 @@ class TaskListen extends Task {
     if (this.finishOnKey || this.passDtmf) {
       ep.removeListener('dtmf', this._dtmfHandler);
     }
+    ep.removeCustomEventListener(ListenEvents.PlayAudio);
+    ep.removeCustomEventListener(ListenEvents.KillAudio);
+    ep.removeCustomEventListener(ListenEvents.Disconnect);
+
   }
 
   _onDtmf(evt) {
@@ -154,11 +164,52 @@ 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();
   }
 
+  /**
+   * play or say something during the call
+   * @param {*} tasks - array of play/say tasks to execute
+   */
+  async whisper(tasks, callSid) {
+    try {
+      const cs = this.callSession;
+      this.logger.debug('Listen:whisper tasks starting');
+      while (tasks.length && !cs.callGone) {
+        const task = tasks.shift();
+        await task.exec(cs, this.ep);
+      }
+      this.logger.debug('Listen:whisper tasks complete');
+    } catch (err) {
+      this.logger.error(err, 'Listen:whisper error');
+    }
+  }
+
 }
 
 module.exports = TaskListen;

lib/tasks/make_task.js

@@ -9,7 +9,6 @@ function makeTask(logger, obj, parent) {
   }
   const name = keys[0];
   const data = obj[name];
-  //logger.debug(data, `makeTask: ${name}`);
   if (typeof data !== 'object') {
     throw errBadInstruction;
   }
@@ -18,12 +17,45 @@ 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.Cognigy:
+      const TaskCognigy = require('./cognigy');
+      return new TaskCognigy(logger, data, parent);
+    case TaskName.Conference:
+      const TaskConference = require('./conference');
+      return new TaskConference(logger, data, parent);
     case TaskName.Dial:
       const TaskDial = require('./dial');
       return new TaskDial(logger, data, parent);
+    case TaskName.Dialogflow:
+      const TaskDialogflow = require('./dialogflow');
+      return new TaskDialogflow(logger, data, parent);
+    case TaskName.Dequeue:
+      const TaskDequeue = require('./dequeue');
+      return new TaskDequeue(logger, data, parent);
+    case TaskName.Dtmf:
+      const TaskDtmf = require('./dtmf');
+      return new TaskDtmf(logger, data, parent);
+    case TaskName.Enqueue:
+      const TaskEnqueue = require('./enqueue');
+      return new TaskEnqueue(logger, data, parent);
     case TaskName.Hangup:
       const TaskHangup = require('./hangup');
       return new TaskHangup(logger, data, parent);
+    case TaskName.Leave:
+      const TaskLeave = require('./leave');
+      return new TaskLeave(logger, data, parent);
+    case TaskName.Lex:
+      const TaskLex = require('./lex');
+      return new TaskLex(logger, data, 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

@@ -0,0 +1,127 @@
+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) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.None;
+
+    this.payload = {
+      message_sid: this.data.message_sid || uuidv4(),
+      carrier: this.data.carrier,
+      to: this.data.to,
+      from: this.data.from,
+      text: this.data.text
+    };
+
+  }
+
+  get name() { return TaskName.Message; }
+
+  /**
+   * Send outbound SMS
+   */
+  async exec(cs) {
+    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 {getSmpp, dbHelpers} = srf.locals;
+      const {lookupSmppGateways} = dbHelpers;
+
+      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.carrier || o.vc.name === this.payload.carrier));
+      }
+      if (gw) {
+        this.logger.info({gw, accountSid}, 'Message:exec - using smpp to send message');
+        url = process.env.K8S ? 'http://smpp' : getSmpp();
+        relativeUrl = '/sms';
+        payload = {
+          ...payload,
+          ...gw.sg,
+          ...gw.vc
+        };
+      }
+      else {
+        //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/`;
+        */
+        this.performAction({
+          ...actionParams,
+          message_status: 'no carriers'
+        }).catch((err) => {});
+        if (res) res.sendStatus(404);
+        return;
+      }
+      if (url) {
+        const post = bent(url, 'POST', 'json', 201, 480);
+        this.logger.info({payload, url}, 'Message:exec sending outbound SMS');
+        const response = await post(relativeUrl, payload);
+        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
+            });
+          }
+        }
+      }
+      else {
+        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 - 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'});
+    }
+  }
+}
+
+module.exports = TaskMessage;

lib/tasks/pause.js

@@ -11,13 +11,13 @@ class TaskPause extends Task {
   get name() { return TaskName.Pause; }
 
   async exec(cs, ep) {
-    super.exec(cs);
+    await super.exec(cs);
     this.timer = setTimeout(this.notifyTaskDone.bind(this), this.length * 1000);
     await this.awaitTaskDone();
   }
 
-  async kill() {
-    super.kill();
+  async kill(cs) {
+    super.kill(cs);
     clearTimeout(this.timer);
     this.notifyTaskDone();
   }

lib/tasks/play.js

@@ -14,11 +14,15 @@ class TaskPlay extends Task {
   get name() { return TaskName.Play; }
 
   async exec(cs, ep) {
-    super.exec(cs);
+    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}`);
@@ -26,11 +30,17 @@ class TaskPlay extends Task {
     this.emit('playDone');
   }
 
-  async kill() {
-    super.kill();
+  async kill(cs) {
+    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/redirect.js

@@ -12,7 +12,7 @@ class TaskRedirect extends Task {
   get name() { return TaskName.Redirect; }
 
   async exec(cs) {
-    super.exec(cs);
+    await super.exec(cs);
     await this.performAction();
   }
 }

lib/tasks/rest_dial.js

@@ -1,7 +1,7 @@
 const Task = require('./task');
 const {TaskName} = require('../utils/constants');
 const makeTask = require('./make_task');
-const normalizeJamones = require('../utils/normalize-jamones');
+const normalizeJambones = require('../utils/normalize-jambones');
 
 /**
  * Manages an outdial made via REST API
@@ -24,16 +24,16 @@ class TaskRestDial extends Task {
   /**
    * INVITE has just been sent at this point
   */
-  async exec(cs, req) {
-    super.exec(cs);
-    this.req = req;
+  async exec(cs) {
+    await super.exec(cs);
+    this.req = cs.req;
 
     this._setCallTimer();
     await this.awaitTaskDone();
   }
 
-  kill() {
-    super.kill();
+  kill(cs) {
+    super.kill(cs);
     this._clearCallTimer();
     if (this.req) {
       this.req.cancel();
@@ -51,7 +51,7 @@ class TaskRestDial extends Task {
       const tasks = await cs.requestor.request(this.call_hook, cs.callInfo);
       if (tasks && Array.isArray(tasks)) {
         this.logger.debug({tasks: tasks}, `TaskRestDial: replacing application with ${tasks.length} tasks`);
-        cs.replaceApplication(normalizeJamones(this.logger, tasks).map((tdata) => makeTask(this.logger, tdata)));
+        cs.replaceApplication(normalizeJambones(this.logger, tasks).map((tdata) => makeTask(this.logger, tdata)));
       }
     } catch (err) {
       this.logger.error(err, 'TaskRestDial:_onConnect error retrieving or parsing application, ending call');

lib/tasks/say-legacy.js

@@ -0,0 +1,53 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+
+class TaskSayLegacy extends Task {
+  constructor(logger, opts, parentTask) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    this.text = this.data.text;
+    this.loop = this.data.loop || 1;
+    this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
+    if (this.data.synthesizer) {
+      this.voice = this.data.synthesizer.voice;
+      switch (this.data.synthesizer.vendor) {
+        case 'google':
+          this.ttsEngine = 'google_tts';
+          break;
+        default:
+          throw new Error(`unsupported tts vendor ${this.data.synthesizer.vendor}`);
+      }
+    }
+  }
+
+  get name() { return TaskName.SayLegacy; }
+
+  async exec(cs, ep) {
+    super.exec(cs);
+    this.ep = ep;
+    try {
+      while (!this.killed && this.loop--) {
+        this.logger.debug(`TaskSayLegacy: remaining loops ${this.loop}`);
+        await ep.speak({
+          ttsEngine: 'google_tts',
+          voice: this.voice || this.callSession.speechSynthesisVoice,
+          text: this.text
+        });
+      }
+    } catch (err) {
+      this.logger.info(err, 'TaskSayLegacy:exec error');
+    }
+    this.emit('playDone');
+  }
+
+  async kill() {
+    super.kill();
+    if (this.ep.connected) {
+      this.logger.debug('TaskSayLegacy:kill - killing audio');
+      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+    }
+  }
+}
+
+module.exports = TaskSayLegacy;

lib/tasks/say.js

@@ -6,34 +6,81 @@ class TaskSay extends Task {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
 
-    this.text = this.data.text;
+    this.text = Array.isArray(this.data.text) ? this.data.text : [this.data.text];
     this.loop = this.data.loop || 1;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
-    if (this.data.synthesizer) {
-      this.voice = this.data.synthesizer.voice;
-      switch (this.data.synthesizer.vendor) {
-        case 'google':
-          this.ttsEngine = 'google_tts';
-          break;
-        default:
-          throw new Error(`unsupported tts vendor ${this.data.synthesizer.vendor}`);
-      }
-    }
+    this.synthesizer = this.data.synthesizer || {};
   }
 
   get name() { return TaskName.Say; }
 
   async exec(cs, ep) {
-    super.exec(cs);
+    await super.exec(cs);
+
+    const {srf} = cs;
+    const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, srf);
+    const {writeAlerts, AlertType, stats} = srf.locals;
+    const {synthAudio} = srf.locals.dbHelpers;
+    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 engine = this.synthesizer.engine || 'standard';
+    const salt = cs.callSid;
+    const credentials = cs.getSpeechCredentials(vendor, 'tts');
+
+    this.logger.info({language, voice}, `Task:say - using vendor: ${vendor}`);
     this.ep = ep;
     try {
-      while (!this.killed && this.loop--) {
-        this.logger.debug(`TaskSay: remaining loops ${this.loop}`);
-        await ep.speak({
-          ttsEngine: 'google_tts',
-          voice: this.voice || this.callSession.speechSynthesisVoice,
-          text: this.text
-        });
+      if (!credentials) {
+        writeAlerts({
+          account_sid: cs.accountSid,
+          alert_type: AlertType.TTS_NOT_PROVISIONED,
+          vendor
+        }).catch((err) => this.logger.info({err}, 'Error generating alert for no tts'));
+        throw new Error('no provisioned speech credentials for TTS');
+      }
+      // synthesize all of the text elements
+      let lastUpdated = false;
+      const filepath = (await Promise.all(this.text.map(async(text) => {
+        const {filePath, servedFromCache} = await synthAudio(stats, {
+          text,
+          vendor,
+          language,
+          voice,
+          engine,
+          salt,
+          credentials
+        }).catch((err) => {
+          this.logger.info(err, 'Error synthesizing tts');
+          writeAlerts({
+            account_sid: cs.accountSid,
+            alert_type: AlertType.TTS_NOT_PROVISIONED,
+            vendor,
+            detail: err.message
+          });
+        }).catch((err) => this.logger.info({err}, 'Error generating alert for tts failure'));
+        this.logger.debug(`file ${filePath}, served from cache ${servedFromCache}`);
+        if (filePath) cs.trackTmpFile(filePath);
+        if (!servedFromCache && !lastUpdated) {
+          lastUpdated = true;
+          updateSpeechCredentialLastUsed(credentials.speech_credential_sid)
+            .catch(() => {/*already logged error */});
+        }
+        return filePath;
+      }))).filter((fp) => fp && fp.length);
+
+      this.logger.debug({filepath}, 'synthesized files for tts');
+
+      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep.connected) {
+        let segment = 0;
+        do {
+          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) {
       this.logger.info(err, 'TaskSay:exec error');
@@ -41,11 +88,17 @@ class TaskSay extends Task {
     this.emit('playDone');
   }
 
-  async kill() {
-    super.kill();
+  async kill(cs) {
+    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_decline.js

@@ -1,5 +1,5 @@
 const Task = require('./task');
-const {TaskName, TaskPreconditions} = require('../utils/constants');
+const {TaskName, TaskPreconditions, CallStatus} = require('../utils/constants');
 
 /**
  * Rejects an incoming call with user-specified status code and reason
@@ -19,6 +19,7 @@ class TaskSipDecline extends Task {
     res.send(this.data.status, this.data.reason, {
       headers: this.headers
     });
+    cs.emit('callStatusChange', {callStatus: CallStatus.Failed, sipStatus: this.data.status});
   }
 }
 

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,61 @@
       "status"
     ]
   },
+  "sip:refer": {
+    "properties": {
+      "referTo": "string",
+      "referredBy": "string",
+      "headers": "object",
+      "actionHook": "object|string",
+      "eventHook": "object|string"
+    },
+    "required": [
+      "referTo"
+    ]
+  },
+  "cognigy": {
+    "properties": {
+      "url": "string",
+      "token": "string",
+      "recognizer": "#recognizer",
+      "tts": "#synthesizer",
+      "prompt": "string",
+      "actionHook": "object|string",
+      "eventHook": "object|string",
+      "data": "object"
+    },
+    "required": [
+      "url",
+      "token"
+    ]
+  },
+  "dequeue": {
+    "properties": {
+      "name": "string",
+      "actionHook": "object|string",
+      "timeout": "number",
+      "beep": "boolean"
+    },
+    "required": [
+      "name"
+    ]
+  },
+  "enqueue": {
+    "properties": {
+      "name": "string",
+      "actionHook": "object|string",
+      "waitHook": "object|string",
+      "_": "object"
+    },
+    "required": [
+      "name"
+    ]
+  },
+  "leave": {
+    "properties": {
+      
+    }
+  },
   "hangup": {
     "properties": {
       "headers": "object"
@@ -19,7 +74,7 @@
   "play": {
     "properties": {
       "url": "string",
-      "loop": "number",
+      "loop": "number|string",
       "earlyMedia": "boolean"
     },
     "required": [
@@ -28,8 +83,8 @@
   },
   "say": {
     "properties": {
-      "text": "string",
-      "loop": "number",
+      "text": "string|array",
+      "loop": "number|string",
       "synthesizer": "#synthesizer",
       "earlyMedia": "boolean"
     },
@@ -51,7 +106,25 @@
       "say": "#say"
     },
     "required": [
-      "actionHook"
+    ]
+  },
+  "conference": {
+    "properties": {
+      "name": "string",
+      "beep": "boolean",
+      "startConferenceOnEnter": "boolean",
+      "endConferenceOnExit": "boolean",
+      "maxParticipants": "number",
+      "joinMuted": "boolean",
+      "actionHook": "object|string",
+      "waitHook": "object|string",
+      "statusEvents": "array",
+      "statusHook": "object|string",
+      "enterHook": "object|string",
+      "record": "#record"
+    },
+    "required": [
+      "name"
     ]
   },
   "dial": {
@@ -68,12 +141,74 @@
       "target": ["#target"],
       "timeLimit": "number",
       "timeout": "number",
+      "proxy": "string",
       "transcribe": "#transcribe"
     },
     "required": [
       "target"
     ]
   },
+  "dialogflow": {
+    "properties": {
+      "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",
+      "events": "[string]",
+      "welcomeEvent": "string",
+      "welcomeEventParams": "object",
+      "noInputTimeout": "number",
+      "noInputEvent": "string",
+      "passDtmfAsTextInput": "boolean",
+      "thinkingMusic": "string",
+      "tts": "#synthesizer",
+      "bargein": "boolean"
+    },
+    "required": [
+      "project",
+      "credentials",
+      "lang"
+    ]
+  },
+  "dtmf": {
+    "properties": {
+      "dtmf": "string",
+      "duration": "number"
+    },
+    "required": [
+      "dtmf"
+    ]
+  },
+  "lex": {
+    "properties": {
+      "botId": "string",
+      "botAlias": "string",
+      "credentials": "object",
+      "region": "string",
+      "locale": "string",
+      "intent": "#lexIntent",
+      "welcomeMessage": "string",
+      "metadata": "object",
+      "bargein": "boolean",
+      "passDtmf": "boolean",
+      "actionHook": "object|string",
+      "eventHook": "object|string",
+      "noInputTimeout": "number",
+      "tts": "#synthesizer"
+    },
+    "required": [
+      "botId",
+      "botAlias",
+      "region",
+      "credentials"
+    ]
+  },
   "listen": {
     "properties": {
       "actionHook": "object|string",
@@ -98,6 +233,22 @@
       "url"
     ]
   },
+  "message": {
+    "properties": {
+      "carrier": "string",
+      "account_sid": "string",
+      "message_sid": "string",
+      "to": "string",
+      "from": "string",
+      "text": "string",
+      "media": "string|array",
+      "actionHook": "object|string"
+    },
+    "required": [
+      "to",
+      "from"
+    ]
+  },
   "pause": {
     "properties": {
       "length": "number"
@@ -106,6 +257,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"
@@ -123,10 +295,12 @@
       "from": "string",
       "speech_synthesis_vendor": "string",
       "speech_synthesis_voice": "string",
+      "speech_synthesis_language": "string",
       "speech_recognizer_vendor": "string",
       "speech_recognizer_language": "string",
       "tag": "object",
       "to": "#target",
+      "headers": "object",
       "timeout": "number"
     },
     "required": [
@@ -150,24 +324,28 @@
       "earlyMedia": "boolean"
     },
     "required": [
-      "transcriptionHook"
+      "recognizer"
     ]
   },
   "target": {
     "properties": {
       "type": {
         "type": "string",
-        "enum": ["phone", "sip", "user"]
+        "enum": ["phone", "sip", "user", "teams"]
       },
-      "url": "string",
+      "confirmHook": "object|string",
       "method": {
         "type": "string",
         "enum": ["GET", "POST"]
       },
+      "name": "string",
       "number": "string",
       "sipUri": "string",
       "auth": "#auth",
-      "name": "string"
+      "vmail": "boolean",
+      "tenant": "string",
+      "trunk": "string",
+      "overrideTo": "string"
     },
     "required": [
       "type"
@@ -187,9 +365,18 @@
     "properties": {
       "vendor": {
         "type": "string",
-        "enum": ["google"]
+        "enum": ["google", "aws", "polly", "microsoft", "default"]
       },
-      "voice": "string"
+      "language": "string",
+      "voice": "string",
+      "engine": {
+        "type": "string",
+        "enum": ["standard", "neural"]
+      },
+      "gender": {
+        "type": "string",
+        "enum": ["MALE", "FEMALE", "NEUTRAL"]
+      }
     },
     "required": [
       "vendor"
@@ -199,16 +386,76 @@
     "properties": {
       "vendor": {
         "type": "string",
-        "enum": ["google"]
+        "enum": ["google", "aws", "microsoft", "default"]
       },
       "language": "string",
       "hints": "array",
+      "altLanguages": "array",
       "profanityFilter": "boolean",
       "interim": "boolean",
-      "dualChannel": "boolean"
+      "singleUtterance": "boolean",
+      "dualChannel": "boolean",
+      "separateRecognitionPerChannel": "boolean",
+      "punctuation": "boolean",
+      "enhancedModel": "boolean",
+      "words": "boolean",
+      "diarization": "boolean",
+      "diarizationMinSpeakers": "number",
+      "diarizationMaxSpeakers": "number",
+      "interactionType": {
+        "type": "string",
+        "enum": [
+          "unspecified",
+          "discussion",
+          "presentation",
+          "phone_call",
+          "voicemail",
+          "voice_search",
+          "voice_command",
+          "dictation"
+        ]
+      },
+      "naicsCode": "number",
+      "identifyChannels": "boolean",
+      "vocabularyName": "string",
+      "vocabularyFilterName": "string",
+      "filterMethod": {
+        "type": "string",
+        "enum": [
+          "remove",
+          "mask",
+          "tag"
+        ]
+      },
+      "outputFormat": {
+        "type": "string",
+        "enum": [
+          "simple",
+          "detailed"
+        ]
+      },
+      "profanityOption": {
+        "type": "string",
+        "enum": [
+          "masked",
+          "removed",
+          "raw"
+        ]
+      },
+      "requestSnr": "boolean",
+      "initialSpeechTimeoutMs": "number"
     },
     "required": [
       "vendor"
     ]
+  },
+  "lexIntent": {
+    "properties": {
+      "name": "string",
+      "slots": "object"
+    },
+    "required": [
+      "name"
+    ]
   }
 }

lib/tasks/task.js

@@ -1,8 +1,9 @@
 const Emitter = require('events');
+const { v4: uuidv4 } = require('uuid');
 const debug = require('debug')('jambonz:feature-server');
 const assert = require('assert');
 const {TaskPreconditions} = require('../utils/constants');
-const normalizeJamones = require('../utils/normalize-jamones');
+const normalizeJambones = require('../utils/normalize-jambones');
 const specs = new Map();
 const _specData = require('./specs');
 for (const key in _specData) {specs.set(key, _specData[key]);}
@@ -22,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);
   }
 
   /**
@@ -55,8 +59,8 @@ class Task extends Emitter {
    * called to kill (/stop) a running task
    * what to do is up to each type of task
    */
-  kill() {
-    this.logger.debug(`${this.name} is being killed`);
+  kill(cs) {
+    if (this.cs && !this.cs.isConfirmCallSession) this.logger.debug(`${this.name} is being killed`);
     this._killInProgress = true;
     // no-op
   }
@@ -76,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
    */
@@ -89,7 +108,7 @@ class Task extends Emitter {
       const json = await this.cs.requestor.request(this.actionHook, params);
       if (expectResponse && json && Array.isArray(json)) {
         const makeTask = require('./make_task');
-        const tasks = normalizeJamones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+        const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
         if (tasks && tasks.length > 0) {
           this.logger.info({tasks: tasks}, `${this.name} replacing application with ${tasks.length} tasks`);
           this.callSession.replaceApplication(tasks);
@@ -98,6 +117,97 @@ 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;
+    const obj = Object.assign({}, cs.application);
+    delete obj.requestor;
+    delete obj.notifier;
+    obj.tasks =  cs.getRemainingTaskData();
+    if (opts && obj.tasks.length > 0) {
+      const key = Object.keys(obj.tasks[0])[0];
+      Object.assign(obj.tasks[0][key], {_: opts});
+    }
+
+    this.logger.debug({obj}, 'Task:_doRefer - final object to store for receiving session on othe server');
+
+    const success = await addKey(uuid, JSON.stringify(obj), 30);
+    if (!success) {
+      this.logger.info(`Task:_doRefer failed storing task data before REFER for ${this.queueName}`);
+      return;
+    }
+    try {
+      this.logger.info(`Task:_doRefer: referring call to ${sipAddress} for ${this.queueName}`);
+      this.callMoved = true;
+      const success = await cs.referCall(`sip:context-${uuid}@${sipAddress}`);
+      if (!success) {
+        this.callMoved = false;
+        this.logger.info('Task:_doRefer REFER failed');
+        return success;
+      }
+      this.logger.info('Task:_doRefer REFER succeeded');
+      return success;
+    } catch (err) {
+      this.logger.error(err, 'Task:_doRefer error');
+    }
+  }
+
   /**
    * validate that the JSON task description is valid
    * @param {string} name - verb name
@@ -117,21 +227,21 @@ class Task extends Emitter {
         const dSpec = specData.properties[dKey];
         debug(`Task:validate validating property ${dKey} with value ${JSON.stringify(dVal)}`);
 
-        if (typeof dSpec === 'string' && ['number', 'string', 'object', 'boolean'].includes(dSpec)) {
-          // simple types
-          if (typeof dVal !== specData.properties[dKey]) {
-            throw new Error(`${name}: property ${dKey} has invalid data type`);
-          }
-        }
-        else if (typeof dSpec === 'string' && dSpec === 'array') {
+        if (typeof dSpec === 'string' && dSpec === 'array') {
           if (!Array.isArray(dVal)) throw new Error(`${name}: property ${dKey} is not an array`);
         }
         else if (typeof dSpec === 'string' && dSpec.includes('|')) {
           const types = dSpec.split('|').map((t) => t.trim());
-          if (!types.includes(typeof dVal)) {
+          if (!types.includes(typeof dVal) && !(types.includes('array') && Array.isArray(dVal))) {
             throw new Error(`${name}: property ${dKey} has invalid data type, must be one of ${types}`);
           }
         }
+        else if (typeof dSpec === 'string' && ['number', 'string', 'object', 'boolean'].includes(dSpec)) {
+          // simple types
+          if (typeof dVal !== specData.properties[dKey]) {
+            throw new Error(`${name}: property ${dKey} has invalid data type`);
+          }
+        }
         else if (Array.isArray(dSpec) && dSpec[0].startsWith('#')) {
           const name = dSpec[0].slice(1);
           for (const item of dVal) {
@@ -164,6 +274,7 @@ class Task extends Emitter {
     }
     if (required.length > 0) throw new Error(`${name}: missing value for ${required}`);
   }
+
 }
 
 module.exports = Task;

lib/tasks/transcribe.js

@@ -1,41 +1,99 @@
 const Task = require('./task');
-const {TaskName, TaskPreconditions, TranscriptionEvents} = require('../utils/constants');
+const {
+  TaskName,
+  TaskPreconditions,
+  GoogleTranscriptionEvents,
+  AzureTranscriptionEvents,
+  AwsTranscriptionEvents
+} = require('../utils/constants');
 
 class TaskTranscribe extends Task {
   constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
+    this.parentTask = parentTask;
 
     this.transcriptionHook = this.data.transcriptionHook;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
-    if (this.data.recognizer) {
-      this.language = this.data.recognizer.language || 'en-US';
-      this.vendor = this.data.recognizer.vendor;
-      this.interim = this.data.recognizer.interim === true;
-      this.dualChannel = this.data.recognizer.dualChannel === true;
-    }
+
+    const recognizer = this.data.recognizer;
+    this.vendor = recognizer.vendor;
+    this.language = recognizer.language;
+    this.interim = !!recognizer.interim;
+    this.separateRecognitionPerChannel = recognizer.separateRecognitionPerChannel;
+
+    /* google-specific options */
+    this.hints = recognizer.hints || [];
+    this.profanityFilter = recognizer.profanityFilter;
+    this.punctuation = !!recognizer.punctuation;
+    this.enhancedModel = !!recognizer.enhancedModel;
+    this.words = !!recognizer.words;
+    this.diarization = !!recognizer.diarization;
+    this.diarizationMinSpeakers = recognizer.diarizationMinSpeakers || 0;
+    this.diarizationMaxSpeakers = recognizer.diarizationMaxSpeakers || 0;
+    this.interactionType = recognizer.interactionType || 'unspecified';
+    this.naicsCode = recognizer.naicsCode || 0;
+    this.altLanguages = recognizer.altLanguages || [];
+
+    /* aws-specific options */
+    this.identifyChannels = !!recognizer.identifyChannels;
+    this.vocabularyName = recognizer.vocabularyName;
+    this.vocabularyFilterName = recognizer.vocabularyFilterName;
+    this.filterMethod = recognizer.filterMethod;
+
+    /* microsoft options */
+    this.outputFormat = recognizer.outputFormat || 'simple';
+    this.profanityOption = recognizer.profanityOption || 'raw';
+    this.requestSnr = recognizer.requestSnr || false;
+    this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
   }
 
   get name() { return TaskName.Transcribe; }
 
   async exec(cs, ep, parentTask) {
     super.exec(cs);
+    const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
+
     this.ep = ep;
+    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');
+
     try {
-      await this._startTranscribing(ep);
+      if (!this.sttCredentials) {
+        const {writeAlerts, AlertType} = cs.srf.locals;
+        this.logger.info(`TaskTranscribe:exec - ERROR stt using ${this.vendor} requested but creds not supplied`);
+        writeAlerts({
+          account_sid: cs.accountSid,
+          alert_type: AlertType.STT_NOT_PROVISIONED,
+          vendor: this.vendor
+        }).catch((err) => this.logger.info({err}, 'Error generating alert for no stt'));
+        throw new Error('no provisioned speech credentials for TTS');
+      }
+      await this._startTranscribing(cs, ep);
+      updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid)
+        .catch(() => {/*already logged error */});
+
       await this.awaitTaskDone();
     } catch (err) {
       this.logger.info(err, 'TaskTranscribe:exec - error');
+      this.parentTask && this.parentTask.emit('error', err);
     }
-    ep.removeCustomEventListener(TranscriptionEvents.Transcription);
-    ep.removeCustomEventListener(TranscriptionEvents.NoAudioDetected);
-    ep.removeCustomEventListener(TranscriptionEvents.MaxDurationExceeded);
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.NoAudioDetected);
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.MaxDurationExceeded);
+    ep.removeCustomEventListener(AwsTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(AwsTranscriptionEvents.NoAudioDetected);
+    ep.removeCustomEventListener(AwsTranscriptionEvents.MaxDurationExceeded);
+    ep.removeCustomEventListener(AzureTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected);
   }
 
-  async kill() {
-    super.kill();
+  async kill(cs) {
+    super.kill(cs);
     if (this.ep.connected) {
-      this.ep.stopTranscription().catch((err) => this.logger.info(err, 'Error TaskTranscribe:kill'));
+      this.ep.stopTranscription({vendor: this.vendor})
+        .catch((err) => this.logger.info(err, 'Error TaskTranscribe:kill'));
 
       // hangup after 1 sec if we don't get a final transcription
       this._timer = setTimeout(() => this.notifyTaskDone(), 1000);
@@ -44,42 +102,146 @@ class TaskTranscribe extends Task {
     await this.awaitTaskDone();
   }
 
-  async _startTranscribing(ep) {
-    const opts = {
-      GOOGLE_SPEECH_USE_ENHANCED: true,
-      GOOGLE_SPEECH_MODEL: 'phone_call'
-    };
-    if (this.hints) {
-      Object.assign(opts, {'GOOGLE_SPEECH_HINTS': this.hints.join(',')});
-    }
-    if (this.profanityFilter) {
-      Object.assign(opts, {'GOOGLE_SPEECH_PROFANITY_FILTER': true});
-    }
-    if (this.dualChannel) {
-      Object.assign(opts, {'GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL': true});
-    }
-    await ep.set(opts)
-      .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing'));
+  async _startTranscribing(cs, ep) {
+    const opts = {};
 
-    ep.addCustomEventListener(TranscriptionEvents.Transcription, this._onTranscription.bind(this, ep));
-    ep.addCustomEventListener(TranscriptionEvents.NoAudioDetected, this._onNoAudio.bind(this, ep));
-    ep.addCustomEventListener(TranscriptionEvents.MaxDurationExceeded, this._onMaxDurationExceeded.bind(this, ep));
+    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, 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,
+      this._onMaxDurationExceeded.bind(this, cs, ep));
+    ep.addCustomEventListener(AzureTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+    ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected, this._onNoAudio.bind(this, cs, ep));
 
+    if (this.vendor === 'google') {
+      if (this.sttCredentials) opts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(this.sttCredentials.credentials);
+      [
+        ['enhancedModel', 'GOOGLE_SPEECH_USE_ENHANCED'],
+        ['separateRecognitionPerChannel', 'GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL'],
+        ['profanityFilter', 'GOOGLE_SPEECH_PROFANITY_FILTER'],
+        ['punctuation', 'GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION'],
+        ['words', 'GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS'],
+        ['diarization', 'GOOGLE_SPEECH_PROFANITY_FILTER']
+      ].forEach((arr) => {
+        if (this[arr[0]]) opts[arr[1]] = true;
+      });
+      if (this.hints.length > 1) opts.GOOGLE_SPEECH_HINTS = this.hints.join(',');
+      if (this.altLanguages.length > 1) opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
+      if ('unspecified' !== this.interactionType) {
+        opts.GOOGLE_SPEECH_METADATA_INTERACTION_TYPE = this.interactionType;
+
+        // additionally set model if appropriate
+        if ('phone_call' === this.interactionType) opts.GOOGLE_SPEECH_MODEL = 'phone_call';
+        else if (['voice_search', 'voice_command'].includes(this.interactionType)) {
+          opts.GOOGLE_SPEECH_MODEL = 'command_and_search';
+        }
+        else opts.GOOGLE_SPEECH_MODEL = 'phone_call';
+      }
+      else opts.GOOGLE_SPEECH_MODEL = 'phone_call';
+      if (this.diarization && this.diarizationMinSpeakers > 0) {
+        opts.GOOGLE_SPEECH_SPEAKER_DIARIZATION_MIN_SPEAKER_COUNT = this.diarizationMinSpeakers;
+      }
+      if (this.diarization && this.diarizationMaxSpeakers > 0) {
+        opts.GOOGLE_SPEECH_SPEAKER_DIARIZATION_MAX_SPEAKER_COUNT = this.diarizationMaxSpeakers;
+      }
+      if (this.naicsCode > 0) opts.GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE = this.naicsCode;
+
+      await ep.set(opts)
+        .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with google'));
+    }
+    else if (this.vendor === 'aws') {
+      [
+        ['diarization', 'AWS_SHOW_SPEAKER_LABEL'],
+        ['identifyChannels', 'AWS_ENABLE_CHANNEL_IDENTIFICATION']
+      ].forEach((arr) => {
+        if (this[arr[0]]) opts[arr[1]] = true;
+      });
+      if (this.vocabularyName) opts.AWS_VOCABULARY_NAME = this.vocabularyName;
+      if (this.vocabularyFilterName) {
+        opts.AWS_VOCABULARY_NAME = this.vocabularyFilterName;
+        opts.AWS_VOCABULARY_FILTER_METHOD = this.filterMethod || 'mask';
+      }
+
+      if (this.sttCredentials) {
+        Object.assign(opts, {
+          AWS_ACCESS_KEY_ID: this.sttCredentials.accessKeyId,
+          AWS_SECRET_ACCESS_KEY: this.sttCredentials.secretAccessKey,
+          AWS_REGION: this.sttCredentials.region
+        });
+      }
+      else {
+        Object.assign(opts, {
+          AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID,
+          AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY,
+          AWS_REGION: process.env.AWS_REGION
+        });
+      }
+
+      await ep.set(opts)
+        .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with aws'));
+    }
+    else if (this.vendor === 'microsoft') {
+      Object.assign(opts, {
+        'AZURE_SUBSCRIPTION_KEY': this.sttCredentials.api_key,
+        'AZURE_REGION': this.sttCredentials.region
+      });
+      if (this.hints && this.hints.length > 1) {
+        opts.AZURE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
+      }
+      if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
+      if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
+      if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;
+      if (this.outputFormat !== 'simple') opts.AZURE_USE_OUTPUT_FORMAT_DETAILED = 1;
+
+      await ep.set(opts)
+        .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with azure'));
+    }
     await this._transcribe(ep);
   }
 
   async _transcribe(ep) {
-    await this.ep.startTranscription({
+    await ep.startTranscription({
+      vendor: this.vendor,
       interim: this.interim ? true : false,
-      language: this.language || this.callSession.speechRecognizerLanguage,
-      channels: this.dualChannel ? 2 : 1
+      locale: this.language,
+      channels: this.separateRecognitionPerChannel ? 2 : 1
     });
   }
 
-  _onTranscription(ep, evt) {
+  _onTranscription(cs, ep, evt) {
     this.logger.debug(evt, 'TaskTranscribe:_onTranscription');
-    this.cs.requestor.request(this.transcriptionHook, Object.assign({speech: evt}, this.cs.callInfo))
-      .catch((err) => this.logger.info(err, 'TranscribeTask:_onTranscription error'));
+    if ('aws' === this.vendor && Array.isArray(evt) && evt.length > 0) evt = evt[0];
+    if ('microsoft' === this.vendor) {
+      const nbest = evt.NBest;
+      const alternatives = nbest ? nbest.map((n) => {
+        return {
+          confidence: n.Confidence,
+          transcript: n.Display
+        };
+      }) :
+        [
+          {
+            transcript: evt.DisplayText
+          }
+        ];
+
+      const newEvent = {
+        is_final: evt.RecognitionStatus === 'Success',
+        alternatives
+      };
+      evt = newEvent;
+    }
+
+    if (this.transcriptionHook) {
+      this.cs.requestor.request(this.transcriptionHook, Object.assign({speech: evt}, this.cs.callInfo))
+        .catch((err) => this.logger.info(err, 'TranscribeTask:_onTranscription error'));
+    }
+    if (this.parentTask) {
+      this.parentTask.emit('transcription', evt);
+    }
     if (this.killed) {
       this.logger.debug('TaskTranscribe:_onTranscription exiting after receiving final transcription');
       this._clearTimer();
@@ -87,12 +249,12 @@ class TaskTranscribe extends Task {
     }
   }
 
-  _onNoAudio(ep) {
+  _onNoAudio(cs, ep) {
     this.logger.debug('TaskTranscribe:_onNoAudio restarting transcription');
     this._transcribe(ep);
   }
 
-  _onMaxDurationExceeded(ep) {
+  _onMaxDurationExceeded(cs, ep) {
     this.logger.debug('TaskTranscribe:_onMaxDurationExceeded restarting transcription');
     this._transcribe(ep);
   }

lib/utils/aws-sns-lifecycle.js

@@ -0,0 +1,186 @@
+const Emitter = require('events');
+const bent = require('bent');
+const assert = require('assert');
+const PORT = process.env.AWS_SNS_PORT || 3001;
+const {LifeCycleEvents} = require('./constants');
+const express = require('express');
+const app = express();
+const getString = bent('string');
+const AWS = require('aws-sdk');
+const sns = new AWS.SNS({apiVersion: '2010-03-31'});
+const autoscaling = new AWS.AutoScaling({apiVersion: '2011-01-01'});
+const {Parser} = require('xml2js');
+const parser = new Parser();
+const {validatePayload} = require('verify-aws-sns-signature');
+
+AWS.config.update({region: process.env.AWS_REGION});
+
+class SnsNotifier extends Emitter {
+  constructor(logger) {
+    super();
+
+    this.logger = logger;
+  }
+
+  async _handlePost(req, res) {
+    try {
+      const parsedBody = JSON.parse(req.body);
+      this.logger.debug({headers: req.headers, body: parsedBody}, 'Received HTTP POST from AWS');
+      if (!validatePayload(parsedBody)) {
+        this.logger.info('incoming AWS SNS HTTP POST failed signature validation');
+        return res.sendStatus(403);
+      }
+      this.logger.debug('incoming HTTP POST passed validation');
+      res.sendStatus(200);
+
+      switch (parsedBody.Type) {
+        case 'SubscriptionConfirmation':
+          const response = await getString(parsedBody.SubscribeURL);
+          const result = await parser.parseStringPromise(response);
+          this.subscriptionArn = result.ConfirmSubscriptionResponse.ConfirmSubscriptionResult[0].SubscriptionArn[0];
+          this.subscriptionRequestId = result.ConfirmSubscriptionResponse.ResponseMetadata[0].RequestId[0];
+          this.logger.info({
+            subscriptionArn: this.subscriptionArn,
+            subscriptionRequestId: this.subscriptionRequestId
+          }, 'response from SNS SubscribeURL');
+          const data = await this.describeInstance();
+          this.lifecycleState = data.AutoScalingInstances[0].LifecycleState;
+          break;
+
+        case 'Notification':
+          if (parsedBody.Subject.startsWith('Auto Scaling:  Lifecycle action \'TERMINATING\'')) {
+            const msg = JSON.parse(parsedBody.Message);
+            if (msg.EC2InstanceId === this.instanceId) {
+              this.logger.info('SnsNotifier - begin scale-in operation');
+              this.scaleInParams = {
+                AutoScalingGroupName: msg.AutoScalingGroupName,
+                LifecycleActionResult: 'CONTINUE',
+                LifecycleActionToken: msg.LifecycleActionToken,
+                LifecycleHookName: msg.LifecycleHookName
+              };
+              this.operationalState = LifeCycleEvents.ScaleIn;
+              this.emit(LifeCycleEvents.ScaleIn);
+              this.unsubscribe();
+            }
+            else {
+              this.logger.debug(`SnsNotifier - instance ${msg.EC2InstanceId} is scaling in (not us)`);
+            }
+          }
+          break;
+
+        default:
+          this.logger.info(`unhandled SNS Post Type: ${parsedBody.Type}`);
+      }
+
+    } catch (err) {
+      this.logger.error({err}, 'Error processing SNS POST request');
+      if (!res.headersSent) res.sendStatus(500);
+    }
+  }
+
+  async init() {
+    try {
+      this.logger.debug('SnsNotifier: retrieving instance data');
+      this.instanceId = await getString('http://169.254.169.254/latest/meta-data/instance-id');
+      this.publicIp = await getString('http://169.254.169.254/latest/meta-data/public-ipv4');
+      this.snsEndpoint = `http://${this.publicIp}:${PORT}`;
+      this.logger.info({
+        instanceId: this.instanceId,
+        publicIp: this.publicIp,
+        snsEndpoint: this.snsEndpoint
+      }, 'retrieved AWS instance data');
+
+      // start listening
+      app.use(express.urlencoded({ extended: true }));
+      app.use(express.json());
+      app.use(express.text());
+      app.post('/', this._handlePost.bind(this));
+      app.use((err, req, res, next) => {
+        this.logger.error(err, 'burped error');
+        res.status(err.status || 500).json({msg: err.message});
+      });
+      app.listen(PORT);
+
+    } catch (err) {
+      this.logger.error({err}, 'Error retrieving AWS instance metadata');
+    }
+  }
+
+  async subscribe() {
+    try {
+      const response = await sns.subscribe({
+        Protocol: 'http',
+        TopicArn: process.env.AWS_SNS_TOPIC_ARM,
+        Endpoint: this.snsEndpoint
+      }).promise();
+      this.logger.info({response}, `response to SNS subscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+    } catch (err) {
+      this.logger.error({err}, `Error subscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+    }
+  }
+
+  async unsubscribe() {
+    if (!this.subscriptionArn) throw new Error('SnsNotifier#unsubscribe called without an active subscription');
+    try {
+      const response = await sns.unsubscribe({
+        SubscriptionArn: this.subscriptionArn
+      }).promise();
+      this.logger.info({response}, `response to SNS unsubscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+    } catch (err) {
+      this.logger.error({err}, `Error unsubscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+    }
+  }
+
+  completeScaleIn() {
+    assert(this.scaleInParams);
+    autoscaling.completeLifecycleAction(this.scaleInParams, (err, response) => {
+      if (err) return this.logger.error({err}, 'Error completing scale-in');
+      this.logger.info({response}, 'Successfully completed scale-in action');
+    });
+  }
+
+  describeInstance() {
+    return new Promise((resolve, reject) => {
+      if (!this.instanceId) return reject('instance-id unknown');
+      autoscaling.describeAutoScalingInstances({
+        InstanceIds: [this.instanceId]
+      }, (err, data) => {
+        if (err) {
+          this.logger.error({err}, 'Error describing instances');
+          reject(err);
+        } else {
+          this.logger.info({data}, 'SnsNotifier: describeInstance');
+          resolve(data);
+        }
+      });
+    });
+  }
+
+}
+
+module.exports = async function(logger) {
+  const notifier = new SnsNotifier(logger);
+  await notifier.init();
+  await notifier.subscribe();
+
+  process.on('SIGHUP', async() => {
+    try {
+      const data = await notifier.describeInstance();
+      const state = data.AutoScalingInstances[0].LifecycleState;
+      if (state !== notifier.lifecycleState) {
+        notifier.lifecycleState = state;
+        switch (state) {
+          case 'Standby':
+            notifier.emit(LifeCycleEvents.StandbyEnter);
+            break;
+          case 'InService':
+            notifier.emit(LifeCycleEvents.StandbyExit);
+            break;
+        }
+      }
+    } catch (err) {
+      console.error(err);
+    }
+  });
+  return notifier;
+};

lib/utils/constants.json

@@ -1,17 +1,29 @@
 {
   "TaskName": {
+    "Cognigy": "cognigy",
+    "Conference": "conference",
+    "Dequeue": "dequeue",
     "Dial": "dial",
+    "Dialogflow": "dialogflow",
+    "Dtmf": "dtmf",
+    "Enqueue": "enqueue",
     "Gather": "gather",
     "Hangup": "hangup",
+    "Leave": "leave",
+    "Lex": "lex",
     "Listen": "listen",
+    "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",
+    "SayLegacy": "say:legacy",
     "Tag": "tag",
     "Transcribe": "transcribe"
   },
@@ -28,7 +40,8 @@
   },
   "CallDirection": {
     "Inbound": "inbound",
-    "Outbound": "outbound"
+    "Outbound": "outbound",
+    "None": "none"
   },
   "ListenStatus": {
     "Pause": "pause",
@@ -41,12 +54,24 @@
     "StableCall": "stable-call",
     "UnansweredCall": "unanswered-call"
   },
-  "TranscriptionEvents": {
+  "GoogleTranscriptionEvents": {
     "Transcription": "google_transcribe::transcription",
     "EndOfUtterance": "google_transcribe::end_of_utterance",
     "NoAudioDetected": "google_transcribe::no_audio_detected",
     "MaxDurationExceeded": "google_transcribe::max_duration_exceeded"
   },
+  "AwsTranscriptionEvents": {
+    "Transcription": "aws_transcribe::transcription",
+    "EndOfTranscript": "aws_transcribe::end_of_transcript",
+    "NoAudioDetected": "aws_transcribe::no_audio_detected",
+    "MaxDurationExceeded": "aws_transcribe::max_duration_exceeded"
+  },
+  "AzureTranscriptionEvents": {
+    "Transcription": "azure_transcribe::transcription",
+    "StartOfUtterance": "azure_transcribe::start_of_utterance",
+    "EndOfUtterance": "azure_transcribe::end_of_utterance",
+    "NoSpeechDetected": "azure_transcribe::no_speech_detected"
+  },
   "ListenEvents": {
     "Connect": "mod_audio_fork::connect",
     "ConnectFailure": "mod_audio_fork::connect_failed",
@@ -59,5 +84,28 @@
     "BufferOverrun": "mod_audio_fork::buffer_overrun",
     "JsonMessage": "mod_audio_fork::json"
   },
-  "MAX_SIMRINGS": 10
+  "LifeCycleEvents" : {
+    "ScaleIn": "scale-in",
+    "StandbyEnter": "standby-enter",
+    "StandbyExit": "standby-exit"
+  },
+  "QueueResults": {
+    "Bridged": "bridged",
+    "Error": "error",
+    "Wait": "hangup",
+    "Leave": "leave"
+  },
+  "DequeueResults": {
+    "Bridged": "bridged",
+    "Error": "error",
+    "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)",
+  "FS_UUID_SET_NAME": "fsUUIDs"
 }

lib/utils/db-utils.js

@@ -0,0 +1,116 @@
+const {decrypt} = require('./encrypt-decrypt');
+
+const sqlAccountDetails = `SELECT * 
+FROM accounts account 
+WHERE account.account_sid = ?`;
+const sqlSpeechCredentials = `SELECT * 
+FROM speech_credentials 
+WHERE account_sid = ? `;
+const sqlSpeechCredentialsForSP = `SELECT * 
+FROM speech_credentials 
+WHERE service_provider_sid =  
+(SELECT service_provider_sid from accounts where account_sid = ?)`;
+const sqlQueryAccountCarrierByName = `SELECT voip_carrier_sid  
+FROM voip_carriers vc 
+WHERE vc.account_sid = ? 
+AND vc.name = ?`;
+const sqlQuerySPCarrierByName = `SELECT voip_carrier_sid  
+FROM voip_carriers vc 
+WHERE vc.account_sid IS NULL 
+AND vc.service_provider_sid = 
+(SELECT service_provider_sid from accounts where account_sid = ?) 
+AND vc.name = ?`;
+
+const speechMapper = (cred) => {
+  const {credential, ...obj} = cred;
+  if ('google' === obj.vendor) {
+    obj.service_key = decrypt(credential);
+  }
+  else if ('aws' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    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;
+  }
+  else if ('wellsaid' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    obj.api_key = o.api_key;
+  }
+  return obj;
+};
+
+module.exports = (logger, srf) => {
+  const {pool}  = srf.locals.dbHelpers;
+  const pp = pool.promise();
+
+  const lookupAccountDetails = async(account_sid) => {
+    const [r] = await pp.query({sql: sqlAccountDetails, nestTables: true}, account_sid);
+    if (0 === r.length) throw new Error(`invalid accountSid: ${account_sid}`);
+    const [r2] = await pp.query(sqlSpeechCredentials, account_sid);
+    const speech = r2.map(speechMapper);
+
+    /* 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');
+    const haveMicrosoft = speech.find((s) => s.vendor === 'microsoft');
+    const haveWellsaid = speech.find((s) => s.vendor === 'wellsaid');
+    if (!haveGoogle || !haveAws || !haveMicrosoft) {
+      const [r3] = await pp.query(sqlSpeechCredentialsForSP, account_sid);
+      if (r3.length) {
+        if (!haveGoogle) {
+          const google = r3.find((s) => s.vendor === 'google');
+          if (google) speech.push(speechMapper(google));
+        }
+        if (!haveAws) {
+          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));
+        }
+        if (!haveWellsaid) {
+          const wellsaid = r3.find((s) => s.vendor === 'wellsaid');
+          if (wellsaid) speech.push(speechMapper(wellsaid));
+        }
+      }
+    }
+
+    return {
+      ...r[0],
+      speech
+    };
+  };
+
+  const updateSpeechCredentialLastUsed = async(speech_credential_sid) => {
+    const pp = pool.promise();
+    const sql = 'UPDATE speech_credentials SET last_used = NOW() WHERE speech_credential_sid = ?';
+    try {
+      await pp.execute(sql, [speech_credential_sid]);
+    } catch (err) {
+      logger.error({err}, `Error updating last_used for speech_credential_sid ${speech_credential_sid}`);
+    }
+  };
+
+  const lookupCarrier = async(account_sid, carrierName) => {
+    const pp = pool.promise();
+    try {
+      const [r] = await pp.query(sqlQueryAccountCarrierByName, [account_sid, carrierName]);
+      if (r.length) return r[0].voip_carrier_sid;
+      const [r2] = await pp.query(sqlQuerySPCarrierByName, [account_sid, carrierName]);
+      if (r2.length) return r2[0].voip_carrier_sid;
+    } catch (err) {
+      logger.error({err}, `lookupCarrier: Error ${account_sid}:${carrierName}`);
+    }
+  };
+
+  return {
+    lookupAccountDetails,
+    updateSpeechCredentialLastUsed,
+    lookupCarrier
+  };
+};

lib/utils/encrypt-decrypt.js

@@ -0,0 +1,35 @@
+const crypto = require('crypto');
+const algorithm = process.env.LEGACY_CRYPTO ? 'aes-256-ctr' : 'aes-256-cbc';
+const iv = crypto.randomBytes(16);
+const secretKey = crypto.createHash('sha256')
+  .update(String(process.env.JWT_SECRET))
+  .digest('base64')
+  .substr(0, 32);
+
+const encrypt = (text) => {
+  const cipher = crypto.createCipheriv(algorithm, secretKey, iv);
+  const encrypted = Buffer.concat([cipher.update(text), cipher.final()]);
+  const data = {
+    iv: iv.toString('hex'),
+    content: encrypted.toString('hex')
+  };
+  return JSON.stringify(data);
+};
+
+const decrypt = (data) => {
+  let hash;
+  try {
+    hash = JSON.parse(data);
+  } catch (err) {
+    console.log(`failed to parse json string ${data}`);
+    throw err;
+  }
+  const decipher = crypto.createDecipheriv(algorithm, secretKey, Buffer.from(hash.iv, 'hex'));
+  const decrpyted = Buffer.concat([decipher.update(Buffer.from(hash.content, 'hex')), decipher.final()]);
+  return decrpyted.toString();
+};
+
+module.exports = {
+  encrypt,
+  decrypt
+};

lib/utils/install-srf-locals.js

@@ -4,10 +4,36 @@ const localIp = ip.address();
 const PORT = process.env.HTTP_PORT || 3000;
 const assert = require('assert');
 
+function initMS(logger, wrapper, ms) {
+  Object.assign(wrapper, {ms, active: true, connects: 1});
+  logger.info(`connected to freeswitch at ${ms.address}`);
+
+  ms.conn
+    .on('esl::end', () => {
+      wrapper.active = false;
+      logger.info(`lost connection to freeswitch at ${ms.address}`);
+    })
+    .on('esl::ready', () => {
+      if (wrapper.connects > 0) {
+        logger.info(`connected to freeswitch at ${ms.address}`);
+      }
+      wrapper.connects = 1;
+      wrapper.active = true;
+    });
+
+  ms.on('channel::open', (evt) => {
+    logger.debug({evt}, `mediaserver ${ms.address} added endpoint`);
+  });
+  ms.on('channel::close', (evt) => {
+    logger.debug({evt}, `mediaserver ${ms.address} removed endpoint`);
+  });
+}
+
 function installSrfLocals(srf, logger) {
+  logger.debug('installing srf locals');
   assert(!srf.locals.dbHelpers);
-  const {getSBC, getSrf} = require('./sbc-pinger')(logger);
-  const StatsCollector = require('jambonz-stats-collector');
+  const {getSBC, lifecycleEmitter} = require('./sbc-pinger')(logger);
+  const StatsCollector = require('@jambonz/stats-collector');
   const stats = srf.locals.stats = new StatsCollector(logger);
 
   // freeswitch connections (typically we connect to only one)
@@ -19,9 +45,12 @@ function installSrfLocals(srf, logger) {
     const fsInventory = process.env.JAMBONES_FREESWITCH
       .split(',')
       .map((fs) => {
-        const arr = /^(.*):(.*):(.*)/.exec(fs);
+        const arr = /^([^:]*):([^:]*):([^:]*)(?::([^:]*))?/.exec(fs);
         assert.ok(arr, `Invalid syntax JAMBONES_FREESWITCH: ${process.env.JAMBONES_FREESWITCH}`);
-        return {address: arr[1], port: arr[2], secret: arr[3]};
+        const opts = {address: arr[1], port: arr[2], secret: arr[3]};
+        if (arr.length > 4) opts.advertisedAddress = arr[4];
+        if (process.env.NODE_ENV === 'test') opts.listenAddress = '0.0.0.0';
+        return opts;
       });
     logger.info({fsInventory}, 'freeswitch inventory');
 
@@ -30,21 +59,7 @@ function installSrfLocals(srf, logger) {
       mediaservers.push(val);
       try {
         const ms = await mrf.connect(fs);
-        Object.assign(val, {ms, active: true, connects: 1});
-        logger.info(`connected to freeswitch at ${fs.address}`);
-
-        ms.conn
-          .on('esl::end', () => {
-            val.active = false;
-            logger.info(`lost connection to freeswitch at ${fs.address}`);
-          })
-          .on('esl::ready', () => {
-            if (val.connects > 0) {
-              logger.info(`connected to freeswitch at ${fs.address}`);
-            }
-            val.connects = 1;
-            val.active = true;
-          });
+        initMS(logger, val, ms);
       }
       catch (err) {
         logger.info(`failed connecting to freeswitch at ${fs.address}, will retry shortly`);
@@ -53,10 +68,11 @@ function installSrfLocals(srf, logger) {
     // retry to connect to any that were initially offline
     setInterval(async() => {
       for (const val of mediaservers) {
-        if (val.connect === 0) {
+        if (val.connects === 0) {
           try {
+            logger.info({mediaserver: val.opts}, 'Retrying initial connection to media server');
             const ms = await mrf.connect(val.opts);
-            val.ms = ms;
+            initMS(logger, val, ms);
           } catch (err) {
             logger.info(`failed connecting to freeswitch at ${val.opts.address}, will retry shortly`);
           }
@@ -66,13 +82,16 @@ function installSrfLocals(srf, logger) {
 
     // if we have a single freeswitch (as is typical) report stats periodically
     if (mediaservers.length === 1) {
-      const ms = mediaservers[0].ms;
+      srf.locals.mediaservers = [mediaservers[0].ms];
       setInterval(() => {
         try {
-          stats.gauge('fs.media.channels.in_use', ms.currentSessions);
-          stats.gauge('fs.media.channels.free', ms.maxSessions - ms.currentSessions);
-          stats.gauge('fs.media.calls_per_second', ms.cps);
-          stats.gauge('fs.media.cpu_idle', ms.cpuIdle);
+          if (mediaservers[0].ms && mediaservers[0].active) {
+            const ms = mediaservers[0].ms;
+            stats.gauge('fs.media.channels.in_use', ms.currentSessions);
+            stats.gauge('fs.media.channels.free', ms.maxSessions - ms.currentSessions);
+            stats.gauge('fs.media.calls_per_second', ms.cps);
+            stats.gauge('fs.media.cpu_idle', ms.cpuIdle);
+          }
         }
         catch (err) {
           logger.info(err, 'Error sending media server metrics');
@@ -91,44 +110,104 @@ function installSrfLocals(srf, logger) {
   }
 
   const {
+    pool,
     lookupAppByPhoneNumber,
+    lookupAppByRegex,
     lookupAppBySid,
-    lookupAppByRealm
-  } = require('jambonz-db-helpers')({
+    lookupAppByRealm,
+    lookupAppByTeamsTenant,
+    lookupTeamsByAccount,
+    lookupAccountBySid,
+    lookupAccountCapacitiesBySid,
+    lookupSmppGateways
+  } = require('@jambonz/db-helpers')({
     host: process.env.JAMBONES_MYSQL_HOST,
     user: process.env.JAMBONES_MYSQL_USER,
+    port: process.env.JAMBONES_MYSQL_PORT || 3306,
     password: process.env.JAMBONES_MYSQL_PASSWORD,
     database: process.env.JAMBONES_MYSQL_DATABASE,
     connectionLimit: process.env.JAMBONES_MYSQL_CONNECTION_LIMIT || 10
   }, logger);
   const {
+    client,
     updateCallStatus,
     retrieveCall,
     listCalls,
-    deleteCall
-  } = require('jambonz-realtimedb-helpers')({
+    deleteCall,
+    synthAudio,
+    createHash,
+    retrieveHash,
+    deleteKey,
+    addKey,
+    retrieveKey,
+    retrieveSet,
+    addToSet,
+    removeFromSet,
+    monitorSet,
+    pushBack,
+    popFront,
+    removeFromList,
+    lengthOfList,
+    getListPosition
+  } = require('@jambonz/realtimedb-helpers')({
     host: process.env.JAMBONES_REDIS_HOST,
     port: process.env.JAMBONES_REDIS_PORT || 6379
   }, logger);
+  const {
+    writeAlerts,
+    AlertType
+  } = require('@jambonz/time-series')(logger, {
+    host: process.env.JAMBONES_TIME_SERIES_HOST,
+    commitSize: 50,
+    commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+  });
 
-  Object.assign(srf.locals, {
+  srf.locals = {...srf.locals,
     dbHelpers: {
+      client,
+      pool,
       lookupAppByPhoneNumber,
+      lookupAppByRegex,
       lookupAppBySid,
       lookupAppByRealm,
+      lookupAppByTeamsTenant,
+      lookupTeamsByAccount,
+      lookupAccountBySid,
+      lookupAccountCapacitiesBySid,
+      lookupSmppGateways,
       updateCallStatus,
       retrieveCall,
       listCalls,
-      deleteCall
+      deleteCall,
+      synthAudio,
+      createHash,
+      retrieveHash,
+      deleteKey,
+      addKey,
+      retrieveKey,
+      retrieveSet,
+      addToSet,
+      removeFromSet,
+      monitorSet,
+      pushBack,
+      popFront,
+      removeFromList,
+      lengthOfList,
+      getListPosition
     },
     parentLogger: logger,
     ipv4: localIp,
     serviceUrl: `http://${localIp}:${PORT}`,
     getSBC,
-    getSrf,
+    getSmpp: () => {
+      return process.env.SMPP_URL;
+    },
+    lifecycleEmitter,
     getFreeswitch,
-    stats: stats
-  });
+    stats: stats,
+    writeAlerts,
+    AlertType
+  };
 }
 
 module.exports = installSrfLocals;

lib/utils/place-outdial.js

@@ -5,18 +5,14 @@ const {TaskPreconditions, CallDirection} = require('../utils/constants');
 const CallInfo = require('../session/call-info');
 const assert = require('assert');
 const ConfirmCallSession = require('../session/confirm-call-session');
-const selectSbc = require('./select-sbc');
-const Registrar = require('jambonz-mw-registrar');
-const registrar = new Registrar({
-  host: process.env.JAMBONES_REDIS_HOST,
-  port: process.env.JAMBONES_REDIS_PORT || 6379
-});
-
+const AdultingCallSession = require('../session/adulting-call-session');
+const deepcopy = require('deepcopy');
 const moment = require('moment');
-const uuidv4 = require('uuid/v4');
+const stripCodecs = require('./strip-ancillary-codecs');
+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);
 
@@ -30,6 +26,8 @@ class SingleDialer extends Emitter {
     this.bindings = logger.bindings();
 
     this.parentCallInfo = callInfo;
+    this.accountInfo = accountInfo;
+
     this.callGone = false;
 
     this.callSid = uuidv4();
@@ -58,28 +56,41 @@ class SingleDialer extends Emitter {
   }
 
   async exec(srf, ms, opts) {
+    opts = opts || {};
+    opts.headers = opts.headers || {};
+    opts.headers = {
+      ...opts.headers,
+      'X-Jambonz-Routing': this.target.type,
+      'X-Jambonz-FS-UUID': srf.locals.fsUUID,
+      'X-Call-Sid': this.callSid
+    };
+    this.ms = ms;
     let uri, to;
     try {
       switch (this.target.type) {
         case 'phone':
+        case 'teams':
           assert(this.target.number);
           uri = `sip:${this.target.number}@${this.sbcAddress}`;
           to = this.target.number;
+          if ('teams' === this.target.type) {
+            assert(this.target.teamsInfo);
+            opts.headers = {...opts.headers,
+              'X-MS-Teams-FQDN': this.target.teamsInfo.ms_teams_fqdn,
+              'X-MS-Teams-Tenant-FQDN': this.target.teamsInfo.tenant_fqdn
+            };
+            if (this.target.vmail === true) uri = `${uri};opaque=app:voicemail`;
+          }
           break;
         case 'user':
           assert(this.target.name);
-          const aor = this.target.name;
           uri = `sip:${this.target.name}`;
           to = this.target.name;
 
-          // need to send to the SBC registered on
-          const reg = await registrar.query(aor);
-          if (reg) {
-            const sbc = selectSbc(reg.sbcAddress);
-            if (sbc) {
-              this.logger.debug(`SingleDialer:exec retrieved registration details for ${aor}, using sbc at ${sbc}`);
-              this.sbcAddress = sbc;
-            }
+          if (this.target.overrideTo) {
+            Object.assign(opts.headers, {
+              'X-Override-To': this.target.overrideTo
+            });
           }
           break;
         case 'sip':
@@ -97,13 +108,22 @@ class SingleDialer extends Emitter {
 
       this.ep = await ms.createEndpoint();
       this.logger.debug(`SingleDialer:exec - created endpoint ${this.ep.uuid}`);
-      let sdp;
+
+      /**
+       * were we killed whilst we were off getting an endpoint ?
+       * https://github.com/jambonz/jambonz-feature-server/issues/30
+       */
+      if (this.killed) {
+        this.logger.info('SingleDialer:exec got quick CANCEL from caller, abort outdial');
+        this.ep.destroy()
+          .catch((err) => this.logger.error({err}, 'Error destroying endpoint'));
+        return;
+      }
+      let lastSdp;
       const connectStream = async(remoteSdp) => {
-        if (remoteSdp !== sdp) {
-          this.ep.modify(sdp = remoteSdp);
-          return true;
-        }
-        return false;
+        if (remoteSdp === lastSdp) return;
+        lastSdp = remoteSdp;
+        return this.ep.modify(remoteSdp);
       };
 
       Object.assign(opts, {
@@ -111,7 +131,7 @@ class SingleDialer extends Emitter {
         localSdp: this.ep.local.sdp
       });
       if (this.target.auth) opts.auth = this.target.auth;
-      this.dlg = await srf.createUAC(uri, opts, {
+      this.dlg = await srf.createUAC(uri, {...opts,  followRedirects: true, keepUriOnRedirect: true}, {
         cbRequest: (err, req) => {
           if (err) {
             this.logger.error(err, 'SingleDialer:exec Error creating call');
@@ -142,26 +162,55 @@ class SingleDialer extends Emitter {
         cbProvisional: (prov) => {
           const status = {sipStatus: prov.status};
           if ([180, 183].includes(prov.status) && prov.body) {
-            status.callStatus = CallStatus.EarlyMedia;
-            if (connectStream(prov.body)) this.emit('earlyMedia');
+            if (status.callStatus !== CallStatus.EarlyMedia) {
+              status.callStatus = CallStatus.EarlyMedia;
+              this.emit('earlyMedia');
+            }
+            connectStream(prov.body);
           }
           else status.callStatus = CallStatus.Ringing;
           this.emit('callStatusChange', status);
         }
       });
-      connectStream(this.dlg.remote.sdp);
+      await connectStream(this.dlg.remote.sdp);
       this.dlg.callSid = this.callSid;
       this.inviteInProgress = null;
       this.emit('callStatusChange', {sipStatus: 200, callStatus: CallStatus.InProgress});
       this.logger.debug(`SingleDialer:exec call connected: ${this.callSid}`);
       const connectTime = this.dlg.connectTime = moment();
 
-      this.dlg.on('destroy', () => {
+      /* 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.logger.debug('SingleDialer:exec called party hung up');
         this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-        this.ep.destroy();
-      });
+        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 && this.ep.destroy();
+        })
+        .on('refresh', () => this.logger.info('SingleDialer:exec - dialog refreshed by uas'))
+        .on('modify', async(req, res) => {
+          try {
+            if (this.ep) {
+              const newSdp = await this.ep.modify(req.body);
+              res.send(200, {body: newSdp});
+              this.logger.info({offer: req.body, answer: newSdp}, 'SingleDialer:exec: handling reINVITE');
+            }
+            else {
+              this.logger.info('SingleDialer:exec: handling reINVITE with released media, emit event');
+              this.emit('reinvite', req, res);
+            }
+          } catch (err) {
+            this.logger.error(err, 'Error handling reinvite');
+          }
+        });
 
       if (this.confirmHook) this._executeApp(this.confirmHook);
       else this.emit('accept');
@@ -186,6 +235,7 @@ class SingleDialer extends Emitter {
    * kill the call in progress or the stable dialog, whichever we have
    */
   async kill() {
+    this.killed = true;
     if (this.inviteInProgress) await this.inviteInProgress.cancel();
     else if (this.dlg && this.dlg.connected) {
       const duration = moment().diff(this.dlg.connectTime, 'seconds');
@@ -209,7 +259,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) => {
@@ -243,6 +293,53 @@ class SingleDialer extends Emitter {
     }
   }
 
+  async doAdulting({logger, tasks, application}) {
+    this.logger = logger;
+    this.adulting = true;
+    this.emit('adulting');
+    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, localSdp) {
+    assert(this.dlg && this.dlg.connected && this.ep && typeof remoteSdp === 'string');
+    const sdp = stripCodecs(this.logger, remoteSdp, localSdp) || remoteSdp;
+    await this.dlg.modify(sdp, {
+      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),
@@ -265,9 +362,10 @@ class SingleDialer extends Emitter {
   }
 }
 
-function placeOutdial({logger, srf, ms, sbcAddress, target, opts, application, callInfo}) {
-  const sd = new SingleDialer({logger, sbcAddress, target, opts, application, callInfo});
-  sd.exec(srf, ms, opts);
+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, accountInfo});
+  sd.exec(srf, ms, myOpts);
   return sd;
 }
 

lib/utils/requestor.js

@@ -1,9 +1,31 @@
 const bent = require('bent');
 const parseUrl = require('parse-url');
 const assert = require('assert');
+const snakeCaseKeys = require('./snakecase-keys');
+const crypto = require('crypto');
+const timeSeries = require('@jambonz/time-series');
+let alerter ;
 
 const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
 
+function computeSignature(payload, timestamp, secret) {
+  assert(secret);
+  const data = `${timestamp}.${JSON.stringify(payload)}`;
+  return crypto
+    .createHmac('sha256', secret)
+    .update(data, 'utf8')
+    .digest('hex');
+}
+
+function generateSigHeader(payload, secret) {
+  const timestamp = Math.floor(Date.now() / 1000);
+  const signature = computeSignature(payload, timestamp, secret);
+  const scheme = 'v1';
+  return {
+    'Jambonz-Signature': `t=${timestamp},${scheme}=${signature}`
+  };
+}
+
 function basicAuth(username, password) {
   if (!username || !password) return {};
   const creds = `${username}:${password || ''}`;
@@ -21,7 +43,7 @@ function isAbsoluteUrl(u) {
 }
 
 class Requestor {
-  constructor(logger, hook) {
+  constructor(logger, account_sid, hook, secret) {
     assert(typeof hook === 'object');
 
     this.logger = logger;
@@ -38,12 +60,22 @@ class Requestor {
 
     this.username = hook.username;
     this.password = hook.password;
+    this.secret = secret;
+    this.account_sid = account_sid;
 
     assert(isAbsoluteUrl(this.url));
     assert(['GET', 'POST'].includes(this.method));
 
     const {stats} = require('../../').srf.locals;
     this.stats = stats;
+
+    if (!alerter) {
+      alerter = timeSeries(logger, {
+        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        commitSize: 50,
+        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+      });
+    }
   }
 
   get baseUrl() {
@@ -62,25 +94,39 @@ class Requestor {
    * @param {object} [params] - request parameters
    */
   async request(hook, params) {
-    params = params || null;
+    const payload = params ? snakeCaseKeys(params, ['customerData', 'sip']) : null;
     const url = hook.url || hook;
     const method = hook.method || 'POST';
-    const {username, password} = typeof hook === 'object' ? hook : {};
 
     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, params}, `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');
       buf = isRelativeUrl(url) ?
-        await this.post(url, params, this.authHeader) :
-        await bent(method, 'buffer', 200, 201)(url, params, basicAuth(username, password));
+        await this.post(url, payload, headers) :
+        await bent(method, 'buffer', 200, 201, 202)(url, payload, headers);
     } catch (err) {
-      this.logger.info({baseUrl: this.baseUrl, url: err.statusCode},
+      this.logger.error({err, secret: this.secret, baseUrl: this.baseUrl, url, statusCode: err.statusCode},
         `web callback returned unexpected error code ${err.statusCode}`);
+      let opts = {account_sid: this.account_sid};
+      if (err.code === 'ECONNREFUSED') {
+        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url};
+      }
+      else if (err.name === 'StatusError') {
+        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_STATUS_FAILURE, url, status: err.statusCode};
+      }
+      else {
+        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url, detail: err.message};
+      }
+      alerter.writeAlerts(opts).catch((err) => this.logger.info({err, opts}, 'Error writing alert'));
+
       throw err;
     }
     const diff = process.hrtime(startAt);
@@ -95,7 +141,7 @@ class Requestor {
         return json;
       }
       catch (err) {
-        this.logger.debug({err, url, method}, `Requestor:request returned non-JSON content: '${buf.toString()}'`);
+        //this.logger.debug({err, url, method}, `Requestor:request returned non-JSON content: '${buf.toString()}'`);
       }
     }
   }

lib/utils/sbc-pinger.js

@@ -1,52 +1,85 @@
 const assert = require('assert');
+const { v4: uuidv4 } = require('uuid');
+const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./constants');
+const Emitter = require('events');
+const debug = require('debug')('jambonz:feature-server');
 const noopLogger = {info: () => {}, error: () => {}};
-const Srf = require('drachtio-srf');
-const debug = require('debug')('jambonz:sbc-inbound');
-const srfs = [];
 
 module.exports = (logger) => {
   logger = logger || noopLogger;
-  let idxSbc = 0, idxSrfs = 0;
+  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');
+  }
 
-  assert.ok(process.env.JAMBONES_FEATURE_SERVERS, 'missing JAMBONES_FEATURE_SERVERS env var');
-  const drachtio = process.env.JAMBONES_FEATURE_SERVERS
-    .split(',')
-    .map((fs) => {
-      const arr = /^(.*):(.*):(.*)/.exec(fs);
-      if (!arr) throw new Error('JAMBONES_FEATURE_SERVERS env var is misconfigured');
-      const srf = new Srf();
-      srf.connect({host: arr[1], port: arr[2], secret: arr[3]})
-        .on('connect', (err, hp) => {
-          if (err) return logger.info(err, `Error connecting to drachtio server at ${arr[1]}:${arr[2]}`);
-          srfs.push(srf);
-          logger.info(err, `Success connecting to drachtio at ${arr[1]}:${arr[2]}, ${srfs.length} online`);
-          pingProxies(srf);
-        })
-        .on('error', (err) => {
-          const place = srfs.indexOf(srf);
-          if (-1 !== place) srfs.splice(place, 1);
-          logger.info(err, `Error connecting to FS at ${arr[1]}:${arr[2]}, ${srfs.length} remain online`);
-        });
-      return {host: arr[1], port: arr[2], secret: arr[3]};
-    });
-  assert.ok(drachtio.length, 'JAMBONES_FEATURE_SERVERS env var is empty');
-  logger.info({drachtio}, 'drachtio feature server inventory');
+  // listen for SNS lifecycle changes
+  let lifecycleEmitter = new Emitter();
+  let dryUpCalls = false;
+  if (process.env.AWS_SNS_TOPIC_ARM && process.env.AWS_REGION) {
+
+    (async function() {
+      try {
+        lifecycleEmitter = await require('./aws-sns-lifecycle')(logger);
+
+        lifecycleEmitter
+          .on(LifeCycleEvents.ScaleIn, () => {
+            logger.info('AWS scale-in notification: begin drying up calls');
+            dryUpCalls = true;
+            lifecycleEmitter.operationalState = LifeCycleEvents.ScaleIn;
+
+            const {srf} = require('../..');
+            pingProxies(srf);
+
+            // if we have zero calls, we can complete the scale-in right
+            setTimeout(() => {
+              const calls = srf.locals.sessionTracker.count;
+              if (calls === 0) {
+                logger.info('scale-in can complete immediately as we have no calls in progress');
+                lifecycleEmitter.completeScaleIn();
+              }
+              else {
+                logger.info(`${calls} calls in progress; scale-in will complete when they are done`);
+              }
+            }, 5000);
+          })
+          .on(LifeCycleEvents.StandbyEnter, () => {
+            dryUpCalls = true;
+            const {srf} = require('../..');
+            pingProxies(srf);
+
+            logger.info('AWS enter pending state notification: begin drying up calls');
+          })
+          .on(LifeCycleEvents.StandbyExit, () => {
+            dryUpCalls = false;
+            const {srf} = require('../..');
+            pingProxies(srf);
+
+            logger.info('AWS enter pending state notification: re-enable calls');
+          });
+      } catch (err) {
+        logger.error({err}, 'Failure creating SNS notifier, lifecycle events will be disabled');
+      }
+    })();
+  }
 
   async function pingProxies(srf) {
+    if (process.env.NODE_ENV === 'test') return;
+
     for (const sbc of sbcs) {
       try {
+        const ms = srf.locals.getFreeswitch();
         const req = await srf.request({
           uri: `sip:${sbc}`,
           method: 'OPTIONS',
           headers: {
-            'X-FS-Status': 'open'
+            'X-FS-Status': ms && !dryUpCalls ? 'open' : 'closed',
+            'X-FS-Calls': srf.locals.sessionTracker.count
           }
         });
         req.on('response', (res) => {
@@ -57,15 +90,44 @@ module.exports = (logger) => {
       }
     }
   }
+  if (process.env.K8S) {
+    setImmediate(() => {
+      logger.info('disabling OPTIONS pings since we are running as a kubernetes service');
+      const {srf} = require('../..');
+      const {addToSet} = srf.locals.dbHelpers;
+      const uuid = srf.locals.fsUUID = uuidv4();
+      addToSet(FS_UUID_SET_NAME, uuid)
+        .catch((err) => logger.info({err}, `Error adding ${uuid} to set ${FS_UUID_SET_NAME}`));
+    });
+  }
+  else {
+    // OPTIONS ping the SBCs from each feature server every 60 seconds
+    setInterval(() => {
+      const {srf} = require('../..');
+      pingProxies(srf);
+    }, process.env.OPTIONS_PING_INTERVAL || 30000);
 
-  // OPTIONS ping the SBCs from each feature server every 60 seconds
-  setInterval(() => {
-    srfs.forEach((srf) => pingProxies(srf));
-  }, 60000);
+    // initial ping once we are up
+    setTimeout(async() => {
+
+      // if SBCs are auto-scaling, monitor them as they come and go
+      const {srf} = require('../..');
+      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);
+  }
 
   return {
-    getSBC: () => sbcs[idxSbc++ % sbcs.length],
-    getSrf: () => srfs[idxSrfs++ % srfs.length]
+    lifecycleEmitter,
+    getSBC: () => sbcs[idxSbc++ % sbcs.length]
   };
 };
 

lib/utils/select-sbc.js

@@ -1,13 +0,0 @@
-const CIDRMatcher = require('cidr-matcher');
-const matcher = new CIDRMatcher([process.env.JAMBONES_NETWORK_CIDR]);
-
-module.exports = (sbcList) => {
-  const obj = sbcList
-    .split(',')
-    .map((str) => {
-      const arr = /^(.*)\/(.*):(\d+)$/.exec(str);
-      return {protocol: arr[1], host: arr[2], port: arr[3]};
-    })
-    .find((obj) => 'udp' == obj.protocol && matcher.contains(obj.host));
-  if (obj) return `${obj.host}:${obj.port}`;
-};

lib/utils/snakecase-keys.js

@@ -0,0 +1,25 @@
+const snakeCase = require('to-snake-case');
+
+const isObject = (value) => typeof value === 'object' && value !== null;
+
+const snakeObject = (obj, excludes) => {
+  if (Array.isArray(obj)) return obj.map((o) => {
+    return isObject(o) ? snakeObject(o, excludes) : o;
+  });
+
+  const target = {};
+  for (const [key, value] of Object.entries(obj)) {
+    if (excludes.includes(key)) {
+      target[key] = value;
+      continue;
+    }
+    const newKey = snakeCase(key);
+    const newValue = isObject(value) ? snakeObject(value, excludes) : value;
+    target[newKey] = newValue;
+  }
+  return target;
+};
+
+module.exports = (obj, excludes = []) => {
+  return snakeObject(obj, excludes);
+};

lib/utils/strip-ancillary-codecs.js

@@ -0,0 +1,30 @@
+const sdpTransform = require('sdp-transform');
+
+const stripCodecs = (logger, remoteSdp, localSdp) => {
+  try {
+    const sdp = sdpTransform.parse(remoteSdp);
+    const local = sdpTransform.parse(localSdp);
+    const m = local.media
+      .find((m) => 'audio' === m.type);
+    const pt = m.rtp[0].payload;
+
+    /* manipulate on the audio section */
+    const audio = sdp.media.find((m) => 'audio' === m.type);
+
+    /* discard all of the codecs except the first in our 200 OK, and telephony-events */
+    const ptSaves = audio.rtp
+      .filter((r) => r.codec === 'telephone-event' || r.payload === pt)
+      .map((r) => r.payload);
+    const rtp = audio.rtp.filter((r) => ptSaves.includes(r.payload));
+
+    /* reattach the new rtp sections and  stripped payload list */
+    audio.rtp = rtp;
+    audio.payloads = rtp.map((r) => r.payload).join(' ');
+    return sdpTransform.write(sdp);
+  } catch (err) {
+    logger.error({err, remoteSdp, localSdp}, 'strip-ancillary-codecs error');
+  }
+};
+
+module.exports = stripCodecs;
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "0.2.1",
+  "version": "v0.7.2",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -21,37 +21,41 @@
   },
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test JAMBONES_NETWORK_CIDR=127.0.0.1/32 node test/ | ./node_modules/.bin/tap-spec",
+    "test": "NODE_ENV=test JAMBONES_HOSTING=1 DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 DRACHTIO_SECRET=cymru JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=127.0.0.1 JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=debug ENABLE_METRICS=0 HTTP_PORT=3000 JAMBONES_SBCS=172.38.0.10 JAMBONES_FREESWITCH=127.0.0.1:8022:ClueCon:docker-host JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_NETWORK_CIDR=172.38.0.0/16 node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
-    "bent": "^7.0.6",
-    "jambonz-mw-registrar": "^0.1.3",
-    "debug": "^4.1.1",
-    "drachtio-fn-b2b-sugar": "0.0.12",
-    "drachtio-fsmrf": "^1.5.14",
-    "drachtio-srf": "^4.4.28",
+    "@cognigy/socket-client": "^4.5.5",
+    "@jambonz/db-helpers": "^0.6.16",
+    "@jambonz/http-health-check": "^0.0.1",
+    "@jambonz/mw-registrar": "^0.2.1",
+    "@jambonz/realtimedb-helpers": "^0.4.19",
+    "@jambonz/stats-collector": "^0.1.6",
+    "@jambonz/time-series": "^0.1.5",
+    "aws-sdk": "^2.1060.0",
+    "bent": "^7.3.12",
+    "cidr-matcher": "^2.1.1",
+    "debug": "^4.3.2",
+    "deepcopy": "^2.1.0",
+    "drachtio-fsmrf": "^2.0.13",
+    "drachtio-srf": "^4.4.55",
     "express": "^4.17.1",
     "ip": "^1.1.5",
-    "cidr-matcher": "^2.1.1",
-    "jambonz-db-helpers": "^0.3.2",
-    "jambonz-realtimedb-helpers": "^0.1.8",
-    "jambonz-stats-collector": "^0.0.3",
-    "moment": "^2.24.0",
-    "parse-url": "^5.0.1",
-    "pino": "^5.16.0"
+    "moment": "^2.29.1",
+    "parse-url": "^5.0.7",
+    "pino": "^6.13.2",
+    "to-snake-case": "^1.0.0",
+    "uuid": "^8.3.2",
+    "verify-aws-sns-signature": "^0.0.6",
+    "xml2js": "^0.4.23"
   },
   "devDependencies": {
-    "blue-tape": "^1.0.0",
-    "clear-module": "^4.0.0",
-    "eslint": "^6.8.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "jsdoc": "^3.6.3",
-    "nyc": "^14.1.1",
-    "tap": "^14.10.6",
-    "tap-dot": "^2.0.0",
-    "tap-spec": "^5.0.0",
-    "tape": "^4.13.0"
+    "async": "^3.2.0",
+    "clear-module": "^4.1.1",
+    "eslint": "^7.20.0",
+    "eslint-plugin-promise": "^4.3.1",
+    "nyc": "^15.1.0",
+    "tape": "^5.2.2"
   }
 }

test/account-validation-tests.js

@@ -0,0 +1,34 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+
+process.on('unhandledRejection', (reason, p) => {
+  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+function connect(connectable) {
+  return new Promise((resolve, reject) => {
+    connectable.on('connect', () => {
+      return resolve();
+    });
+  });
+}
+
+test('account validation tests', async(t) => {
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    await sippUac('uac-expect-500.xml', '172.38.0.10');
+    t.pass('rejected INVITE without X-Account-Sid header');
+    await sippUac('uac-invalid-account-expect-503.xml', '172.38.0.10');
+    t.pass('rejected INVITE with invalid X-Account-Sid header');
+    await sippUac('uac-inactive-account-expect-503.xml', '172.38.0.10');
+    t.pass('rejected INVITE from inactive account');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/create-test-db.js

@@ -1,9 +1,12 @@
-const test = require('tape').test ;
+const test = require('tape') ;
 const exec = require('child_process').exec ;
-const pwd = process.env.TRAVIS ? '' : '-p$MYSQL_ROOT_PASSWORD';
+const fs = require('fs');
+const {encrypt} = require('../lib/utils/encrypt-decrypt');
 
 test('creating jambones_test database', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} < ${__dirname}/db/create_test_db.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360 < ${__dirname}/db/create_test_db.sql`, (err, stdout, stderr) => {
+    console.log(stdout);
+    console.log(stderr)
     if (err) return t.end(err);
     t.pass('database successfully created');
     t.end();
@@ -11,17 +14,35 @@ test('creating jambones_test database', (t) => {
 });
 
 test('creating schema', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} -D jambones_test < ${__dirname}/db/jambones-sql.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360  -D jambones_test < ${__dirname}/db/create-and-populate-schema.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
-    t.pass('schema successfully created');
-    t.end();
+    t.pass('schema and test data successfully created');
+
+    if (process.env.GCP_JSON_KEY && process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY) {
+      const google_credential = encrypt(process.env.GCP_JSON_KEY);
+      const aws_credential = encrypt(JSON.stringify({
+        access_key_id: process.env.AWS_ACCESS_KEY_ID,
+        secret_access_key: process.env.AWS_SECRET_ACCESS_KEY
+      }));
+      const cmd = `
+UPDATE speech_credentials SET credential='${google_credential}' WHERE vendor='google';
+UPDATE speech_credentials SET credential='${aws_credential}' WHERE vendor='aws';
+`;
+      const path = `${__dirname}/.creds.sql`;
+      fs.writeFileSync(path, cmd);
+      exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360  -D jambones_test < ${path}`, (err, stdout, stderr) => {
+        console.log(stdout);
+        console.log(stderr);
+        if (err) return t.end(err);
+        fs.unlinkSync(path)
+        fs.writeFileSync(`${__dirname}/credentials/gcp.json`, process.env.GCP_JSON_KEY);
+        t.pass('set account-level speech credentials');
+        t.end();
+      });
+    }
+    else {
+      t.end();
+    }
   });
 });
 
-test('populating test case data', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} -D jambones_test < ${__dirname}/db/populate-test-data.sql`, (err, stdout, stderr) => {
-    if (err) return t.end(err);
-    t.pass('test data set created');
-    t.end();
-  });
-});

test/data/good/alternate-syntax.json

@@ -13,7 +13,7 @@
       "text": "Please say the name of the department that you would like to speak with.  To speak to an operator, just say operator.",
       "synthesizer": {
         "vendor": "google",
-        "voice": "en-US-Wavenet-C"
+        "language": "en-US"
       }
     }
   },
@@ -22,7 +22,7 @@
     "text": "I'm sorry, I did not hear a response.  Goodbye.",
     "synthesizer": {
       "vendor": "google",
-      "voice": "en-US-Wavenet-C"
+      "language": "en-US"
     }
   },
   {

test/data/good/say-text-array.json

@@ -0,0 +1,9 @@
+{
+  "say": {
+    "text": ["hi there", "John"],
+    "synthesizer": {
+      "vendor": "google",
+      "language": "en-US"
+    }
+  }
+}

test/data/good/say.json

@@ -0,0 +1,9 @@
+{
+  "say": {
+    "text": "hi there",
+    "synthesizer": {
+      "vendor": "google",
+      "language": "en-US"
+    }
+  }
+}

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

@@ -0,0 +1,751 @@
+-- MySQL dump 10.13  Distrib 8.0.18, for macos10.14 (x86_64)
+--
+-- Host: 127.0.0.1    Database: jambones_test
+-- ------------------------------------------------------
+-- Server version	5.7.33
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!50503 SET NAMES utf8mb4 */;
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+
+--
+-- Table structure for table `account_products`
+--
+
+DROP TABLE IF EXISTS `account_products`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `account_products` (
+  `account_product_sid` char(36) NOT NULL,
+  `account_subscription_sid` char(36) NOT NULL,
+  `product_sid` char(36) NOT NULL,
+  `quantity` int(11) NOT NULL,
+  PRIMARY KEY (`account_product_sid`),
+  UNIQUE KEY `account_product_sid` (`account_product_sid`),
+  KEY `account_product_sid_idx` (`account_product_sid`),
+  KEY `account_subscription_sid_idx` (`account_subscription_sid`),
+  KEY `product_sid_idxfk` (`product_sid`),
+  CONSTRAINT `account_subscription_sid_idxfk` FOREIGN KEY (`account_subscription_sid`) REFERENCES `account_subscriptions` (`account_subscription_sid`),
+  CONSTRAINT `product_sid_idxfk` FOREIGN KEY (`product_sid`) REFERENCES `products` (`product_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `account_products`
+--
+
+LOCK TABLES `account_products` WRITE;
+/*!40000 ALTER TABLE `account_products` DISABLE KEYS */;
+INSERT INTO `account_products` VALUES ('bb0e8a44-0e59-4103-a44c-f7ff950319fb','02639178-e073-4f8e-9b7e-48b1d36f4b7a','35a9fb10-233d-4eb9-aada-78de5814d680',10),('e2cd5148-07ad-4cdc-b395-22e4b4e23d7e','02639178-e073-4f8e-9b7e-48b1d36f4b7a','2c815913-5c26-4004-b748-183b459329df',10),('f9b320aa-c287-438b-a4c0-e4383b4f0256','02639178-e073-4f8e-9b7e-48b1d36f4b7a','c4403cdb-8e75-4b27-9726-7d8315e3216d',10);
+/*!40000 ALTER TABLE `account_products` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `account_static_ips`
+--
+
+DROP TABLE IF EXISTS `account_static_ips`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `account_static_ips` (
+  `account_static_ip_sid` char(36) NOT NULL,
+  `account_sid` char(36) NOT NULL,
+  `ipv4` varchar(16) NOT NULL,
+  `sbc_address_sid` char(36) NOT NULL,
+  PRIMARY KEY (`account_static_ip_sid`),
+  UNIQUE KEY `account_static_ip_sid` (`account_static_ip_sid`),
+  UNIQUE KEY `ipv4` (`ipv4`),
+  KEY `account_static_ip_sid_idx` (`account_static_ip_sid`),
+  KEY `account_sid_idx` (`account_sid`),
+  KEY `sbc_address_sid_idxfk` (`sbc_address_sid`),
+  CONSTRAINT `account_sid_idxfk_3` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `sbc_address_sid_idxfk` FOREIGN KEY (`sbc_address_sid`) REFERENCES `sbc_addresses` (`sbc_address_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `account_static_ips`
+--
+
+LOCK TABLES `account_static_ips` WRITE;
+/*!40000 ALTER TABLE `account_static_ips` DISABLE KEYS */;
+/*!40000 ALTER TABLE `account_static_ips` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `account_subscriptions`
+--
+
+DROP TABLE IF EXISTS `account_subscriptions`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `account_subscriptions` (
+  `account_subscription_sid` char(36) NOT NULL,
+  `account_sid` char(36) NOT NULL,
+  `pending` tinyint(1) NOT NULL DEFAULT '0',
+  `effective_start_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `effective_end_date` datetime DEFAULT NULL,
+  `change_reason` varchar(255) DEFAULT NULL,
+  `stripe_subscription_id` varchar(56) DEFAULT NULL,
+  `stripe_payment_method_id` varchar(56) DEFAULT NULL,
+  `stripe_statement_descriptor` varchar(255) DEFAULT NULL,
+  `last4` char(4) DEFAULT NULL,
+  `exp_month` int(11) DEFAULT NULL,
+  `exp_year` int(11) DEFAULT NULL,
+  `card_type` varchar(16) DEFAULT NULL,
+  `pending_reason` varbinary(52) DEFAULT NULL,
+  PRIMARY KEY (`account_subscription_sid`),
+  UNIQUE KEY `account_subscription_sid` (`account_subscription_sid`),
+  KEY `account_subscription_sid_idx` (`account_subscription_sid`),
+  KEY `account_sid_idx` (`account_sid`),
+  CONSTRAINT `account_sid_idxfk` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `account_subscriptions`
+--
+
+LOCK TABLES `account_subscriptions` WRITE;
+/*!40000 ALTER TABLE `account_subscriptions` DISABLE KEYS */;
+INSERT INTO `account_subscriptions` VALUES ('02639178-e073-4f8e-9b7e-48b1d36f4b7a','bb845d4b-83a9-4cde-a6e9-50f3743bab3f',0,'2021-04-03 15:41:03',NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL);
+/*!40000 ALTER TABLE `account_subscriptions` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `accounts`
+--
+
+DROP TABLE IF EXISTS `accounts`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `accounts` (
+  `account_sid` char(36) NOT NULL,
+  `name` varchar(64) NOT NULL,
+  `sip_realm` varchar(132) DEFAULT NULL COMMENT 'sip domain that will be used for devices registering under this account',
+  `service_provider_sid` char(36) NOT NULL COMMENT 'service provider that owns the customer relationship with this account',
+  `registration_hook_sid` char(36) DEFAULT NULL COMMENT 'webhook to call when devices underr this account attempt to register',
+  `device_calling_application_sid` char(36) DEFAULT NULL COMMENT 'application to use for outbound calling from an account',
+  `is_active` tinyint(1) NOT NULL DEFAULT '1',
+  `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `plan_type` enum('trial','free','paid') NOT NULL DEFAULT 'trial',
+  `stripe_customer_id` varchar(56) DEFAULT NULL,
+  `webhook_secret` varchar(36) NOT NULL,
+  `disable_cdrs` tinyint(1) NOT NULL DEFAULT '0',
+  `trial_end_date` datetime DEFAULT NULL,
+  `deactivated_reason` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`account_sid`),
+  UNIQUE KEY `account_sid` (`account_sid`),
+  UNIQUE KEY `sip_realm` (`sip_realm`),
+  KEY `account_sid_idx` (`account_sid`),
+  KEY `sip_realm_idx` (`sip_realm`),
+  KEY `service_provider_sid_idx` (`service_provider_sid`),
+  KEY `registration_hook_sid_idxfk_1` (`registration_hook_sid`),
+  KEY `device_calling_application_sid_idxfk` (`device_calling_application_sid`),
+  CONSTRAINT `device_calling_application_sid_idxfk` FOREIGN KEY (`device_calling_application_sid`) REFERENCES `applications` (`application_sid`),
+  CONSTRAINT `registration_hook_sid_idxfk_1` FOREIGN KEY (`registration_hook_sid`) REFERENCES `webhooks` (`webhook_sid`),
+  CONSTRAINT `service_provider_sid_idxfk_6` FOREIGN KEY (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='An enterprise that uses the platform for comm services';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `accounts`
+--
+
+LOCK TABLES `accounts` WRITE;
+/*!40000 ALTER TABLE `accounts` DISABLE KEYS */;
+INSERT INTO `accounts` VALUES ('bb845d4b-83a9-4cde-a6e9-50f3743bab3f','Joe User','test.yakeeda.com','2708b1b3-2736-40ea-b502-c53d8396247f',NULL,NULL,1,'2021-04-03 15:41:03','trial',NULL,'wh_secret_ehV2dVyzNBs5kHxeJcatRQ',0,NULL,NULL);
+INSERT INTO `accounts` VALUES ('622f62e4-303a-49f2-bbe0-eb1e1714e37a','Dave Horton','delta.yakeeda.com','2708b1b3-2736-40ea-b502-c53d8396247f',NULL,NULL,0,'2021-04-03 15:41:03','trial',NULL,'wh_secret_ehV2dVyzNBs5kHxeJcatRQ',0,NULL,NULL);
+/*!40000 ALTER TABLE `accounts` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `api_keys`
+--
+
+DROP TABLE IF EXISTS `api_keys`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `api_keys` (
+  `api_key_sid` char(36) NOT NULL,
+  `token` char(36) NOT NULL,
+  `account_sid` char(36) DEFAULT NULL,
+  `service_provider_sid` char(36) DEFAULT NULL,
+  `expires_at` timestamp NULL DEFAULT NULL,
+  `last_used` timestamp NULL DEFAULT NULL,
+  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (`api_key_sid`),
+  UNIQUE KEY `api_key_sid` (`api_key_sid`),
+  UNIQUE KEY `token` (`token`),
+  KEY `api_key_sid_idx` (`api_key_sid`),
+  KEY `account_sid_idx` (`account_sid`),
+  KEY `service_provider_sid_idx` (`service_provider_sid`),
+  CONSTRAINT `account_sid_idxfk_4` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `service_provider_sid_idxfk` FOREIGN KEY (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='An authorization token that is used to access the REST api';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `api_keys`
+--
+
+LOCK TABLES `api_keys` WRITE;
+/*!40000 ALTER TABLE `api_keys` DISABLE KEYS */;
+INSERT INTO `api_keys` VALUES ('3f35518f-5a0d-4c2e-90a5-2407bb3b36f0','38700987-c7a4-4685-a5bb-af378f9734de',NULL,NULL,NULL,NULL,'2021-04-03 15:40:37'),('b00b1025-2b65-453b-a243-599b75be7d0a','52c2eb45-9f72-4545-9c60-9639e3f4eaf7','bb845d4b-83a9-4cde-a6e9-50f3743bab3f',NULL,NULL,NULL,'2021-04-03 15:42:40');
+/*!40000 ALTER TABLE `api_keys` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `applications`
+--
+
+DROP TABLE IF EXISTS `applications`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `applications` (
+  `application_sid` char(36) NOT NULL,
+  `name` varchar(64) NOT NULL,
+  `service_provider_sid` char(36) DEFAULT NULL COMMENT 'if non-null, this application is a test application that can be used by any account under the associated service provider',
+  `account_sid` char(36) DEFAULT NULL COMMENT 'account that this application belongs to (if null, this is a service provider test application)',
+  `call_hook_sid` char(36) DEFAULT NULL COMMENT 'webhook to call for inbound calls ',
+  `call_status_hook_sid` char(36) DEFAULT NULL COMMENT 'webhook to call for call status events',
+  `messaging_hook_sid` char(36) DEFAULT NULL COMMENT 'webhook to call for inbound SMS/MMS ',
+  `speech_synthesis_vendor` varchar(64) NOT NULL DEFAULT 'google',
+  `speech_synthesis_language` varchar(12) NOT NULL DEFAULT 'en-US',
+  `speech_synthesis_voice` varchar(64) DEFAULT NULL,
+  `speech_recognizer_vendor` varchar(64) NOT NULL DEFAULT 'google',
+  `speech_recognizer_language` varchar(64) NOT NULL DEFAULT 'en-US',
+  PRIMARY KEY (`application_sid`),
+  UNIQUE KEY `application_sid` (`application_sid`),
+  UNIQUE KEY `applications_idx_name` (`account_sid`,`name`),
+  KEY `application_sid_idx` (`application_sid`),
+  KEY `service_provider_sid_idx` (`service_provider_sid`),
+  KEY `account_sid_idx` (`account_sid`),
+  KEY `call_hook_sid_idxfk` (`call_hook_sid`),
+  KEY `call_status_hook_sid_idxfk` (`call_status_hook_sid`),
+  KEY `messaging_hook_sid_idxfk` (`messaging_hook_sid`),
+  CONSTRAINT `account_sid_idxfk_10` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `call_hook_sid_idxfk` FOREIGN KEY (`call_hook_sid`) REFERENCES `webhooks` (`webhook_sid`),
+  CONSTRAINT `call_status_hook_sid_idxfk` FOREIGN KEY (`call_status_hook_sid`) REFERENCES `webhooks` (`webhook_sid`),
+  CONSTRAINT `messaging_hook_sid_idxfk` FOREIGN KEY (`messaging_hook_sid`) REFERENCES `webhooks` (`webhook_sid`),
+  CONSTRAINT `service_provider_sid_idxfk_5` FOREIGN KEY (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='A defined set of behaviors to be applied to phone calls ';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `applications`
+--
+
+LOCK TABLES `applications` WRITE;
+/*!40000 ALTER TABLE `applications` DISABLE KEYS */;
+INSERT INTO `applications` VALUES ('0dddaabf-0a30-43e3-84e8-426873b1a78b','decline call',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','c71e79db-24f2-4866-a3ee-febb0f97b341','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,'google','en-US','en-US-Standard-C','google','en-US');
+INSERT INTO `applications` VALUES ('308b4f41-1a18-4052-b89a-c054e75ce242','say',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','54ab0976-a6c0-45d8-89a4-d90d45bf9d96','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,'google','en-US','en-US-Standard-C','google','en-US');
+INSERT INTO `applications` VALUES ('24d0f6af-e976-44dd-a2e8-41c7b55abe33','say account 2',NULL,'622f62e4-303a-49f2-bbe0-eb1e1714e37a','54ab0976-a6c0-45d8-89a4-d90d45bf9d96','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,'google','en-US','en-US-Standard-C','google','en-US');
+INSERT INTO `applications` VALUES ('17461c69-56b5-4dab-ad83-1c43a0f93a3d','gather',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','10692465-a511-4277-9807-b7157e4f81e1','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,'google','en-US','en-US-Standard-C','google','en-US');
+INSERT INTO `applications` VALUES ('baf9213b-5556-4c20-870c-586392ed246f','transcribe',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','ecb67a8f-f7ce-4919-abf0-bbc69c1001e5','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,'google','en-US','en-US-Standard-C','google','en-US');
+INSERT INTO `applications` VALUES ('ae026ab5-3029-47b4-9d7c-236e3a4b4ebe','transcribe account 2',NULL,'622f62e4-303a-49f2-bbe0-eb1e1714e37a','ecb67a8f-f7ce-4919-abf0-bbc69c1001e5','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,'google','en-US','en-US-Standard-C','google','en-US');
+/*!40000 ALTER TABLE `applications` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `call_routes`
+--
+
+DROP TABLE IF EXISTS `call_routes`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `call_routes` (
+  `call_route_sid` char(36) NOT NULL,
+  `priority` int(11) NOT NULL,
+  `account_sid` char(36) NOT NULL,
+  `regex` varchar(255) NOT NULL,
+  `application_sid` char(36) NOT NULL,
+  PRIMARY KEY (`call_route_sid`),
+  UNIQUE KEY `call_route_sid` (`call_route_sid`),
+  KEY `call_route_sid_idx` (`call_route_sid`),
+  KEY `account_sid_idxfk_1` (`account_sid`),
+  KEY `application_sid_idxfk` (`application_sid`),
+  CONSTRAINT `account_sid_idxfk_1` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `application_sid_idxfk` FOREIGN KEY (`application_sid`) REFERENCES `applications` (`application_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='a regex-based pattern match for call routing';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `call_routes`
+--
+
+LOCK TABLES `call_routes` WRITE;
+/*!40000 ALTER TABLE `call_routes` DISABLE KEYS */;
+/*!40000 ALTER TABLE `call_routes` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `dns_records`
+--
+
+DROP TABLE IF EXISTS `dns_records`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `dns_records` (
+  `dns_record_sid` char(36) NOT NULL,
+  `account_sid` char(36) NOT NULL,
+  `record_type` varchar(6) NOT NULL,
+  `record_id` int(11) NOT NULL,
+  PRIMARY KEY (`dns_record_sid`),
+  UNIQUE KEY `dns_record_sid` (`dns_record_sid`),
+  KEY `dns_record_sid_idx` (`dns_record_sid`),
+  KEY `account_sid_idxfk_2` (`account_sid`),
+  CONSTRAINT `account_sid_idxfk_2` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `dns_records`
+--
+
+LOCK TABLES `dns_records` WRITE;
+/*!40000 ALTER TABLE `dns_records` DISABLE KEYS */;
+/*!40000 ALTER TABLE `dns_records` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `lcr_carrier_set_entry`
+--
+
+DROP TABLE IF EXISTS `lcr_carrier_set_entry`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `lcr_carrier_set_entry` (
+  `lcr_carrier_set_entry_sid` char(36) NOT NULL,
+  `workload` int(11) NOT NULL DEFAULT '1' COMMENT 'represents a proportion of traffic to send through the associated carrier; can be used for load balancing traffic across carriers with a common priority for a destination',
+  `lcr_route_sid` char(36) NOT NULL,
+  `voip_carrier_sid` char(36) NOT NULL,
+  `priority` int(11) NOT NULL DEFAULT '0' COMMENT 'lower priority carriers are attempted first',
+  PRIMARY KEY (`lcr_carrier_set_entry_sid`),
+  KEY `lcr_route_sid_idxfk` (`lcr_route_sid`),
+  KEY `voip_carrier_sid_idxfk_2` (`voip_carrier_sid`),
+  CONSTRAINT `lcr_route_sid_idxfk` FOREIGN KEY (`lcr_route_sid`) REFERENCES `lcr_routes` (`lcr_route_sid`),
+  CONSTRAINT `voip_carrier_sid_idxfk_2` FOREIGN KEY (`voip_carrier_sid`) REFERENCES `voip_carriers` (`voip_carrier_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='An entry in the LCR routing list';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `lcr_carrier_set_entry`
+--
+
+LOCK TABLES `lcr_carrier_set_entry` WRITE;
+/*!40000 ALTER TABLE `lcr_carrier_set_entry` DISABLE KEYS */;
+/*!40000 ALTER TABLE `lcr_carrier_set_entry` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `lcr_routes`
+--
+
+DROP TABLE IF EXISTS `lcr_routes`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `lcr_routes` (
+  `lcr_route_sid` char(36) NOT NULL,
+  `regex` varchar(32) NOT NULL COMMENT 'regex-based pattern match against dialed number, used for LCR routing of PSTN calls',
+  `description` varchar(1024) DEFAULT NULL,
+  `priority` int(11) NOT NULL COMMENT 'lower priority routes are attempted first',
+  PRIMARY KEY (`lcr_route_sid`),
+  UNIQUE KEY `priority` (`priority`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='Least cost routing table';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `lcr_routes`
+--
+
+LOCK TABLES `lcr_routes` WRITE;
+/*!40000 ALTER TABLE `lcr_routes` DISABLE KEYS */;
+/*!40000 ALTER TABLE `lcr_routes` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `ms_teams_tenants`
+--
+
+DROP TABLE IF EXISTS `ms_teams_tenants`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `ms_teams_tenants` (
+  `ms_teams_tenant_sid` char(36) NOT NULL,
+  `service_provider_sid` char(36) NOT NULL,
+  `account_sid` char(36) NOT NULL,
+  `application_sid` char(36) DEFAULT NULL,
+  `tenant_fqdn` varchar(255) NOT NULL,
+  PRIMARY KEY (`ms_teams_tenant_sid`),
+  UNIQUE KEY `ms_teams_tenant_sid` (`ms_teams_tenant_sid`),
+  UNIQUE KEY `tenant_fqdn` (`tenant_fqdn`),
+  KEY `ms_teams_tenant_sid_idx` (`ms_teams_tenant_sid`),
+  KEY `service_provider_sid_idxfk_1` (`service_provider_sid`),
+  KEY `account_sid_idxfk_5` (`account_sid`),
+  KEY `application_sid_idxfk_1` (`application_sid`),
+  KEY `tenant_fqdn_idx` (`tenant_fqdn`),
+  CONSTRAINT `account_sid_idxfk_5` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `application_sid_idxfk_1` FOREIGN KEY (`application_sid`) REFERENCES `applications` (`application_sid`),
+  CONSTRAINT `service_provider_sid_idxfk_1` FOREIGN KEY (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='A Microsoft Teams customer tenant';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `ms_teams_tenants`
+--
+
+LOCK TABLES `ms_teams_tenants` WRITE;
+/*!40000 ALTER TABLE `ms_teams_tenants` DISABLE KEYS */;
+/*!40000 ALTER TABLE `ms_teams_tenants` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `phone_numbers`
+--
+
+DROP TABLE IF EXISTS `phone_numbers`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `phone_numbers` (
+  `phone_number_sid` char(36) NOT NULL,
+  `number` varchar(32) NOT NULL,
+  `voip_carrier_sid` char(36) DEFAULT NULL,
+  `account_sid` char(36) DEFAULT NULL,
+  `application_sid` char(36) DEFAULT NULL,
+  `service_provider_sid` char(36) DEFAULT NULL COMMENT 'if not null, this number is a test number for the associated service provider',
+  PRIMARY KEY (`phone_number_sid`),
+  UNIQUE KEY `number` (`number`),
+  UNIQUE KEY `phone_number_sid` (`phone_number_sid`),
+  KEY `phone_number_sid_idx` (`phone_number_sid`),
+  KEY `number_idx` (`number`),
+  KEY `voip_carrier_sid_idx` (`voip_carrier_sid`),
+  KEY `account_sid_idxfk_9` (`account_sid`),
+  KEY `application_sid_idxfk_3` (`application_sid`),
+  KEY `service_provider_sid_idx` (`service_provider_sid`),
+  CONSTRAINT `account_sid_idxfk_9` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `application_sid_idxfk_3` FOREIGN KEY (`application_sid`) REFERENCES `applications` (`application_sid`),
+  CONSTRAINT `service_provider_sid_idxfk_4` FOREIGN KEY (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`),
+  CONSTRAINT `voip_carrier_sid_idxfk` FOREIGN KEY (`voip_carrier_sid`) REFERENCES `voip_carriers` (`voip_carrier_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='A phone number that has been assigned to an account';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `phone_numbers`
+--
+
+LOCK TABLES `phone_numbers` WRITE;
+/*!40000 ALTER TABLE `phone_numbers` DISABLE KEYS */;
+INSERT INTO `phone_numbers` VALUES ('4b439355-debc-40c7-9cfa-5be58c2bed6b','16174000000','5145b436-2f38-4029-8d4c-fd8c67831c7a','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','0dddaabf-0a30-43e3-84e8-426873b1a78b', NULL);
+INSERT INTO `phone_numbers` VALUES ('9cc9e7fc-b7b0-4101-8f3c-9fe13ce5df0a','16174000001','5145b436-2f38-4029-8d4c-fd8c67831c7a','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','308b4f41-1a18-4052-b89a-c054e75ce242', NULL);
+INSERT INTO `phone_numbers` VALUES ('e686a320-0725-418f-be65-532159bdc3ed','16174000002','5145b436-2f38-4029-8d4c-fd8c67831c7a','622f62e4-303a-49f2-bbe0-eb1e1714e37a','24d0f6af-e976-44dd-a2e8-41c7b55abe33', NULL);
+INSERT INTO `phone_numbers` VALUES ('05eeed62-b29b-4679-bf38-d7a4e318be44','16174000003','5145b436-2f38-4029-8d4c-fd8c67831c7a','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','17461c69-56b5-4dab-ad83-1c43a0f93a3d', NULL);
+INSERT INTO `phone_numbers` VALUES ('f3c53863-b629-4cf6-9dcb-c7fb7072314b','16174000004','5145b436-2f38-4029-8d4c-fd8c67831c7a','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','baf9213b-5556-4c20-870c-586392ed246f', NULL);
+INSERT INTO `phone_numbers` VALUES ('f6416c17-829a-4f11-9c32-f0d00e4a9ae9','16174000005','5145b436-2f38-4029-8d4c-fd8c67831c7a','622f62e4-303a-49f2-bbe0-eb1e1714e37a','ae026ab5-3029-47b4-9d7c-236e3a4b4ebe', NULL);
+/*!40000 ALTER TABLE `phone_numbers` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `products`
+--
+
+DROP TABLE IF EXISTS `products`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `products` (
+  `product_sid` char(36) NOT NULL,
+  `name` varchar(32) NOT NULL,
+  `category` enum('api_rate','voice_call_session','device') NOT NULL,
+  PRIMARY KEY (`product_sid`),
+  UNIQUE KEY `product_sid` (`product_sid`),
+  KEY `product_sid_idx` (`product_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `products`
+--
+
+LOCK TABLES `products` WRITE;
+/*!40000 ALTER TABLE `products` DISABLE KEYS */;
+INSERT INTO `products` VALUES ('2c815913-5c26-4004-b748-183b459329df','registered device','device'),('35a9fb10-233d-4eb9-aada-78de5814d680','api call','api_rate'),('c4403cdb-8e75-4b27-9726-7d8315e3216d','concurrent call session','voice_call_session');
+/*!40000 ALTER TABLE `products` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `sbc_addresses`
+--
+
+DROP TABLE IF EXISTS `sbc_addresses`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `sbc_addresses` (
+  `sbc_address_sid` char(36) NOT NULL,
+  `ipv4` varchar(255) NOT NULL,
+  `port` int(11) NOT NULL DEFAULT '5060',
+  `service_provider_sid` char(36) DEFAULT NULL,
+  PRIMARY KEY (`sbc_address_sid`),
+  UNIQUE KEY `sbc_address_sid` (`sbc_address_sid`),
+  KEY `sbc_addresses_idx_host_port` (`ipv4`,`port`),
+  KEY `sbc_address_sid_idx` (`sbc_address_sid`),
+  KEY `service_provider_sid_idx` (`service_provider_sid`),
+  CONSTRAINT `service_provider_sid_idxfk_2` FOREIGN KEY (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `sbc_addresses`
+--
+
+LOCK TABLES `sbc_addresses` WRITE;
+/*!40000 ALTER TABLE `sbc_addresses` DISABLE KEYS */;
+INSERT INTO `sbc_addresses` VALUES ('8d6d0fda-4550-41ab-8e2f-60761d81fe7d','3.39.45.30',5060,NULL);
+/*!40000 ALTER TABLE `sbc_addresses` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `service_providers`
+--
+
+DROP TABLE IF EXISTS `service_providers`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `service_providers` (
+  `service_provider_sid` char(36) NOT NULL,
+  `name` varchar(64) NOT NULL,
+  `description` varchar(255) DEFAULT NULL,
+  `root_domain` varchar(128) DEFAULT NULL,
+  `registration_hook_sid` char(36) DEFAULT NULL,
+  `ms_teams_fqdn` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`service_provider_sid`),
+  UNIQUE KEY `service_provider_sid` (`service_provider_sid`),
+  UNIQUE KEY `name` (`name`),
+  UNIQUE KEY `root_domain` (`root_domain`),
+  KEY `service_provider_sid_idx` (`service_provider_sid`),
+  KEY `name_idx` (`name`),
+  KEY `root_domain_idx` (`root_domain`),
+  KEY `registration_hook_sid_idxfk` (`registration_hook_sid`),
+  CONSTRAINT `registration_hook_sid_idxfk` FOREIGN KEY (`registration_hook_sid`) REFERENCES `webhooks` (`webhook_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='A partition of the platform used by one service provider';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `service_providers`
+--
+
+LOCK TABLES `service_providers` WRITE;
+/*!40000 ALTER TABLE `service_providers` DISABLE KEYS */;
+INSERT INTO `service_providers` VALUES ('2708b1b3-2736-40ea-b502-c53d8396247f','jambonz.us','jambonz.us service provider','yakeeda.com',NULL,NULL);
+/*!40000 ALTER TABLE `service_providers` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `sip_gateways`
+--
+
+DROP TABLE IF EXISTS `sip_gateways`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `sip_gateways` (
+  `sip_gateway_sid` char(36) NOT NULL,
+  `ipv4` varchar(128) NOT NULL COMMENT 'ip address or DNS name of the gateway.  For gateways providing inbound calling service, ip address is required.',
+  `port` int(11) NOT NULL DEFAULT '5060' COMMENT 'sip signaling port',
+  `inbound` tinyint(1) NOT NULL COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+  `outbound` tinyint(1) NOT NULL COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+  `voip_carrier_sid` char(36) NOT NULL,
+  `is_active` tinyint(1) NOT NULL DEFAULT '1',
+  PRIMARY KEY (`sip_gateway_sid`),
+  KEY `sip_gateway_idx_hostport` (`ipv4`,`port`),
+  KEY `voip_carrier_sid_idx` (`voip_carrier_sid`),
+  CONSTRAINT `voip_carrier_sid_idxfk_1` FOREIGN KEY (`voip_carrier_sid`) REFERENCES `voip_carriers` (`voip_carrier_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='A whitelisted sip gateway used for origination/termination';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `sip_gateways`
+--
+
+LOCK TABLES `sip_gateways` WRITE;
+/*!40000 ALTER TABLE `sip_gateways` DISABLE KEYS */;
+INSERT INTO `sip_gateways` VALUES ('46b727eb-c7dc-44fa-b063-96e48d408e4a','3.3.3.3',5060,1,1,'5145b436-2f38-4029-8d4c-fd8c67831c7a',1),('81629182-6904-4588-8c72-a78d70053fb9','54.172.60.1',5060,1,1,'df0aefbf-ca7b-4d48-9fbf-3c66fef72060',1);
+/*!40000 ALTER TABLE `sip_gateways` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `speech_credentials`
+--
+
+DROP TABLE IF EXISTS `speech_credentials`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `speech_credentials` (
+  `speech_credential_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',
+  `use_for_stt` tinyint(1) DEFAULT '1',
+  `last_used` datetime DEFAULT NULL,
+  `last_tested` datetime DEFAULT NULL,
+  `tts_tested_ok` tinyint(1) DEFAULT NULL,
+  `stt_tested_ok` tinyint(1) DEFAULT NULL,
+  PRIMARY KEY (`speech_credential_sid`),
+  UNIQUE KEY `speech_credential_sid` (`speech_credential_sid`),
+  UNIQUE KEY `speech_credentials_idx_1` (`vendor`,`account_sid`),
+  KEY `speech_credential_sid_idx` (`speech_credential_sid`),
+  KEY `account_sid_idx` (`account_sid`),
+  CONSTRAINT `account_sid_idxfk_6` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for 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',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;
+
+--
+-- Table structure for table `users`
+--
+
+DROP TABLE IF EXISTS `users`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `users` (
+  `user_sid` char(36) NOT NULL,
+  `name` varchar(255) NOT NULL,
+  `email` varchar(255) NOT NULL,
+  `pending_email` varchar(255) DEFAULT NULL,
+  `phone` varchar(20) DEFAULT NULL,
+  `hashed_password` varchar(1024) DEFAULT NULL,
+  `salt` char(16) DEFAULT NULL,
+  `account_sid` char(36) DEFAULT NULL,
+  `service_provider_sid` char(36) DEFAULT NULL,
+  `force_change` tinyint(1) NOT NULL DEFAULT '0',
+  `provider` varchar(255) NOT NULL,
+  `provider_userid` varchar(255) DEFAULT NULL,
+  `scope` varchar(16) NOT NULL DEFAULT 'read-write',
+  `phone_activation_code` varchar(16) DEFAULT NULL,
+  `email_activation_code` varchar(16) DEFAULT NULL,
+  `email_validated` tinyint(1) NOT NULL DEFAULT '0',
+  `phone_validated` tinyint(1) NOT NULL DEFAULT '0',
+  `email_content_opt_out` tinyint(1) NOT NULL DEFAULT '0',
+  PRIMARY KEY (`user_sid`),
+  UNIQUE KEY `user_sid` (`user_sid`),
+  UNIQUE KEY `phone` (`phone`),
+  KEY `user_sid_idx` (`user_sid`),
+  KEY `email_idx` (`email`),
+  KEY `phone_idx` (`phone`),
+  KEY `account_sid_idx` (`account_sid`),
+  KEY `service_provider_sid_idx` (`service_provider_sid`),
+  KEY `email_activation_code_idx` (`email_activation_code`),
+  CONSTRAINT `account_sid_idxfk_7` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `service_provider_sid_idxfk_3` FOREIGN KEY (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `users`
+--
+
+LOCK TABLES `users` WRITE;
+/*!40000 ALTER TABLE `users` DISABLE KEYS */;
+INSERT INTO `users` VALUES ('d9cdf199-78d1-4f92-b717-5f9dbdf56565','Dave Horton','daveh@drachtio.org',NULL,NULL,NULL,NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f',NULL,0,'github','davehorton','read-write',NULL,NULL,1,0,0);
+/*!40000 ALTER TABLE `users` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `voip_carriers`
+--
+
+DROP TABLE IF EXISTS `voip_carriers`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `voip_carriers` (
+  `voip_carrier_sid` char(36) NOT NULL,
+  `name` varchar(64) NOT NULL,
+  `description` varchar(255) DEFAULT NULL,
+  `account_sid` char(36) DEFAULT NULL COMMENT 'if provided, indicates this entity represents a sip trunk that is associated with a specific account',
+  `application_sid` char(36) DEFAULT NULL COMMENT 'If provided, all incoming calls from this source will be routed to the associated application',
+  `e164_leading_plus` tinyint(1) NOT NULL DEFAULT '0' COMMENT 'if true, a leading plus should be prepended to outbound phone numbers',
+  `requires_register` tinyint(1) NOT NULL DEFAULT '0',
+  `register_username` varchar(64) DEFAULT NULL,
+  `register_sip_realm` varchar(64) DEFAULT NULL,
+  `register_password` varchar(64) DEFAULT NULL,
+  `tech_prefix` varchar(16) DEFAULT NULL COMMENT 'tech prefix to prepend to outbound calls to this carrier',
+  PRIMARY KEY (`voip_carrier_sid`),
+  UNIQUE KEY `voip_carrier_sid` (`voip_carrier_sid`),
+  KEY `voip_carrier_sid_idx` (`voip_carrier_sid`),
+  KEY `account_sid_idx` (`account_sid`),
+  KEY `application_sid_idxfk_2` (`application_sid`),
+  CONSTRAINT `account_sid_idxfk_8` FOREIGN KEY (`account_sid`) REFERENCES `accounts` (`account_sid`),
+  CONSTRAINT `application_sid_idxfk_2` FOREIGN KEY (`application_sid`) REFERENCES `applications` (`application_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='A Carrier or customer PBX that can send or receive calls';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `voip_carriers`
+--
+
+LOCK TABLES `voip_carriers` WRITE;
+/*!40000 ALTER TABLE `voip_carriers` DISABLE KEYS */;
+INSERT INTO `voip_carriers` VALUES ('5145b436-2f38-4029-8d4c-fd8c67831c7a','my test carrier',NULL,NULL,NULL,0,0,NULL,NULL,NULL,NULL),('df0aefbf-ca7b-4d48-9fbf-3c66fef72060','my test carrier',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f',NULL,0,0,NULL,NULL,NULL,NULL);
+/*!40000 ALTER TABLE `voip_carriers` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `webhooks`
+--
+
+DROP TABLE IF EXISTS `webhooks`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `webhooks` (
+  `webhook_sid` char(36) NOT NULL,
+  `url` varchar(1024) NOT NULL,
+  `method` enum('GET','POST') NOT NULL DEFAULT 'POST',
+  `username` varchar(255) DEFAULT NULL,
+  `password` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`webhook_sid`),
+  UNIQUE KEY `webhook_sid` (`webhook_sid`),
+  KEY `webhook_sid_idx` (`webhook_sid`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='An HTTP callback';
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `webhooks`
+--
+
+LOCK TABLES `webhooks` WRITE;
+/*!40000 ALTER TABLE `webhooks` DISABLE KEYS */;
+INSERT INTO `webhooks` VALUES ('6ac36aeb-6bd0-428a-80a1-aed95640a296','https://flows.jambonz.us/callStatus','POST',NULL,NULL),('d9c205c6-a129-443e-a9c0-d1bb437d4bb7','https://flows.jambonz.us/testCall','POST',NULL,NULL);
+INSERT INTO `webhooks` VALUES ('293904c1-351b-4bca-8d58-1a29b853c7db','http://127.0.0.1:3100/callStatus','POST',NULL,NULL);
+INSERT INTO `webhooks` VALUES ('c71e79db-24f2-4866-a3ee-febb0f97b341','http://127.0.0.1:3100/','POST',NULL,NULL);
+INSERT INTO `webhooks` VALUES ('54ab0976-a6c0-45d8-89a4-d90d45bf9d96','http://127.0.0.1:3101/','POST',NULL,NULL);
+INSERT INTO `webhooks` VALUES ('10692465-a511-4277-9807-b7157e4f81e1','http://127.0.0.1:3102/','POST',NULL,NULL);
+INSERT INTO `webhooks` VALUES ('ecb67a8f-f7ce-4919-abf0-bbc69c1001e5','http://127.0.0.1:3103/','POST',NULL,NULL);
+/*!40000 ALTER TABLE `webhooks` ENABLE KEYS */;
+UNLOCK TABLES;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+
+-- Dump completed on 2021-04-03 11:50:25

test/db/create_test_db.sql

@@ -1,3 +1,3 @@
 create database jambones_test;
-create user jambones_test@localhost IDENTIFIED WITH mysql_native_password by 'jambones_test';
-grant all on jambones_test.* to jambones_test@localhost;
+create user jambones_test@'%' IDENTIFIED WITH mysql_native_password by 'jambones_test';
+grant all on jambones_test.* to jambones_test@'%';

test/db/jambones-sql.sql

@@ -1,272 +1,575 @@
 /* SQLEditor (MySQL (2))*/
 
+SET FOREIGN_KEY_CHECKS=0;
 
-DROP TABLE IF EXISTS `call_routes`;
+DROP TABLE IF EXISTS account_static_ips;
 
-DROP TABLE IF EXISTS `conference_participants`;
+DROP TABLE IF EXISTS account_products;
 
-DROP TABLE IF EXISTS `queue_members`;
+DROP TABLE IF EXISTS account_subscriptions;
 
-DROP TABLE IF EXISTS `calls`;
+DROP TABLE IF EXISTS beta_invite_codes;
 
-DROP TABLE IF EXISTS `phone_numbers`;
+DROP TABLE IF EXISTS call_routes;
 
-DROP TABLE IF EXISTS `applications`;
+DROP TABLE IF EXISTS dns_records;
 
-DROP TABLE IF EXISTS `conferences`;
+DROP TABLE IF EXISTS lcr_carrier_set_entry;
 
-DROP TABLE IF EXISTS `queues`;
+DROP TABLE IF EXISTS lcr_routes;
 
-DROP TABLE IF EXISTS `subscriptions`;
+DROP TABLE IF EXISTS predefined_sip_gateways;
 
-DROP TABLE IF EXISTS `registrations`;
+DROP TABLE IF EXISTS predefined_smpp_gateways;
 
-DROP TABLE IF EXISTS `api_keys`;
+DROP TABLE IF EXISTS predefined_carriers;
 
-DROP TABLE IF EXISTS `accounts`;
+DROP TABLE IF EXISTS account_offers;
 
-DROP TABLE IF EXISTS `service_providers`;
+DROP TABLE IF EXISTS products;
 
-DROP TABLE IF EXISTS `sip_gateways`;
+DROP TABLE IF EXISTS schema_version;
 
-DROP TABLE IF EXISTS `voip_carriers`;
+DROP TABLE IF EXISTS api_keys;
 
-CREATE TABLE IF NOT EXISTS `applications`
+DROP TABLE IF EXISTS sbc_addresses;
+
+DROP TABLE IF EXISTS ms_teams_tenants;
+
+DROP TABLE IF EXISTS signup_history;
+
+DROP TABLE IF EXISTS smpp_addresses;
+
+DROP TABLE IF EXISTS speech_credentials;
+
+DROP TABLE IF EXISTS users;
+
+DROP TABLE IF EXISTS smpp_gateways;
+
+DROP TABLE IF EXISTS phone_numbers;
+
+DROP TABLE IF EXISTS sip_gateways;
+
+DROP TABLE IF EXISTS voip_carriers;
+
+DROP TABLE IF EXISTS accounts;
+
+DROP TABLE IF EXISTS applications;
+
+DROP TABLE IF EXISTS service_providers;
+
+DROP TABLE IF EXISTS webhooks;
+
+CREATE TABLE account_static_ips
 (
-`application_sid` CHAR(36) NOT NULL UNIQUE ,
-`name` VARCHAR(255) NOT NULL,
-`account_sid` CHAR(36) NOT NULL,
-`call_hook` VARCHAR(255) NOT NULL,
-`call_status_hook` VARCHAR(255) NOT NULL,
-PRIMARY KEY (`application_sid`)
-) ENGINE=InnoDB COMMENT='A defined set of behaviors to be applied to phone calls with';
-
-CREATE TABLE IF NOT EXISTS `call_routes`
-(
-`call_route_sid` CHAR(36) NOT NULL UNIQUE ,
-`order` INTEGER NOT NULL,
-`account_sid` CHAR(36) NOT NULL,
-`regex` VARCHAR(255) NOT NULL,
-`application_sid` CHAR(36) NOT NULL,
-PRIMARY KEY (`call_route_sid`)
-) ENGINE=InnoDB;
-
-CREATE TABLE IF NOT EXISTS `conferences`
-(
-`id` INTEGER(10) UNSIGNED NOT NULL AUTO_INCREMENT UNIQUE ,
-`conference_sid` CHAR(36) NOT NULL UNIQUE ,
-`name` VARCHAR(255),
-PRIMARY KEY (`id`)
-) ENGINE=InnoDB COMMENT='An audio conference';
-
-CREATE TABLE IF NOT EXISTS `conference_participants`
-(
-`conference_participant_sid` CHAR(36) NOT NULL UNIQUE ,
-`call_sid` CHAR(36),
-`conference_sid` CHAR(36) NOT NULL,
-PRIMARY KEY (`conference_participant_sid`)
-) ENGINE=InnoDB COMMENT='A relationship between a call and a conference that it is co';
-
-CREATE TABLE IF NOT EXISTS `queues`
-(
-`id` INTEGER(10) UNSIGNED NOT NULL AUTO_INCREMENT UNIQUE ,
-`queue_sid` CHAR(36) NOT NULL UNIQUE ,
-`name` VARCHAR(255),
-PRIMARY KEY (`id`)
-) ENGINE=InnoDB COMMENT='A set of behaviors to be applied to parked calls';
-
-CREATE TABLE IF NOT EXISTS `registrations`
-(
-`registration_sid` CHAR(36) NOT NULL UNIQUE ,
-`username` VARCHAR(255) NOT NULL,
-`domain` VARCHAR(255) NOT NULL,
-`sip_contact` VARCHAR(255) NOT NULL,
-`sip_user_agent` VARCHAR(255),
-PRIMARY KEY (`registration_sid`)
-) ENGINE=InnoDB COMMENT='An active sip registration';
-
-CREATE TABLE IF NOT EXISTS `queue_members`
-(
-`queue_member_sid` CHAR(36) NOT NULL UNIQUE ,
-`call_sid` CHAR(36),
-`queue_sid` CHAR(36) NOT NULL,
-`position` INTEGER,
-PRIMARY KEY (`queue_member_sid`)
-) ENGINE=InnoDB COMMENT='A relationship between a call and a queue that it is waiting';
-
-CREATE TABLE IF NOT EXISTS `calls`
-(
-`call_sid` CHAR(36) NOT NULL UNIQUE ,
-`parent_call_sid` CHAR(36),
-`application_sid` CHAR(36),
-`status_url` VARCHAR(255),
-`time_start` DATETIME NOT NULL,
-`time_alerting` DATETIME,
-`time_answered` DATETIME,
-`time_ended` DATETIME,
-`direction` ENUM('inbound','outbound'),
-`phone_number_sid` CHAR(36),
-`inbound_user_sid` CHAR(36),
-`outbound_user_sid` CHAR(36),
-`calling_number` VARCHAR(255),
-`called_number` VARCHAR(255),
-`caller_name` VARCHAR(255),
-`status` VARCHAR(255) NOT NULL COMMENT 'Possible values are queued, ringing, in-progress, completed, failed, busy and no-answer',
-`sip_uri` VARCHAR(255) NOT NULL,
-`sip_call_id` VARCHAR(255) NOT NULL,
-`sip_cseq` INTEGER NOT NULL,
-`sip_from_tag` VARCHAR(255) NOT NULL,
-`sip_via_branch` VARCHAR(255) NOT NULL,
-`sip_contact` VARCHAR(255),
-`sip_final_status` INTEGER UNSIGNED,
-`sdp_offer` VARCHAR(4096),
-`sdp_answer` VARCHAR(4096),
-`source_address` VARCHAR(255) NOT NULL,
-`source_port` INTEGER UNSIGNED NOT NULL,
-`dest_address` VARCHAR(255),
-`dest_port` INTEGER UNSIGNED,
-`url` VARCHAR(255),
-PRIMARY KEY (`call_sid`)
-) ENGINE=InnoDB COMMENT='A phone call';
-
-CREATE TABLE IF NOT EXISTS `service_providers`
-(
-`service_provider_sid` CHAR(36) NOT NULL UNIQUE ,
-`name` VARCHAR(255) NOT NULL UNIQUE ,
-`description` VARCHAR(255),
-`root_domain` VARCHAR(255) UNIQUE ,
-`registration_hook` VARCHAR(255),
-`hook_basic_auth_user` VARCHAR(255),
-`hook_basic_auth_password` VARCHAR(255),
-PRIMARY KEY (`service_provider_sid`)
-) ENGINE=InnoDB COMMENT='An organization that provides communication services to its ';
-
-CREATE TABLE IF NOT EXISTS `api_keys`
-(
-`api_key_sid` CHAR(36) NOT NULL UNIQUE ,
-`token` CHAR(36) NOT NULL UNIQUE ,
-`account_sid` CHAR(36),
-`service_provider_sid` CHAR(36),
-PRIMARY KEY (`api_key_sid`)
-) ENGINE=InnoDB COMMENT='An authorization token that is used to access the REST api';
-
-CREATE TABLE IF NOT EXISTS `accounts`
-(
-`account_sid` CHAR(36) NOT NULL UNIQUE ,
-`name` VARCHAR(255) NOT NULL,
-`sip_realm` VARCHAR(255) UNIQUE ,
-`service_provider_sid` CHAR(36) NOT NULL,
-`registration_hook` VARCHAR(255),
-`hook_basic_auth_user` VARCHAR(255),
-`hook_basic_auth_password` VARCHAR(255),
-`is_active` BOOLEAN NOT NULL DEFAULT true,
-PRIMARY KEY (`account_sid`)
-) ENGINE=InnoDB COMMENT='A single end-user of the platform';
-
-CREATE TABLE IF NOT EXISTS `subscriptions`
-(
-`id` INTEGER(10) UNSIGNED NOT NULL AUTO_INCREMENT UNIQUE ,
-`subscription_sid` CHAR(36) NOT NULL UNIQUE ,
-`registration_sid` CHAR(36) NOT NULL,
-`event` VARCHAR(255),
-PRIMARY KEY (`id`)
-) ENGINE=InnoDB COMMENT='An active sip subscription';
-
-CREATE TABLE IF NOT EXISTS `voip_carriers`
-(
-`voip_carrier_sid` CHAR(36) NOT NULL UNIQUE ,
-`name` VARCHAR(255) NOT NULL UNIQUE ,
-`description` VARCHAR(255),
-PRIMARY KEY (`voip_carrier_sid`)
-) ENGINE=InnoDB COMMENT='An external organization that can provide sip trunking and D';
-
-CREATE TABLE IF NOT EXISTS `phone_numbers`
-(
-`phone_number_sid` CHAR(36) UNIQUE ,
-`number` VARCHAR(255) NOT NULL UNIQUE ,
-`voip_carrier_sid` CHAR(36) NOT NULL,
-`account_sid` CHAR(36),
-`application_sid` CHAR(36),
-PRIMARY KEY (`phone_number_sid`)
-) ENGINE=InnoDB COMMENT='A phone number that has been assigned to an account';
-
-CREATE TABLE IF NOT EXISTS `sip_gateways`
-(
-`sip_gateway_sid` CHAR(36),
-`ipv4` VARCHAR(32) NOT NULL,
-`port` INTEGER NOT NULL DEFAULT 5060,
-`inbound` BOOLEAN NOT NULL,
-`outbound` BOOLEAN NOT NULL,
-`voip_carrier_sid` CHAR(36) NOT NULL,
-`is_active` BOOLEAN NOT NULL DEFAULT true,
-PRIMARY KEY (`sip_gateway_sid`)
+account_static_ip_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+public_ipv4 VARCHAR(16) NOT NULL UNIQUE ,
+private_ipv4 VARBINARY(16) NOT NULL UNIQUE ,
+PRIMARY KEY (account_static_ip_sid)
 );
 
-CREATE UNIQUE INDEX `applications_idx_name` ON `applications` (`account_sid`,`name`);
+CREATE TABLE account_subscriptions
+(
+account_subscription_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+pending BOOLEAN NOT NULL DEFAULT false,
+effective_start_date DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+effective_end_date DATETIME,
+change_reason VARCHAR(255),
+stripe_subscription_id VARCHAR(56),
+stripe_payment_method_id VARCHAR(56),
+stripe_statement_descriptor VARCHAR(255),
+last4 VARCHAR(512),
+exp_month INTEGER,
+exp_year INTEGER,
+card_type VARCHAR(16),
+pending_reason VARBINARY(52),
+PRIMARY KEY (account_subscription_sid)
+);
 
-CREATE INDEX `applications_application_sid_idx` ON `applications` (`application_sid`);
-CREATE INDEX `applications_name_idx` ON `applications` (`name`);
-CREATE INDEX `applications_account_sid_idx` ON `applications` (`account_sid`);
-ALTER TABLE `applications` ADD FOREIGN KEY account_sid_idxfk (`account_sid`) REFERENCES `accounts` (`account_sid`);
+CREATE TABLE beta_invite_codes
+(
+invite_code CHAR(6) NOT NULL UNIQUE ,
+in_use BOOLEAN NOT NULL DEFAULT false,
+PRIMARY KEY (invite_code)
+);
 
-CREATE INDEX `call_routes_call_route_sid_idx` ON `call_routes` (`call_route_sid`);
-ALTER TABLE `call_routes` ADD FOREIGN KEY account_sid_idxfk_1 (`account_sid`) REFERENCES `accounts` (`account_sid`);
+CREATE TABLE call_routes
+(
+call_route_sid CHAR(36) NOT NULL UNIQUE ,
+priority INTEGER NOT NULL,
+account_sid CHAR(36) NOT NULL,
+regex VARCHAR(255) NOT NULL,
+application_sid CHAR(36) NOT NULL,
+PRIMARY KEY (call_route_sid)
+) COMMENT='a regex-based pattern match for call routing';
 
-ALTER TABLE `call_routes` ADD FOREIGN KEY application_sid_idxfk (`application_sid`) REFERENCES `applications` (`application_sid`);
+CREATE TABLE dns_records
+(
+dns_record_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+record_type VARCHAR(6) NOT NULL,
+record_id INTEGER NOT NULL,
+PRIMARY KEY (dns_record_sid)
+);
 
-CREATE INDEX `conferences_conference_sid_idx` ON `conferences` (`conference_sid`);
-CREATE INDEX `conference_participants_conference_participant_sid_idx` ON `conference_participants` (`conference_participant_sid`);
-ALTER TABLE `conference_participants` ADD FOREIGN KEY call_sid_idxfk (`call_sid`) REFERENCES `calls` (`call_sid`);
+CREATE TABLE lcr_routes
+(
+lcr_route_sid CHAR(36),
+regex VARCHAR(32) NOT NULL COMMENT 'regex-based pattern match against dialed number, used for LCR routing of PSTN calls',
+description VARCHAR(1024),
+priority INTEGER NOT NULL UNIQUE  COMMENT 'lower priority routes are attempted first',
+PRIMARY KEY (lcr_route_sid)
+) COMMENT='Least cost routing table';
 
-ALTER TABLE `conference_participants` ADD FOREIGN KEY conference_sid_idxfk (`conference_sid`) REFERENCES `conferences` (`conference_sid`);
+CREATE TABLE predefined_carriers
+(
+predefined_carrier_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
+requires_static_ip BOOLEAN NOT NULL DEFAULT false,
+e164_leading_plus BOOLEAN NOT NULL DEFAULT false COMMENT 'if true, a leading plus should be prepended to outbound phone numbers',
+requires_register BOOLEAN NOT NULL DEFAULT false,
+register_username VARCHAR(64),
+register_sip_realm VARCHAR(64),
+register_password VARCHAR(64),
+tech_prefix VARCHAR(16) COMMENT 'tech prefix to prepend to outbound calls to this carrier',
+inbound_auth_username VARCHAR(64),
+inbound_auth_password VARCHAR(64),
+diversion VARCHAR(32),
+PRIMARY KEY (predefined_carrier_sid)
+);
 
-CREATE INDEX `queues_queue_sid_idx` ON `queues` (`queue_sid`);
-CREATE INDEX `registrations_registration_sid_idx` ON `registrations` (`registration_sid`);
-CREATE INDEX `queue_members_queue_member_sid_idx` ON `queue_members` (`queue_member_sid`);
-ALTER TABLE `queue_members` ADD FOREIGN KEY call_sid_idxfk_1 (`call_sid`) REFERENCES `calls` (`call_sid`);
+CREATE TABLE predefined_sip_gateways
+(
+predefined_sip_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway.  For gateways providing inbound calling service, ip address is required.',
+port INTEGER NOT NULL DEFAULT 5060 COMMENT 'sip signaling port',
+inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+outbound BOOLEAN NOT NULL COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+netmask INTEGER NOT NULL DEFAULT 32,
+predefined_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (predefined_sip_gateway_sid)
+);
 
-ALTER TABLE `queue_members` ADD FOREIGN KEY queue_sid_idxfk (`queue_sid`) REFERENCES `queues` (`queue_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 INDEX `calls_call_sid_idx` ON `calls` (`call_sid`);
-ALTER TABLE `calls` ADD FOREIGN KEY parent_call_sid_idxfk (`parent_call_sid`) REFERENCES `calls` (`call_sid`);
+CREATE TABLE products
+(
+product_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(32) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device') NOT NULL,
+PRIMARY KEY (product_sid)
+);
 
-ALTER TABLE `calls` ADD FOREIGN KEY application_sid_idxfk_1 (`application_sid`) REFERENCES `applications` (`application_sid`);
+CREATE TABLE account_products
+(
+account_product_sid CHAR(36) NOT NULL UNIQUE ,
+account_subscription_sid CHAR(36) NOT NULL,
+product_sid CHAR(36) NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (account_product_sid)
+);
 
-CREATE INDEX `calls_phone_number_sid_idx` ON `calls` (`phone_number_sid`);
-ALTER TABLE `calls` ADD FOREIGN KEY phone_number_sid_idxfk (`phone_number_sid`) REFERENCES `phone_numbers` (`phone_number_sid`);
+CREATE TABLE account_offers
+(
+account_offer_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+product_sid CHAR(36) NOT NULL,
+stripe_product_id VARCHAR(56) NOT NULL,
+PRIMARY KEY (account_offer_sid)
+);
 
-ALTER TABLE `calls` ADD FOREIGN KEY inbound_user_sid_idxfk (`inbound_user_sid`) REFERENCES `registrations` (`registration_sid`);
+CREATE TABLE schema_version
+(
+version VARCHAR(16)
+);
 
-ALTER TABLE `calls` ADD FOREIGN KEY outbound_user_sid_idxfk (`outbound_user_sid`) REFERENCES `registrations` (`registration_sid`);
+CREATE TABLE api_keys
+(
+api_key_sid CHAR(36) NOT NULL UNIQUE ,
+token CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36),
+service_provider_sid CHAR(36),
+expires_at TIMESTAMP NULL  DEFAULT NULL,
+last_used TIMESTAMP NULL  DEFAULT NULL,
+created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (api_key_sid)
+) COMMENT='An authorization token that is used to access the REST api';
 
-CREATE INDEX `service_providers_service_provider_sid_idx` ON `service_providers` (`service_provider_sid`);
-CREATE INDEX `service_providers_name_idx` ON `service_providers` (`name`);
-CREATE INDEX `service_providers_root_domain_idx` ON `service_providers` (`root_domain`);
-CREATE INDEX `api_keys_api_key_sid_idx` ON `api_keys` (`api_key_sid`);
-CREATE INDEX `api_keys_account_sid_idx` ON `api_keys` (`account_sid`);
-ALTER TABLE `api_keys` ADD FOREIGN KEY account_sid_idxfk_2 (`account_sid`) REFERENCES `accounts` (`account_sid`);
+CREATE TABLE sbc_addresses
+(
+sbc_address_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(255) NOT NULL,
+port INTEGER NOT NULL DEFAULT 5060,
+service_provider_sid CHAR(36),
+PRIMARY KEY (sbc_address_sid)
+);
 
-CREATE INDEX `api_keys_service_provider_sid_idx` ON `api_keys` (`service_provider_sid`);
-ALTER TABLE `api_keys` ADD FOREIGN KEY service_provider_sid_idxfk (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`);
+CREATE TABLE ms_teams_tenants
+(
+ms_teams_tenant_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36) NOT NULL,
+account_sid CHAR(36) NOT NULL,
+application_sid CHAR(36),
+tenant_fqdn VARCHAR(255) NOT NULL UNIQUE ,
+PRIMARY KEY (ms_teams_tenant_sid)
+) COMMENT='A Microsoft Teams customer tenant';
 
-CREATE INDEX `accounts_account_sid_idx` ON `accounts` (`account_sid`);
-CREATE INDEX `accounts_name_idx` ON `accounts` (`name`);
-CREATE INDEX `accounts_sip_realm_idx` ON `accounts` (`sip_realm`);
-CREATE INDEX `accounts_service_provider_sid_idx` ON `accounts` (`service_provider_sid`);
-ALTER TABLE `accounts` ADD FOREIGN KEY service_provider_sid_idxfk_1 (`service_provider_sid`) REFERENCES `service_providers` (`service_provider_sid`);
+CREATE TABLE signup_history
+(
+email VARCHAR(255) NOT NULL,
+name VARCHAR(255),
+signed_up_at DATETIME DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (email)
+);
 
-ALTER TABLE `subscriptions` ADD FOREIGN KEY registration_sid_idxfk (`registration_sid`) REFERENCES `registrations` (`registration_sid`);
+CREATE TABLE smpp_addresses
+(
+smpp_address_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(255) NOT NULL,
+port INTEGER NOT NULL DEFAULT 5060,
+use_tls BOOLEAN NOT NULL DEFAULT 0,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+service_provider_sid CHAR(36),
+PRIMARY KEY (smpp_address_sid)
+);
 
-CREATE INDEX `voip_carriers_voip_carrier_sid_idx` ON `voip_carriers` (`voip_carrier_sid`);
-CREATE INDEX `voip_carriers_name_idx` ON `voip_carriers` (`name`);
-CREATE INDEX `phone_numbers_phone_number_sid_idx` ON `phone_numbers` (`phone_number_sid`);
-CREATE INDEX `phone_numbers_voip_carrier_sid_idx` ON `phone_numbers` (`voip_carrier_sid`);
-ALTER TABLE `phone_numbers` ADD FOREIGN KEY voip_carrier_sid_idxfk (`voip_carrier_sid`) REFERENCES `voip_carriers` (`voip_carrier_sid`);
+CREATE TABLE speech_credentials
+(
+speech_credential_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36),
+account_sid CHAR(36),
+vendor VARCHAR(32) NOT NULL,
+credential VARCHAR(8192) NOT NULL,
+use_for_tts BOOLEAN DEFAULT true,
+use_for_stt BOOLEAN DEFAULT true,
+last_used DATETIME,
+last_tested DATETIME,
+tts_tested_ok BOOLEAN,
+stt_tested_ok BOOLEAN,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (speech_credential_sid)
+);
 
-ALTER TABLE `phone_numbers` ADD FOREIGN KEY account_sid_idxfk_3 (`account_sid`) REFERENCES `accounts` (`account_sid`);
+CREATE TABLE users
+(
+user_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(255) NOT NULL,
+email VARCHAR(255) NOT NULL,
+pending_email VARCHAR(255),
+phone VARCHAR(20) UNIQUE ,
+hashed_password VARCHAR(1024),
+account_sid CHAR(36),
+service_provider_sid CHAR(36),
+force_change BOOLEAN NOT NULL DEFAULT FALSE,
+provider VARCHAR(255) NOT NULL,
+provider_userid VARCHAR(255),
+scope VARCHAR(16) NOT NULL DEFAULT 'read-write',
+phone_activation_code VARCHAR(16),
+email_activation_code VARCHAR(16),
+email_validated BOOLEAN NOT NULL DEFAULT false,
+phone_validated BOOLEAN NOT NULL DEFAULT false,
+email_content_opt_out BOOLEAN NOT NULL DEFAULT false,
+PRIMARY KEY (user_sid)
+);
 
-ALTER TABLE `phone_numbers` ADD FOREIGN KEY application_sid_idxfk_2 (`application_sid`) REFERENCES `applications` (`application_sid`);
+CREATE TABLE voip_carriers
+(
+voip_carrier_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
+description VARCHAR(255),
+account_sid CHAR(36) COMMENT 'if provided, indicates this entity represents a sip trunk that is associated with a specific account',
+service_provider_sid CHAR(36),
+application_sid CHAR(36) COMMENT 'If provided, all incoming calls from this source will be routed to the associated application',
+e164_leading_plus BOOLEAN NOT NULL DEFAULT false COMMENT 'if true, a leading plus should be prepended to outbound phone numbers',
+requires_register BOOLEAN NOT NULL DEFAULT false,
+register_username VARCHAR(64),
+register_sip_realm VARCHAR(64),
+register_password VARCHAR(64),
+tech_prefix VARCHAR(16) COMMENT 'tech prefix to prepend to outbound calls to this carrier',
+inbound_auth_username VARCHAR(64),
+inbound_auth_password VARCHAR(64),
+diversion VARCHAR(32),
+is_active BOOLEAN NOT NULL DEFAULT true,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+smpp_system_id VARCHAR(255),
+smpp_password VARCHAR(64),
+smpp_enquire_link_interval INTEGER DEFAULT 0,
+smpp_inbound_system_id VARCHAR(255),
+smpp_inbound_password VARCHAR(64),
+PRIMARY KEY (voip_carrier_sid)
+) COMMENT='A Carrier or customer PBX that can send or receive calls';
 
-CREATE UNIQUE INDEX `sip_gateways_sip_gateway_idx_hostport` ON `sip_gateways` (`ipv4`,`port`);
+CREATE TABLE smpp_gateways
+(
+smpp_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL,
+port INTEGER NOT NULL DEFAULT 2775,
+netmask INTEGER NOT NULL DEFAULT 32,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+inbound BOOLEAN NOT NULL DEFAULT 0 COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+outbound BOOLEAN NOT NULL DEFAULT 1 COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+use_tls BOOLEAN DEFAULT 0,
+voip_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (smpp_gateway_sid)
+);
 
-ALTER TABLE `sip_gateways` ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (`voip_carrier_sid`) REFERENCES `voip_carriers` (`voip_carrier_sid`);
+CREATE TABLE phone_numbers
+(
+phone_number_sid CHAR(36) UNIQUE ,
+number VARCHAR(32) NOT NULL UNIQUE ,
+voip_carrier_sid CHAR(36),
+account_sid CHAR(36),
+application_sid CHAR(36),
+service_provider_sid CHAR(36) COMMENT 'if not null, this number is a test number for the associated service provider',
+PRIMARY KEY (phone_number_sid)
+) COMMENT='A phone number that has been assigned to an account';
+
+CREATE TABLE sip_gateways
+(
+sip_gateway_sid CHAR(36),
+ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway.  For gateways providing inbound calling service, ip address is required.',
+netmask INTEGER NOT NULL DEFAULT 32,
+port INTEGER NOT NULL DEFAULT 5060 COMMENT 'sip signaling port',
+inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+outbound BOOLEAN NOT NULL COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+voip_carrier_sid CHAR(36) NOT NULL,
+is_active BOOLEAN NOT NULL DEFAULT 1,
+PRIMARY KEY (sip_gateway_sid)
+) COMMENT='A whitelisted sip gateway used for origination/termination';
+
+CREATE TABLE lcr_carrier_set_entry
+(
+lcr_carrier_set_entry_sid CHAR(36),
+workload INTEGER NOT NULL DEFAULT 1 COMMENT 'represents a proportion of traffic to send through the associated carrier; can be used for load balancing traffic across carriers with a common priority for a destination',
+lcr_route_sid CHAR(36) NOT NULL,
+voip_carrier_sid CHAR(36) NOT NULL,
+priority INTEGER NOT NULL DEFAULT 0 COMMENT 'lower priority carriers are attempted first',
+PRIMARY KEY (lcr_carrier_set_entry_sid)
+) COMMENT='An entry in the LCR routing list';
+
+CREATE TABLE webhooks
+(
+webhook_sid CHAR(36) NOT NULL UNIQUE ,
+url VARCHAR(1024) NOT NULL,
+method ENUM("GET","POST") NOT NULL DEFAULT 'POST',
+username VARCHAR(255),
+password VARCHAR(255),
+PRIMARY KEY (webhook_sid)
+) COMMENT='An HTTP callback';
+
+CREATE TABLE applications
+(
+application_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
+service_provider_sid CHAR(36) COMMENT 'if non-null, this application is a test application that can be used by any account under the associated service provider',
+account_sid CHAR(36) COMMENT 'account that this application belongs to (if null, this is a service provider test application)',
+call_hook_sid CHAR(36) COMMENT 'webhook to call for inbound calls ',
+call_status_hook_sid CHAR(36) COMMENT 'webhook to call for call status events',
+messaging_hook_sid CHAR(36) COMMENT 'webhook to call for inbound SMS/MMS ',
+speech_synthesis_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
+speech_synthesis_language VARCHAR(12) NOT NULL DEFAULT 'en-US',
+speech_synthesis_voice VARCHAR(64),
+speech_recognizer_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
+speech_recognizer_language VARCHAR(64) NOT NULL DEFAULT 'en-US',
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (application_sid)
+) COMMENT='A defined set of behaviors to be applied to phone calls ';
+
+CREATE TABLE service_providers
+(
+service_provider_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL UNIQUE ,
+description VARCHAR(255),
+root_domain VARCHAR(128) UNIQUE ,
+registration_hook_sid CHAR(36),
+ms_teams_fqdn VARCHAR(255),
+PRIMARY KEY (service_provider_sid)
+) COMMENT='A partition of the platform used by one service provider';
+
+CREATE TABLE accounts
+(
+account_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
+sip_realm VARCHAR(132) UNIQUE  COMMENT 'sip domain that will be used for devices registering under this account',
+service_provider_sid CHAR(36) NOT NULL COMMENT 'service provider that owns the customer relationship with this account',
+registration_hook_sid CHAR(36) COMMENT 'webhook to call when devices underr this account attempt to register',
+queue_event_hook_sid CHAR(36),
+device_calling_application_sid CHAR(36) COMMENT 'application to use for outbound calling from an account',
+is_active BOOLEAN NOT NULL DEFAULT true,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+plan_type ENUM('trial','free','paid') NOT NULL DEFAULT 'trial',
+stripe_customer_id VARCHAR(56),
+webhook_secret VARCHAR(36) NOT NULL,
+disable_cdrs BOOLEAN NOT NULL DEFAULT 0,
+trial_end_date DATETIME,
+deactivated_reason VARCHAR(255),
+device_to_call_ratio INTEGER NOT NULL DEFAULT 5,
+PRIMARY KEY (account_sid)
+) COMMENT='An enterprise that uses the platform for comm services';
+
+CREATE INDEX account_static_ip_sid_idx ON account_static_ips (account_static_ip_sid);
+CREATE INDEX account_sid_idx ON account_static_ips (account_sid);
+ALTER TABLE account_static_ips ADD FOREIGN KEY account_sid_idxfk (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX account_subscription_sid_idx ON account_subscriptions (account_subscription_sid);
+CREATE INDEX account_sid_idx ON account_subscriptions (account_sid);
+ALTER TABLE account_subscriptions ADD FOREIGN KEY account_sid_idxfk_1 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX invite_code_idx ON beta_invite_codes (invite_code);
+CREATE INDEX call_route_sid_idx ON call_routes (call_route_sid);
+ALTER TABLE call_routes ADD FOREIGN KEY account_sid_idxfk_2 (account_sid) REFERENCES accounts (account_sid);
+
+ALTER TABLE call_routes ADD FOREIGN KEY application_sid_idxfk (application_sid) REFERENCES applications (application_sid);
+
+CREATE INDEX dns_record_sid_idx ON dns_records (dns_record_sid);
+ALTER TABLE dns_records ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX predefined_carrier_sid_idx ON predefined_carriers (predefined_carrier_sid);
+CREATE INDEX predefined_sip_gateway_sid_idx ON predefined_sip_gateways (predefined_sip_gateway_sid);
+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);
+ALTER TABLE account_products ADD FOREIGN KEY account_subscription_sid_idxfk (account_subscription_sid) REFERENCES account_subscriptions (account_subscription_sid);
+
+ALTER TABLE account_products ADD FOREIGN KEY product_sid_idxfk (product_sid) REFERENCES products (product_sid);
+
+CREATE INDEX account_offer_sid_idx ON account_offers (account_offer_sid);
+CREATE INDEX account_sid_idx ON account_offers (account_sid);
+ALTER TABLE account_offers ADD FOREIGN KEY account_sid_idxfk_4 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX product_sid_idx ON account_offers (product_sid);
+ALTER TABLE account_offers ADD FOREIGN KEY product_sid_idxfk_1 (product_sid) REFERENCES products (product_sid);
+
+CREATE INDEX api_key_sid_idx ON api_keys (api_key_sid);
+CREATE INDEX account_sid_idx ON api_keys (account_sid);
+ALTER TABLE api_keys ADD FOREIGN KEY account_sid_idxfk_5 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX service_provider_sid_idx ON api_keys (service_provider_sid);
+ALTER TABLE api_keys ADD FOREIGN KEY service_provider_sid_idxfk (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX sbc_addresses_idx_host_port ON sbc_addresses (ipv4,port);
+
+CREATE INDEX sbc_address_sid_idx ON sbc_addresses (sbc_address_sid);
+CREATE INDEX service_provider_sid_idx ON sbc_addresses (service_provider_sid);
+ALTER TABLE sbc_addresses ADD FOREIGN KEY service_provider_sid_idxfk_1 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX ms_teams_tenant_sid_idx ON ms_teams_tenants (ms_teams_tenant_sid);
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY service_provider_sid_idxfk_2 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY account_sid_idxfk_6 (account_sid) REFERENCES accounts (account_sid);
+
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY application_sid_idxfk_1 (application_sid) REFERENCES applications (application_sid);
+
+CREATE INDEX tenant_fqdn_idx ON ms_teams_tenants (tenant_fqdn);
+CREATE INDEX email_idx ON signup_history (email);
+CREATE INDEX smpp_address_sid_idx ON smpp_addresses (smpp_address_sid);
+CREATE INDEX service_provider_sid_idx ON smpp_addresses (service_provider_sid);
+ALTER TABLE smpp_addresses ADD FOREIGN KEY service_provider_sid_idxfk_3 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE UNIQUE INDEX speech_credentials_idx_1 ON speech_credentials (vendor,account_sid);
+
+CREATE INDEX speech_credential_sid_idx ON speech_credentials (speech_credential_sid);
+CREATE INDEX service_provider_sid_idx ON speech_credentials (service_provider_sid);
+ALTER TABLE speech_credentials ADD FOREIGN KEY service_provider_sid_idxfk_4 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX account_sid_idx ON speech_credentials (account_sid);
+ALTER TABLE speech_credentials ADD FOREIGN KEY account_sid_idxfk_7 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX user_sid_idx ON users (user_sid);
+CREATE INDEX email_idx ON users (email);
+CREATE INDEX phone_idx ON users (phone);
+CREATE INDEX account_sid_idx ON users (account_sid);
+ALTER TABLE users ADD FOREIGN KEY account_sid_idxfk_8 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX service_provider_sid_idx ON users (service_provider_sid);
+ALTER TABLE users ADD FOREIGN KEY service_provider_sid_idxfk_5 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX email_activation_code_idx ON users (email_activation_code);
+CREATE INDEX voip_carrier_sid_idx ON voip_carriers (voip_carrier_sid);
+CREATE INDEX account_sid_idx ON voip_carriers (account_sid);
+ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_9 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX service_provider_sid_idx ON voip_carriers (service_provider_sid);
+ALTER TABLE voip_carriers ADD FOREIGN KEY service_provider_sid_idxfk_6 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+ALTER TABLE voip_carriers ADD FOREIGN KEY application_sid_idxfk_2 (application_sid) REFERENCES applications (application_sid);
+
+CREATE INDEX smpp_gateway_sid_idx ON smpp_gateways (smpp_gateway_sid);
+CREATE INDEX voip_carrier_sid_idx ON smpp_gateways (voip_carrier_sid);
+ALTER TABLE smpp_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
+CREATE INDEX phone_number_sid_idx ON phone_numbers (phone_number_sid);
+CREATE INDEX number_idx ON phone_numbers (number);
+CREATE INDEX voip_carrier_sid_idx ON phone_numbers (voip_carrier_sid);
+ALTER TABLE phone_numbers ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
+ALTER TABLE phone_numbers ADD FOREIGN KEY account_sid_idxfk_10 (account_sid) REFERENCES accounts (account_sid);
+
+ALTER TABLE phone_numbers ADD FOREIGN KEY application_sid_idxfk_3 (application_sid) REFERENCES applications (application_sid);
+
+CREATE INDEX service_provider_sid_idx ON phone_numbers (service_provider_sid);
+ALTER TABLE phone_numbers ADD FOREIGN KEY service_provider_sid_idxfk_7 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX sip_gateway_idx_hostport ON sip_gateways (ipv4,port);
+
+CREATE INDEX voip_carrier_sid_idx ON sip_gateways (voip_carrier_sid);
+ALTER TABLE sip_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk_2 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
+ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY lcr_route_sid_idxfk (lcr_route_sid) REFERENCES lcr_routes (lcr_route_sid);
+
+ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY voip_carrier_sid_idxfk_3 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
+CREATE INDEX webhook_sid_idx ON webhooks (webhook_sid);
+CREATE UNIQUE INDEX applications_idx_name ON applications (account_sid,name);
+
+CREATE INDEX application_sid_idx ON applications (application_sid);
+CREATE INDEX service_provider_sid_idx ON applications (service_provider_sid);
+ALTER TABLE applications ADD FOREIGN KEY service_provider_sid_idxfk_8 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX account_sid_idx ON applications (account_sid);
+ALTER TABLE applications ADD FOREIGN KEY account_sid_idxfk_11 (account_sid) REFERENCES accounts (account_sid);
+
+ALTER TABLE applications ADD FOREIGN KEY call_hook_sid_idxfk (call_hook_sid) REFERENCES webhooks (webhook_sid);
+
+ALTER TABLE applications ADD FOREIGN KEY call_status_hook_sid_idxfk (call_status_hook_sid) REFERENCES webhooks (webhook_sid);
+
+ALTER TABLE applications ADD FOREIGN KEY messaging_hook_sid_idxfk (messaging_hook_sid) REFERENCES webhooks (webhook_sid);
+
+CREATE INDEX service_provider_sid_idx ON service_providers (service_provider_sid);
+CREATE INDEX name_idx ON service_providers (name);
+CREATE INDEX root_domain_idx ON service_providers (root_domain);
+ALTER TABLE service_providers ADD FOREIGN KEY registration_hook_sid_idxfk (registration_hook_sid) REFERENCES webhooks (webhook_sid);
+
+CREATE INDEX account_sid_idx ON accounts (account_sid);
+CREATE INDEX sip_realm_idx ON accounts (sip_realm);
+CREATE INDEX service_provider_sid_idx ON accounts (service_provider_sid);
+ALTER TABLE accounts ADD FOREIGN KEY service_provider_sid_idxfk_9 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+ALTER TABLE accounts ADD FOREIGN KEY registration_hook_sid_idxfk_1 (registration_hook_sid) REFERENCES webhooks (webhook_sid);
+
+ALTER TABLE accounts ADD FOREIGN KEY queue_event_hook_sid_idxfk (queue_event_hook_sid) REFERENCES webhooks (webhook_sid);
+
+ALTER TABLE accounts ADD FOREIGN KEY device_calling_application_sid_idxfk (device_calling_application_sid) REFERENCES applications (application_sid);
+
+SET FOREIGN_KEY_CHECKS=0;

test/db/remove_test_db.sql

@@ -1,3 +1,3 @@
 DROP DATABASE jambones_test;
-REVOKE ALL PRIVILEGES, GRANT OPTION FROM 'jambones_test'@'localhost';
-DROP USER 'jambones_test'@'localhost';
+REVOKE ALL PRIVILEGES, GRANT OPTION FROM 'jambones_test'@'%';
+DROP USER 'jambones_test'@'%';

test/docker-compose-testbed.yaml

@@ -1,55 +1,132 @@
-version: '3'
-
+version: '3.9'
 networks:
-  sbc-inbound:
+  fs:
     driver: bridge
     ipam:
       config:
         - subnet: 172.38.0.0/16
 
 services:
-  sbc:
-    image: drachtio/drachtio-server:latest
-    command: drachtio --contact "sip:*;transport=udp" --loglevel debug --sofia-loglevel 9
+  mysql:
+    image: mysql:5.7
+    platform: linux/x86_64
     ports:
-      - "9060:9022/tcp"
+      - "3360:3306"
+    environment: 
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "127.0.0.1", "--protocol", "tcp"]
+      timeout: 5s
+      retries: 10
     networks:
-      sbc-inbound:
-        ipv4_address: 172.38.0.10
-
-  appserver:
-    image: drachtio/sipp:latest
-    command: sipp -sf /tmp/uas.xml
-    volumes:
-      - ./scenarios:/tmp
-    tty: true
-    networks:
-      sbc-inbound:
-        ipv4_address: 172.38.0.11
-
-  auth-server:
-    image: jambonz/customer-auth-server:latest
-    command: npm start
-    ports:
-      - "4000:4000/tcp"
-    env_file: docker.env
-    networks:
-      sbc-inbound:
-        ipv4_address: 172.38.0.12
+      fs:
+        ipv4_address: 172.38.0.5
 
   redis:
     image: redis:5-alpine
     ports:
       - "16379:6379/tcp"
+    depends_on:
+      - mysql
     networks:
-      sbc-inbound:
-        ipv4_address: 172.38.0.13
+      fs:
+        ipv4_address: 172.38.0.6
 
-  rtpengine:
-    image: drachtio/rtpengine:latest
+  docker-host:
+    image: qoomon/docker-host
+    cap_add: [ 'NET_ADMIN', 'NET_RAW' ]
+    mem_limit: 8M
+    restart: on-failure
+    networks:
+      fs:
+        ipv4_address: 172.38.0.7
+
+  drachtio:
+    image: drachtio/drachtio-server:latest
+    restart: always
+    command: drachtio --contact "sip:*;transport=udp,tcp" --address 0.0.0.0 --port 9022
     ports:
-      - "12222:22222/udp"
+      - "9060:9022/tcp"
     networks:
-      sbc-inbound:
-        ipv4_address: 172.38.0.14
+      fs:
+        ipv4_address: 172.38.0.50
+    depends_on:
+      mysql:
+        condition: service_healthy
+      freeswitch:
+        condition: service_healthy
 
+  freeswitch:
+    image: drachtio/drachtio-freeswitch-mrf:v1.10.1-full
+    restart: always
+    command: freeswitch --rtp-range-start 20000 --rtp-range-end 20100
+    environment:
+      GOOGLE_APPLICATION_CREDENTIALS: /opt/credentials/gcp.json
+    ports:
+      - "8022:8021/tcp"
+    volumes:
+      - /tmp:/tmp
+      - ./credentials:/opt/credentials
+    healthcheck:
+      test: ['CMD', 'fs_cli' ,'-x', '"sofia status"']
+      timeout: 5s
+      retries: 15
+    networks:
+      fs:
+        ipv4_address: 172.38.0.51
+
+  webhook-decline:
+    image: jambonz/webhook-test-scaffold:latest
+    environment:
+      APP_PATH: /tmp/decline.json
+    ports:
+      - "3100:3000/tcp"
+    volumes:
+      - ./test-apps:/tmp
+    networks:
+      fs:
+        ipv4_address: 172.38.0.60
+
+  webhook-say:
+    image: jambonz/webhook-test-scaffold:latest
+    environment:
+      APP_PATH: /tmp/say.json
+    ports:
+      - "3101:3000/tcp"
+    volumes:
+      - ./test-apps:/tmp
+    networks:
+      fs:
+        ipv4_address: 172.38.0.61
+
+  webhook-gather:
+    image: jambonz/webhook-test-scaffold:latest
+    environment:
+      APP_PATH: /tmp/gather.json
+    ports:
+      - "3102:3000/tcp"
+    volumes:
+      - ./test-apps:/tmp
+    networks:
+      fs:
+        ipv4_address: 172.38.0.62
+
+  webhook-transcribe:
+    image: jambonz/webhook-test-scaffold:latest
+    environment:
+      APP_PATH: /tmp/transcribe.json
+    ports:
+      - "3103:3000/tcp"
+    volumes:
+      - ./test-apps:/tmp
+    networks:
+      fs:
+        ipv4_address: 172.38.0.63
+
+  influxdb:
+    image: influxdb:1.8
+    ports:
+      - "8086:8086"
+    networks:
+      fs:
+        ipv4_address: 172.38.0.90

test/docker_start.js

@@ -1,9 +1,10 @@
-const test = require('tape').test ;
+const test = require('tape') ;
 const exec = require('child_process').exec ;
 const async = require('async');
 
-test('starting docker network..', (t) => {
+test('starting docker network..takes a bit for mysql and freeswitch to come up..patience..', (t) => {
   exec(`docker-compose -f ${__dirname}/docker-compose-testbed.yaml up -d`, (err, stdout, stderr) => {
+    t.pass('docker network is up');
     t.end(err);
   });
   

test/docker_stop.js

@@ -1,4 +1,4 @@
-const test = require('tape').test ;
+const test = require('tape') ;
 const exec = require('child_process').exec ;
 
 test('stopping docker network..', (t) => {

test/gather-tests.js

@@ -0,0 +1,36 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const bent = require('bent');
+const getJSON = bent('json')
+const clearModule = require('clear-module');
+
+process.on('unhandledRejection', (reason, p) => {
+  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+function connect(connectable) {
+  return new Promise((resolve, reject) => {
+    connectable.on('connect', () => {
+      return resolve();
+    });
+  });
+}
+
+test('\'gather\' and \'transcribe\' tests', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10');
+    let obj = await getJSON('http://127.0.0.1:3102/actionHook');
+    t.ok(obj.speech.alternatives[0].transcript = 'I\'d like to speak to customer support',
+      'gather: succeeds when using account credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/index.js

@@ -1,8 +1,9 @@
 require('./unit-tests');
-/*
 require('./docker_start');
 require('./create-test-db');
-require('./sip-tests');
+require('./account-validation-tests');
+require('./webhooks-tests');
+require('./say-tests');
+require('./gather-tests');
 require('./remove-test-db');
 require('./docker_stop');
-*/

test/remove-test-db.js

@@ -1,11 +1,11 @@
-const test = require('tape').test ;
+const test = require('tape') ;
 const exec = require('child_process').exec ;
-const pwd = process.env.TRAVIS ? '' : '-p$MYSQL_ROOT_PASSWORD';
-
+const fs = require('fs');
 test('dropping jambones_test database', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} < ${__dirname}/db/remove_test_db.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360 < ${__dirname}/db/remove_test_db.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('database successfully dropped');
+    fs.unlinkSync(`${__dirname}/credentials/gcp.json`);
     t.end();
   });
 });

test/say-tests.js

@@ -0,0 +1,32 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const clearModule = require('clear-module');
+
+process.on('unhandledRejection', (reason, p) => {
+  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+function connect(connectable) {
+  return new Promise((resolve, reject) => {
+    connectable.on('connect', () => {
+      return resolve();
+    });
+  });
+}
+
+test('\'say\' tests', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    await sippUac('uac-say-account-creds-success.xml', '172.38.0.10');
+    t.pass('say: succeeds when using using account credentials');
+  
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/scenarios/uac-expect-500.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="Basic Sipstone UAC">
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: [service] <sip:[service]@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-expect-500
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="500">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      ACK sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: [service] <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-expect-500
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-expect-603.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="Basic Sipstone UAC">
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000000@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000000@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-expect-603
+      X-Account-Sid: bb845d4b-83a9-4cde-a6e9-50f3743bab3f
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="603">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000000@[remote_ip]:[remote_port] SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000000@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-expect-603
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-gather-account-creds-success.xml

@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000003@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000003@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: bb845d4b-83a9-4cde-a6e9-50f3743bab3f
+      Subject: uac-gather-account-creds-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000003@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000003 <sip:16174000003@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-gather-account-creds-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <nop>
+    <action>
+	    <exec rtp_stream="/tmp/scenarios/wav/speak-to-customer-support.wav,1,0"/>
+    </action>
+  </nop>
+
+  <recv request="BYE">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-inactive-account-expect-503.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="Basic Sipstone UAC">
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000001@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: 2a14b9ef-2d01-4b50-8123-fa79f56ab684
+      Subject: uac-inactive-account-expect-503
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="503">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      ACK sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000001@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-inactive-account-expect-503
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-invalid-account-expect-503.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="Basic Sipstone UAC">
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: [service] <sip:[service]@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: deadbeef
+      Subject: uac-invalid-account-expect-503
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="503">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      ACK sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: [service] <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-invalid-account-expect-503
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-say-account-creds-success.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000001@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000001@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: bb845d4b-83a9-4cde-a6e9-50f3743bab3f
+      Subject: uac-say
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000001@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000001 <sip:16174000001@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-say
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="BYE">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-say-fail-low-balance.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000002@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000002@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: 2a14b9ef-2d01-4b50-8123-fa79f56ab684
+      Subject: uac-say
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000002@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000002 <sip:16174000002@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-say
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="BYE">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-say-our-creds-success.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000002@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000002@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: 2a14b9ef-2d01-4b50-8123-fa79f56ab684
+      Subject: uac-say
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000002@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000002 <sip:16174000002@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-say
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="BYE">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+</scenario>
+

test/scenarios/uac-transcribe-account-creds-success.xml

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000004@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000004@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: bb845d4b-83a9-4cde-a6e9-50f3743bab3f
+      Subject: uac-transcribe-account-creds-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000004@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000004 <sip:16174000004@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-transcribe-account-creds-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <nop>
+    <action>
+	    <exec rtp_stream="/tmp/scenarios/wav/speak-to-customer-support.wav,1,0"/>
+    </action>
+  </nop>
+
+  <pause milliseconds="10000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:sip:16174000004@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000004 <sip:16174000004@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Max-Forwards: 70
+      Subject: uac-transcribe-account-creds-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+</scenario>
+

test/scenarios/uac-transcribe-our-creds-fail-low-balance.xml

@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000005@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000005@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: 2a14b9ef-2d01-4b50-8123-fa79f56ab684
+      Subject: uac-transcribe-our-creds-fail-low-balance
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000005@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000005 <sip:16174000004@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-transcribe-our-creds-fail-low-balance
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="BYE">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+
+</scenario>
+

test/scenarios/uac-transcribe-our-creds-success.xml

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16174000005@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000005@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: 2a14b9ef-2d01-4b50-8123-fa79f56ab684
+      Subject: uac-transcribe-our-creds-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16174000005@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000005 <sip:16174000004@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-transcribe-our-creds-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <nop>
+    <action>
+	    <exec rtp_stream="/tmp/scenarios/wav/speak-to-customer-support.wav,1,0"/>
+    </action>
+  </nop>
+
+  <pause milliseconds="10000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:sip:16174000005@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: 16174000005 <sip:16174000005@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Max-Forwards: 70
+      Subject: uac-transcribe-our-creds-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+</scenario>
+