interpolate tags

The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-XML2JS-5414874

.eslintrc.json

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

.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - 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 }}
+          MICROSOFT_REGION: ${{ secrets.MICROSOFT_REGION }}
+          MICROSOFT_API_KEY: ${{ secrets.MICROSOFT_API_KEY }}

.github/workflows/docker-publish.yml

@@ -0,0 +1,51 @@
+name: Docker
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE_NAME: feature-server
+
+jobs:
+  push:
+
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Login to Docker Hub 
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: prepare tag 
+        run: |
+            IMAGE_ID=jambonz/$IMAGE_NAME
+
+            # 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
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ IMAGE_ID }}:${{ VERSION }}
+          build-args: |
+            GITHUB_REPOSITORY=$GITHUB_REPOSITORY
+            GITHUB_REF=$GITHUB_REF

.gitignore

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

.travis.yml

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

Dockerfile

@@ -1,13 +1,23 @@
-FROM node:lts-alpine
+FROM --platform=linux/amd64 node:18.14.1-alpine3.16 as base
 
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
+RUN apk --update --no-cache add --virtual .builds-deps build-base python3
+
+WORKDIR /opt/app/
+
+FROM base as build
+
+COPY package.json package-lock.json ./
+
+RUN npm ci
+
+COPY . .
+
+FROM base
+
+COPY --from=build /opt/app /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 [ "node", "app.js" ]

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,82 +1,92 @@
-# 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.
 
+> Note: If you are a developer looking to work on the code please read  our [how-to for that](./docs/contributing.md).
+
 ## 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|
+|ENCRYPTION_SECRET| secret for credential encryption(JWT_SECRET is deprecated) |yes|
+|GOOGLE_APPLICATION_CREDENTIALS| path to gcp service key file|yes|
+|HTTP_PORT| tcp port to listen on for API requests from jambonz-api-server|yes|
+|JAMBONES_GATHER_EARLY_HINTS_MATCH| if true and hints are provided, gather will opportunistically review interim transcripts if possible to reduce ASR latency |no|
+|JAMBONES_FREESWITCH| IP:port:secret for Freeswitch server (e.g. '127.0.0.1:8021:JambonzR0ck$'|yes|
+|JAMBONES_LOGLEVEL| log level for application, 'info' or 'debug'|no|
+|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
-The test suite currently only consists of JSON-parsing unit tests.  A full end-to-end sip test suite should be added.
-```
-npm test
-```
+
+Please [see this]](./docs/contributing.md#run-the-regression-test-suite).

app.js

@@ -7,37 +7,34 @@ 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');
+assert.ok(process.env.ENCRYPTION_SECRET || process.env.JWT_SECRET, 'missing ENCRYPTION_SECRET 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 logger = require('pino')(opts);
-const {LifeCycleEvents} = require('./lib/utils/constants');
+const tracer = require('./tracer')(process.env.JAMBONES_OTEL_SERVICE_NAME || 'jambonz-feature-server');
+const api = require('@opentelemetry/api');
+srf.locals = {...srf.locals, otel: {tracer, api}};
+
+const opts = {level: process.env.JAMBONES_LOGLEVEL || 'info'};
+const pino = require('pino');
+const logger = pino(opts, pino.destination({sync: false}));
+const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./lib/utils/constants');
 const installSrfLocals = require('./lib/utils/install-srf-locals');
 installSrfLocals(srf, logger);
 
 const {
   initLocals,
+  createRootSpan,
+  handleSipRec,
+  getAccountDetails,
   normalizeNumbers,
   retrieveApplication,
   invokeWebCallback
 } = require('./lib/middleware')(srf, logger);
 
-// HTTP
-const express = require('express');
-const app = express();
-Object.assign(app.locals, {
-  logger,
-  srf
-});
-
-const httpRoutes = require('./lib/http-routes');
-
 const InboundCallSession = require('./lib/session/inbound-call-session');
+const SipRecCallSession = require('./lib/session/siprec-call-session');
 
 if (process.env.DRACHTIO_HOST) {
   srf.connect({host: process.env.DRACHTIO_HOST, port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET });
@@ -57,25 +54,23 @@ if (process.env.NODE_ENV === 'test') {
   });
 }
 
-srf.use('invite', [initLocals, normalizeNumbers, retrieveApplication, invokeWebCallback]);
+srf.use('invite', [
+  initLocals,
+  createRootSpan,
+  handleSipRec,
+  getAccountDetails,
+  normalizeNumbers,
+  retrieveApplication,
+  invokeWebCallback
+]);
 
-srf.invite((req, res) => {
-  const session = new InboundCallSession(req, res);
+srf.invite(async(req, res) => {
+  const isSipRec = !!req.locals.siprec;
+  const session = isSipRec ? new SipRecCallSession(req, res) : new InboundCallSession(req, res);
+  if (isSipRec) await session.answerSipRecCall();
   session.exec();
 });
 
-// HTTP
-app.use(express.urlencoded({ extended: true }));
-app.use(express.json());
-app.use('/', httpRoutes);
-app.use((err, req, res, next) => {
-  logger.error(err, 'burped error');
-  res.status(err.status || 500).json({msg: err.message});
-});
-app.listen(PORT);
-
-logger.info(`listening for HTTP requests on port ${PORT}, serviceUrl is ${srf.locals.serviceUrl}`);
-
 const sessionTracker = srf.locals.sessionTracker = require('./lib/session/session-tracker');
 sessionTracker.on('idle', () => {
   if (srf.locals.lifecycleEmitter.operationalState === LifeCycleEvents.ScaleIn) {
@@ -83,9 +78,67 @@ sessionTracker.on('idle', () => {
     srf.locals.lifecycleEmitter.scaleIn();
   }
 });
+const getCount = () => sessionTracker.count;
+const healthCheck = require('@jambonz/http-health-check');
+let httpServer;
+
+const createHttpListener = require('./lib/utils/http-listener');
+createHttpListener(logger, srf)
+  .then(({server, app}) => {
+    httpServer = server;
+    healthCheck({app, logger, path: '/', fn: getCount});
+    return {server, app};
+  })
+  .catch((err) => {
+    logger.error(err, 'Error creating http listener');
+  });
+
 
 setInterval(() => {
   srf.locals.stats.gauge('fs.sip.calls.count', sessionTracker.count);
-}, 5000);
+}, 20000);
 
-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('SIGTERM', handle);
+
+function handle(signal) {
+  const {removeFromSet} = srf.locals.dbHelpers;
+  srf.locals.disabled = true;
+  logger.info(`got signal ${signal}`);
+  const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
+  if (setName && srf.locals.localSipAddress) {
+    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);
+  if (process.env.K8S) {
+    srf.locals.lifecycleEmitter.operationalState = LifeCycleEvents.ScaleIn;
+  }
+  if (getCount() === 0) {
+    logger.info('no calls in progress, exiting');
+    process.exit(0);
+  }
+}
+
+if (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS) {
+  const {clearFiles} = require('./lib/utils/cron-jobs');
+
+  /* cleanup orphaned files or channels every so often */
+  setInterval(async() => {
+    try {
+      await clearFiles();
+    } catch (err) {
+      logger.error({err}, 'app.js: error clearing files');
+    }
+  }, 1000 * 60 * (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS || 60));
+}
+
+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);
+  }
+})();

data/example-voicemail-greetings.json

@@ -0,0 +1,52 @@
+{
+  "en-US": [
+    "call has been forwarded",
+    "at the beep",
+    "at the tone",
+    "leave a message",
+    "leave me a message",
+    "not available right now",
+    "not available to take your call",
+    "can't take your call",
+    "I will get back to you",
+    "I'll get back to you",
+    "we will get back to you",
+    "we are unable",
+    "we are not available"
+  ],
+  "es-ES": [
+    "le pasamos la llamada",
+    "después del bip",
+    "después del tono",
+    "deja un mensaje",
+    "déjame un mensaje",
+    "no estamos disponibles",
+    "no estoy disponible",
+    "ahora no puedo",
+    "no puedo contestar",
+    "no le puedo contestar",
+    "me pondré en contacto",
+    "nos pondremos en contacto",
+    "ahora no estamos disponibles",
+    "no estamos disponibles"
+  ],
+  "ca-ES": [
+    "passem la seva trucada",
+    "després del bip",
+    "després del to",
+    "deixi un missatge",
+    "deixa un missatge",
+    "deixim un missatge",
+    "no estem disponibles",
+    "no estem a l'oficina",
+    "no estic disponible",
+    "ara no puc",
+    "no puc contestar",
+    "no puc respondre",
+    "no li puc respondre",
+    "em posaré en contacte",
+    "ens posarem en contacto",
+    "ara no estem disponibles",
+    "no hi som"
+  ]
+}

docs/contributing.md

@@ -0,0 +1,123 @@
+# Contributors are welcome!
+
+So, you want to hack on jambonz?  Maybe add some features, maybe help fix some bugs?  Awesome, welcome aboard! 
+
+This brief document should get you started.  Here you will find instructions showing how to set up your laptop to run the regression test suite (which you should always run before committing any changes), as well as some basic info on the structure of the code.
+
+## Getting oriented
+
+First of all, you are in the right place to begin hacking on jambonz. The jambonz-feature-server app is kinda the center of the universe for jambonz.  Most of the core logic in jambonz is implemented here: things like the [webhook verbs](../lib/tasks), [session management](../lib/session), and the [client-side webhook implementation](../lib/utils/http-requestor.js). A common thing you might want to do, for instance, is to add support for an all-new verb, and this code base is where would do that.
+
+This jambonz-feature-server app works together quite closely with a [drachtio server](https://github.com/drachtio/drachtio-server) and a Freeswitch.  In fact, these three components are bundled together into a single VM/instance (or a Deployment, in Kubernetes) that we more generally refer to as "Feature Server".  The Feature Server is a horizontally-scalable unit that is deployed behind the public-facing SBC elements of a jambonz cluster (the SBC is itself a separately scalable unit).  The drachtio-server handles the SIP signaling, the Freeswitch handles media operations and speech vendor integration, and the jambonz-feature-server app orchestrates all of it via the use of [drachtio-srf](https://github.com/drachtio/drachtio-srf) and [drachtio-fsmrf](https://github.com/drachtio/drachtio-fsmrf).
+
+## How to do things
+
+First of all, please join our [slack channel](https://joinslack.jambonz.org) in order to coordinate with us on the work, i.e. to notify us of what you are doing and make sure that no one else is already working on the same thing.
+
+To prepare to make changes, please fork the repo to your own Github account, make changes, test them on your own running jambonz cluster, then run the regression test suite and lint check before giving us a PR.
+
+### lint
+
+We have some opinionated conventions that you must follow - see our [eslintrc.json](../.eslintrc.json) for details. Make sure your code passes by running:
+
+```bash
+npm run jslint
+```
+
+### test suite
+
+#### Generate speech credentials and create run-tests.sh
+
+The test suite also requires you to provide speech credentials for both GCP and AWS.  You will want to create a new file named `run-tests.sh` in the project folder. Make the file executable and then copy in the text below, substituting your speech credentials where indicated:
+
+```bash
+#!/bin/bash
+GCP_JSON_KEY='{"type":"service_account","project_id":"...etc"}' \
+AWS_ACCESS_KEY_ID='your-aws-access-key-id' \
+AWS_SECRET_ACCESS_KEY='your-aws-secret-access-key' \
+AWS_REGION='us-east-1' \
+JWT_SECRET='foobar' \
+npm test
+```
+>> Note: The project's .gitignore file prevents this file from being sent to Github, so you do not need to worry about exposing your credentials.  Just make sure you name if run-tests.sh and create it in the project folder
+
+The GCP credential is the JSON service key in stringified format.
+
+#### Install Docker
+
+The test suite ralso equires [Docker](https://www.docker.com/) and docker-compose to be installed on your laptop.  Docker is used to set up a network with all of the elements required to test the jambonz-feature-server in a black-box type of fashion.
+
+Once you have docker installed, you can optionally make sure everything Docker-wise is working properly by running this command from the project folder:
+
+```bash
+docker-compose -f test/docker-compose-testbed.yaml up -d
+```
+
+This may take several minutes to complete, mainly because the mysql schema needs to be installed and seeded, but if successful the output should look like this:
+
+```bash
+$ docker-compose -f test/docker-compose-testbed.yaml up -d
+Creating network "test_fs" with driver "bridge"
+Creating test_webhook-transcribe_1 ... done
+Creating test_webhook-decline_1    ... done
+Creating test_mysql_1              ... done
+Creating test_docker-host_1        ... done
+Creating test_webhook-gather_1     ... done
+Creating test_webhook-say_1        ... done
+Creating test_freeswitch_1         ... done
+Creating test_influxdb_1           ... done
+Creating test_redis_1              ... done
+Creating test_drachtio_1           ... done
+```
+
+At that point, you can run `docker ps` to see all of the containers running
+
+```bash
+docker ps
+CONTAINER ID   IMAGE                                           COMMAND                  CREATED              STATUS                   PORTS                               NAMES
+abbc3594f390   drachtio/drachtio-server:latest                 "/entrypoint.sh drac…"   About a minute ago   Up About a minute        0.0.0.0:9060->9022/tcp              test_drachtio_1
+1f384a274f87   redis:5-alpine                                  "docker-entrypoint.s…"   2 minutes ago        Up 2 minutes             0.0.0.0:16379->6379/tcp             test_redis_1
+78d0bb6ec9b1   influxdb:1.8                                    "/entrypoint.sh infl…"   2 minutes ago        Up 2 minutes             0.0.0.0:8086->8086/tcp              test_influxdb_1
+9616ff790709   jambonz/webhook-test-scaffold:latest            "/entrypoint.sh"         2 minutes ago        Up 2 minutes             0.0.0.0:3102->3000/tcp              test_webhook-gather_1
+7323ab273ff4   drachtio/drachtio-freeswitch-mrf:v1.10.1-full   "/entrypoint.sh free…"   2 minutes ago        Up 2 minutes (healthy)   0.0.0.0:8022->8021/tcp              test_freeswitch_1
+e45e7d28dbc7   mysql:5.7                                       "docker-entrypoint.s…"   2 minutes ago        Up 2 minutes (healthy)   33060/tcp, 0.0.0.0:3360->3306/tcp   test_mysql_1
+b626e5f3067e   qoomon/docker-host                              "/entrypoint.sh"         2 minutes ago        Up 2 minutes                                                 test_docker-host_1
+b0a94b5e8941   jambonz/webhook-test-scaffold:latest            "/entrypoint.sh"         2 minutes ago        Up 2 minutes             0.0.0.0:3101->3000/tcp              test_webhook-say_1
+f80adda48eb5   jambonz/webhook-test-scaffold:latest            "/entrypoint.sh"         2 minutes ago        Up 2 minutes             0.0.0.0:3103->3000/tcp              test_webhook-transcribe_1
+223db4a9c670   jambonz/webhook-test-scaffold:latest            "/entrypoint.sh"         2 minutes ago        Up 2 minutes             0.0.0.0:3100->3000/tcp              test_webhook-decline_1
+```
+
+#### Run the regression test suite
+
+The test suite has a dependency that the mysql client is installed on your laptop/machine where the test will be run.  This is needed in order to seed the mysql database that is running in the docker network.
+
+Assuming you have installed the mysql client, and done the above steps, you should now be able to run the tests:
+
+```bash
+./run-tests.sh
+```
+
+If the docker network has not been started (as described above) it will start now, and this will take a minute or two.  Otherwise, the test suite will start running immediately.
+
+In evaluating the test results, be advised that the output is fairly verbose, and also in the process of shutting down once the tests are complete you will see a bunch of errors from redis (`@jambonz/realtimedb-helpers - redis error`).  You can ignore these errors, they are just spit out by jambonz-feature-server as the test environment is torn down and it tries and fails to reconnect to redis.
+
+The final output will indicate the number of tests run and passed:
+
+```bash
+1..28
+# tests 28
+# pass  28
+
+# ok
+```
+
+#### Adding your own tests
+
+Running a successful regression test means you haven't broken anything - Great!  
+
+It doesn't, of course, mean that your shiny new feature or bugfix works.  Adding a new test case to the suite is (unfortunately) non-trivial.  We will add more documentation in the future with a how-to guide on that, but be advised it does require knowledge of the SIP protocol and the [SIPp](http://sipp.sourceforge.net/doc/reference.html) tool.
+
+For now, if you are unable to add tests to the regression suite, please do test your feature as thoroughly as you can on your own jambonz cluster before giving us a pull request.
+
+
+

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

@@ -3,18 +3,24 @@ 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 uuidv4 = require('uuid-random');
 const SipError = require('drachtio-srf').SipError;
 const sysError = require('./error');
-const Requestor = require('../../utils/requestor');
+const HttpRequestor = require('../../utils/http-requestor');
+const WsRequestor = require('../../utils/ws-requestor');
+const RootSpan = require('../../utils/call-tracer');
+const dbUtils = require('../../utils/db-utils');
 
 router.post('/', async(req, res) => {
   const {logger} = req.app.locals;
+  const accountSid = req.body.account_sid;
+  const {srf} = require('../../..');
 
   logger.debug({body: req.body}, 'got createCall request');
   try {
     let uri, cs, to;
     const restDial = makeTask(logger, {'rest:dial': req.body});
-    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');
@@ -24,14 +30,44 @@ router.post('/', async(req, res) => {
       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-Jambonz-Routing': target.type,
+      'X-Jambonz-FS-UUID': srf.locals.fsUUID,
+      'X-Call-Sid': callSid,
+      'X-Account-Sid': accountSid,
+      ...(restDial.fromHost && {'X-Preferred-From-Host': restDial.fromHost})
+    };
+
     switch (target.type) {
       case 'phone':
+      case 'teams':
         uri = `sip:${target.number}@${sbcAddress}`;
         to = target.number;
+        if ('teams' === target.type) {
+          const obj = await lookupTeamsByAccount(accountSid);
+          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;
@@ -39,6 +75,16 @@ router.post('/', async(req, res) => {
         break;
     }
 
+    if (target.type === 'phone' && target.trunk) {
+      const {lookupCarrier} = dbUtils(this.logger, srf);
+      const voip_carrier_sid = await lookupCarrier(req.body.account_sid, target.trunk);
+      logger.info(
+        `createCall: selected ${voip_carrier_sid} for requested carrier: ${target.trunk || 'unspecified'})`);
+      if (voip_carrier_sid) {
+        opts.headers['X-Requested-Carrier-Sid'] = voip_carrier_sid;
+      }
+    }
+
     /* create endpoint for outdial */
     const ms = getFreeswitch();
     if (!ms) throw new Error('no available Freeswitch for outbound call creation');
@@ -58,7 +104,7 @@ router.post('/', async(req, res) => {
       proxy: `sip:${sbcAddress}`,
       localSdp: ep.local.sdp
     });
-    if (target.auth) opts.auth = this.target.auth;
+    if (target.auth) opts.auth = target.auth;
 
 
     /**
@@ -72,40 +118,89 @@ 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);
-    else app.notifier = {request: () => {}};
+    if ('WS' === app.call_hook?.method || /^wss?:/.test(app.call_hook.url)) {
+      logger.debug({call_hook: app.call_hook}, 'creating websocket for call hook');
+      app.requestor = new WsRequestor(logger, account.account_sid, app.call_hook, account.webhook_secret) ;
+      if (app.call_hook.url === app.call_status_hook.url  || !app.call_status_hook?.url) {
+        logger.debug('reusing websocket for call status hook');
+        app.notifier = app.requestor;
+      }
+    }
+    else {
+      logger.debug({call_hook: app.call_hook}, 'creating http client for call hook');
+      app.requestor = new HttpRequestor(logger, account.account_sid, app.call_hook, account.webhook_secret);
+    }
+    if (!app.notifier && app.call_status_hook) {
+      app.notifier = new HttpRequestor(logger, account.account_sid, app.call_status_hook, account.webhook_secret);
+      logger.debug({call_hook: app.call_hook}, 'creating http client for call status hook');
+    }
+    else if (!app.notifier) {
+      logger.debug('creating null call status hook');
+      app.notifier = {request: () => {}, close: () => {}};
+    }
 
     /* 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
+              except to update the req so that it can later be canceled if need be
+          */
+          if (res.headersSent) {
+            logger.info(`create-call: got redirect, updating request to new call-id ${req.get('Call-ID')}`);
+            if (cs) cs.req = inviteReq;
+            return;
+          }
+
           if (err) {
             logger.error(err, 'createCall Error creating call');
             res.status(500).send('Call Failure');
             return;
           }
+          inviteReq.srf = srf;
+          inviteReq.locals = {
+            ...(inviteReq || {}),
+            callSid,
+            application_sid: app.application_sid
+          };
           /* ok our outbound INVITE is in flight */
 
           const tasks = [restDial];
+          const rootSpan = new RootSpan('rest-call', inviteReq);
+          sipLogger = logger.child({
+            callSid,
+            callId: inviteReq.get('Call-ID'),
+            accountSid,
+            traceId: rootSpan.traceId
+          });
+          app.requestor.logger = app.notifier.logger = sipLogger;
           const callInfo = new CallInfo({
             direction: CallDirection.Outbound,
             req: inviteReq,
             to,
             tag: app.tag,
+            callSid,
             accountSid: req.body.account_sid,
-            applicationSid: app.application_sid
+            applicationSid: app.application_sid,
+            traceId: rootSpan.traceId
+          });
+          cs = new RestCallSession({
+            logger: sipLogger,
+            application: app,
+            srf,
+            req: inviteReq,
+            ep,
+            tasks,
+            callInfo,
+            accountInfo,
+            rootSpan
           });
-          cs = new RestCallSession({logger, application: app, srf, req: inviteReq, ep, tasks, callInfo});
           cs.exec(req);
 
-          res.status(201).json({sid: cs.callSid});
+          res.status(201).json({sid: cs.callSid, callId: inviteReq.get('Call-ID')});
 
-          sipLogger = logger.child({
-            callSid: cs.callSid,
-            callId: callInfo.callId
-          });
-          sipLogger.info(`outbound REST call attempt to ${JSON.stringify(target)} has been sent`);
+          sipLogger.info({sid: cs.callSid, callId: inviteReq.get('Call-ID')},
+            `outbound REST call attempt to ${JSON.stringify(target)} has been sent`);
         },
         cbProvisional: (prov) => {
           const callStatus = prov.body ? CallStatus.EarlyMedia : CallStatus.Ringing;
@@ -115,7 +210,11 @@ router.post('/', async(req, res) => {
         }
       });
       connectStream(dlg.remote.sdp);
-      cs.emit('callStatusChange', {callStatus: CallStatus.InProgress, sipStatus: 200});
+      cs.emit('callStatusChange', {
+        callStatus: CallStatus.InProgress,
+        sipStatus: 200,
+        sipReason: 'OK'
+      });
       restDial.emit('callStatus', 200);
       restDial.emit('connect', dlg);
     }
@@ -124,14 +223,25 @@ 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,
+          sipReason: err.reason
+        });
       }
       else {
-        cs.emit('callStatusChange', {callStatus, sipStatus: 500});
-        sipLogger.error({err}, 'REST outdial failed');
+        if (cs) cs.emit('callStatusChange', {
+          callStatus,
+          sipStatus: 500,
+          sipReason: 'Internal Server Error'
+        });
+        if (sipLogger) sipLogger.error({err}, 'REST outdial failed');
+        else console.error(err);
       }
       ep.destroy();
+      setTimeout(restDial.kill.bind(restDial), 5000);
     }
   } catch (err) {
     sysError(logger, res, err);

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('@jambonz/verb-specifications');
+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/enqueue.js

@@ -7,11 +7,13 @@ const {DbErrorUnprocessableRequest} = require('../utils/errors');
 /**
  * validate the call state
  */
-function retrieveCallSession(callSid, opts) {
+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}`);
     }
   }
@@ -19,14 +21,14 @@ function retrieveCallSession(callSid, opts) {
 }
 
 /**
- * notify a waiting session that a conference has started
+ * 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({body: req.body}, 'got enqueue event');
+  logger.debug({callSid, body: req.body}, 'got enqueue event');
   try {
-    const cs = retrieveCallSession(callSid, req.body);
+    const cs = retrieveCallSession(logger, callSid, req.body);
     if (!cs) {
       logger.info(`enqueue: callSid not found ${callSid}`);
       return res.sendStatus(404);

lib/http-routes/api/index.js

@@ -6,8 +6,7 @@ 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,86 @@
+const router = require('express').Router();
+const HttpRequestor = require('../../utils/http-requestor');
+const WsRequestor = require('../../utils/ws-requestor');
+const CallInfo = require('../../session/call-info');
+const {CallDirection} = require('../../utils/constants');
+const SmsSession = require('../../session/sms-call-session');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+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;
+  let requestor;
+
+  if ('WS' === hook?.method) {
+    app.requestor = new WsRequestor(logger, account.account_sid, hook, account.webhook_secret) ;
+    app.notifier = app.requestor;
+  }
+  else {
+    app.requestor = new HttpRequestor(logger, account.account_sid, hook, account.webhook_secret);
+    app.notifier = {request: () => {}};
+  }
+
+  const payload = {
+    carrier: req.params.partner,
+    messageSid: app.messageSid,
+    accountSid: app.accountSid,
+    serviceProviderSid: account.service_provider_sid,
+    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('session:new', 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/api/update-call.js

@@ -12,6 +12,9 @@ function retrieveCallSession(callSid, opts) {
     throw new DbErrorBadRequest('call_status_hook can be updated only when call_hook is also being updated');
   }
   const cs = sessionTracker.get(callSid);
+  if (!cs) {
+    throw new DbErrorUnprocessableRequest('call session is gone');
+  }
 
   if (opts.call_status === CallStatus.Completed && !cs.hasStableDialog) {
     throw new DbErrorUnprocessableRequest('current call state is incompatible with requested action');
@@ -45,8 +48,18 @@ router.post('/:callSid', async(req, res) => {
       logger.info(`updateCall: callSid not found ${callSid}`);
       return res.sendStatus(404);
     }
-    res.sendStatus(202);
-    cs.updateCall(req.body, callSid);
+
+    if (req.body.sip_request) {
+      const response = await cs.updateCall(req.body, callSid);
+      res.status(200).json({
+        status: response.status,
+        reason: response.reason
+      });
+    }
+    else {
+      res.sendStatus(202);
+      cs.updateCall(req.body, callSid);
+    }
   } catch (err) {
     sysError(logger, res, err);
   }

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,36 +1,162 @@
-const uuidv4 = require('uuid/v4');
-const {CallDirection} = require('./utils/constants');
+const uuidv4 = require('uuid-random');
+const {CallDirection, AllowedSipRecVerbs} = require('./utils/constants');
+const {parseSiprecPayload} = require('./utils/siprec-utils');
 const CallInfo = require('./session/call-info');
-const Requestor = require('./utils/requestor');
+const HttpRequestor = require('./utils/http-requestor');
+const WsRequestor = require('./utils/ws-requestor');
 const makeTask = require('./tasks/make_task');
 const parseUri = require('drachtio-srf').parseUri;
-const normalizeJambones = require('./utils/normalize-jambones');
+const { normalizeJambones }  = require('@jambonz/verb-specifications');
+const dbUtils = require('./utils/db-utils');
+const RootSpan = require('./utils/call-tracer');
+const listTaskNames = require('./utils/summarize-tasks');
 
 module.exports = function(srf, logger) {
-  const {lookupAppByPhoneNumber, lookupAppBySid, lookupAppByRealm, lookupAppByTeamsTenant}  = srf.locals.dbHelpers;
+  const {
+    lookupAppByPhoneNumber,
+    lookupAppByRegex,
+    lookupAppBySid,
+    lookupAppByRealm,
+    lookupAppByTeamsTenant
+  }  = srf.locals.dbHelpers;
+  const {
+    writeAlerts,
+    AlertType
+  } = srf.locals;
+  const {lookupAccountDetails} = dbUtils(logger, srf);
 
   function initLocals(req, res, next) {
+    const callId = req.get('Call-ID');
+    logger.info({
+      callId,
+      callingNumber: req.callingNumber,
+      calledNumber: req.calledNumber
+    }, 'new incoming call');
+    if (!req.has('X-Account-Sid')) {
+      logger.info('getAccountDetails - rejecting call due to missing X-Account-Sid header');
+      return res.send(500);
+    }
     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})
-    };
+    const account_sid = req.get('X-Account-Sid');
+    req.locals = {callSid, account_sid, callId};
     if (req.has('X-Application-Sid')) {
       const application_sid = req.get('X-Application-Sid');
-      req.locals.logger.debug(`got application from X-Application-Sid header: ${application_sid}`);
+      logger.debug(`got application from X-Application-Sid header: ${application_sid}`);
       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');
+    if (req.has('X-Cisco-Recording-Participant')) {
+      const ciscoParticipants = req.get('X-Cisco-Recording-Participant');
+      const regex = /sip:[\d]+@[\d]+\.[\d]+\.[\d]+\.[\d]+/g;
+      const sipURIs = ciscoParticipants.match(regex);
+      logger.info(`X-Cisco-Recording-Participant : ${sipURIs} `);
+      if (sipURIs && sipURIs.length > 0) {
+        req.locals.calledNumber = sipURIs[0];
+        req.locals.callingNumber = sipURIs[1];
+      }
+    }
+    next();
+  }
+
+  function createRootSpan(req, res, next) {
+    const {callId, callSid, account_sid} = req.locals;
+    const rootSpan = new RootSpan('incoming-call', req);
+    const traceId = rootSpan.traceId;
+
+    req.locals = {
+      ...req.locals,
+      traceId,
+      logger: logger.child({
+        callId,
+        callSid,
+        accountSid: account_sid,
+        callingNumber: req.callingNumber,
+        calledNumber: req.calledNumber,
+        traceId}),
+      rootSpan
+    };
+
+    /**
+     * end the span on final failure or cancel from caller;
+     * otherwise it will be closed when sip dialog is destroyed
+    */
+    req.once('cancel', () => {
+      rootSpan.setAttributes({finalStatus: 487});
+      rootSpan.end();
+    });
+    res.once('finish', () => {
+      rootSpan.setAttributes({finalStatus: res.statusCode});
+      res.statusCode >= 300 && rootSpan.end();
+    });
 
     next();
   }
 
+  const handleSipRec = async(req, res, next) => {
+    if (Array.isArray(req.payload) && req.payload.length > 1) {
+      const {callId, logger} = req.locals;
+      logger.debug({payload: req.payload}, 'handling siprec call');
+
+      try {
+        const sdp = req.payload
+          .find((p) => p.type === 'application/sdp')
+          .content;
+        const {sdp1, sdp2, ...metadata} = await parseSiprecPayload(req, logger);
+        if (!req.locals.calledNumber && !req.locals.calledNumber) {
+          req.locals.calledNumber = metadata.caller.number;
+          req.locals.callingNumber = metadata.callee.number;
+        }
+        req.locals = {
+          ...req.locals,
+          siprec: {
+            metadata,
+            sdp1,
+            sdp2
+          }
+        };
+        logger.info({callId, metadata, sdp}, 'successfully parsed SIPREC payload');
+      } catch (err) {
+        logger.info({callId}, 'Error parsing multipart payload');
+        return res.send(503);
+      }
+    }
+    next();
+  };
+
+  /**
+   * retrieve account information for the incoming call
+   */
+  async function getAccountDetails(req, res, next) {
+    const {rootSpan, account_sid} = req.locals;
+
+    const {span} = rootSpan.startChildSpan('lookupAccountDetails');
+    try {
+      req.locals.accountInfo = await lookupAccountDetails(account_sid);
+      req.locals.service_provider_sid = req.locals.accountInfo?.account?.service_provider_sid;
+      span.end();
+      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) {
+      span.end();
+      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 '+
    */
   function normalizeNumbers(req, res, next) {
-    const logger = req.locals.logger;
+    const {logger, siprec} = req.locals;
+
+    if (siprec) return next();
+
     Object.assign(req.locals, {
       calledNumber: req.calledNumber,
       callingNumber: req.callingNumber
@@ -51,7 +177,8 @@ module.exports = function(srf, logger) {
    * Given the dialed DID/phone number, retrieve the application to invoke
    */
   async function retrieveApplication(req, res, next) {
-    const logger = req.locals.logger;
+    const {logger, accountInfo, account_sid, rootSpan} = req.locals;
+    const {span} = rootSpan.startChildSpan('lookupApplication');
     try {
       let app;
       if (req.locals.application_sid) app = await lookupAppBySid(req.locals.application_sid);
@@ -71,7 +198,7 @@ module.exports = function(srf, logger) {
       }
       else {
         const uri = parseUri(req.uri);
-        const arr = /context-(.*)/.exec(uri.user);
+        const arr = /context-(.*)/.exec(uri?.user);
         if (arr) {
           // this is a transfer from another feature server
           const {retrieveKey, deleteKey} = srf.locals.dbHelpers;
@@ -84,9 +211,22 @@ module.exports = function(srf, logger) {
             logger.error(err, `Error retrieving transferred call app for ${arr[1]}`);
           }
         }
-        else app = await lookupAppByPhoneNumber(req.locals.calledNumber);
+        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);
+          }
+        }
       }
 
+      span.setAttributes({
+        'app.hook': app?.call_hook?.url,
+        'application_sid': req.locals.application_sid
+      });
+      span.end();
       if (!app || !app.call_hook || !app.call_hook.url) {
         logger.info(`rejecting call to ${req.locals.calledNumber}: no application or webhook url`);
         return res.send(480, {
@@ -100,18 +240,38 @@ 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);
-      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}`);
-      req.locals.callInfo = new CallInfo({req, app, direction: CallDirection.Inbound});
+      /* allow for caching data - when caching treat retrieved data as immutable */
+      const app2 = process.env.JAMBONES_MYSQL_REFRESH_TTL ? JSON.parse(JSON.stringify(app)) : app;
+      if ('WS' === app.call_hook?.method ||
+        app.call_hook?.url.startsWith('ws://') || app.call_hook?.url.startsWith('wss://')) {
+        app2.requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
+        app2.notifier = app.requestor;
+        app2.call_hook.method = 'WS';
+      }
+      else {
+        app2.requestor = new HttpRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
+        if (app.call_status_hook) app2.notifier = new HttpRequestor(logger, account_sid, app.call_status_hook,
+          accountInfo.account.webhook_secret);
+        else app2.notifier = {request: () => {}};
+      }
+
+      req.locals.application = app2;
+
+      // eslint-disable-next-line no-unused-vars
+      const {call_hook, call_status_hook, ...appInfo} = app;  // mask sensitive data like user/pass on webhook
+      // eslint-disable-next-line no-unused-vars
+      const {requestor, notifier, ...loggable} = appInfo;
+      logger.info({app: loggable}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
+      req.locals.callInfo = new CallInfo({
+        req,
+        app: app2,
+        direction: CallDirection.Inbound,
+        traceId: rootSpan.traceId
+      });
       next();
     } catch (err) {
+      span.end();
       logger.error(err, `${req.get('Call-ID')} Error looking up application for ${req.calledNumber}`);
       res.send(500);
     }
@@ -122,29 +282,82 @@ module.exports = function(srf, logger) {
    */
   async function invokeWebCallback(req, res, next) {
     const logger = req.locals.logger;
-    const app = req.locals.application;
+    const {rootSpan, siprec, application:app} = req.locals;
+    let span;
     try {
-
-      if (app.tasks) {
+      if (app.tasks && !process.env.JAMBONES_MYSQL_REFRESH_TTL) {
         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);
+      let json;
+      if (app.app_json) {
+        json = JSON.parse(app.app_json);
+      } else {
+        const params = Object.assign(['POST', 'WS'].includes(app.call_hook.method) ? { sip: req.msg } : {},
+          req.locals.callInfo,
+          { service_provider_sid: req.locals.service_provider_sid },
+          {
+            defaults: {
+              synthesizer: {
+                vendor: app.speech_synthesis_vendor,
+                language: app.speech_synthesis_language,
+                voice: app.speech_synthesis_voice
+              },
+              recognizer: {
+                vendor: app.speech_recognizer_vendor,
+                language: app.speech_recognizer_language
+              }
+            }
+          });
+        logger.debug({ params }, 'sending initial webhook');
+        const obj = rootSpan.startChildSpan('performAppWebhook');
+        span = obj.span;
+        const b3 = rootSpan.getTracingPropagation();
+        const httpHeaders = b3 && { b3 };
+        json = await app.requestor.request('session:new', app.call_hook, params, httpHeaders);
+      }
       app.tasks = normalizeJambones(logger, json).map((tdata) => makeTask(logger, tdata));
+      span?.setAttributes({
+        'http.statusCode': 200,
+        'app.tasks': listTaskNames(app.tasks)
+      });
+      span?.end();
       if (0 === app.tasks.length) throw new Error('no application provided');
+
+      if (siprec) {
+        const tasks = app.tasks.filter((t) => AllowedSipRecVerbs.includes(t.name));
+        if (0 === tasks.length) {
+          logger.info({tasks: app.tasks}, 'no valid verbs in app found for an incoming siprec call');
+          throw new Error('invalid verbs for incoming siprec call');
+        }
+        if (tasks.length < app.tasks.length) {
+          logger.info('removing verbs that are not allowed for incoming siprec call');
+          app.tasks = tasks;
+        }
+      }
       next();
     } catch (err) {
-      logger.info(`Error retrieving or parsing application: ${err.message}`);
-      res.send(480, {headers: {'X-Reason': err.message}});
+      span?.setAttributes({webhookStatus: err.statusCode});
+      span?.end();
+      writeAlerts({
+        account_sid: req.locals.account_sid,
+        target_sid: req.locals.callSid,
+        alert_type: AlertType.INVALID_APP_PAYLOAD,
+        message: `${err?.message}`.trim()
+      }).catch((err) => this.logger.info({err}, 'Error generating alert for parsing application'));
+      logger.info({err}, `Error retrieving or parsing application: ${err?.message}`);
+      res.send(480, {headers: {'X-Reason': err?.message || 'unknown'}});
+      app.requestor.close();
     }
   }
 
   return {
     initLocals,
+    createRootSpan,
+    handleSipRec,
+    getAccountDetails,
     normalizeNumbers,
     retrieveApplication,
     invokeWebCallback

lib/session/adulting-call-session.js

@@ -0,0 +1,55 @@
+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, rootSpan}) {
+    super({
+      logger,
+      application,
+      srf: singleDialer.dlg.srf,
+      tasks,
+      callInfo,
+      accountInfo,
+      rootSpan
+    });
+    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;
+  }
+
+  /**
+   * Note: this is not an error.  It is only here to avoid an assert ("no setter for dlg")
+   * when there is a call in Session:_clearResources to null out dlg and ep
+   */
+  set dlg(newDlg) {}
+
+  get ep() {
+    return this.sd.ep;
+  }
+
+  /* see note above */
+  set ep(newEp) {}
+
+  get callSid() {
+    return this.callInfo.callSid;
+  }
+
+  _callerHungup() {
+  }
+}
+
+module.exports = AdultingCallSession;

lib/session/call-info.js

@@ -1,7 +1,6 @@
 const {CallDirection, CallStatus} = require('../utils/constants');
 const parseUri = require('drachtio-srf').parseUri;
-const uuidv4 = require('uuid/v4');
-
+const uuidv4 = require('uuid-random');
 /**
  * @classdesc Represents the common information for all calls
  * that is provided in call status webhooks
@@ -9,7 +8,10 @@ const uuidv4 = require('uuid/v4');
 class CallInfo {
   constructor(opts) {
     let from ;
+    let srf;
     this.direction = opts.direction;
+    this.traceId = opts.traceId;
+    this.callTerminationBy = undefined;
     if (opts.req) {
       const u = opts.req.getParsedHeader('from');
       const uri = parseUri(u.uri);
@@ -19,6 +21,7 @@ class CallInfo {
     if (this.direction === CallDirection.Inbound) {
       // inbound call
       const {app, req} = opts;
+      srf = req.srf;
       this.callSid = req.locals.callSid,
       this.accountSid = app.account_sid,
       this.applicationSid = app.application_sid;
@@ -26,13 +29,32 @@ class CallInfo {
       this.to = req.calledNumber;
       this.callId = req.get('Call-ID');
       this.sipStatus = 100;
+      this.sipReason = 'Trying';
       this.callStatus = CallStatus.Trying;
       this.originatingSipIp = req.get('X-Forwarded-For');
       this.originatingSipTrunkName = req.get('X-Originating-Carrier');
+      const {siprec} = req.locals;
+      if (siprec) {
+        const caller = parseUri(req.locals.callingNumber);
+        const callee = parseUri(req.locals.calledNumber);
+        this.participants = [
+          {
+            participant: 'caller',
+            uriUser: caller.user,
+            uriHost: caller.host
+          },
+          {
+            participant: 'callee',
+            uriUser: callee.user,
+            uriHost: callee.host
+          }
+        ];
+      }
     }
     else if (opts.parentCallInfo) {
       // outbound call that is a child of an existing call
       const {req, parentCallInfo, to, callSid} = opts;
+      srf = req.srf;
       this.callSid = callSid || uuidv4();
       this.parentCallSid = parentCallInfo.callSid;
       this.accountSid = parentCallInfo.accountSid;
@@ -43,20 +65,37 @@ class CallInfo {
       this.callId = req.get('Call-ID');
       this.callStatus = CallStatus.Trying,
       this.sipStatus = 100;
+      this.sipReason = 'Trying';
+    }
+    else if (this.direction === CallDirection.None) {
+      // outbound SMS
+      const {messageSid, accountSid, applicationSid, res} = opts;
+      srf = res.srf;
+      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;
+      srf = req.srf;
+      this.callSid = callSid;
       this.accountSid = accountSid;
       this.applicationSid = applicationSid;
       this.callStatus = CallStatus.Trying,
       this.callId = req.get('Call-ID');
       this.sipStatus = 100;
+      this.sipReason = 'Trying';
       this.from = from || req.callingNumber;
       this.to = to;
       if (tag) this._customerData = tag;
     }
+
+    this.localSipAddress = srf.locals.localSipAddress;
+    if (srf.locals.publicIp) {
+      this.publicIp = srf.locals.publicIp;
+    }
   }
 
   /**
@@ -64,9 +103,10 @@ class CallInfo {
    * @param {string} callStatus - current call status
    * @param {number} sipStatus - current sip status
    */
-  updateCallStatus(callStatus, sipStatus) {
+  updateCallStatus(callStatus, sipStatus, sipReason) {
     this.callStatus = callStatus;
     if (sipStatus) this.sipStatus = sipStatus;
+    if (sipReason) this.sipReason = sipReason;
   }
 
   /**
@@ -89,12 +129,15 @@ class CallInfo {
       to: this.to,
       callId: this.callId,
       sipStatus: this.sipStatus,
+      sipReason: this.sipReason,
       callStatus: this.callStatus,
       callerId: this.callerId,
       accountSid: this.accountSid,
-      applicationSid: this.applicationSid
+      traceId: this.traceId,
+      applicationSid: this.applicationSid,
+      fsSipAddress: this.localSipAddress
     };
-    ['parentCallSid', 'originatingSipIp', 'originatingSipTrunkName'].forEach((prop) => {
+    ['parentCallSid', 'originatingSipIp', 'originatingSipTrunkName', 'callTerminationBy'].forEach((prop) => {
       if (this[prop]) obj[prop] = this[prop];
     });
     if (typeof this.duration === 'number') obj.duration = this.duration;
@@ -102,6 +145,13 @@ class CallInfo {
     if (this._customerData) {
       Object.assign(obj, {customerData: this._customerData});
     }
+
+    if (process.env.JAMBONES_API_BASE_URL) {
+      Object.assign(obj, {apiBaseUrl: process.env.JAMBONES_API_BASE_URL});
+    }
+    if (this.publicIp) {
+      Object.assign(obj, {fsPublicIp: this.publicIp});
+    }
     return obj;
   }
 

lib/session/confirm-call-session.js

@@ -8,14 +8,18 @@ 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, rootSpan}) {
     super({
       logger,
       application,
       srf: dlg.srf,
       callSid: dlg.callSid,
       tasks,
-      callInfo
+      callInfo,
+      accountInfo,
+      memberId,
+      confName,
+      rootSpan
     });
     this.dlg = dlg;
     this.ep = ep;
@@ -27,6 +31,10 @@ class ConfirmCallSession extends CallSession {
   _clearResources() {
   }
 
+  _callerHungup() {
+  }
+
+
 }
 
 module.exports = ConfirmCallSession;

lib/session/inbound-call-session.js

@@ -15,23 +15,38 @@ class InboundCallSession extends CallSession {
       srf: req.srf,
       application: req.locals.application,
       callInfo: req.locals.callInfo,
-      tasks: req.locals.application.tasks
+      accountInfo: req.locals.accountInfo,
+      tasks: req.locals.application.tasks,
+      rootSpan: req.locals.rootSpan
     });
     this.req = req;
     this.res = res;
 
-    req.on('cancel', () => {
-      this._notifyCallStatusChange({callStatus: CallStatus.NoAnswer, sipStatus: 487});
-      this._callReleased();
-    });
+    req.once('cancel', this._onCancel.bind(this));
 
     this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
-    this._notifyCallStatusChange({callStatus: CallStatus.Trying, sipStatus: 100});
+    this._notifyCallStatusChange({
+      callStatus: CallStatus.Trying,
+      sipStatus: 100,
+      sipReason: 'Trying'
+    });
+  }
+
+  _onCancel() {
+    this.rootSpan.setAttributes({'call.termination': 'caller abandoned'});
+    this.callInfo.callTerminationBy = 'caller';
+    this._notifyCallStatusChange({
+      callStatus: CallStatus.NoAnswer,
+      sipStatus: 487,
+      sipReason: 'Request Terminated'
+    });
+    this._callReleased();
   }
 
   _onTasksDone() {
     if (!this.res.finalResponseSent) {
       if (this._mediaServerFailure) {
+        this.rootSpan.setAttributes({'call.termination': 'media server failure'});
         this.logger.info('InboundCallSession:_onTasksDone generating 480 due to media server failure');
         this.res.send(480, {
           headers: {
@@ -40,10 +55,12 @@ class InboundCallSession extends CallSession {
         });
       }
       else {
+        this.rootSpan.setAttributes({'call.termination': 'tasks completed without answering call'});
         this.logger.info('InboundCallSession:_onTasksDone auto-generating non-success response to invite');
         this.res.send(603);
       }
     }
+    this.req.removeAllListeners('cancel');
   }
 
   /**
@@ -52,9 +69,15 @@ class InboundCallSession extends CallSession {
   _callerHungup() {
     assert(this.dlg.connectTime);
     const duration = moment().diff(this.dlg.connectTime, 'seconds');
-    this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-    this.logger.debug('InboundCallSession: caller hung up');
+    this.rootSpan.setAttributes({'call.termination': 'hangup by caller'});
+    this.callInfo.callTerminationBy = 'caller';
+    this.emit('callStatusChange', {
+      callStatus: CallStatus.Completed,
+      duration
+    });
+    this.logger.info('InboundCallSession: caller hung up');
     this._callReleased();
+    this.req.removeAllListeners('cancel');
   }
 }
 

lib/session/rest-call-session.js

@@ -8,20 +8,26 @@ 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, rootSpan}) {
     super({
       logger,
       application,
       srf,
       callSid: callInfo.callSid,
       tasks,
-      callInfo
+      callInfo,
+      accountInfo,
+      rootSpan
     });
     this.req = req;
     this.ep = ep;
 
     this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
-    this._notifyCallStatusChange({callStatus: CallStatus.Trying, sipStatus: 100});
+    this._notifyCallStatusChange({
+      callStatus: CallStatus.Trying,
+      sipStatus: 100,
+      sipReason: 'Trying'
+    });
   }
 
   /**
@@ -38,6 +44,7 @@ class RestCallSession extends CallSession {
    * This is invoked when the called party hangs up, in order to calculate the call duration.
    */
   _callerHungup() {
+    this.callInfo.callTerminationBy = 'caller';
     const duration = moment().diff(this.dlg.connectTime, 'seconds');
     this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
     this.logger.debug('RestCallSession: called party hung up');

lib/session/siprec-call-session.js

@@ -0,0 +1,86 @@
+const InboundCallSession = require('./inbound-call-session');
+const {createSipRecPayload} = require('../utils/siprec-utils');
+const {CallStatus} = require('../utils/constants');
+const {parseSiprecPayload} = require('../utils/siprec-utils');
+/**
+ * @classdesc Subclass of InboundCallSession.  This represents a CallSession that is
+ * established for an inbound SIPREC call.
+ * @extends InboundCallSession
+ */
+class SipRecCallSession extends InboundCallSession {
+  constructor(req, res) {
+    super(req, res);
+
+    const {sdp1, sdp2, metadata} = req.locals.siprec;
+    this.sdp1 = sdp1;
+    this.sdp2 = sdp2;
+    this.metadata = metadata;
+  }
+
+  async _onReinvite(req, res) {
+    try {
+      this.logger.info(req.payload, 'SipRec Re-INVITE payload');
+      const {sdp1: reSdp1, sdp2: reSdp2, metadata: reMetadata} = await parseSiprecPayload(req, this.logger);
+      this.sdp1 = reSdp1;
+      this.sdp2 = reSdp2;
+      this.metadata = reMetadata;
+
+      if (this.ep && this.ep2) {
+        let remoteSdp = this.sdp1.replace(/sendonly/, 'sendrecv');
+        const newSdp1 = await this.ep.modify(remoteSdp);
+        remoteSdp = this.sdp2.replace(/sendonly/, 'sendrecv');
+        const newSdp2 = await this.ep2.modify(remoteSdp);
+        const combinedSdp = await createSipRecPayload(newSdp1, newSdp2, this.logger);
+        res.send(200, {body: combinedSdp});
+        this.logger.info({offer: req.body, answer: combinedSdp}, 'SipRec handling reINVITE');
+      }
+      else {
+        this.logger.info('got SipRec reINVITE but no endpoint and media has not been released');
+        res.send(488);
+      }
+    } catch (err) {
+      this.logger.error(err, 'Error handling reinvite');
+    }
+  }
+
+  async answerSipRecCall() {
+    try {
+      this.ms = this.getMS();
+      let remoteSdp = this.sdp1.replace(/sendonly/, 'sendrecv');
+      this.ep = await this.ms.createEndpoint({remoteSdp});
+      //this.logger.debug({remoteSdp, localSdp: this.ep.local.sdp}, 'SipRecCallSession - allocated first endpoint');
+      remoteSdp = this.sdp2.replace(/sendonly/, 'sendrecv');
+      this.ep2 = await this.ms.createEndpoint({remoteSdp});
+      //this.logger.debug({remoteSdp, localSdp: this.ep2.local.sdp}, 'SipRecCallSession - allocated second endpoint');
+      await this.ep.bridge(this.ep2);
+      const combinedSdp = await createSipRecPayload(this.ep.local.sdp, this.ep2.local.sdp, this.logger);
+      /*
+      this.logger.debug({
+        combinedSdp
+      }, 'SipRecCallSession:_answerSipRecCall - created SIPREC payload');
+      */
+      this.dlg = await this.srf.createUAS(this.req, this.res, {
+        headers: {
+          'Content-Type': 'application/sdp',
+          'X-Trace-ID': this.req.locals.traceId,
+          'X-Call-Sid': this.req.locals.callSid,
+          ...(this.applicationSid && {'X-Application-Sid': this.applicationSid})
+        },
+        localSdp: combinedSdp
+      });
+      this.dlg.on('destroy', this._callerHungup.bind(this));
+      this.wrapDialog(this.dlg);
+      this.dlg.callSid = this.callSid;
+      this.emit('callStatusChange', {sipStatus: 200, sipReason: 'OK', callStatus: CallStatus.InProgress});
+
+      this.dlg.on('modify', this._onReinvite.bind(this));
+      this.dlg.on('refer', this._onRefer.bind(this));
+    } catch (err) {
+      this.logger.error({err}, 'SipRecCallSession:_answerSipRecCall error:');
+      if (this.res && !this.res.finalResponseSent) this.res.send(500);
+      this._callReleased();
+    }
+  }
+}
+
+module.exports = SipRecCallSession;

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/conference.js

@@ -2,7 +2,7 @@ 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 { normalizeJambones } = require('@jambonz/verb-specifications');
 const makeTask = require('./make_task');
 const bent = require('bent');
 const assert = require('assert');
@@ -10,6 +10,7 @@ const WAIT = 'wait';
 const JOIN = 'join';
 const START = 'start';
 
+
 function confNoMatch(str) {
   return str.match(/^No active conferences/) || str.match(/Conference.*not found/);
 }
@@ -27,7 +28,8 @@ function camelize(str) {
 
 function unhandled(logger, cs, evt) {
   this.participantCount = parseInt(evt.getHeader('Conference-Size'));
-  logger.debug({evt}, `unhandled conference event: ${evt.getHeader('Action')}`) ;
+  // logger.debug({evt}, `unhandled conference event: ${evt.getHeader('Action')}`) ;
+  logger.debug(`unhandled conference event: ${evt.getHeader('Action')}`) ;
 }
 
 function capitalize(s) {
@@ -45,10 +47,10 @@ class Conference extends Task {
 
     this.confName = this.data.name;
     [
-      'beep', 'startConferenceOnEnter', 'endConferenceOnExit',
+      'beep', 'startConferenceOnEnter', 'endConferenceOnExit', 'joinMuted',
       'maxParticipants', 'waitHook', 'statusHook', 'endHook', 'enterHook'
     ].forEach((attr) => this[attr] = this.data[attr]);
-
+    this.record = this.data.record || {};
     this.statusEvents = [];
     if (this.statusHook) {
       ['start', 'end', 'join', 'leave', 'start-talking', 'stop-talking'].forEach((e) => {
@@ -67,13 +69,16 @@ class Conference extends Task {
 
   get name() { return TaskName.Conference; }
 
-  async exec(cs, ep) {
+  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.this.connectTime) dlg.connectTime = this.connectTime;
+    if (this.connectTime) dlg.connectTime = this.connectTime;
 
 
     this.ep.on('destroy', this._kicked.bind(this, cs, dlg));
@@ -103,6 +108,10 @@ class Conference extends Task {
   async kill(cs) {
     super.kill(cs);
     this.logger.info(`Conference:kill ${this.confName}`);
+    if (this._playSession) {
+      this._playSession.kill();
+      this._playSession = null;
+    }
     this.emitter.emit('kill');
     await this._doFinalMemberCheck(cs);
     if (this.ep && this.ep.connected) this.ep.conn.removeAllListeners('esl::event::CUSTOM::*') ;
@@ -213,6 +222,7 @@ class Conference extends Task {
             this._playSession.kill();
             this._playSession = null;
           }
+          cs.clearConferenceDetails();
           resolve();
         });
 
@@ -330,15 +340,30 @@ class Conference extends Task {
 
     const opts = {};
     if (this.endConferenceOnExit) Object.assign(opts, {flags: {endconf: true}});
+    if (this.startConferenceOnEnter) Object.assign(opts, {flags: {moderator: true}});
+    if (this.joinMuted) Object.assign(opts, {flags: {mute: true}});
+
     try {
       const {memberId, confUuid} = await this.ep.join(this.confName, opts);
       this.logger.debug({memberId, confUuid}, `Conference:_joinConference: successfully joined ${this.confName}`);
       this.memberId = memberId;
       this.confUuid = confUuid;
+
+      cs.setConferenceDetails(memberId, this.confName, confUuid);
       const response = await this.ep.api('conference', [this.confName, 'get', 'count']);
       if (response.body && /\d+/.test(response.body)) this.participantCount = parseInt(response.body);
       this._notifyConferenceEvent(cs, 'join');
 
+      // start recording if requested and we just started the conference
+      if (startConf && this.shouldRecord) {
+        this.logger.info(`recording conference to ${this.record.path}`);
+        try {
+          await this.ep.api(`conference ${this.confName} record ${this.record.path}`);
+        } catch (err) {
+          this.logger.info({err}, 'Conference:_joinConference - failed to start recording');
+        }
+      }
+
       // listen for conference events
       this.ep.filter('Conference-Unique-ID', this.confUuid);
       this.ep.conn.on('esl::event::CUSTOM::*', this.__onConferenceEvent.bind(this, cs)) ;
@@ -356,7 +381,7 @@ class Conference extends Task {
     }
 
     if (typeof this.maxParticipants === 'number' && this.maxParticipants > 1) {
-      this.endpoint.api('conference', `${this.confName} set max_members ${this.maxParticipants}`)
+      this.ep.api('conference', `${this.confName} set max_members ${this.maxParticipants}`)
         .catch((err) => this.logger.error(err, `Error setting max participants to ${this.maxParticipants}`));
     }
   }
@@ -371,9 +396,78 @@ class Conference extends Task {
    */
   notifyStartConference(cs, opts) {
     this.logger.info({opts}, `Conference:notifyStartConference: conference ${this.confName} has now started`);
+    this.conferenceStartTime = new Date();
     this.emitter.emit('join', opts);
   }
 
+  async doConferenceMuteNonModerators(cs, opts) {
+    const mute = opts.conf_mute_status === 'mute';
+    assert (cs.isInConference);
+
+    this.logger.info(`Conference:doConferenceMuteNonModerators ${mute ? 'muting' : 'unmuting'} non-moderators`);
+    this.ep.api(`conference ${this.confName} ${mute ? 'mute' : 'unmute'} non_moderator`)
+      .catch((err) => this.logger.info({err}, 'Error muting or unmuting non_moderators'));
+
+    if (this.conf_hold_status !== 'hold' && this._playSession) {
+      this._playSession.kill();
+      this._playSession = null;
+    }
+  }
+
+  async doConferenceHold(cs, opts) {
+    assert (cs.isInConference);
+
+    const {conf_hold_status, wait_hook} = opts;
+    let hookOnly = true;
+
+    if (this.conf_hold_status !== conf_hold_status) {
+      hookOnly = false;
+      this.conf_hold_status = conf_hold_status;
+      const hold = conf_hold_status === 'hold';
+
+      this.ep.api(`conference ${this.confName} ${hold ? 'mute' : 'unmute'} ${this.memberId}`)
+        .catch((err) => this.logger.info({err}, 'Error muting or unmuting participant'));
+      this.ep.api(`conference ${this.confName} ${hold ? 'deaf' : 'undeaf'} ${this.memberId}`)
+        .catch((err) => this.logger.info({err}, 'Error deafing or undeafing participant'));
+    }
+
+    if (wait_hook) {
+      if (this.wait_hook)
+        delete this.wait_hook.url;
+      this.wait_hook = {url: wait_hook};
+    }
+
+    if (hookOnly && this._playSession) {
+      this._playSession.kill();
+      this._playSession = null;
+    }
+    if (this.wait_hook?.url && this.conf_hold_status === 'hold') {
+      const {dlg} = cs;
+      this._doWaitHookWhileOnHold(cs, dlg, this.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 {
+        let tasks = [];
+        if (wait_hook.url)
+          tasks = await this._playHook(cs, dlg, wait_hook.url);
+        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
@@ -447,24 +541,33 @@ class Conference extends Task {
 
   async _playHook(cs, dlg, hook, allowed = [TaskName.Play, TaskName.Say, TaskName.Pause]) {
     assert(!this._playSession);
-    const json = await cs.application.requestor.request(hook, cs.callInfo);
+    const b3 = this.getTracingPropagation();
+    const httpHeaders = b3 && {b3};
+    const json = await cs.application.requestor.request('verb:hook', hook, cs.callInfo, httpHeaders);
+    const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
 
-    const allowedTasks = json.filter((task) => allowed.includes(task.verb));
-    if (json.length !== allowedTasks.length) {
-      this.logger.debug({json, allowedTasks}, 'unsupported task');
-      throw new Error(`unsupported verb in dial conference wait/enterHook: only ${JSON.stringify(allowed)}`);
+    const allowedTasks = tasks.filter((t) => allowed.includes(t.name));
+    if (tasks.length !== allowedTasks.length) {
+      this.logger.debug({tasks, allowedTasks}, 'unsupported task');
+      throw new Error(`unsupported verb in conference waitHook: only ${JSON.stringify(allowed)}`);
     }
-    this.logger.debug(`Conference:_playHook: executing ${json.length} tasks`);
+    this.logger.debug(`Conference:_playHook: executing ${tasks.length} tasks`);
 
-    if (json.length > 0) {
-      const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+    /* we might have been killed while off fetching waitHook */
+    if (this.killed) return [];
+
+    if (tasks.length > 0) {
       this._playSession = new ConfirmCallSession({
         logger: this.logger,
         application: cs.application,
         dlg,
         ep: cs.ep,
         callInfo: cs.callInfo,
-        tasks
+        accountInfo: cs.accountInfo,
+        memberId: this.memberId,
+        confName: this.confName,
+        tasks,
+        rootSpan: cs.rootSpan
       });
       await this._playSession.exec();
       this._playSession = null;
@@ -480,10 +583,15 @@ class Conference extends Task {
    */
   _kicked(cs, dlg) {
     this.logger.info(`Conference:kicked - I was dropped from conference ${this.confName}, task is complete`);
+    if (this._playSession) {
+      this._playSession.kill();
+      this._playSession = null;
+    }
     this.replaceEndpointAndEnd(cs);
   }
 
   async replaceEndpointAndEnd(cs) {
+    cs.clearConferenceDetails();
     if (this.replaced) return;
     this.replaced = true;
     try {
@@ -496,11 +604,14 @@ class Conference extends Task {
 
   _notifyConferenceEvent(cs, eventName, params = {}) {
     if (this.statusEvents.includes(eventName)) {
+      const b3 = this.getTracingPropagation();
+      const httpHeaders = b3 && {b3};
       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))
+      cs.application.requestor
+        .request('verb:hook', this.statusHook, Object.assign(params, this.statusParams, httpHeaders))
         .catch((err) => this.logger.info(err, 'Conference:notifyConferenceEvent - error'));
     }
   }
@@ -514,9 +625,6 @@ class Conference extends Task {
       const functionName = `_on${capitalize(camelize(action))}`;
       (Conference.prototype[functionName] || unhandled).bind(this, this.logger, cs, evt)() ;
     }
-    else {
-      this.logger.debug(`Conference#__onConferenceEvent: got unhandled custom event: ${eventName}`) ;
-    }
   }
 
   // conference event handlers

lib/tasks/config.js

@@ -0,0 +1,183 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+
+class TaskConfig extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    [
+      'synthesizer',
+      'recognizer',
+      'bargeIn',
+      'record',
+      'listen'
+    ].forEach((k) => this[k] = this.data[k] || {});
+
+    if ('notifyEvents' in this.data) {
+      this.notifyEvents = !!this.data.notifyEvents;
+    }
+
+    if (this.bargeIn.enable) {
+      this.gatherOpts = {
+        verb: 'gather',
+        timeout: 0,
+        bargein: true,
+        input: ['speech']
+      };
+      [
+        'finishOnKey', 'input', 'numDigits', 'minDigits', 'maxDigits',
+        'interDigitTimeout', 'bargein', 'dtmfBargein', 'minBargeinWordCount', 'actionHook'
+      ].forEach((k) => {
+        if (this.bargeIn[k]) this.gatherOpts[k] = this.bargeIn[k];
+      });
+    }
+    if (this.bargeIn.sticky) this.autoEnable = true;
+    this.preconditions = (this.bargeIn.enable || this.record?.action || this.listen?.url || this.data.amd) ?
+      TaskPreconditions.Endpoint :
+      TaskPreconditions.None;
+  }
+
+  get name() { return TaskName.Config; }
+
+  get hasSynthesizer() { return Object.keys(this.synthesizer).length; }
+  get hasRecognizer() { return Object.keys(this.recognizer).length; }
+  get hasRecording() { return Object.keys(this.record).length; }
+  get hasListen() { return Object.keys(this.listen).length; }
+
+  get summary() {
+    const phrase = [];
+    if (this.bargeIn.enable) phrase.push('enable barge-in');
+    if (this.hasSynthesizer) {
+      const {vendor:v, language:l, voice} = this.synthesizer;
+      const s = `{${v},${l},${voice}}`;
+      phrase.push(`set synthesizer${s}`);
+    }
+    if (this.hasRecognizer) {
+      const {vendor:v, language:l} = this.recognizer;
+      const s = `{${v},${l}}`;
+      phrase.push(`set recognizer${s}`);
+    }
+    if (this.hasRecording) phrase.push(this.record.action);
+    if (this.hasListen) {
+      phrase.push(this.listen.enable ? `listen ${this.listen.url}` : 'stop listen');
+    }
+    if (this.data.amd) phrase.push('enable amd');
+    if (this.notifyEvents) phrase.push(`event notification ${this.notifyEvents ? 'on' : 'off'}`);
+    return `${this.name}{${phrase.join(',')}`;
+  }
+
+  async exec(cs, {ep} = {}) {
+    await super.exec(cs);
+
+    if (this.notifyEvents) {
+      this.logger.debug(`turning event notification ${this.notifyEvents ? 'on' : 'off'}`);
+      cs.notifyEvents = !!this.data.notifyEvents;
+    }
+
+    if (this.data.amd) {
+      this.startAmd = cs.startAmd;
+      this.stopAmd = cs.stopAmd;
+      this.on('amd', this._onAmdEvent.bind(this, cs));
+
+      try {
+        this.ep = ep;
+        this.startAmd(cs, ep, this, this.data.amd);
+      } catch (err) {
+        this.logger.info({err}, 'Config:exec - Error calling startAmd');
+      }
+    }
+
+    if (this.hasSynthesizer) {
+      cs.speechSynthesisVendor = this.synthesizer.vendor !== 'default'
+        ? this.synthesizer.vendor
+        : cs.speechSynthesisVendor;
+      cs.speechSynthesisLanguage = this.synthesizer.language !== 'default'
+        ?  this.synthesizer.language
+        : cs.speechSynthesisLanguage;
+      cs.speechSynthesisVoice = this.synthesizer.voice !== 'default'
+        ? this.synthesizer.voice
+        : cs.speechSynthesisVoice;
+      this.logger.info({synthesizer: this.synthesizer}, 'Config: updated synthesizer');
+    }
+    if (this.hasRecognizer) {
+      cs.speechRecognizerVendor = this.recognizer.vendor !== 'default'
+        ? this.recognizer.vendor
+        : cs.speechRecognizerVendor;
+      cs.speechRecognizerLanguage = this.recognizer.language !== 'default'
+        ? this.recognizer.language
+        : cs.speechRecognizerLanguage;
+      cs.isContinuousAsr = typeof this.recognizer.asrTimeout === 'number' ? true : false;
+      if (cs.isContinuousAsr) {
+        cs.asrTimeout = this.recognizer.asrTimeout;
+        cs.asrDtmfTerminationDigit = this.recognizer.asrDtmfTerminationDigit;
+      }
+      if (Array.isArray(this.recognizer.hints)) {
+        const obj = {hints: this.recognizer.hints};
+        if (typeof this.recognizer.hintsBoost === 'number') {
+          obj.hintsBoost = this.recognizer.hintsBoost;
+        }
+        cs.globalSttHints = obj;
+      }
+      if (Array.isArray(this.recognizer.altLanguages)) {
+        this.logger.info({altLanguages: this.recognizer.altLanguages}, 'Config: updated altLanguages');
+        cs.altLanguages = this.recognizer.altLanguages;
+      }
+      if ('punctuation' in this.recognizer) {
+        cs.globalSttPunctuation = this.recognizer.punctuation;
+      }
+      this.logger.info({
+        recognizer: this.recognizer,
+        isContinuousAsr: cs.isContinuousAsr
+      }, 'Config: updated recognizer');
+    }
+    if ('enable' in this.bargeIn) {
+      if (this.bargeIn.enable === true && this.gatherOpts) {
+        this.gatherOpts.recognizer = this.hasRecognizer ?
+          this.recognizer :
+          {
+            vendor: cs.speechRecognizerVendor,
+            language: cs.speechRecognizerLanguage
+          };
+        this.logger.info({opts: this.gatherOpts}, 'Config: enabling bargeIn');
+        cs.enableBotMode(this.gatherOpts, this.autoEnable);
+      }
+      else if (this.bargeIn.enable === false) {
+        this.logger.info('Config: disabling bargeIn');
+        cs.disableBotMode();
+      }
+    }
+    if (this.record.action) {
+      try {
+        await cs.notifyRecordOptions(this.record);
+      } catch (err) {
+        this.logger.info({err}, 'Config: error starting recording');
+      }
+    }
+    if (this.hasListen) {
+      const {enable, ...opts} = this.listen;
+      if (enable) {
+        this.logger.debug({opts}, 'Config: enabling listen');
+        cs.startBackgroundListen({verb: 'listen', ...opts});
+      } else {
+        this.logger.info('Config: disabling listen');
+        cs.stopBackgroundListen();
+      }
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    //if (this.ep && this.stopAmd) this.stopAmd(this.ep, this);
+  }
+
+  _onAmdEvent(cs, evt) {
+    this.logger.info({evt}, 'Config:_onAmdEvent');
+    const {actionHook} = this.data.amd;
+    this.performHook(cs, actionHook, evt)
+      .catch((err) => {
+        this.logger.error({err}, 'Config:_onAmdEvent - error calling actionHook');
+      });
+
+  }
+}
+
+module.exports = TaskConfig;

lib/tasks/dequeue.js

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

lib/tasks/dial.js

@@ -1,11 +1,20 @@
 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');
+const {parseUri} = require('drachtio-srf');
 
 function parseDtmfOptions(logger, dtmfCapture) {
   let parentDtmfCollector, childDtmfCollector;
@@ -37,12 +46,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 t1.name === t2.name;
     case 'teams':
-      return t2.name === t1.name;
+      return t1.number === t2.number;
     case 'sip':
-      return t2.sipUri === t1.sipUri;
+      return t1.sipUri === t2.sipUri;
   }
 }
 
@@ -82,7 +92,9 @@ class TaskDial extends Task {
     this.timeLimit = this.data.timeLimit;
     this.confirmHook = this.data.confirmHook;
     this.confirmMethod = this.data.confirmMethod;
+    this.referHook = this.data.referHook;
     this.dtmfHook = this.data.dtmfHook;
+    this.proxy = this.data.proxy;
 
     if (this.dtmfHook) {
       const {parentDtmfCollector, childDtmfCollector} = parseDtmfOptions(logger, this.data.dtmfCapture || {});
@@ -111,14 +123,49 @@ 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 &&
+      !this.startAmd;
+  }
+
+  get summary() {
+    if (this.target.length === 1) {
+      const target = this.target[0];
+      switch (target.type) {
+        case 'phone':
+        case 'teams':
+          return `${this.name}{type=${target.type},number=${target.number}}`;
+        case 'user':
+          return `${this.name}{type=${target.type},name=${target.name}}`;
+        case 'sip':
+          return `${this.name}{type=${target.type},sipUri=${target.sipUri}}`;
+        default:
+          return `${this.name}`;
+      }
+    }
+    else return `${this.name}{${this.target.length} targets}`;
+  }
+
   async exec(cs) {
     await super.exec(cs);
     try {
+      if (this.data.amd) {
+        this.startAmd = cs.startAmd;
+        this.stopAmd = cs.stopAmd;
+        this.on('amd', this._onAmdEvent.bind(this, cs));
+      }
       if (cs.direction === CallDirection.Inbound) {
         await this._initializeInbound(cs);
       }
@@ -128,31 +175,55 @@ class TaskDial extends Task {
           this.epOther.play(this.dialMusic).catch((err) => {});
         }
       }
-      this._installDtmfDetection(cs, this.epOther, this.parentDtmfCollector);
-      await this._attemptCalls(cs);
+      if (!this.killed) 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(cs);
     }
   }
 
-  async kill(cs) {
+  async kill(cs, reason) {
     super.kill(cs);
-    this._removeDtmfDetection(this.cs, this.epOther);
-    this._removeDtmfDetection(this.cs, this.ep);
+    try {
+      if (this.ep && this.ep.amd) this.stopAmd(this.ep, this);
+    } catch (err) {
+      this.logger.error({err}, 'DialTask:kill - error stopping answering machine detectin');
+    }
+    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.removeAllListeners();
       this.sd = null;
     }
     if (this.callSid) sessionTracker.remove(this.callSid);
-    if (this.listenTask) await this.listenTask.kill(cs);
-    if (this.transcribeTask) await this.transcribeTask.kill(cs);
-    if (this.timerMaxCallDuration) clearTimeout(this.timerMaxCallDuration);
+    if (this.listenTask) {
+      await this.listenTask.kill(cs);
+      this.listenTask = null;
+    }
+    if (this.transcribeTask) {
+      await this.transcribeTask.kill(cs);
+      this.transcribeTask = null;
+    }
     this.notifyTaskDone();
   }
 
@@ -161,18 +232,32 @@ 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');
       while (tasks.length && !cs.callGone) {
         const task = tasks.shift();
-        await task.exec(cs, callSid === this.callSid ? this.ep : this.epOther);
+        const {span, ctx} = this.startChildSpan(`whisper:${task.summary}`);
+        task.span = span;
+        task.ctx = ctx;
+        await task.exec(cs, callSid === this.callSid ? {ep: this.ep} : {ep: this.epOther});
+        span.end();
       }
       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');
     }
@@ -182,56 +267,120 @@ 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`);
     }
   }
 
+  async handleRefer(cs, req, res, callInfo = cs.callInfo) {
+    if (this.referHook) {
+      try {
+        const isChild = !!callInfo.parentCallSid;
+        const referring_call_sid = isChild ? callInfo.callSid : cs.callSid;
+        const referred_call_sid = isChild ? callInfo.parentCallSid : this.sd.callSid;
+
+        const b3 = this.getTracingPropagation();
+        const httpHeaders = b3 && {b3};
+
+        const to = parseUri(req.getParsedHeader('Refer-To').uri);
+        const by = parseUri(req.getParsedHeader('Referred-By').uri);
+        this.logger.info({to}, 'refer to parsed');
+        await cs.requestor.request('verb:hook', this.referHook, {
+          ...callInfo,
+          refer_details: {
+            sip_refer_to: req.get('Refer-To'),
+            sip_referred_by: req.get('Referred-By'),
+            sip_user_agent: req.get('User-Agent'),
+            refer_to_user: to.user,
+            referred_by_user: by.user,
+            referring_call_sid,
+            referred_call_sid
+          }
+        }, httpHeaders);
+        res.send(202);
+        this.logger.info('DialTask:handleRefer - sent 202 Accepted');
+      } catch (err) {
+        res.send(err.statusCode || 501);
+      }
+    }
+    else {
+      this.logger.info('DialTask:handleRefer - got REFER but no referHook, responding 501');
+      res.send(501);
+    }
+  }
+
+  _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.removeAllListeners('dtmf');
-    }
+  _removeDtmfDetection(dlg) {
+    dlg && dlg.removeAllListeners('info');
   }
 
-  _onDtmf(cs, ep, evt) {
-    if (ep.dtmfDetector) {
-      const match = ep.dtmfDetector.keyPress(evt.dtmf);
-      const requestor = ep.dtmfDetector === this.parentDtmfCollector ?
-        cs.requestor :
-        this.sd.requestor;
-      if (match) {
-        this.logger.debug(`parentCall triggered dtmf match: ${match}`);
-        requestor.request(this.dtmfHook, Object.assign({dtmf: match}, cs.callInfo))
-          .catch((err) => this.logger.info(err, 'Dial:_onDtmf - error'));
-      }
+  _onInfo(cs, dlg, req, res) {
+    res.send(200);
+    if (req.get('Content-Type') !== 'application/dtmf-relay') return;
+
+    const dtmfDetector = dlg === cs.dlg ? this.parentDtmfCollector : this.childDtmfCollector;
+    if (!dtmfDetector) return;
+    let requestor, callSid, callInfo;
+    if (dtmfDetector === this.parentDtmfCollector) {
+      requestor = cs.requestor;
+      callSid = cs.callSid;
+      callInfo = cs.callInfo;
+    }
+    else {
+      requestor = this.sd?.requestor;
+      callSid = this.sd?.callSid;
+      callInfo = this.sd?.callInfo;
+    }
+    if (!requestor) return;
+    const arr = /Signal=([0-9#*])/.exec(req.body);
+    if (!arr) return;
+    const key = arr[1];
+    const match = dtmfDetector.keyPress(key);
+    if (match) {
+      const b3 = this.getTracingPropagation();
+      const httpHeaders = b3 && {b3};
+      this.logger.info({callSid}, `Dial:_onInfo triggered dtmf match: ${match}`);
+      requestor.request('verb:hook', this.dtmfHook, {dtmf: match, ...callInfo.toJSON()}, httpHeaders)
+        .catch((err) => this.logger.info(err, 'Dial:_onDtmf - error'));
     }
   }
 
   async _initializeInbound(cs) {
-    const ep = await cs._evalEndpointPrecondition(this);
+    const {ep} = await cs._evalEndpointPrecondition(this);
     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
@@ -244,34 +393,74 @@ class TaskDial extends Task {
   async _attemptCalls(cs) {
     const {req, srf} = cs;
     const {getSBC} = srf.locals;
-    const {lookupTeamsByAccount} = srf.locals.dbHelpers;
-    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 (!sbcAddress) throw new Error('no SBC found for outbound call');
+    this.headers = {
+      'X-Account-Sid': cs.accountSid,
+      ...(req && req.has('X-CID') && {'X-CID': req.get('X-CID')}),
+      ...(req && req.has('P-Asserted-Identity') && {'P-Asserted-Identity': req.get('P-Asserted-Identity')}),
+      // Put headers at the end to make sure opt.headers override all default behavior.
+      ...this.headers
+    };
+
     const opts = {
-      headers: req && req.has('X-CID') ? Object.assign(this.headers, {'X-CID': req.get('X-CID')}) : this.headers,
+      headers: this.headers,
       proxy: `sip:${sbcAddress}`,
       callingNumber: this.callerId || req.callingNumber
     };
 
-    if (this.target.find((t) => t.type === 'teams')) {
+    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: obj.tenant_fqdn, ms_teams_fqdn: obj.ms_teams_fqdn});
+      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.result = {
+        dialCallStatus: CallStatus.NoAnswer,
+        dialSipStatus: 487
+      };
+      this.kill(cs);
     }, this.timeout * 1000);
 
-    this.target.forEach((t) => {
+    this.span.setAttributes({'dial.target': JSON.stringify(this.target)});
+    this.target.forEach(async(t) => {
       try {
-        t.url = t.url || this.confirmUrl;
-        t.method = t.method || this.confirmMethod || 'POST';
+        t.confirmHook = t.confirmHook || this.confirmHook;
+        //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;
+          }
+        }
+
+        if (this.killed) return;
+
         const sd = placeCall({
           logger: this.logger,
           application: cs.application,
@@ -280,13 +469,19 @@ class TaskDial extends Task {
           sbcAddress,
           target: t,
           opts,
-          callInfo: cs.callInfo
+          callInfo: cs.callInfo,
+          accountInfo: cs.accountInfo,
+          rootSpan: cs.rootSpan,
+          startSpan: this.startSpan.bind(this)
         });
         this.dials.set(sd.callSid, sd);
 
         sd
+          .on('refer', (callInfo, req, res) => this.handleRefer(cs, req, res, callInfo))
           .on('callCreateFail', () => {
+            clearTimeout(this.timerRing);
             this.dials.delete(sd.callSid);
+            sd.removeAllListeners();
             if (this.dials.size === 0 && !this.sd) {
               this.logger.debug('Dial:_attemptCalls - all calls failed after call create err, ending task');
               this.kill(cs);
@@ -296,6 +491,7 @@ class TaskDial extends Task {
             if (this.results.dialCallStatus !== CallStatus.Completed) {
               Object.assign(this.results, {
                 dialCallStatus: obj.callStatus,
+                dialSipStatus: obj.sipStatus,
                 dialCallSid: sd.callSid,
               });
             }
@@ -309,7 +505,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:
@@ -317,23 +514,51 @@ 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);
+                  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);
+            clearTimeout(this.timerRing);
+            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}`);
+            clearTimeout(this.timerRing);
             this.dials.delete(sd.callSid);
+            sd.removeAllListeners();
             if (this.dials.size === 0 && !this.sd) {
               this.logger.debug('Dial:_attemptCalls - all calls failed after decline, ending task');
               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');
+            }
+          })
+          .on('refer', (callInfo, req, res) => {
+
+          })
+          .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');
@@ -341,29 +566,38 @@ 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
    * - save the dialog and endpoint
    * - clock the start time of the call,
    * - start a max call length timer (optionally)
+   * - start answering machine detection (optionally)
    * - 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);
 
@@ -371,33 +605,47 @@ 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(cs);
-      }, 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(cs);
+      /* 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 (this.transcribeTask) this.transcribeTask.exec(cs, {ep2: this.epOther, ep:this.ep});
+    if (this.listenTask) this.listenTask.exec(cs, {ep: this.epOther});
+    if (this.startAmd) {
+      try {
+        this.startAmd(cs, this.ep, this, this.data.amd);
+      } catch (err) {
+        this.logger.info({err}, 'Dial:_selectSingleDial - Error calling startAmd');
+      }
+    }
+
+    /* if we can release the media back to the SBC, do so now */
+    if (this.canReleaseMedia) setTimeout(this._releaseMedia.bind(this, cs, sd), 200);
   }
 
   _bridgeEarlyMedia(sd) {
@@ -409,6 +657,47 @@ class TaskDial extends Task {
     }
   }
 
+  /**
+   * 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});
+  }
+
+  _onAmdEvent(cs, evt) {
+    this.logger.info({evt}, 'Dial:_onAmdEvent');
+    const {actionHook} = this.data.amd;
+    this.performHook(cs, actionHook, evt)
+      .catch((err) => {
+        this.logger.error({err}, 'Dial:_onAmdEvent - error calling actionHook');
+      });
+  }
 }
 
 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,484 @@
+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('@jambonz/verb-specifications');
+
+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.thinkingMusic && !transcription.isEmpty && transcription.isFinal &&
+      transcription.confidence > 0.8) {
+      ep.play(this.data.thinkingMusic).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.thinkingMusic) {
+      ep.play(this.thinkingMusic).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 b3 = this.getTracingPropagation();
+    const httpHeaders = b3 && {b3};
+    const json = await this.cs.requestor.request('verb:hook', hook,
+      {...results, ...cs.callInfo.toJSON()}, httpHeaders);
+    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

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

lib/tasks/gather.js

@@ -1,121 +1,494 @@
 const Task = require('./task');
-const {TaskName, TaskPreconditions, TranscriptionEvents} = require('../utils/constants');
+const {
+  TaskName,
+  TaskPreconditions,
+  GoogleTranscriptionEvents,
+  NuanceTranscriptionEvents,
+  AwsTranscriptionEvents,
+  AzureTranscriptionEvents,
+  DeepgramTranscriptionEvents,
+  SonioxTranscriptionEvents,
+  IbmTranscriptionEvents,
+  NvidiaTranscriptionEvents,
+  JambonzTranscriptionEvents
+} = require('../utils/constants');
+
 const makeTask = require('./make_task');
 const assert = require('assert');
 
+const compileTranscripts = (logger, evt, arr) => {
+  if (!Array.isArray(arr) || arr.length === 0) return;
+  let t = '';
+  for (const a of arr) {
+    t += ` ${a.alternatives[0].transcript}`;
+  }
+  t += ` ${evt.alternatives[0].transcript}`;
+  evt.alternatives[0].transcript = t.trim();
+};
+
 class TaskGather extends Task {
-  constructor(logger, opts) {
+  constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
 
+    const {
+      setChannelVarsForStt,
+      normalizeTranscription,
+      removeSpeechListeners,
+      setSpeechCredentialsAtRuntime,
+      compileSonioxTranscripts
+    } = require('../utils/transcription-utils')(logger);
+    this.setChannelVarsForStt = setChannelVarsForStt;
+    this.normalizeTranscription = normalizeTranscription;
+    this.removeSpeechListeners = removeSpeechListeners;
+    this.compileSonioxTranscripts = compileSonioxTranscripts;
+
     [
-      'finishOnKey', 'hints', 'input', 'numDigits',
-      'partialResultHook', 'profanityFilter',
+      'finishOnKey', 'input', 'numDigits', 'minDigits', 'maxDigits',
+      'interDigitTimeout', 'partialResultHook', 'bargein', 'dtmfBargein',
       'speechTimeout', 'timeout', 'say', 'play'
     ].forEach((k) => this[k] = this.data[k]);
 
-    this.timeout = (this.timeout || 5) * 1000;
-    this.interim = this.partialResultCallback;
+    /* when collecting dtmf, bargein on dtmf is true unless explicitly set to false */
+    if (this.dtmfBargein !== false  && this.input.includes('digits')) this.dtmfBargein = true;
+
+    /* timeout of zero means no timeout */
+    this.timeout = this.timeout === 0 ? 0 : (this.timeout || 15) * 1000;
+    this.interim = !!this.partialResultHook || this.bargein || (this.timeout > 0);
+    this.listenDuringPrompt = this.data.listenDuringPrompt === false ? false : true;
+    this.minBargeinWordCount = this.data.minBargeinWordCount || 1;
     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;
+
+      /* let credentials be supplied in the recognizer object at runtime */
+      this.sttCredentials = setSpeechCredentialsAtRuntime(recognizer);
+
+      /* continuous ASR (i.e. compile transcripts until a special timeout or dtmf key) */
+      this.asrTimeout = typeof recognizer.asrTimeout === 'number' ? recognizer.asrTimeout * 1000 : 0;
+      if (this.asrTimeout > 0) this.asrDtmfTerminationDigit = recognizer.asrDtmfTerminationDigit;
+      this.isContinuousAsr = this.asrTimeout > 0;
+
+      if (Array.isArray(this.data.recognizer.hints) &&
+        0 == this.data.recognizer.hints.length && process.env.JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS) {
+        logger.debug('Gather: an empty hints array was supplied, so we will mask global hints');
+        this.maskGlobalSttHints = true;
+      }
+      this.data.recognizer.hints = this.data.recognizer.hints || [];
+      this.data.recognizer.altLanguages = this.data.recognizer.altLanguages || [];
     }
+    else this.data.recognizer = {hints: [], altLanguages: []};
 
     this.digitBuffer = '';
     this._earlyMedia = this.data.earlyMedia === true;
 
-    if (this.say) this.sayTask = makeTask(this.logger, {say: this.say}, this);
-    if (this.play) this.playTask = makeTask(this.logger, {play: this.play}, this);
+    if (this.say) {
+      this.sayTask = makeTask(this.logger, {say: this.say}, this);
+    }
+    if (this.play) {
+      this.playTask = makeTask(this.logger, {play: this.play}, this);
+    }
+    if (!this.sayTask && !this.playTask) this.listenDuringPrompt = false;
+
+    /* buffer speech for continuous asr */
+    this._bufferedTranscripts = [];
+
+    /* buffer for soniox transcripts */
+    this._sonioxTranscripts = [];
+
+    this.parentTask = parentTask;
+    this.partialTranscriptsCount = 0;
   }
 
   get name() { return TaskName.Gather; }
 
+  get needsStt() { return this.input.includes('speech'); }
+
+  get wantsSingleUtterance() {
+    return this.data.recognizer?.singleUtterance === true;
+  }
+
   get earlyMedia() {
     return (this.sayTask && this.sayTask.earlyMedia) ||
       (this.playTask && this.playTask.earlyMedia);
   }
 
-  async exec(cs, ep) {
+  get summary() {
+    let s = `${this.name}{`;
+    if (this.input.length === 2) s += 'inputs=[speech,digits],';
+    else if (this.input.includes('digits')) s += 'inputs=digits';
+    else s += 'inputs=speech,';
+
+    if (this.input.includes('speech')) {
+      s += `vendor=${this.vendor || 'default'},language=${this.language || 'default'}`;
+    }
+    if (this.sayTask) s += ',with nested say task';
+    if (this.playTask) s += ',with nested play task';
+    s += '}';
+    return s;
+  }
+
+  async exec(cs, {ep}) {
+    this.logger.debug({options: this.data}, 'Gather:exec');
     await super.exec(cs);
+    const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
+    const {getNuanceAccessToken, getIbmAccessToken} = cs.srf.locals.dbHelpers;
+
+    if (cs.hasGlobalSttHints && !this.maskGlobalSttHints) {
+      const {hints, hintsBoost} = cs.globalSttHints;
+      const setOfHints = new Set(this.data.recognizer.hints
+        .concat(hints)
+        .filter((h) => typeof h === 'string' && h.length > 0));
+      this.data.recognizer.hints = [...setOfHints];
+      if (!this.data.recognizer.hintsBoost && hintsBoost) this.data.recognizer.hintsBoost = hintsBoost;
+      this.logger.debug({hints: this.data.recognizer.hints, hintsBoost: this.data.recognizer.hintsBoost},
+        'Gather:exec - applying global sttHints');
+    }
+    if (cs.hasAltLanguages) {
+      this.data.recognizer.altLanguages = this.data.recognizer.altLanguages.concat(cs.altLanguages);
+      this.logger.debug({altLanguages: this.altLanguages},
+        'Gather:exec - applying altLanguages');
+    }
+    if (cs.hasGlobalSttPunctuation && !this.data.recognizer.punctuation) {
+      this.data.recognizer.punctuation = cs.globalSttPunctuation;
+    }
+    if (!this.isContinuousAsr && cs.isContinuousAsr) {
+      this.isContinuousAsr = true;
+      this.asrTimeout = cs.asrTimeout * 1000;
+      this.asrDtmfTerminationDigit = cs.asrDtmfTerminationDigit;
+      this.logger.debug({
+        asrTimeout: this.asrTimeout,
+        asrDtmfTerminationDigit: this.asrDtmfTerminationDigit
+      }, 'Gather:exec - enabling continuous ASR since it is turned on for the session');
+    }
+    const {JAMBONZ_GATHER_EARLY_HINTS_MATCH, JAMBONES_GATHER_EARLY_HINTS_MATCH} = process.env;
+    if ((JAMBONZ_GATHER_EARLY_HINTS_MATCH || JAMBONES_GATHER_EARLY_HINTS_MATCH) && this.needsStt &&
+      !this.isContinuousAsr &&
+      this.data.recognizer?.hints?.length > 0 && this.data.recognizer?.hints?.length <= 10) {
+      this.earlyHintsMatch = true;
+      this.interim = true;
+      this.logger.debug('Gather:exec - early hints match enabled');
+    }
+
     this.ep = ep;
+    if ('default' === this.vendor || !this.vendor) {
+      this.vendor = cs.speechRecognizerVendor;
+      if (this.data.recognizer) this.data.recognizer.vendor = this.vendor;
+    }
+    if ('default' === this.language || !this.language) {
+      this.language = cs.speechRecognizerLanguage;
+      if (this.data.recognizer) this.data.recognizer.language = this.language;
+    }
+    if (!this.data.recognizer.vendor) {
+      this.data.recognizer.vendor = this.vendor;
+    }
+    if (this.needsStt && !this.sttCredentials) 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'));
+      // Notify application that STT vender is wrong.
+      this.notifyError({
+        msg: 'ASR error',
+        details: `No speech-to-text service credentials for ${this.vendor} have been configured`
+      });
+      this.notifyTaskDone();
+      throw new Error(`No speech-to-text service credentials for ${this.vendor} have been configured`);
+    }
+
+    if (this.vendor === 'nuance' && this.sttCredentials.client_id) {
+      /* get nuance access token */
+      const {client_id, secret} = this.sttCredentials;
+      const {access_token, servedFromCache} = await getNuanceAccessToken(client_id, secret, 'asr tts');
+      this.logger.debug({client_id}, `Gather:exec - got nuance access token ${servedFromCache ? 'from cache' : ''}`);
+      this.sttCredentials = {...this.sttCredentials, access_token};
+    }
+    else if (this.vendor == 'ibm' && this.sttCredentials.stt_api_key) {
+      /* get ibm access token */
+      const {stt_api_key, stt_region} = this.sttCredentials;
+      const {access_token, servedFromCache} = await getIbmAccessToken(stt_api_key);
+      this.logger.debug({stt_api_key}, `Gather:exec - got ibm access token ${servedFromCache ? 'from cache' : ''}`);
+      this.sttCredentials = {...this.sttCredentials, access_token, stt_region};
+    }
+    const startListening = (cs, ep) => {
+      this._startTimer();
+      if (this.isContinuousAsr && 0 === this.timeout) this._startAsrTimer();
+      if (this.input.includes('speech') && !this.listenDuringPrompt) {
+        this._initSpeech(cs, ep)
+          .then(() => {
+            if (this.killed) {
+              this.logger.info('Gather:exec - task was quickly killed so do not transcribe');
+              return;
+            }
+            this._startTranscribing(ep);
+            return updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid);
+          })
+          .catch((err) => {
+            this.logger.error({err}, 'error in initSpeech');
+          });
+      }
+    };
 
     try {
       if (this.sayTask) {
-        this.sayTask.exec(cs, ep);  // kicked off, _not_ waiting for it to complete
+        const {span, ctx} = this.startChildSpan(`nested:${this.sayTask.summary}`);
+        this.sayTask.span = span;
+        this.sayTask.ctx = ctx;
+        this.sayTask.exec(cs, {ep});  // kicked off, _not_ waiting for it to complete
         this.sayTask.on('playDone', (err) => {
-          if (!this.killed) this._startTimer();
+          span.end();
+          if (err) this.logger.error({err}, 'Gather:exec Error playing tts');
+          this.logger.debug('Gather: nested say task completed');
+          if (!this.killed) {
+            startListening(cs, ep);
+            if (this.input.includes('speech') && this.vendor === 'nuance' && this.listenDuringPrompt) {
+              this.logger.debug('Gather:exec - starting transcription timers after say completes');
+              ep.startTranscriptionTimers((err) => {
+                if (err) this.logger.error({err}, 'Gather:exec - error starting transcription timers');
+              });
+            }
+          }
         });
       }
       else if (this.playTask) {
-        this.playTask.exec(cs, ep);  // kicked off, _not_ waiting for it to complete
+        const {span, ctx} = this.startChildSpan(`nested:${this.playTask.summary}`);
+        this.playTask.span = span;
+        this.playTask.ctx = ctx;
+        this.playTask.exec(cs, {ep});  // kicked off, _not_ waiting for it to complete
         this.playTask.on('playDone', (err) => {
-          if (!this.killed) this._startTimer();
+          span.end();
+          if (err) this.logger.error({err}, 'Gather:exec Error playing url');
+          this.logger.debug('Gather: nested play task completed');
+          if (!this.killed) {
+            startListening(cs, ep);
+            if (this.input.includes('speech') && this.vendor === 'nuance' && this.listenDuringPrompt) {
+              this.logger.debug('Gather:exec - starting transcription timers after play completes');
+              ep.startTranscriptionTimers((err) => {
+                if (err) this.logger.error({err}, 'Gather:exec - error starting transcription timers');
+              });
+            }
+          }
         });
       }
-      else this._startTimer();
-
-      if (this.input.includes('speech')) {
-        await this._initSpeech(ep);
-        this._startTranscribing(ep);
+      else {
+        if (this.killed) {
+          this.logger.info('Gather:exec - task was immediately killed so do not transcribe');
+          return;
+        }
+        startListening(cs, ep);
       }
 
-      if (this.input.includes('digits')) {
-        ep.on('dtmf', this._onDtmf.bind(this, ep));
+      if (this.input.includes('speech') && this.listenDuringPrompt) {
+        await this._initSpeech(cs, ep);
+        this._startTranscribing(ep);
+        updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid)
+          .catch(() => {/*already logged error */});
+      }
+
+      if (this.input.includes('digits') || this.dtmfBargein || this.asrDtmfTerminationDigit) {
+        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);
+    this.removeSpeechListeners(ep);
   }
 
   kill(cs) {
     super.kill(cs);
-    this._killAudio();
+    this._killAudio(cs);
+    this.ep.removeAllListeners('dtmf');
+    clearTimeout(this.interDigitTimer);
+    this._clearAsrTimer();
+    this.playTask?.span.end();
+    this.sayTask?.span.end();
     this._resolve('killed');
   }
 
-  _onDtmf(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');
+  updateTaskInProgress(opts) {
+    if (!this.needsStt && opts.input.includes('speech')) {
+      this.logger.info('TaskGather:updateTaskInProgress - adding speech to a background gather');
+      return false; // this needs be handled by killing the background gather and starting a new one
     }
-    this._killAudio();
+    const {timeout} = opts;
+    this.timeout = timeout;
+    this._startTimer();
+    return true;
   }
 
-  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(',')});
+  _onDtmf(cs, ep, evt) {
+    this.logger.debug(evt, 'TaskGather:_onDtmf');
+    clearTimeout(this.interDigitTimer);
+    let resolved = false;
+    if (this.dtmfBargein) {
+      this._killAudio(cs);
+      this.emit('dtmf', evt);
     }
-    if (this.profanityFilter === true) {
-      Object.assign(opts, {'GOOGLE_SPEECH_PROFANITY_FILTER': true});
+    if (evt.dtmf === this.finishOnKey && this.input.includes('digits')) {
+      resolved = true;
+      this._resolve('dtmf-terminator-key');
     }
-    this.logger.debug(`setting freeswitch vars ${JSON.stringify(opts)}`);
+    else if (this.input.includes('digits')) {
+      this.digitBuffer += evt.dtmf;
+      const len = this.digitBuffer.length;
+      if (len === this.numDigits || len === this.maxDigits) {
+        resolved = true;
+        this._resolve('dtmf-num-digits');
+      }
+    }
+    else if (this.isContinuousAsr && evt.dtmf === this.asrDtmfTerminationDigit) {
+      this.logger.info(`continuousAsr triggered with dtmf ${this.asrDtmfTerminationDigit}`);
+      this._clearAsrTimer();
+      this._clearTimer();
+      this._startFinalAsrTimer();
+      return;
+    }
+    if (!resolved && this.interDigitTimeout > 0 && this.digitBuffer.length >= this.minDigits) {
+      /* start interDigitTimer */
+      const ms = this.interDigitTimeout * 1000;
+      this.logger.debug(`starting interdigit timer of ${ms}`);
+      this.interDigitTimer = setTimeout(() => this._resolve('dtmf-interdigit-timeout'), ms);
+    }
+  }
+
+  async _initSpeech(cs, ep) {
+    const opts = this.setChannelVarsForStt(this, this.sttCredentials, this.data.recognizer);
+    switch (this.vendor) {
+      case 'google':
+        this.bugname = 'google_transcribe';
+        ep.addCustomEventListener(GoogleTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(GoogleTranscriptionEvents.EndOfUtterance, this._onEndOfUtterance.bind(this, cs, ep));
+        ep.addCustomEventListener(GoogleTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
+        break;
+
+      case 'aws':
+      case 'polly':
+        this.bugname = 'aws_transcribe';
+        ep.addCustomEventListener(AwsTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(AwsTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
+        break;
+      case 'microsoft':
+        this.bugname = 'azure_transcribe';
+        ep.addCustomEventListener(AzureTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected,
+          this._onNoSpeechDetected.bind(this, cs, ep));
+        ep.addCustomEventListener(AzureTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
+        break;
+      case 'nuance':
+        this.bugname = 'nuance_transcribe';
+        ep.addCustomEventListener(NuanceTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(NuanceTranscriptionEvents.StartOfSpeech,
+          this._onStartOfSpeech.bind(this, cs, ep));
+        ep.addCustomEventListener(NuanceTranscriptionEvents.TranscriptionComplete,
+          this._onTranscriptionComplete.bind(this, cs, ep));
+        ep.addCustomEventListener(NuanceTranscriptionEvents.VadDetected,
+          this._onVadDetected.bind(this, cs, ep));
+
+        /* stall timers until prompt finishes playing */
+        if ((this.sayTask || this.playTask) && this.listenDuringPrompt) {
+          opts.NUANCE_STALL_TIMERS = 1;
+        }
+        break;
+
+      case 'deepgram':
+        this.bugname = 'deepgram_transcribe';
+        ep.addCustomEventListener(DeepgramTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(DeepgramTranscriptionEvents.Connect, this._onDeepgramConnect.bind(this, cs, ep));
+        ep.addCustomEventListener(DeepgramTranscriptionEvents.ConnectFailure,
+          this._onDeepGramConnectFailure.bind(this, cs, ep));
+        break;
+
+      case 'soniox':
+        this.bugname = 'soniox_transcribe';
+        ep.addCustomEventListener(SonioxTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        break;
+
+      case 'ibm':
+        this.bugname = 'ibm_transcribe';
+        ep.addCustomEventListener(IbmTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(IbmTranscriptionEvents.Connect, this._onIbmConnect.bind(this, cs, ep));
+        ep.addCustomEventListener(IbmTranscriptionEvents.ConnectFailure,
+          this._onIbmConnectFailure.bind(this, cs, ep));
+        break;
+
+      case 'nvidia':
+        this.bugname = 'nvidia_transcribe';
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.StartOfSpeech,
+          this._onStartOfSpeech.bind(this, cs, ep));
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.TranscriptionComplete,
+          this._onTranscriptionComplete.bind(this, cs, ep));
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.VadDetected,
+          this._onVadDetected.bind(this, cs, ep));
+
+        /* I think nvidia has this (??) - stall timers until prompt finishes playing */
+        if ((this.sayTask || this.playTask) && this.listenDuringPrompt) {
+          opts.NVIDIA_STALL_TIMERS = 1;
+        }
+        break;
+
+      default:
+        if (this.vendor.startsWith('custom:')) {
+          this.bugname = `${this.vendor}_transcribe`;
+          ep.addCustomEventListener(JambonzTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+          ep.addCustomEventListener(JambonzTranscriptionEvents.Connect, this._onJambonzConnect.bind(this, cs, ep));
+          ep.addCustomEventListener(JambonzTranscriptionEvents.ConnectFailure,
+            this._onJambonzConnectFailure.bind(this, cs, ep));
+          break;
+        }
+        else {
+          this.notifyError({ msg: 'ASR error', details:`Invalid vendor ${this.vendor}`});
+          this.notifyTaskDone();
+          throw new Error(`Invalid vendor ${this.vendor}`);
+        }
+    }
+
+    /* common handler for all stt engine errors */
+    ep.addCustomEventListener(JambonzTranscriptionEvents.Error, this._onJambonzError.bind(this, cs, ep));
     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) {
+    this.logger.debug({
+      vendor: this.vendor,
+      locale: this.language,
+      interim: this.interim,
+      bugname: this.bugname
+    }, 'Gather:_startTranscribing');
     ep.startTranscription({
-      interim: this.partialResultCallback ? true : false,
-      language: this.language || this.callSession.speechRecognizerLanguage
-    }).catch((err) => this.logger.error(err, 'TaskGather:_startTranscribing error'));
+      vendor: this.vendor,
+      locale: this.language,
+      interim: this.interim,
+      bugname: this.bugname,
+    }).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._timeoutTimer = setTimeout(() => this._resolve('timeout'), this.timeout);
+    if (0 === this.timeout) return;
+    this._clearTimer();
+    this._timeoutTimer = setTimeout(() => {
+      if (this.isContinuousAsr) this._startAsrTimer();
+      else this._resolve(this.digitBuffer.length >= this.minDigits ? 'dtmf-num-digits' : 'timeout');
+    }, this.timeout);
   }
 
   _clearTimer() {
@@ -125,40 +498,356 @@ class TaskGather extends Task {
     }
   }
 
-  _killAudio() {
+  _startAsrTimer() {
+    assert(this.isContinuousAsr);
+    this._clearAsrTimer();
+    this._asrTimer = setTimeout(() => {
+      this.logger.debug('_startAsrTimer - asr timer went off');
+      this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout');
+    }, this.asrTimeout);
+    this.logger.debug(`_startAsrTimer: set for ${this.asrTimeout}ms`);
+  }
+
+  _clearAsrTimer() {
+    if (this._asrTimer) clearTimeout(this._asrTimer);
+    this._asrTimer = null;
+  }
+
+  _startFinalAsrTimer() {
+    this._clearFinalAsrTimer();
+    this._finalAsrTimer = setTimeout(() => {
+      this.logger.debug('_startFinalAsrTimer - final asr timer went off');
+      this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout');
+    }, 1000);
+    this.logger.debug('_startFinalAsrTimer: set for 1 second');
+  }
+
+  _clearFinalAsrTimer() {
+    if (this._finalAsrTimer) clearTimeout(this._finalAsrTimer);
+    this._finalAsrTimer = null;
+  }
+
+  _killAudio(cs) {
+    if (!this.sayTask && !this.playTask && this.bargein) {
+      if (this.ep?.connected && !this.playComplete) {
+        this.logger.debug('Gather:_killAudio: killing playback of any audio');
+        this.playComplete = true;
+        this.ep.api('uuid_break', this.ep.uuid)
+          .catch((err) => this.logger.info(err, 'Error killing audio'));
+      }
+      return;
+    }
     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) {
-    this.logger.debug(evt, 'TaskGather:_onTranscription');
-    if (evt.is_final) this._resolve('speech', evt);
-    else if (this.partialResultHook) {
-      this.cs.requestor.request(this.partialResultHook,  Object.assign({speech: evt}, this.cs.callInfo))
-        .catch((err) => this.logger.info(err, 'GatherTask:_onTranscription error'));
+  _onTranscription(cs, ep, evt, fsEvent) {
+    // make sure this is not a transcript from answering machine detection
+    const bugname = fsEvent.getHeader('media-bugname');
+    const finished = fsEvent.getHeader('transcription-session-finished');
+    this.logger.debug({evt, bugname, finished}, `Gather:_onTranscription for vendor ${this.vendor}`);
+    if (bugname && this.bugname !== bugname) return;
+
+    if (this.vendor === 'ibm') {
+      if (evt?.state === 'listening') return;
+    }
+
+    evt = this.normalizeTranscription(evt, this.vendor, 1, this.language);
+    if (evt.alternatives.length === 0) {
+      this.logger.info({evt}, 'TaskGather:_onTranscription - got empty transcript, continue listening');
+      return;
+    }
+
+    /* fast path: our first partial transcript exactly matches an early hint */
+    if (this.earlyHintsMatch && evt.is_final === false && this.partialTranscriptsCount++ === 0) {
+      const transcript = evt.alternatives[0].transcript?.toLowerCase();
+      const hints = this.data.recognizer?.hints || [];
+      if (hints.find((h) => h.toLowerCase() === transcript)) {
+        this.logger.debug({evt}, 'Gather:_onTranscription: early hint match');
+        this._resolve('speech', evt);
+        return;
+      }
+    }
+
+    /* count words for bargein feature */
+    const words = evt.alternatives[0]?.transcript.split(' ').length;
+    const bufferedWords = this._sonioxTranscripts.length +
+      this._bufferedTranscripts.reduce((count, e) => count + e.alternatives[0]?.transcript.split(' ').length, 0);
+
+    if (evt.is_final) {
+      if (evt.alternatives[0].transcript === '' && !this.callSession.callGone && !this.killed) {
+        if (finished === 'true' && ['microsoft', 'deepgram'].includes(this.vendor)) {
+          this.logger.debug({evt}, 'TaskGather:_onTranscription - got empty transcript from old gather, disregarding');
+        }
+        else {
+          this.logger.info({evt}, 'TaskGather:_onTranscription - got empty transcript, continue listening');
+        }
+        return;
+      }
+
+      if (this.isContinuousAsr) {
+        /* append the transcript and start listening again for asrTimeout */
+        const t = evt.alternatives[0].transcript;
+        if (t) {
+          /* remove trailing punctuation */
+          if (/[,;:\.!\?]$/.test(t)) {
+            this.logger.debug('TaskGather:_onTranscription - removing trailing punctuation');
+            evt.alternatives[0].transcript = t.slice(0, -1);
+          }
+          else this.logger.debug({t}, 'TaskGather:_onTranscription - no trailing punctuation');
+        }
+        this.logger.info({evt}, 'TaskGather:_onTranscription - got transcript during continous asr');
+        this._bufferedTranscripts.push(evt);
+        this._clearTimer();
+        if (this._finalAsrTimer) {
+          this._clearFinalAsrTimer();
+          return this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout');
+        }
+        this._startAsrTimer();
+
+        /* some STT engines will keep listening after a final response, so no need to restart */
+        if (!['soniox', 'aws', 'microsoft', 'deepgram'].includes(this.vendor)) this._startTranscribing(ep);
+      }
+      else {
+        if (this.bargein && (words + bufferedWords) < this.minBargeinWordCount) {
+          this.logger.debug({evt, words, bufferedWords},
+            'TaskGather:_onTranscription - final transcript but < min barge words');
+          this._bufferedTranscripts.push(evt);
+          this._startTranscribing(ep);
+          return;
+        }
+        else {
+          if (this.vendor === 'soniox') {
+            /* compile transcripts into one */
+            this._sonioxTranscripts.push(evt.vendor.finalWords);
+            evt = this.compileSonioxTranscripts(this._sonioxTranscripts, 1, this.language);
+            this._sonioxTranscripts = [];
+          }
+          this._resolve('speech', evt);
+        }
+      }
+    }
+    else {
+      /* google has a measure of stability:
+        https://cloud.google.com/speech-to-text/docs/basics#streaming_responses
+        others do not.
+      */
+      //const isStableEnough = typeof evt.stability === 'undefined' || evt.stability > GATHER_STABILITY_THRESHOLD;
+      this._clearTimer();
+      this._startTimer();
+      if (this.bargein && (words + bufferedWords) >= this.minBargeinWordCount) {
+        if (!this.playComplete) {
+          this.logger.debug({transcript: evt.alternatives[0].transcript}, 'killing audio due to speech');
+          this.emit('vad');
+        }
+        this._killAudio(cs);
+      }
+      if (this.partialResultHook) {
+        const b3 = this.getTracingPropagation();
+        const httpHeaders = b3 && {b3};
+        this.cs.requestor.request('verb:hook', this.partialResultHook,  Object.assign({speech: evt},
+          this.cs.callInfo, httpHeaders));
+      }
+      if (this.vendor === 'soniox') {
+        this._clearTimer();
+        if (evt.vendor.finalWords.length) {
+          this.logger.debug({evt}, 'TaskGather:_onTranscription - buffering soniox transcript');
+          this._sonioxTranscripts.push(evt.vendor.finalWords);
+        }
+      }
     }
   }
-  _onEndOfUtterance(ep, evt) {
-    this.logger.info(evt, 'TaskGather:_onEndOfUtterance');
-    this._startTranscribing(ep);
+  _onEndOfUtterance(cs, ep) {
+    this.logger.debug('TaskGather:_onEndOfUtterance');
+    if (this.bargein && this.minBargeinWordCount === 0) {
+      this._killAudio(cs);
+    }
+
+    /**
+     * By default, Gather asks google for multiple utterances.
+     * The reason is that we can sometimes get an 'end_of_utterance' event without
+     * getting a transcription.  This can happen if someone coughs or mumbles.
+     * For that reason don't ask for a single utterance and we'll terminate the transcribe operation
+     * once we get a final transcript.
+     * However, if the usr has specified a singleUtterance, then we need to restart here
+     * since we dont have a final transcript yet.
+     */
+    if (!this.resolved && !this.killed && !this._bufferedTranscripts.length && this.wantsSingleUtterance) {
+      this._startTranscribing(ep);
+    }
+  }
+
+  _onStartOfSpeech(cs, ep) {
+    this.logger.debug('TaskGather:_onStartOfSpeech');
+    if (this.bargein) {
+      this._killAudio(cs);
+    }
+  }
+  _onTranscriptionComplete(cs, ep) {
+    this.logger.debug('TaskGather:_onTranscriptionComplete');
+  }
+  _onDeepgramConnect(_cs, _ep) {
+    this.logger.debug('TaskGather:_onDeepgramConnect');
+  }
+  _onJambonzConnect(_cs, _ep) {
+    this.logger.debug('TaskGather:_onJambonzConnect');
+  }
+  _onJambonzError(cs, _ep, evt) {
+    this.logger.info({evt}, 'TaskGather:_onJambonzError');
+    const {writeAlerts, AlertType} = cs.srf.locals;
+
+    if (this.vendor === 'nuance') {
+      const {code, error} = evt;
+      if (code === 404 && error === 'No speech') return this._resolve('timeout');
+      if (code === 413 && error === 'Too much speech') return this._resolve('timeout');
+    }
+    this.logger.info({evt}, 'TaskGather:_onJambonzError');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Custom speech vendor ${this.vendor} error: ${evt.error}`,
+      vendor: this.vendor,
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for jambonz custom connection failure'));
+    this.notifyError({msg: 'ASR error', details:`Custom speech vendor ${this.vendor} error: ${evt.error}`});
+  }
+
+  _onDeepGramConnectFailure(cs, _ep, evt) {
+    const {reason} = evt;
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    this.logger.info({evt}, 'TaskGather:_onDeepgramConnectFailure');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Failed connecting to Deepgram speech recognizer: ${reason}`,
+      vendor: 'deepgram',
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for deepgram connection failure'));
+    this.notifyError({msg: 'ASR error', details:`Failed connecting to speech vendor deepgram: ${reason}`});
+    this.notifyTaskDone();
+  }
+  _onJambonzConnectFailure(cs, _ep, evt) {
+    const {reason} = evt;
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    this.logger.info({evt}, 'TaskGather:_onJambonzConnectFailure');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Failed connecting to ${this.vendor} speech recognizer: ${reason}`,
+      vendor: this.vendor,
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for jambonz custom connection failure'));
+    this.notifyError({msg: 'ASR error', details:`Failed connecting to speech vendor ${this.vendor}: ${reason}`});
+    this.notifyTaskDone();
+  }
+
+  _onIbmConnect(_cs, _ep) {
+    this.logger.debug('TaskGather:_onIbmConnect');
+  }
+
+  _onIbmConnectFailure(cs, _ep, evt) {
+    const {reason} = evt;
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    this.logger.info({evt}, 'TaskGather:_onIbmConnectFailure');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Failed connecting to IBM watson speech recognizer: ${reason}`,
+      vendor: 'ibm',
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for IBM connection failure'));
+    this.notifyError({msg: 'ASR error', details:`Failed connecting to speech vendor IBM: ${reason}`});
+    this.notifyTaskDone();
+  }
+
+  _onIbmError(cs, _ep, evt) {
+    this.logger.info({evt}, 'TaskGather:_onIbmError');  }
+
+  _onVadDetected(cs, ep) {
+    if (this.bargein && this.minBargeinWordCount === 0) {
+      this.logger.debug('TaskGather:_onVadDetected');
+      this._killAudio(cs);
+      this.emit('vad');
+    }
+  }
+
+  _onNoSpeechDetected(cs, ep, evt, fsEvent) {
+    if (!this.callSession.callGone && !this.killed) {
+      const finished = fsEvent.getHeader('transcription-session-finished');
+      if (this.vendor === 'microsoft' && finished === 'true') {
+        this.logger.debug('TaskGather:_onNoSpeechDetected for old gather, ignoring');
+      }
+      else {
+        this.logger.debug('TaskGather:_onNoSpeechDetected - listen again');
+        this._startTranscribing(ep);
+      }
+      return;
+    }
   }
 
   async _resolve(reason, evt) {
     this.logger.debug(`TaskGather:resolve with reason ${reason}`);
+    if (this.resolved) return;
 
+    this.resolved = true;
+    // Clear dtmf event
+    if (this.dtmfBargein) {
+      this.ep.removeAllListeners('dtmf');
+    }
+    clearTimeout(this.interDigitTimer);
     this._clearTimer();
-    if (reason.startsWith('dtmf')) {
-      await this.performAction({digits: this.digitBuffer});
+
+    if (this.isContinuousAsr && reason.startsWith('speech')) {
+      evt = {
+        is_final: true,
+        transcripts: this._bufferedTranscripts
+      };
+      this.logger.debug({evt}, 'TaskGather:resolve continuous asr');
     }
-    else if (reason.startsWith('speech')) {
-      await this.performAction({speech: evt});
+    else if (!this.isContinuousAsr && reason.startsWith('speech') && this._bufferedTranscripts.length) {
+      compileTranscripts(this.logger, evt, this._bufferedTranscripts);
+      this.logger.debug({evt}, 'TaskGather:resolve buffered results');
     }
+
+    this.span.setAttributes({'stt.resolve': reason, 'stt.result': JSON.stringify(evt)});
+    if (this.needsStt && this.ep && this.ep.connected) {
+      this.ep.stopTranscription({vendor: this.vendor})
+        .catch((err) => this.logger.error({err}, 'Error stopping transcription'));
+    }
+
+    if (this.callSession && this.callSession.callGone) {
+      this.logger.debug('TaskGather:_resolve - call is gone, not invoking web callback');
+      this.notifyTaskDone();
+      return;
+    }
+
+    try {
+      if (reason.startsWith('dtmf')) {
+        if (this.parentTask) this.parentTask.emit('dtmf', evt);
+        else {
+          this.emit('dtmf', evt);
+          await this.performAction({digits: this.digitBuffer, reason: 'dtmfDetected'});
+        }
+      }
+      else if (reason.startsWith('speech')) {
+        if (this.parentTask) this.parentTask.emit('transcription', evt);
+        else {
+          this.emit('transcription', evt);
+          await this.performAction({speech: evt, reason: 'speechDetected'});
+        }
+      }
+      else if (reason.startsWith('timeout')) {
+        if (this.parentTask) this.parentTask.emit('timeout', evt);
+        else {
+          this.emit('timeout', evt);
+          await this.performAction({reason: 'timeout'});
+        }
+      }
+    } catch (err) {  /*already logged error*/ }
     this.notifyTaskDone();
   }
 }

lib/tasks/hangup.js

@@ -14,10 +14,11 @@ class TaskHangup extends Task {
   /**
    * Hangup the call
    */
-  async exec(cs, dlg) {
+  async exec(cs, {dlg}) {
     await super.exec(cs);
     try {
       await dlg.destroy({headers: this.headers});
+      cs._callReleased();
     } catch (err) {
       this.logger.error(err, 'TaskHangup:exec - Error hanging up call');
     }

lib/tasks/leave.js

@@ -8,7 +8,7 @@ class TaskLeave extends Task {
 
   get name() { return TaskName.Leave; }
 
-  async exec(cs, ep) {
+  async exec(cs, {ep}) {
     await super.exec(cs);
     await this.awaitTaskDone();
   }

lib/tasks/lex.js

@@ -0,0 +1,308 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+
+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 b3 = this.getTracingPropagation();
+    const httpHeaders = b3 && {b3};
+    const json = await this.cs.requestor.request('verb:hook', hook, results, httpHeaders);
+    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

@@ -2,6 +2,7 @@ const Task = require('./task');
 const {TaskName, TaskPreconditions, ListenEvents, ListenStatus} = require('../utils/constants');
 const makeTask = require('./make_task');
 const moment = require('moment');
+const MAX_PLAY_AUDIO_QUEUE_SIZE = 10;
 
 class TaskListen extends Task {
   constructor(logger, opts, parentTask) {
@@ -10,7 +11,7 @@ class TaskListen extends Task {
 
     [
       'action', 'auth', 'method', 'url', 'finishOnKey', 'maxLength', 'metadata', 'mixType', 'passDtmf', 'playBeep',
-      'sampleRate', 'timeout', 'transcribe', 'wsAuth'
+      'sampleRate', 'timeout', 'transcribe', 'wsAuth', 'disableBidirectionalAudio'
     ].forEach((k) => this[k] = this.data[k]);
 
     this.mixType = this.mixType || 'mono';
@@ -20,17 +21,18 @@ class TaskListen extends Task {
     this.nested = parentTask instanceof Task;
 
     this.results = {};
+    this.playAudioQueue = [];
+    this.isPlayingAudioFromQueue = false;
 
     if (this.transcribe) this.transcribeTask = makeTask(logger, {'transcribe': opts.transcribe}, this);
-
-    this._dtmfHandler = this._onDtmf.bind(this);
   }
 
   get name() { return TaskName.Listen; }
 
-  async exec(cs, ep) {
+  async exec(cs, {ep}) {
     await super.exec(cs);
     this.ep = ep;
+    this._dtmfHandler = this._onDtmf.bind(this, ep);
 
     try {
       this.hook = this.normalizeUrl(this.url, 'GET', this.wsAuth);
@@ -38,7 +40,12 @@ class TaskListen extends Task {
       if (this.playBeep) await this._playBeep(ep);
       if (this.transcribeTask) {
         this.logger.debug('TaskListen:exec - starting nested transcribe task');
-        this.transcribeTask.exec(cs, ep);
+        const {span, ctx} = this.startChildSpan(`nested:${this.transcribeTask.summary}`);
+        this.transcribeTask.span = span;
+        this.transcribeTask.ctx = ctx;
+        this.transcribeTask.exec(cs, {ep})
+          .then((result) => span.end())
+          .catch((err) => span.end());
       }
       await this._startListening(cs, ep);
       await this.awaitTaskDone();
@@ -54,16 +61,25 @@ class TaskListen extends Task {
     super.kill(cs);
     this.logger.debug(`TaskListen:kill endpoint connected? ${this.ep && this.ep.connected}`);
     this._clearTimer();
+    this.playAudioQueue = [];
     if (this.ep && this.ep.connected) {
       this.logger.debug('TaskListen:kill closing websocket');
-      await this.ep.forkAudioStop()
-        .catch((err) => this.logger.info(err, 'TaskListen:kill'));
+      try {
+        await this.ep.forkAudioStop();
+        this.logger.debug('TaskListen:kill successfully closed websocket');
+      } catch (err) {
+        this.logger.info(err, 'TaskListen:kill');
+      }
     }
     if (this.recordStartTime) {
       const duration = moment().diff(this.recordStartTime, 'seconds');
       this.results.dialCallDuration = duration;
     }
-    if (this.transcribeTask) await this.transcribeTask.kill(cs);
+    if (this.transcribeTask) {
+      await this.transcribeTask.kill(cs);
+      this.transcribeTask = null;
+    }
+    this.ep && this._removeListeners(this.ep);
     this.notifyTaskDone();
   }
 
@@ -122,6 +138,13 @@ class TaskListen extends Task {
     if (this.finishOnKey || this.passDtmf) {
       ep.on('dtmf', this._dtmfHandler);
     }
+
+    /* support bi-directional audio */
+    if (!this.disableBiDirectionalAudio) {
+      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,9 +154,19 @@ 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) {
+  _onDtmf(ep, evt) {
+    this.logger.debug({evt}, `TaskListen:_onDtmf received dtmf ${evt.dtmf}`);
+    if (this.passDtmf && this.ep?.connected) {
+      const obj = {event: 'dtmf', dtmf: evt.dtmf, duration: evt.duration};
+      this.ep.forkAudioSendText(obj)
+        .catch((err) => this.logger.info({err}, 'TaskListen:_onDtmf error sending dtmf'));
+    }
     if (evt.dtmf === this.finishOnKey) {
       this.logger.info(`TaskListen:_onDtmf terminating task due to dtmf ${evt.dtmf}`);
       this.results.digits = evt.dtmf;
@@ -154,11 +187,72 @@ class TaskListen extends Task {
     this.logger.info(evt, 'TaskListen:_onConnectFailure');
     this.notifyTaskDone();
   }
+
+  async _playAudio(ep, evt, logger) {
+    try {
+      const results = await ep.play(evt.file);
+      logger.debug(`Finished playing file, result: ${JSON.stringify(results)}`);
+      ep.forkAudioSendText({type: 'playDone', data: Object.assign({id: evt.id}, results)});
+    } catch (err) {
+      logger.error({err}, 'Error playing file');
+    }
+  }
+
+  async _onPlayAudio(ep, evt) {
+    this.logger.info(`received play_audio event: ${JSON.stringify(evt)}`);
+    if (!evt.queuePlay) {
+      this.playAudioQueue = [];
+      this._playAudio(ep, evt, this.logger);
+      this.isPlayingAudioFromQueue = false;
+      return;
+    }
+
+    if (this.playAudioQueue.length <= MAX_PLAY_AUDIO_QUEUE_SIZE) {
+      this.playAudioQueue.push(evt);
+    }
+
+    if (this.isPlayingAudioFromQueue) return;
+
+    this.isPlayingAudioFromQueue = true;
+    while (this.playAudioQueue.length > 0) {
+      await this._playAudio(ep, this.playAudioQueue.shift(), this.logger);
+    }
+    this.isPlayingAudioFromQueue = false;
+  }
+
+  _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, {ep: 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

@@ -1,4 +1,4 @@
-const Task = require('./task');
+const { validateVerb } = require('@jambonz/verb-specifications');
 const {TaskName} = require('../utils/constants');
 const errBadInstruction = new Error('malformed jambonz application payload');
 
@@ -12,21 +12,35 @@ function makeTask(logger, obj, parent) {
   if (typeof data !== 'object') {
     throw errBadInstruction;
   }
-  Task.validate(name, data);
+  validateVerb(name, data, logger);
   switch (name) {
     case TaskName.SipDecline:
       const TaskSipDecline = require('./sip_decline');
       return new TaskSipDecline(logger, data, parent);
+    case TaskName.SipRequest:
+      const TaskSipRequest = require('./sip_request');
+      return new TaskSipRequest(logger, data, parent);
+    case TaskName.SipRefer:
+      const TaskSipRefer = require('./sip_refer');
+      return new TaskSipRefer(logger, data, parent);
+    case TaskName.Config:
+      const TaskConfig = require('./config');
+      return new TaskConfig(logger, data, parent);
     case TaskName.Conference:
-      logger.debug({data}, 'Conference verb');
       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);
@@ -36,6 +50,15 @@ function makeTask(logger, obj, 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 uuidv4 = require('uuid-random');
+
+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

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

lib/tasks/play.js

@@ -7,20 +7,66 @@ class TaskPlay extends Task {
     this.preconditions = TaskPreconditions.Endpoint;
 
     this.url = this.data.url;
+    this.seekOffset = this.data.seekOffset || -1;
+    this.timeoutSecs = this.data.timeoutSecs || -1;
     this.loop = this.data.loop || 1;
     this.earlyMedia = this.data.earlyMedia === true;
   }
 
   get name() { return TaskName.Play; }
 
-  async exec(cs, ep) {
+  get summary() {
+    return `${this.name}:{url=${this.url}}`;
+  }
+
+  async exec(cs, {ep}) {
     await super.exec(cs);
     this.ep = ep;
+    let timeout;
+    let playbackSeconds = 0;
+    let playbackMilliseconds = 0;
+    let completed = !(this.timeoutSecs > 0 || this.loop);
+    if (this.timeoutSecs > 0) {
+      timeout = setTimeout(async() => {
+        completed = true;
+        try {
+          await this.kill(cs);
+        } catch (err) {
+          this.logger.info(err, 'Error killing audio on timeoutSecs');
+        }
+      }, this.timeoutSecs * 1000);
+    }
     try {
-      while (!this.killed && this.loop--) {
-        await ep.play(this.url);
+      this.notifyStatus({event: 'start-playback'});
+      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep.connected) {
+        if (cs.isInConference) {
+          const {memberId, confName, confUuid} = cs;
+          if (Array.isArray(this.url)) {
+            for (const playUrl of this.url) {
+              await this.playToConfMember(this.ep, memberId, confName, confUuid, playUrl);
+            }
+          } else {
+            await this.playToConfMember(this.ep, memberId, confName, confUuid, this.url);
+          }
+        } else {
+          let file = this.url;
+          if (this.seekOffset >= 0) {
+            file = {file: this.url, seekOffset: this.seekOffset};
+            this.seekOffset = -1;
+          }
+          const result = await ep.play(file);
+          playbackSeconds += parseInt(result.playbackSeconds);
+          playbackMilliseconds += parseInt(result.playbackMilliseconds);
+          if (this.killed || !this.loop || completed) {
+            if (timeout) clearTimeout(timeout);
+            await this.performAction(
+              Object.assign(result, {reason: 'playCompleted', playbackSeconds, playbackMilliseconds}),
+              !(this.parentTask || cs.isConfirmCallSession));
+          }
+        }
       }
     } catch (err) {
+      if (timeout) clearTimeout(timeout);
       this.logger.info(err, `TaskPlay:exec - error playing ${this.url}`);
     }
     this.emit('playDone');
@@ -30,7 +76,14 @@ class TaskPlay extends Task {
     super.kill(cs);
     if (this.ep.connected && !this.playComplete) {
       this.logger.debug('TaskPlay:kill - killing audio');
-      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+      if (cs.isInConference) {
+        const {memberId, confName} = cs;
+        this.killPlayToConfMember(this.ep, memberId, confName);
+      }
+      else {
+        this.notifyStatus({event: 'kill-playback'});
+        this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+      }
     }
   }
 }

lib/tasks/rasa.js

@@ -0,0 +1,170 @@
+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);
+      const {span, ctx} = this.startChildSpan(`nested:${this.gatherTask.summary}`);
+      this.gatherTask.span = span;
+      this.gatherTask.ctx = ctx;
+      this.gatherTask.exec(cs, {ep})
+        .then(() => span.end())
+        .catch((err) => {
+          span.end();
+          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);
+        const {span, ctx} = this.startChildSpan(`nested:${this.gatherTask.summary}`);
+        this.gatherTask.span = span;
+        this.gatherTask.ctx = ctx;
+        this.gatherTask.exec(cs, {ep})
+          .then(() => span.end())
+          .catch((err) => {
+            span.end();
+            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/rest_dial.js

@@ -1,7 +1,7 @@
 const Task = require('./task');
 const {TaskName} = require('../utils/constants');
 const makeTask = require('./make_task');
-const normalizeJambones = require('../utils/normalize-jambones');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 
 /**
  * Manages an outdial made via REST API
@@ -11,6 +11,7 @@ class TaskRestDial extends Task {
     super(logger, opts);
 
     this.from = this.data.from;
+    this.fromHost = this.data.fromHost;
     this.to = this.data.to;
     this.call_hook = this.data.call_hook;
     this.timeout = this.data.timeout || 60;
@@ -26,7 +27,7 @@ class TaskRestDial extends Task {
   */
   async exec(cs) {
     await super.exec(cs);
-    this.req = cs.req;
+    this.canCancel = true;
 
     this._setCallTimer();
     await this.awaitTaskDone();
@@ -35,20 +36,36 @@ class TaskRestDial extends Task {
   kill(cs) {
     super.kill(cs);
     this._clearCallTimer();
-    if (this.req) {
-      this.req.cancel();
-      this.req = null;
+    if (this.canCancel && cs?.req) {
+      this.canCancel = false;
+      cs.req.cancel();
     }
     this.notifyTaskDone();
   }
 
   async _onConnect(dlg) {
-    this.req = null;
+    this.canCancel = false;
     const cs = this.callSession;
     cs.setDialog(dlg);
 
     try {
-      const tasks = await cs.requestor.request(this.call_hook, cs.callInfo);
+      const b3 = this.getTracingPropagation();
+      const httpHeaders = b3 && {b3};
+      const params = {
+        ...cs.callInfo,
+        defaults: {
+          synthesizer: {
+            vendor: cs.speechSynthesisVendor,
+            language: cs.speechSynthesisLanguage,
+            voice: cs.speechSynthesisVoice
+          },
+          recognizer: {
+            vendor:  cs.speechRecognizerVendor,
+            language: cs.speechRecognizerLanguage
+          }
+        }
+      };
+      const tasks = await cs.requestor.request('session:new', this.call_hook, params, httpHeaders);
       if (tasks && Array.isArray(tasks)) {
         this.logger.debug({tasks: tasks}, `TaskRestDial: replacing application with ${tasks.length} tasks`);
         cs.replaceApplication(normalizeJambones(this.logger, tasks).map((tdata) => makeTask(this.logger, tdata)));
@@ -62,7 +79,7 @@ class TaskRestDial extends Task {
   _onCallStatus(status) {
     this.logger.debug(`CallStatus: ${status}`);
     if (status >= 200) {
-      this.req = null;
+      this.canCancel = false;
       this._clearCallTimer();
       if (status !== 200) this.notifyTaskDone();
     }

lib/tasks/say-legacy.js

@@ -23,7 +23,7 @@ class TaskSayLegacy extends Task {
 
   get name() { return TaskName.SayLegacy; }
 
-  async exec(cs, ep) {
+  async exec(cs, {ep}) {
     super.exec(cs);
     this.ep = ep;
     try {

lib/tasks/say.js

@@ -1,43 +1,175 @@
 const Task = require('./task');
 const {TaskName, TaskPreconditions} = require('../utils/constants');
+const pollySSMLSplit = require('polly-ssml-split');
+
+const breakLengthyTextIfNeeded = (logger,  text) => {
+  const chunkSize = 1000;
+  const isSSML = text.startsWith('<speak>');
+  if (text.length <= chunkSize || !isSSML) return [text];
+  const options = {
+    // MIN length
+    softLimit: 100,
+    // MAX length, exclude 15 characters <speak></speak>
+    hardLimit: chunkSize - 15,
+    // Set of extra split characters (Optional property)
+    extraSplitChars: ',;!?',
+  };
+  pollySSMLSplit.configure(options);
+  try {
+    return pollySSMLSplit.split(text);
+  } catch (err) {
+    logger.info({err}, 'Error spliting SSML long text');
+    return [text];
+  }
+};
 
 class TaskSay extends Task {
   constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
 
-    this.text = Array.isArray(this.data.text) ? this.data.text : [this.data.text];
+    this.text = (Array.isArray(this.data.text) ? this.data.text : [this.data.text])
+      .map((t) => breakLengthyTextIfNeeded(this.logger, t))
+      .flat();
+
     this.loop = this.data.loop || 1;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
     this.synthesizer = this.data.synthesizer || {};
+    this.disableTtsCache = this.data.disableTtsCache;
   }
 
   get name() { return TaskName.Say; }
 
-  async exec(cs, ep) {
-    const {srf} = cs;
-    const {synthAudio} = srf.locals.dbHelpers;
+  get summary() {
+    for (let i = 0; i < this.text.length; i++) {
+      if (this.text[i].startsWith('silence_stream')) continue;
+      return `${this.name}{text=${this.text[i].slice(0, 15)}${this.text[i].length > 15 ? '...' : ''}}`;
+    }
+    return `${this.name}{${this.text[0]}}`;
+  }
+
+  async exec(cs, {ep}) {
     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 vendor = this.synthesizer.vendor && this.synthesizer.vendor !== 'default' ?
+      this.synthesizer.vendor :
+      cs.speechSynthesisVendor;
+    const language = this.synthesizer.language && this.synthesizer.language !== 'default' ?
+      this.synthesizer.language :
+      cs.speechSynthesisLanguage ;
+    let voice =  this.synthesizer.voice && this.synthesizer.voice !== 'default' ?
+      this.synthesizer.voice :
+      cs.speechSynthesisVoice;
+    const engine = this.synthesizer.engine || 'standard';
+    const salt = cs.callSid;
+    const credentials = cs.getSpeechCredentials(vendor, 'tts');
+
+    /* parse Nuance voices into name and model */
+    let model;
+    if (vendor === 'nuance' && voice) {
+      const arr = /([A-Za-z-]*)\s+-\s+(enhanced|standard)/.exec(voice);
+      if (arr) {
+        voice = arr[1];
+        model = arr[2];
+      }
+    }
+
+    this.logger.info({vendor, language, voice, model}, 'TaskSay:exec');
     this.ep = ep;
     try {
-      const filepath = [];
-      while (!this.killed && this.loop--) {
-        let segment = 0;
-        do {
-          if (filepath.length <= segment) {
-            const opts = Object.assign({
-              text: this.text[segment],
-              vendor: cs.speechSynthesisVendor,
-              language: cs.speechSynthesisLanguage,
-              voice: cs.speechSynthesisVoice,
-              salt: cs.callSid
-            }, this.synthesizer);
-            const path = await synthAudio(opts);
-            filepath.push(path);
-            cs.trackTmpFile(path);
+      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'));
+        this.notifyError({
+          msg: 'TTS error',
+          details:`No speech credentials provisioned for selected vendor ${vendor}`
+        });
+        throw new Error('no provisioned speech credentials for TTS');
+      }
+      // synthesize all of the text elements
+      let lastUpdated = false;
+
+      /* produce an audio segment from the provided text */
+      const generateAudio = async(text) => {
+        if (this.killed) return;
+        if (text.startsWith('silence_stream://')) return text;
+
+        /* otel: trace time for tts */
+        const {span} = this.startChildSpan('tts-generation', {
+          'tts.vendor': vendor,
+          'tts.language': language,
+          'tts.voice': voice
+        });
+        try {
+          const {filePath, servedFromCache, rtt} = await synthAudio(stats, {
+            text,
+            vendor,
+            language,
+            voice,
+            engine,
+            model,
+            salt,
+            credentials,
+            disableTtsCache : this.disableTtsCache
+          });
+          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 */});
           }
-          await ep.play(filepath[segment]);
-        } while (++segment < this.text.length);
+          span.setAttributes({'tts.cached': servedFromCache});
+          span.end();
+          if (!servedFromCache && rtt) {
+            this.notifyStatus({
+              event: 'synthesized-audio',
+              vendor,
+              language,
+              characters: text.length,
+              elapsedTime: rtt
+            });
+          }
+          return filePath;
+        } catch (err) {
+          this.logger.info({err}, 'Error synthesizing tts');
+          span.end();
+          writeAlerts({
+            account_sid: cs.accountSid,
+            alert_type: AlertType.TTS_FAILURE,
+            vendor,
+            detail: err.message
+          }).catch((err) => this.logger.info({err}, 'Error generating alert for tts failure'));
+          this.notifyError({msg: 'TTS error', details: err.message || err});
+          return;
+        }
+      };
+
+      const arr = this.text.map((t) => generateAudio(t));
+      const filepath = (await Promise.all(arr)).filter((fp) => fp && fp.length);
+      this.notifyStatus({event: 'start-playback'});
+
+      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep?.connected) {
+        let segment = 0;
+        while (!this.killed && segment < filepath.length) {
+          if (cs.isInConference) {
+            const {memberId, confName, confUuid} = cs;
+            await this.playToConfMember(this.ep, memberId, confName, confUuid, filepath[segment]);
+          }
+          else {
+            this.logger.debug(`Say:exec sending command to play file ${filepath[segment]}`);
+            await ep.play(filepath[segment]);
+            this.logger.debug(`Say:exec completed play file ${filepath[segment]}`);
+          }
+          segment++;
+        }
       }
     } catch (err) {
       this.logger.info(err, 'TaskSay:exec error');
@@ -49,7 +181,14 @@ class TaskSay extends Task {
     super.kill(cs);
     if (this.ep.connected) {
       this.logger.debug('TaskSay:kill - killing audio');
-      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+      if (cs.isInConference) {
+        const {memberId, confName} = cs;
+        this.killPlayToConfMember(this.ep, memberId, confName);
+      }
+      else {
+        this.notifyStatus({event: 'kill-playback'});
+        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,11 @@ 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,
+      sipReason: this.data.reason
+    });
   }
 }
 

lib/tasks/sip_refer.js

@@ -0,0 +1,128 @@
+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);
+      /* otel: trace time for tts */
+      this.referSpan = this.startSpan('send-refer', {
+        'refer.refer_to': referTo,
+        'refer.referred_by': referredBy
+      });
+
+      const response = await dlg.request({
+        method: 'REFER',
+        headers: {
+          ...this.headers,
+          ...(this.referToIsUri && {'X-Refer-To-Leave-Untouched': true}),
+          'Refer-To': referTo,
+          'Referred-By': referredBy
+        }
+      });
+      this.referStatus = response.status;
+      this.referSpan.setAttributes({'refer.status_code': 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) {
+        this._notifyTimer = setTimeout(() => {
+          this.logger.info('TaskSipRefer:exec - no NOTIFY received in 15 secs, exiting');
+          this.performAction({refer_status: this.referStatus})
+            .catch((err) => this.logger.error(err, 'TaskSipRefer:exec - error performing action'));
+          this.notifyTaskDone();
+        }, 15000);
+        await this.awaitTaskDone();
+        if (this._notifyTimer) {
+          clearTimeout(this._notifyTimer);
+          this._notifyTimer = null;
+        }
+      }
+      else {
+        await this.performAction({refer_status: this.referStatus});
+      }
+    } catch (err) {
+      this.logger.info({err}, 'TaskSipRefer:exec - error sending REFER');
+    }
+    this.referSpan?.end();
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    const {dlg} = cs;
+    dlg.off('notify', this.notifyHandler);
+    this.notifyTaskDone();
+  }
+
+  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?.includes('message/sipfrag')) {
+      const arr = /SIP\/2\.0\s+(\d+)/.exec(req.body);
+      if (arr) {
+        const status = typeof arr[1] === 'string' ? parseInt(arr[1], 10) : arr[1];
+        this.logger.debug(`TaskSipRefer:_handleNotify: call got status ${status}`);
+        if (this.eventHook) {
+          const b3 = this.getTracingPropagation();
+          const httpHeaders = b3 && {b3};
+          await cs.requestor.request('verb:hook', this.eventHook,
+            {event: 'transfer-status', call_status: status}, httpHeaders);
+        }
+        if (status >= 200) {
+          this.referSpan.setAttributes({'refer.finalNotify': status});
+          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}`;
+    }
+    else this.referToIsUri = true;
+    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/sip_request.js

@@ -0,0 +1,49 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+
+/**
+ * Send a SIP request (e.g. INFO, NOTIFY, etc) on an existing call leg
+ */
+class TaskSipRequest extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.StableCall;
+
+    this.method = this.data.method.toUpperCase();
+    this.headers = this.data.headers || {};
+    this.body = this.data.body;
+    if (this.body) this.body = `${this.body}\n`;
+  }
+
+  get name() { return TaskName.SipRequest; }
+
+  async exec(cs, {dlg}) {
+    super.exec(cs);
+    try {
+      this.logger.info({dlg}, `TaskSipRequest: sending a SIP ${this.method}`);
+      const res = await dlg.request({
+        method: this.method,
+        headers: this.headers,
+        body: this.body
+      });
+      const result = {result: 'success', sipStatus: res.status};
+      this.span.setAttributes({
+        ...this.headers,
+        ...(this.body && {body: this.body}),
+        'response.status_code': res.status
+      });
+      this.logger.debug({result}, `TaskSipRequest: received response to ${this.method}`);
+      await this.performAction(result);
+    } catch (err) {
+      this.logger.error({err}, 'TaskSipRequest: error');
+      this.span.setAttributes({
+        ...this.headers,
+        ...(this.body && {body: this.body}),
+        'response.error': err.message
+      });
+      await this.performAction({result: 'failed', err: err.message});
+    }
+  }
+}
+
+module.exports = TaskSipRequest;

lib/tasks/specs.json

@@ -1,265 +0,0 @@
-{
-  "sip:decline": {
-    "properties": {
-      "status": "number",
-      "reason": "string",
-      "headers": "object"
-    },
-    "required": [
-      "status"
-    ]
-  },
-  "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"
-    },
-    "required": [
-    ]
-  },
-  "play": {
-    "properties": {
-      "url": "string",
-      "loop": "number",
-      "earlyMedia": "boolean"
-    },
-    "required": [
-      "url"
-    ]
-  },
-  "say": {
-    "properties": {
-      "text": "string|array",
-      "loop": "number",
-      "synthesizer": "#synthesizer",
-      "earlyMedia": "boolean"
-    },
-    "required": [
-      "text"
-    ]
-  },
-  "gather": {
-    "properties": {
-      "actionHook": "object|string",
-      "finishOnKey": "string",
-      "input": "array",
-      "numDigits": "number",
-      "partialResultHook": "object|string",
-      "speechTimeout": "number",
-      "timeout": "number",
-      "recognizer": "#recognizer",
-      "play": "#play",
-      "say": "#say"
-    },
-    "required": [
-      "actionHook"
-    ]
-  },
-  "conference": {
-    "properties": {
-      "name": "string",
-      "beep": "boolean",
-      "startConferenceOnEnter": "boolean",
-      "endConferenceOnExit": "boolean",
-      "maxParticipants": "number",
-      "actionHook": "object|string",
-      "waitHook": "object|string",
-      "statusEvents": "array",
-      "statusHook": "object|string",
-      "enterHook": "object|string"
-    },
-    "required": [
-      "name"
-    ]
-  },
-  "dial": {
-    "properties": {
-      "actionHook": "object|string",
-      "answerOnBridge": "boolean",
-      "callerId": "string",
-      "confirmHook": "object|string",
-      "dialMusic": "string",
-      "dtmfCapture": "object",
-      "dtmfHook": "object|string",
-      "headers": "object",
-      "listen": "#listen",
-      "target": ["#target"],
-      "timeLimit": "number",
-      "timeout": "number",
-      "transcribe": "#transcribe"
-    },
-    "required": [
-      "target"
-    ]
-  },
-  "listen": {
-    "properties": {
-      "actionHook": "object|string",
-      "auth": "#auth",
-      "finishOnKey": "string",
-      "maxLength": "number",
-      "metadata": "object",
-      "mixType": {
-        "type": "string",
-        "enum": ["mono", "stereo", "mixed"]
-      },
-      "passDtmf": "boolean",
-      "playBeep": "boolean",
-      "sampleRate": "number",
-      "timeout": "number",
-      "transcribe": "#transcribe",
-      "url": "string",
-      "wsAuth": "#auth",
-      "earlyMedia": "boolean"
-    },
-    "required": [
-      "url"
-    ]
-  },
-  "pause": {
-    "properties": {
-      "length": "number"
-    },
-    "required": [
-      "length"
-    ]
-  },
-  "redirect": {
-    "properties": {
-      "actionHook": "object|string"
-    },
-    "required": [
-      "actionHook"
-    ]
-  },
-  "rest:dial": {
-    "properties": {
-      "account_sid": "string",
-      "application_sid": "string",
-      "call_hook": "object|string",
-      "call_status_hook": "object|string",
-      "from": "string",
-      "speech_synthesis_vendor": "string",
-      "speech_synthesis_voice": "string",
-      "speech_recognizer_vendor": "string",
-      "speech_recognizer_language": "string",
-      "tag": "object",
-      "to": "#target",
-      "headers": "object",
-      "timeout": "number"
-    },
-    "required": [
-      "call_hook",
-      "from",
-      "to"
-    ]
-  },
-  "tag": {
-    "properties": {
-      "data": "object"
-    },
-    "required": [
-      "data"
-    ]
-  },
-  "transcribe": {
-    "properties": {
-      "transcriptionHook": "string",
-      "recognizer": "#recognizer",
-      "earlyMedia": "boolean"
-    },
-    "required": [
-      "transcriptionHook"
-    ]
-  },
-  "target": {
-    "properties": {
-      "type": {
-        "type": "string",
-        "enum": ["phone", "sip", "user", "teams"]
-      },
-      "url": "string",
-      "method": {
-        "type": "string",
-        "enum": ["GET", "POST"]
-      },
-      "name": "string",
-      "number": "string",
-      "sipUri": "string",
-      "auth": "#auth",
-      "vmail": "boolean"
-    },
-    "required": [
-      "type"
-    ]
-  },
-  "auth": {
-    "properties": {
-      "username": "string",
-      "password": "string"
-    },
-    "required": [
-      "username",
-      "password"
-    ]
-  },
-  "synthesizer": {
-    "properties": {
-      "vendor": {
-        "type": "string",
-        "enum": ["google", "aws", "polly"]
-      },
-      "language": "string",
-      "voice": "string",
-      "gender": {
-        "type": "string",
-        "enum": ["MALE", "FEMALE", "NEUTRAL"]
-      }
-    },
-    "required": [
-      "vendor"
-    ]
-  },
-  "recognizer": {
-    "properties": {
-      "vendor": {
-        "type": "string",
-        "enum": ["google"]
-      },
-      "language": "string",
-      "hints": "array",
-      "profanityFilter": "boolean",
-      "interim": "boolean",
-      "dualChannel": "boolean"
-    },
-    "required": [
-      "vendor"
-    ]
-  }
-}

lib/tasks/task.js

@@ -1,12 +1,10 @@
 const Emitter = require('events');
-const uuidv4 = require('uuid/v4');
-const debug = require('debug')('jambonz:feature-server');
-const assert = require('assert');
+const uuidv4 = require('uuid-random');
 const {TaskPreconditions} = require('../utils/constants');
-const normalizeJambones = require('../utils/normalize-jambones');
-const specs = new Map();
-const _specData = require('./specs');
-for (const key in _specData) {specs.set(key, _specData[key]);}
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+const WsRequestor = require('../utils/ws-requestor');
+const {TaskName} = require('../utils/constants');
+const {trace} = require('@opentelemetry/api');
 
 /**
  * @classdesc Represents a jambonz verb. This is a superclass that is extended
@@ -20,9 +18,13 @@ class Task extends Emitter {
     this.logger = logger;
     this.data = data;
     this.actionHook = this.data.actionHook;
+    this.id = data.id;
 
     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);
   }
 
   /**
@@ -39,6 +41,10 @@ class Task extends Emitter {
     return this.cs;
   }
 
+  get summary() {
+    return this.name;
+  }
+
   toJSON() {
     return this.data;
   }
@@ -59,7 +65,37 @@ class Task extends Emitter {
   kill(cs) {
     if (this.cs && !this.cs.isConfirmCallSession) this.logger.debug(`${this.name} is being killed`);
     this._killInProgress = true;
-    // no-op
+
+    /* remove reference to parent task or else entangled parent-child tasks will not be gc'ed */
+    setImmediate(() => this.parentTask = null);
+  }
+
+  startSpan(name, attributes) {
+    const {srf} = require('../..');
+    const {tracer} = srf.locals.otel;
+    const span = tracer.startSpan(name, undefined, this.ctx);
+    if (attributes) span.setAttributes(attributes);
+    trace.setSpan(this.ctx, span);
+    return span;
+  }
+
+  startChildSpan(name, attributes) {
+    const {srf} = require('../..');
+    const {tracer} = srf.locals.otel;
+    const span = tracer.startSpan(name, undefined, this.ctx);
+    if (attributes) span.setAttributes(attributes);
+    const ctx = trace.setSpan(this.ctx, span);
+    return {span, ctx};
+  }
+
+  getTracingPropagation(encoding, span) {
+    // TODO: support encodings beyond b3 https://github.com/openzipkin/b3-propagation
+    if (span) {
+      return `${span.spanContext().traceId}-${span.spanContext().spanId}-1`;
+    }
+    if (this.span) {
+      return `${this.span.spanContext().traceId}-${this.span.spanContext().spanId}-1`;
+    }
   }
 
   /**
@@ -77,6 +113,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
    */
@@ -84,18 +135,116 @@ class Task extends Emitter {
     return this.callSession.normalizeUrl(url, method, auth);
   }
 
+  notifyError(obj) {
+    if (this.cs.requestor instanceof WsRequestor) {
+      const params = {...obj, verb: this.name, id: this.id};
+      this.cs.requestor.request('jambonz:error', '/error', params)
+        .catch((err) => this.logger.info({err}, 'Task:notifyError error sending error'));
+    }
+  }
+
+  notifyStatus(obj) {
+    if (this.cs.notifyEvents && this.cs.requestor instanceof WsRequestor) {
+      const params = {...obj, verb: this.name, id: this.id};
+      this.cs.requestor.request('verb:status', '/status', params)
+        .catch((err) => this.logger.info({err}, 'Task:notifyStatus error sending error'));
+    }
+  }
+
   async performAction(results, expectResponse = true) {
     if (this.actionHook) {
-      const params = results ? Object.assign(results, this.cs.callInfo.toJSON()) : this.cs.callInfo.toJSON();
-      const json = await this.cs.requestor.request(this.actionHook, params);
-      if (expectResponse && json && Array.isArray(json)) {
+      const type = this.name === TaskName.Redirect ? 'session:redirect' : 'verb:hook';
+      const params = results ? Object.assign(this.cs.callInfo.toJSON(), results) : this.cs.callInfo.toJSON();
+      const span = this.startSpan(type, {'hook.url': this.actionHook});
+      const b3 = this.getTracingPropagation('b3', span);
+      const httpHeaders = b3 && {b3};
+      span.setAttributes({'http.body': JSON.stringify(params)});
+      try {
+        const json = await this.cs.requestor.request(type, this.actionHook, params, httpHeaders);
+        span.setAttributes({'http.statusCode': 200});
+        span.end();
+        if (expectResponse && json && Array.isArray(json)) {
+          const makeTask = require('./make_task');
+          const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+          if (tasks && tasks.length > 0) {
+            this.logger.info({tasks: tasks}, `${this.name} replacing application with ${tasks.length} tasks`);
+            this.callSession.replaceApplication(tasks);
+          }
+        }
+      } catch (err) {
+        span.setAttributes({'http.statusCode': err.statusCode});
+        span.end();
+        throw err;
+      }
+    }
+  }
+
+  async performHook(cs, hook, results) {
+    const params = results ? Object.assign(cs.callInfo.toJSON(), results) : cs.callInfo.toJSON();
+    const span = this.startSpan('verb:hook', {'hook.url': hook});
+    const b3 = this.getTracingPropagation('b3', span);
+    const httpHeaders = b3 && {b3};
+    span.setAttributes({'http.body': JSON.stringify(params)});
+    try {
+      const json = await cs.requestor.request('verb:hook', hook, params, httpHeaders);
+      span.setAttributes({'http.statusCode': 200});
+      span.end();
+      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.callSession.replaceApplication(tasks);
+          this.redirect(cs, tasks);
+          return true;
         }
       }
+      return false;
+    } catch (err) {
+      span.setAttributes({'http.statusCode': err.statusCode});
+      span.end();
+      throw err;
+    }
+  }
+
+  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();
+      }
     }
   }
 
@@ -106,12 +255,12 @@ class Task extends Emitter {
     delete obj.requestor;
     delete obj.notifier;
     obj.tasks =  cs.getRemainingTaskData();
-    if (opts && obj.tasks.length > 1) {
+    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');
+    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) {
@@ -133,73 +282,6 @@ class Task extends Emitter {
       this.logger.error(err, 'Task:_doRefer error');
     }
   }
-
-  /**
-   * validate that the JSON task description is valid
-   * @param {string} name - verb name
-   * @param {object} data - verb properties
-   */
-  static validate(name, data) {
-    debug(`validating ${name} with data ${JSON.stringify(data)}`);
-    // validate the instruction is supported
-    if (!specs.has(name)) throw new Error(`invalid instruction: ${name}`);
-
-    // check type of each element and make sure required elements are present
-    const specData = specs.get(name);
-    let required = specData.required || [];
-    for (const dKey in data) {
-      if (dKey in specData.properties) {
-        const dVal = data[dKey];
-        const dSpec = specData.properties[dKey];
-        debug(`Task:validate validating property ${dKey} with value ${JSON.stringify(dVal)}`);
-
-        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) && !(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) {
-            Task.validate(name, item);
-          }
-        }
-        else if (typeof dSpec === 'object') {
-          // complex types
-          const type = dSpec.type;
-          assert.ok(['number', 'string', 'object', 'boolean'].includes(type),
-            `invalid or missing type in spec ${JSON.stringify(dSpec)}`);
-          if (type === 'string' && dSpec.enum) {
-            assert.ok(Array.isArray(dSpec.enum), `enum must be an array ${JSON.stringify(dSpec.enum)}`);
-            if (!dSpec.enum.includes(dVal)) throw new Error(`invalid value ${dVal} must be one of ${dSpec.enum}`);
-          }
-        }
-        else if (typeof dSpec === 'string' && dSpec.startsWith('#')) {
-          // reference to another datatype (i.e. nested type)
-          const name = dSpec.slice(1);
-          //const obj = {};
-          //obj[name] = dVal;
-          Task.validate(name, dVal);
-        }
-        else {
-          assert.ok(0, `invalid spec ${JSON.stringify(dSpec)}`);
-        }
-        required = required.filter((item) => item !== dKey);
-      }
-      else throw new Error(`${name}: unknown property ${dKey}`);
-    }
-    if (required.length > 0) throw new Error(`${name}: missing value for ${required}`);
-  }
 }
 
 module.exports = Task;

lib/tasks/transcribe.js

@@ -1,85 +1,315 @@
 const Task = require('./task');
-const {TaskName, TaskPreconditions, TranscriptionEvents} = require('../utils/constants');
+const {
+  TaskName,
+  TaskPreconditions,
+  GoogleTranscriptionEvents,
+  NuanceTranscriptionEvents,
+  AwsTranscriptionEvents,
+  AzureTranscriptionEvents,
+  DeepgramTranscriptionEvents,
+  SonioxTranscriptionEvents,
+  IbmTranscriptionEvents,
+  NvidiaTranscriptionEvents,
+  JambonzTranscriptionEvents
+} = require('../utils/constants');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 
 class TaskTranscribe extends Task {
   constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
+    this.parentTask = parentTask;
+
+    const {
+      setChannelVarsForStt,
+      normalizeTranscription,
+      removeSpeechListeners,
+      setSpeechCredentialsAtRuntime,
+      compileSonioxTranscripts
+    } = require('../utils/transcription-utils')(logger);
+    this.setChannelVarsForStt = setChannelVarsForStt;
+    this.normalizeTranscription = normalizeTranscription;
+    this.removeSpeechListeners = removeSpeechListeners;
+    this.compileSonioxTranscripts = compileSonioxTranscripts;
 
     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;
+
+    /* let credentials be supplied in the recognizer object at runtime */
+    this.sttCredentials = setSpeechCredentialsAtRuntime(recognizer);
+
+    /* buffer for soniox transcripts */
+    this._sonioxTranscripts = [];
+
+    recognizer.hints = recognizer.hints || [];
+    recognizer.altLanguages = recognizer.altLanguages || [];
   }
 
   get name() { return TaskName.Transcribe; }
 
-  async exec(cs, ep, parentTask) {
+  async exec(cs, {ep, ep2}) {
     super.exec(cs);
+    const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
+    const {getNuanceAccessToken, getIbmAccessToken} = cs.srf.locals.dbHelpers;
+
+    if (cs.hasGlobalSttHints) {
+      const {hints, hintsBoost} = cs.globalSttHints;
+      this.data.recognizer.hints = this.data.recognizer.hints.concat(hints);
+      if (!this.data.recognizer.hintsBoost && hintsBoost) this.data.recognizer.hintsBoost = hintsBoost;
+      this.logger.debug({hints: this.data.recognizer.hints, hintsBoost: this.data.recognizer.hintsBoost},
+        'Transcribe:exec - applying global sttHints');
+    }
+    if (cs.hasAltLanguages) {
+      this.data.recognizer.altLanguages = this.data.recognizer.altLanguages.concat(cs.altLanguages);
+      this.logger.debug({altLanguages: this.altLanguages},
+        'Transcribe:exec - applying altLanguages');
+    }
+    if (cs.hasGlobalSttPunctuation && !this.data.recognizer.punctuation) {
+      this.data.recognizer.punctuation = cs.globalSttPunctuation;
+    }
+
     this.ep = ep;
+    this.ep2 = ep2;
+    if ('default' === this.vendor || !this.vendor) {
+      this.vendor = cs.speechRecognizerVendor;
+      if (this.data.recognizer) this.data.recognizer.vendor = this.vendor;
+    }
+    if ('default' === this.language || !this.language) {
+      this.language = cs.speechRecognizerLanguage;
+      if (this.data.recognizer) this.data.recognizer.language = this.language;
+    }
+    if (!this.data.recognizer.vendor) {
+      this.data.recognizer.vendor = this.vendor;
+    }
+    if (!this.sttCredentials) 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');
+      }
+
+      if (this.vendor === 'nuance' && this.sttCredentials.client_id) {
+        /* get nuance access token */
+        const {client_id, secret} = this.sttCredentials;
+        const {access_token, servedFromCache} = await getNuanceAccessToken(client_id, secret, 'asr tts');
+        this.logger.debug({client_id},
+          `Transcribe:exec - got nuance access token ${servedFromCache ? 'from cache' : ''}`);
+        this.sttCredentials = {...this.sttCredentials, access_token};
+      }
+      else if (this.vendor == 'ibm' && this.sttCredentials.stt_api_key) {
+        /* get ibm access token */
+        const {stt_api_key, stt_region} = this.sttCredentials;
+        const {access_token, servedFromCache} = await getIbmAccessToken(stt_api_key);
+        this.logger.debug({stt_api_key}, `Gather:exec - got ibm access token ${servedFromCache ? 'from cache' : ''}`);
+        this.sttCredentials = {...this.sttCredentials, access_token, stt_region};
+      }
+      await this._startTranscribing(cs, ep, 1);
+      if (this.separateRecognitionPerChannel && ep2) {
+        await this._startTranscribing(cs, ep2, 2);
+      }
+
+      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);
+    this.removeSpeechListeners(ep);
   }
 
   async kill(cs) {
     super.kill(cs);
-    if (this.ep.connected) {
-      this.ep.stopTranscription().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);
+    let stopTranscription = false;
+    if (this.ep?.connected) {
+      stopTranscription = true;
+      this.ep.stopTranscription({vendor: this.vendor})
+        .catch((err) => this.logger.info(err, 'Error TaskTranscribe:kill'));
     }
+    if (this.separateRecognitionPerChannel && this.ep2 && this.ep2.connected) {
+      stopTranscription = true;
+      this.ep2.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
+    if (stopTranscription) this._timer = setTimeout(() => this.notifyTaskDone(), 1500);
     else this.notifyTaskDone();
+
     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, channel) {
+    const opts = this.setChannelVarsForStt(this, this.sttCredentials, this.data.recognizer);
+    switch (this.vendor) {
+      case 'google':
+        this.bugname = 'google_transcribe';
+        ep.addCustomEventListener(GoogleTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(GoogleTranscriptionEvents.NoAudioDetected,
+          this._onNoAudio.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(GoogleTranscriptionEvents.MaxDurationExceeded,
+          this._onMaxDurationExceeded.bind(this, cs, ep, channel));
+        break;
 
-    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));
+      case 'aws':
+      case 'polly':
+        this.bugname = 'aws_transcribe';
+        ep.addCustomEventListener(AwsTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(AwsTranscriptionEvents.NoAudioDetected,
+          this._onNoAudio.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(AwsTranscriptionEvents.MaxDurationExceeded,
+          this._onMaxDurationExceeded.bind(this, cs, ep, channel));
+        break;
+      case 'microsoft':
+        this.bugname = 'azure_transcribe';
+        ep.addCustomEventListener(AzureTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected,
+          this._onNoAudio.bind(this, cs, ep, channel));
+        break;
+      case 'nuance':
+        this.bugname = 'nuance_transcribe';
+        ep.addCustomEventListener(NuanceTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(NuanceTranscriptionEvents.StartOfSpeech,
+          this._onStartOfSpeech.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(NuanceTranscriptionEvents.TranscriptionComplete,
+          this._onTranscriptionComplete.bind(this, cs, ep, channel));
+        break;
+      case 'deepgram':
+        this.bugname = 'deepgram_transcribe';
+        ep.addCustomEventListener(DeepgramTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(DeepgramTranscriptionEvents.Connect,
+          this._onDeepgramConnect.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(DeepgramTranscriptionEvents.ConnectFailure,
+          this._onDeepGramConnectFailure.bind(this, cs, ep, channel));
+        break;
+      case 'soniox':
+        this.bugname = 'soniox_transcribe';
+        ep.addCustomEventListener(SonioxTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        break;
+      case 'ibm':
+        this.bugname = 'ibm_transcribe';
+        ep.addCustomEventListener(IbmTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(IbmTranscriptionEvents.Connect,
+          this._onIbmConnect.bind(this, cs, ep, channel));
+        ep.addCustomEventListener(IbmTranscriptionEvents.ConnectFailure,
+          this._onIbmConnectFailure.bind(this, cs, ep, channel));
+        break;
+
+      case 'nvidia':
+        this.bugname = 'nvidia_transcribe';
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.StartOfSpeech,
+          this._onStartOfSpeech.bind(this, cs, ep));
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.TranscriptionComplete,
+          this._onTranscriptionComplete.bind(this, cs, ep));
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.VadDetected,
+          this._onVadDetected.bind(this, cs, ep));
+        break;
+      default:
+        throw new Error(`Invalid vendor ${this.vendor}`);
+    }
+
+    /* common handler for all stt engine errors */
+    ep.addCustomEventListener(JambonzTranscriptionEvents.Error, this._onJambonzError.bind(this, cs, ep));
+    await ep.set(opts)
+      .catch((err) => this.logger.info(err, 'Error setting channel variables'));
 
     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,
+      bugname: this.bugname
     });
   }
 
-  _onTranscription(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'));
+  async _onTranscription(cs, ep, channel, evt, fsEvent) {
+    // make sure this is not a transcript from answering machine detection
+    const bugname = fsEvent.getHeader('media-bugname');
+    if (bugname && this.bugname !== bugname) return;
+
+    if (this.vendor === 'ibm') {
+      if (evt?.state === 'listening') return;
+    }
+    this.logger.debug({evt}, 'TaskTranscribe:_onTranscription - before normalization');
+
+    evt = this.normalizeTranscription(evt, this.vendor, channel, this.language);
+    this.logger.debug({evt}, 'TaskTranscribe:_onTranscription');
+    if (evt.alternatives.length === 0) {
+      this.logger.info({evt}, 'TaskTranscribe:_onTranscription - got empty transcript, continue listening');
+      return;
+    }
+
+    if (evt.alternatives[0]?.transcript === '' && !cs.callGone && !this.killed) {
+      if (['microsoft', 'deepgram'].includes(this.vendor)) {
+        this.logger.info({evt}, 'TaskTranscribe:_onTranscription - got empty transcript, continue listening');
+      }
+      else {
+        this.logger.info({evt}, 'TaskTranscribe:_onTranscription - got empty transcript, listen again');
+        this._transcribe(ep);
+      }
+      return;
+    }
+
+    if (this.vendor === 'soniox') {
+      /* compile transcripts into one */
+      this._sonioxTranscripts.push(evt.vendor.finalWords);
+      if (evt.is_final) {
+        evt = this.compileSonioxTranscripts(this._sonioxTranscripts, 1, this.language);
+        this._sonioxTranscripts = [];
+      }
+    }
+
+    if (this.transcriptionHook) {
+      const b3 = this.getTracingPropagation();
+      const httpHeaders = b3 && {b3};
+      try {
+        const json = await this.cs.requestor.request('verb:hook', this.transcriptionHook, {
+          ...this.cs.callInfo,
+          ...httpHeaders,
+          speech: evt
+        });
+        this.logger.info({json}, 'sent transcriptionHook');
+        if (json && Array.isArray(json) && !this.parentTask) {
+          const makeTask = require('./make_task');
+          const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+          if (tasks && tasks.length > 0) {
+            this.logger.info({tasks: tasks}, `${this.name} replacing application with ${tasks.length} tasks`);
+            this.cs.replaceApplication(tasks);
+          }
+        }
+      } 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,13 +317,13 @@ class TaskTranscribe extends Task {
     }
   }
 
-  _onNoAudio(ep) {
-    this.logger.debug('TaskTranscribe:_onNoAudio restarting transcription');
+  _onNoAudio(cs, ep, channel) {
+    this.logger.debug(`TaskTranscribe:_onNoAudio restarting transcription on channel ${channel}`);
     this._transcribe(ep);
   }
 
-  _onMaxDurationExceeded(ep) {
-    this.logger.debug('TaskTranscribe:_onMaxDurationExceeded restarting transcription');
+  _onMaxDurationExceeded(cs, ep, channel) {
+    this.logger.debug(`TaskTranscribe:_onMaxDurationExceeded restarting transcription on channel ${channel}`);
     this._transcribe(ep);
   }
 
@@ -103,6 +333,64 @@ class TaskTranscribe extends Task {
       this._timer = null;
     }
   }
+  _onDeepgramConnect(_cs, _ep) {
+    this.logger.debug('TaskTranscribe:_onDeepgramConnect');
+  }
+
+  _onDeepGramConnectFailure(cs, _ep, _channel, evt) {
+    const {reason} = evt;
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    this.logger.info({evt}, 'TaskTranscribe:_onDeepgramConnectFailure');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Failed connecting to Deepgram speech recognizer: ${reason}`,
+      vendor: 'deepgram',
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for deepgram connection failure'));
+    this.notifyError(`Failed connecting to speech vendor deepgram: ${reason}`);
+    this.notifyTaskDone();
+  }
+
+  _onIbmConnect(_cs, _ep) {
+    this.logger.debug('TaskTranscribe:_onIbmConnect');
+  }
+
+  _onIbmConnectFailure(cs, _ep, _channel, evt) {
+    const {reason} = evt;
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    this.logger.info({evt}, 'TaskTranscribe:_onIbmConnectFailure');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Failed connecting to IBM watson speech recognizer: ${reason}`,
+      vendor: 'ibm',
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for IBM connection failure'));
+    this.notifyError(`Failed connecting to speech vendor IBM: ${reason}`);
+    this.notifyTaskDone();
+  }
+  _onIbmError(cs, _ep, _channel, evt) {
+    this.logger.info({evt}, 'TaskTranscribe:_onIbmError');
+  }
+  _onJambonzError(cs, _ep, evt) {
+    this.logger.info({evt}, 'TaskTranscribe:_onJambonzError');
+    const {writeAlerts, AlertType} = cs.srf.locals;
+
+    if (this.vendor === 'nuance') {
+      const {code, error} = evt;
+      if (code === 404 && error === 'No speech') return this._resolve('timeout');
+      if (code === 413 && error === 'Too much speech') return this._resolve('timeout');
+    }
+    this.logger.info({evt}, 'TaskTranscribe:_onJambonzError');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Custom speech vendor ${this.vendor} error: ${evt.error}`,
+      vendor: this.vendor,
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for jambonz custom connection failure'));
+    this.notifyError({msg: 'ASR error', details:`Custom speech vendor ${this.vendor} error: ${evt.error}`});
+  }
+
+
 }
 
 module.exports = TaskTranscribe;

lib/utils/amd-utils.js

@@ -0,0 +1,343 @@
+const Emitter = require('events');
+const {readFile} = require('fs');
+const {
+  GoogleTranscriptionEvents,
+  AwsTranscriptionEvents,
+  AzureTranscriptionEvents,
+  AmdEvents,
+  AvmdEvents
+} = require('./constants');
+const bugname = 'amd_bug';
+const {VMD_HINTS_FILE} = process.env;
+let voicemailHints = [];
+
+const updateHints = async(file, callback) => {
+  readFile(file, 'utf8', (err, data) => {
+    if (err) return callback(err);
+    try {
+      callback(null, JSON.parse(data));
+    } catch (err) {
+      callback(err);
+    }
+  });
+};
+
+if (VMD_HINTS_FILE) {
+  updateHints(VMD_HINTS_FILE, (err, hints) => {
+    if (err) {  console.error(err); }
+    voicemailHints = hints;
+
+    /* if successful, update the hints every hour */
+    setInterval(() => {
+      updateHints(VMD_HINTS_FILE, (err, hints) => {
+        if (err) {  console.error(err); }
+        voicemailHints = hints;
+      });
+    }, 60000);
+  });
+}
+
+class Amd extends Emitter {
+  constructor(logger, cs, opts) {
+    super();
+    this.logger = logger;
+    this.vendor = opts.recognizer?.vendor || cs.speechRecognizerVendor;
+    if ('default' === this.vendor) this.vendor = cs.speechRecognizerVendor;
+
+    this.language = opts.recognizer?.language || cs.speechRecognizerLanguage;
+    if ('default' === this.language) this.language = cs.speechRecognizerLanguage;
+
+    this.sttCredentials = cs.getSpeechCredentials(this.vendor, 'stt');
+
+    if (!this.sttCredentials) throw new Error(`No speech credentials found for vendor ${this.vendor}`);
+
+    this.thresholdWordCount = opts.thresholdWordCount || 9;
+    const {normalizeTranscription} = require('./transcription-utils')(logger);
+    this.normalizeTranscription = normalizeTranscription;
+
+    const {
+      noSpeechTimeoutMs = 5000,
+      decisionTimeoutMs = 15000,
+      toneTimeoutMs = 20000,
+      greetingCompletionTimeoutMs = 2000
+    } = opts.timers || {};
+    this.noSpeechTimeoutMs = noSpeechTimeoutMs;
+    this.decisionTimeoutMs = decisionTimeoutMs;
+    this.toneTimeoutMs = toneTimeoutMs;
+    this.greetingCompletionTimeoutMs = greetingCompletionTimeoutMs;
+
+    this.beepDetected = false;
+  }
+
+  startDecisionTimer() {
+    this.decisionTimer = setTimeout(this._onDecisionTimeout.bind(this), this.decisionTimeoutMs);
+    this.noSpeechTimer = setTimeout(this._onNoSpeechTimeout.bind(this), this.noSpeechTimeoutMs);
+    this.startToneTimer();
+  }
+  stopDecisionTimer() {
+    this.decisionTimer && clearTimeout(this.decisionTimer);
+  }
+  stopNoSpeechTimer() {
+    this.noSpeechTimer && clearTimeout(this.noSpeechTimer);
+  }
+  startToneTimer() {
+    this.toneTimer = setTimeout(this._onToneTimeout.bind(this), this.toneTimeoutMs);
+  }
+  startGreetingCompletionTimer() {
+    this.greetingCompletionTimer = setTimeout(
+      this._onGreetingCompletionTimeout.bind(this),
+      this.beepDetected ? 1000 : this.greetingCompletionTimeoutMs);
+  }
+  stopGreetingCompletionTimer() {
+    this.greetingCompletionTimer && clearTimeout(this.greetingCompletionTimer);
+  }
+  restartGreetingCompletionTimer() {
+    this.stopGreetingCompletionTimer();
+    this.startGreetingCompletionTimer();
+  }
+  stopToneTimer() {
+    this.toneTimer && clearTimeout(this.toneTimer);
+  }
+  stopAllTimers() {
+    this.stopDecisionTimer();
+    this.stopNoSpeechTimer();
+    this.stopToneTimer();
+    this.stopGreetingCompletionTimer();
+  }
+  _onDecisionTimeout() {
+    this.emit(this.decision = AmdEvents.DecisionTimeout);
+    this.stopNoSpeechTimer();
+  }
+  _onToneTimeout() {
+    this.emit(AmdEvents.ToneTimeout);
+  }
+  _onNoSpeechTimeout() {
+    this.emit(this.decision = AmdEvents.NoSpeechDetected);
+    this.stopDecisionTimer();
+  }
+  _onGreetingCompletionTimeout() {
+    this.emit(AmdEvents.MachineStoppedSpeaking);
+  }
+
+  evaluateTranscription(evt) {
+    if (this.decision) {
+      /* at this point we are only listening for the machine to stop speaking */
+      if (this.decision === AmdEvents.MachineDetected) {
+        this.restartGreetingCompletionTimer();
+      }
+      return;
+    }
+    this.stopNoSpeechTimer();
+
+    this.logger.debug({evt}, 'Amd:evaluateTranscription - raw');
+    const t = this.normalizeTranscription(evt, this.vendor, this.language);
+    const hints = voicemailHints[this.language] || [];
+
+    this.logger.debug({t}, 'Amd:evaluateTranscription - normalized');
+
+    if (Array.isArray(t.alternatives) && t.alternatives.length > 0) {
+      const wordCount = t.alternatives[0].transcript.split(' ').length;
+      const final = t.is_final;
+
+      const foundHint = hints.find((h) =>  t.alternatives[0].transcript.includes(h));
+      if (foundHint) {
+        /* we detected a common voice mail greeting */
+        this.logger.debug(`Amd:evaluateTranscription: found hint ${foundHint}`);
+        this.emit(this.decision = AmdEvents.MachineDetected, {
+          reason: 'hint',
+          hint: foundHint,
+          language: t.language_code
+        });
+      }
+      else if (final && wordCount < this.thresholdWordCount) {
+        /* a short greeting is typically a human */
+        this.emit(this.decision = AmdEvents.HumanDetected, {
+          reason: 'short greeting',
+          greeting: t.alternatives[0].transcript,
+          language: t.language_code
+        });
+      }
+      else if (wordCount >= this.thresholdWordCount) {
+        /* a long greeting is typically a machine */
+        this.emit(this.decision = AmdEvents.MachineDetected, {
+          reason: 'long greeting',
+          greeting: t.alternatives[0].transcript,
+          language: t.language_code
+        });
+      }
+
+      if (this.decision) {
+        this.stopDecisionTimer();
+
+        if (this.decision === AmdEvents.MachineDetected) {
+          /* if we detected a machine, then wait for greeting to end */
+          this.startGreetingCompletionTimer();
+        }
+      }
+      return this.decision;
+    }
+  }
+}
+
+module.exports = (logger) => {
+  const startTranscribing = async(cs, ep, task) => {
+    const {vendor, language} = ep.amd;
+    ep.startTranscription({
+      vendor,
+      language,
+      interim: true,
+      bugname
+    }).catch((err) => {
+      const {writeAlerts, AlertType} = cs.srf.locals;
+      ep.amd = null;
+      task.emit(AmdEvents.Error, err);
+      logger.error(err, 'amd:_startTranscribing error');
+      writeAlerts({
+        account_sid: cs.accountSid,
+        alert_type: AlertType.STT_FAILURE,
+        vendor: vendor,
+        detail: err.message
+      });
+    }).catch((err) => logger.info({err}, 'Error generating alert for tts failure'));
+
+  };
+
+  const onEndOfUtterance = (cs, ep, task) => {
+    logger.debug('amd:onEndOfUtterance');
+    startTranscribing(cs, ep, task);
+  };
+  const onNoSpeechDetected = (cs, ep, task) => {
+    logger.debug('amd:onNoSpeechDetected');
+    ep.amd.stopAllTimers();
+    task.emit(AmdEvents.NoSpeechDetected);
+  };
+  const onTranscription = (cs, ep, task, evt, fsEvent) => {
+    if (fsEvent.getHeader('media-bugname') !== bugname) return;
+    ep.amd?.evaluateTranscription(evt);
+  };
+  const onBeep = (cs, ep, task, evt, fsEvent) => {
+    logger.debug({evt, fsEvent}, 'onBeep');
+    const frequency = Math.floor(fsEvent.getHeader('Frequency'));
+    const variance = Math.floor(fsEvent.getHeader('Frequency-variance'));
+    task.emit('amd', {type: AmdEvents.ToneDetected, frequency, variance});
+    if (ep.amd) {
+      ep.amd.stopToneTimer();
+      ep.amd.beepDetected = true;
+    }
+    ep.execute('avmd_stop').catch((err) => this.logger.info(err, 'Error stopping avmd'));
+  };
+
+  const startAmd = async(cs, ep, task, opts) => {
+    const amd = ep.amd = new Amd(logger, cs, opts);
+    const {vendor, language, sttCredentials} = amd;
+    const sttOpts = {};
+    const hints = voicemailHints[language] || [];
+
+    /* set stt options */
+    logger.info(`starting amd for vendor ${vendor} and language ${language}`);
+    if ('google' === vendor) {
+      sttOpts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(sttCredentials.credentials);
+      sttOpts.GOOGLE_SPEECH_USE_ENHANCED = true;
+      sttOpts.GOOGLE_SPEECH_HINTS = hints.join(',');
+      if (opts.recognizer?.altLanguages) {
+        sttOpts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = opts.recognizer.altLanguages.join(',');
+      }
+      ep.addCustomEventListener(GoogleTranscriptionEvents.Transcription, onTranscription.bind(null, cs, ep, task));
+      ep.addCustomEventListener(GoogleTranscriptionEvents.EndOfUtterance, onEndOfUtterance.bind(null, cs, ep, task));
+    }
+    else if (['aws', 'polly'].includes(vendor)) {
+      Object.assign(sttOpts, {
+        AWS_ACCESS_KEY_ID: sttCredentials.accessKeyId,
+        AWS_SECRET_ACCESS_KEY: sttCredentials.secretAccessKey,
+        AWS_REGION: sttCredentials.region
+      });
+      ep.addCustomEventListener(AwsTranscriptionEvents.Transcription, onTranscription.bind(null, cs, ep, task));
+    }
+    else if ('microsoft' === vendor) {
+      Object.assign(sttOpts, {
+        'AZURE_SUBSCRIPTION_KEY': sttCredentials.api_key,
+        'AZURE_REGION': sttCredentials.region
+      });
+      sttOpts.AZURE_SPEECH_HINTS = hints.join(',');
+      if (opts.recognizer?.altLanguages) {
+        sttOpts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = opts.recognizer.altLanguages.join(',');
+      }
+      sttOpts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = opts.resolveTimeoutMs || 20000;
+
+      ep.addCustomEventListener(AzureTranscriptionEvents.Transcription, onTranscription.bind(null, cs, ep, task));
+      ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected, onNoSpeechDetected.bind(null, cs, ep, task));
+    }
+    await ep.set(sttOpts).catch((err) => logger.info(err, 'Error setting channel variables'));
+
+    amd
+      .on(AmdEvents.NoSpeechDetected, (evt) => {
+        task.emit('amd', {type: AmdEvents.NoSpeechDetected, ...evt});
+        try {
+          ep.connected && ep.stopTranscription({vendor, bugname});
+        } catch (err) {
+          logger.info({err}, 'Error stopping transcription');
+        }
+      })
+      .on(AmdEvents.HumanDetected, (evt) => {
+        task.emit('amd', {type: AmdEvents.HumanDetected, ...evt});
+        try {
+          ep.connected && ep.stopTranscription({vendor, bugname});
+        } catch (err) {
+          logger.info({err}, 'Error stopping transcription');
+        }
+      })
+      .on(AmdEvents.MachineDetected, (evt) => {
+        task.emit('amd', {type: AmdEvents.MachineDetected, ...evt});
+      })
+      .on(AmdEvents.DecisionTimeout, (evt) => {
+        task.emit('amd', {type: AmdEvents.DecisionTimeout, ...evt});
+        try {
+          ep.connected && ep.stopTranscription({vendor, bugname});
+        } catch (err) {
+          logger.info({err}, 'Error stopping transcription');
+        }
+      })
+      .on(AmdEvents.ToneTimeout, (evt) => {
+        //task.emit('amd', {type: AmdEvents.ToneTimeout, ...evt});
+        try {
+          ep.connected && ep.execute('avmd_stop').catch((err) => logger.info(err, 'Error stopping avmd'));
+        } catch (err) {
+          logger.info({err}, 'Error stopping avmd');
+        }
+      })
+      .on(AmdEvents.MachineStoppedSpeaking, () => {
+        task.emit('amd', {type: AmdEvents.MachineStoppedSpeaking});
+        try {
+          ep.connected && ep.stopTranscription({vendor, bugname});
+        } catch (err) {
+          logger.info({err}, 'Error stopping transcription');
+        }
+      });
+
+    /* start transcribing, and also listening for beep */
+    amd.startDecisionTimer();
+    startTranscribing(cs, ep, task);
+
+    ep.addCustomEventListener(AvmdEvents.Beep, onBeep.bind(null, cs, ep, task));
+    ep.execute('avmd_start').catch((err) => this.logger.info(err, 'Error starting avmd'));
+  };
+
+  const stopAmd = (ep, task) => {
+    let vendor;
+    if (ep.amd) {
+      vendor = ep.amd.vendor;
+      ep.amd.stopAllTimers();
+      ep.amd = null;
+    }
+
+    if (ep.connected) {
+      ep.stopTranscription({vendor, bugname})
+        .catch((err) => logger.info(err, 'stopAmd: Error stopping transcription'));
+      task.emit('amd', {type: AmdEvents.Stopped});
+      ep.execute('avmd_stop').catch((err) => this.logger.info(err, 'Error stopping avmd'));
+    }
+    ep.removeCustomEventListener(AvmdEvents.Beep);
+  };
+
+  return {startAmd, stopAmd};
+};

lib/utils/aws-sns-lifecycle.js

@@ -1,7 +1,7 @@
 const Emitter = require('events');
 const bent = require('bent');
 const assert = require('assert');
-const PORT = process.env.AWS_SNS_PORT || 3001;
+const PORT = process.env.AWS_SNS_PORT || 3010;
 const {LifeCycleEvents} = require('./constants');
 const express = require('express');
 const app = express();
@@ -21,6 +21,26 @@ class SnsNotifier extends Emitter {
 
     this.logger = logger;
   }
+  _doListen(logger, app, port, resolve) {
+    return app.listen(port, () => {
+      this.snsEndpoint = `http://${this.publicIp}:${port}`;
+      logger.info(`SNS lifecycle server listening on http://localhost:${port}`);
+      resolve(app);
+    });
+  }
+
+  _handleErrors(logger, app, resolve, reject, e) {
+    if (e.code === 'EADDRINUSE' &&
+      process.env.AWS_SNS_PORT_MAX &&
+      e.port < process.env.AWS_SNS_PORT_MAX) {
+
+      logger.info(`SNS lifecycle server failed to bind port on ${e.port}, will try next port`);
+      const server = this._doListen(logger, app, ++e.port, resolve);
+      server.on('error', this._handleErrors.bind(this, logger, app, resolve, reject));
+      return;
+    }
+    reject(e);
+  }
 
   async _handlePost(req, res) {
     try {
@@ -45,6 +65,7 @@ class SnsNotifier extends Emitter {
           }, 'response from SNS SubscribeURL');
           const data = await this.describeInstance();
           this.lifecycleState = data.AutoScalingInstances[0].LifecycleState;
+          this.emit('SubscriptionConfirmation', {publicIp: this.publicIp});
           break;
 
         case 'Notification':
@@ -83,11 +104,9 @@ class SnsNotifier extends Emitter {
       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
+        publicIp: this.publicIp
       }, 'retrieved AWS instance data');
 
       // start listening
@@ -99,7 +118,10 @@ class SnsNotifier extends Emitter {
         this.logger.error(err, 'burped error');
         res.status(err.status || 500).json({msg: err.message});
       });
-      app.listen(PORT);
+      return new Promise((resolve, reject) => {
+        const server = this._doListen(this.logger, app, PORT, resolve);
+        server.on('error', this._handleErrors.bind(this, this.logger, app, resolve, reject));
+      });
 
     } catch (err) {
       this.logger.error({err}, 'Error retrieving AWS instance metadata');

lib/utils/base-requestor.js

@@ -0,0 +1,75 @@
+const assert = require('assert');
+const Emitter = require('events');
+const crypto = require('crypto');
+const timeSeries = require('@jambonz/time-series');
+let alerter ;
+
+class BaseRequestor extends Emitter {
+  constructor(logger, account_sid, hook, secret) {
+    super();
+    assert(typeof hook === 'object');
+
+    this.logger = logger;
+    this.url = hook.url;
+
+    this.username = hook.username;
+    this.password = hook.password;
+    this.secret = secret;
+    this.account_sid = account_sid;
+
+    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 Alerter() {
+    return alerter;
+  }
+
+  close() {
+    /* subclass responsibility */
+  }
+
+  _computeSignature(payload, timestamp, secret) {
+    assert(secret);
+    const data = `${timestamp}.${JSON.stringify(payload)}`;
+    return crypto
+      .createHmac('sha256', secret)
+      .update(data, 'utf8')
+      .digest('hex');
+  }
+
+  _generateSigHeader(payload, secret) {
+    const timestamp = Math.floor(Date.now() / 1000);
+    const signature = this._computeSignature(payload, timestamp, secret);
+    const scheme = 'v1';
+    return {
+      'Jambonz-Signature': `t=${timestamp},${scheme}=${signature}`
+    };
+  }
+
+  _isAbsoluteUrl(u) {
+    return typeof u === 'string' &&
+      u.startsWith('https://') || u.startsWith('http://') ||
+      u.startsWith('ws://') || u.startsWith('wss://');
+  }
+  _isRelativeUrl(u) {
+    return typeof u === 'string' && u.startsWith('/');
+  }
+  _roundTrip(startAt) {
+    const diff = process.hrtime(startAt);
+    const time = diff[0] * 1e3 + diff[1] * 1e-6;
+    return time.toFixed(0);
+  }
+
+
+}
+
+module.exports = BaseRequestor;

lib/utils/call-tracer.js

@@ -0,0 +1,78 @@
+const {context, trace} = require('@opentelemetry/api');
+const {Dialog} = require('drachtio-srf');
+class RootSpan {
+  constructor(callType, req) {
+    let tracer, callSid, linkedSpanId;
+
+    if (req instanceof Dialog) {
+      const dlg = req;
+      tracer = dlg.srf.locals.otel.tracer;
+      callSid = dlg.callSid;
+      linkedSpanId = dlg.linkedSpanId;
+    }
+    else {
+      tracer = req.srf.locals.otel.tracer;
+      callSid = req.locals.callSid;
+    }
+    this._span = tracer.startSpan(callType || 'incoming-call');
+    if (req instanceof Dialog) {
+      const dlg = req;
+      this._span.setAttributes({
+        linkedSpanId,
+        callId: dlg.sip.callId
+      });
+    }
+    else {
+      this._span.setAttributes({
+        callSid,
+        accountSid: req.get('X-Account-Sid'),
+        applicationSid: req.locals.application_sid,
+        callId: req.get('Call-ID'),
+        externalCallId: req.get('X-CID')
+      });
+    }
+
+    this._ctx = trace.setSpan(context.active(), this._span);
+    this.tracer = tracer;
+  }
+
+  get context() {
+    return this._ctx;
+  }
+
+  get traceId() {
+    return this._span.spanContext().traceId;
+  }
+
+  get spanId() {
+    return this._span.spanContext().spanId;
+  }
+
+  get traceFlags() {
+    return this._span.spanContext().traceFlags;
+  }
+
+  getTracingPropagation(encoding) {
+    // TODO: support encodings beyond b3 https://github.com/openzipkin/b3-propagation
+    if (this._span  && this.traceId !== '00000000000000000000000000000000') {
+      return `${this.traceId}-${this.spanId}-1`;
+    }
+  }
+
+  setAttributes(attrs) {
+    this._span.setAttributes(attrs);
+  }
+
+  end() {
+    this._span.end();
+  }
+
+  startChildSpan(name, attributes) {
+    const span = this.tracer.startSpan(name, attributes, this._ctx);
+    const ctx = trace.setSpan(context.active(), span);
+    return {span, ctx};
+  }
+}
+
+module.exports = RootSpan;
+

lib/utils/constants.json

@@ -1,18 +1,27 @@
 {
   "TaskName": {
+    "Cognigy": "cognigy",
     "Conference": "conference",
+    "Config": "config",
     "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",
+    "SipRequest": "sip:request",
+    "SipRefer": "sip:refer",
     "SipNotify": "sip:notify",
     "SipRedirect": "sip:redirect",
     "Say": "say",
@@ -20,6 +29,7 @@
     "Tag": "tag",
     "Transcribe": "transcribe"
   },
+  "AllowedSipRecVerbs": ["config", "gather", "transcribe", "listen"],
   "CallStatus": {
     "Trying": "trying",
     "Ringing": "ringing",
@@ -33,7 +43,8 @@
   },
   "CallDirection": {
     "Inbound": "inbound",
-    "Outbound": "outbound"
+    "Outbound": "outbound",
+    "None": "none"
   },
   "ListenStatus": {
     "Pause": "pause",
@@ -46,11 +57,64 @@
     "StableCall": "stable-call",
     "UnansweredCall": "unanswered-call"
   },
-  "TranscriptionEvents": {
+  "AvmdEvents": {
+    "Beep": "avmd::beep"
+  },
+  "GoogleTranscriptionEvents": {
     "Transcription": "google_transcribe::transcription",
     "EndOfUtterance": "google_transcribe::end_of_utterance",
     "NoAudioDetected": "google_transcribe::no_audio_detected",
-    "MaxDurationExceeded": "google_transcribe::max_duration_exceeded"
+    "MaxDurationExceeded": "google_transcribe::max_duration_exceeded",
+    "VadDetected": "google_transcribe::vad_detected"
+  },
+  "NuanceTranscriptionEvents": {
+    "Transcription": "nuance_transcribe::transcription",
+    "StartOfSpeech": "nuance_transcribe::start_of_speech",
+    "TranscriptionComplete": "nuance_transcribe::end_of_transcription",
+    "Error": "nuance_transcribe::error",
+    "VadDetected": "nuance_transcribe::vad_detected"
+  },
+  "NvidiaTranscriptionEvents": {
+    "Transcription": "nvidia_transcribe::transcription",
+    "StartOfSpeech": "nvidia_transcribe::start_of_speech",
+    "TranscriptionComplete": "nvidia_transcribe::end_of_transcription",
+    "Error": "nvidia_transcribe::error",
+    "VadDetected": "nvidia_transcribe::vad_detected"
+  },
+  "DeepgramTranscriptionEvents": {
+    "Transcription": "deepgram_transcribe::transcription",
+    "ConnectFailure": "deepgram_transcribe::connect_failed",
+    "Connect": "deepgram_transcribe::connect"
+  },
+  "SonioxTranscriptionEvents": {
+    "Transcription": "soniox_transcribe::transcription",
+    "Error": "soniox_transcribe::error"
+  },
+  "IbmTranscriptionEvents": {
+    "Transcription": "ibm_transcribe::transcription",
+    "ConnectFailure": "ibm_transcribe::connect_failed",
+    "Connect": "ibm_transcribe::connect",
+    "Error": "ibm_transcribe::error"
+  },
+  "AwsTranscriptionEvents": {
+    "Transcription": "aws_transcribe::transcription",
+    "EndOfTranscript": "aws_transcribe::end_of_transcript",
+    "NoAudioDetected": "aws_transcribe::no_audio_detected",
+    "MaxDurationExceeded": "aws_transcribe::max_duration_exceeded",
+    "VadDetected": "aws_transcribe::vad_detected"
+  },
+  "AzureTranscriptionEvents": {
+    "Transcription": "azure_transcribe::transcription",
+    "StartOfUtterance": "azure_transcribe::start_of_utterance",
+    "EndOfUtterance": "azure_transcribe::end_of_utterance",
+    "NoSpeechDetected": "azure_transcribe::no_speech_detected",
+    "VadDetected": "azure_transcribe::vad_detected"
+  },
+  "JambonzTranscriptionEvents": {
+    "Transcription": "jambonz_transcribe::transcription",
+    "ConnectFailure": "jambonz_transcribe::connect_failed",
+    "Connect": "jambonz_transcribe::connect",
+    "Error": "jambonz_transcribe::error"
   },
   "ListenEvents": {
     "Connect": "mod_audio_fork::connect",
@@ -81,6 +145,38 @@
     "Hangup": "hangup",
     "Timeout": "timeout"
   },
+  "KillReason": {
+    "Hangup": "hangup",
+    "Replaced": "replaced"
+  },
+  "HookMsgTypes": [
+    "session:new",
+    "session:reconnect",
+    "session:redirect",
+    "call:status",
+    "queue:status",
+    "dial:confirm",
+    "verb:hook",
+    "verb:status",
+    "jambonz:error"
+  ],
+  "RecordState": {
+    "RecordingOn": "recording_on",
+    "RecordingOff": "recording_off",
+    "RecordingPaused": "recording_paused"
+  },
+  "AmdEvents": {
+    "NoSpeechDetected": "amd_no_speech_detected",
+    "HumanDetected": "amd_human_detected",
+    "MachineDetected": "amd_machine_detected",
+    "MachineStoppedSpeaking": "amd_machine_stopped_speaking",
+    "Error": "amd_error",
+    "DecisionTimeout": "amd_decision_timeout",
+    "ToneDetected": "amd_tone_detected",
+    "ToneTimeout": "amd_tone_timeout",
+    "Stopped": "amd_stopped"
+  },
   "MAX_SIMRINGS": 10,
-  "BONG_TONE": "tone_stream://v=-7;%(100,0,941.0,1477.0);v=-7;>=2;+=.1;%(1400,0,350,440)"
+  "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/cron-jobs.js

@@ -0,0 +1,52 @@
+const {execSync} = require('child_process');
+const now = Date.now();
+const fsInventory = process.env.JAMBONES_FREESWITCH
+  .split(',')
+  .map((fs) => {
+    const arr = /^([^:]*):([^:]*):([^:]*)(?::([^:]*))?/.exec(fs);
+    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;
+  });
+
+const clearChannels = () => {
+  const {logger} = require('../..');
+  const pwd = fsInventory[0].secret;
+  const maxDurationMins = process.env.JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS || 180;
+
+  const calls = execSync(`/usr/local/freeswitch/bin/fs_cli -p ${pwd} -x "show calls"`, {encoding: 'utf8'})
+    .split('\n')
+    .filter((line) => line.match(/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{8}/))
+    .map((line) => {
+      const arr = line.split(',');
+      const dt = new Date(arr[2]);
+      const duration = (now - dt.getTime()) / 1000;
+      return {
+        uuid: arr[0],
+        time: arr[2],
+        duration
+      };
+    })
+    .filter((c) => c.duration > 60 * maxDurationMins);
+
+  if (calls.length > 0) {
+    logger.debug(`clearChannels: clearing ${calls.length} old calls longer than ${maxDurationMins} mins`);
+    for (const call of calls) {
+      const cmd = `/usr/local/freeswitch/bin/fs_cli -p ${pwd} -x "uuid_kill ${call.uuid}"`;
+      const out = execSync(cmd, {encoding: 'utf8'});
+      logger.debug({out}, 'clearChannels: command output');
+    }
+  }
+  return calls.length;
+};
+
+const clearFiles = () => {
+  //const {logger} = require('../..');
+  /*const out = */ execSync('find /tmp -name "*.mp3" -mtime +2 -exec rm {} \\;');
+  //logger.debug({out}, 'clearFiles: command output');
+};
+
+
+module.exports = {clearChannels, clearFiles};
+

lib/utils/db-utils.js

@@ -0,0 +1,136 @@
+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;
+  try {
+    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;
+      obj.aws_region = o.aws_region;
+    }
+    else if ('microsoft' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+      obj.region = o.region;
+      obj.use_custom_stt = o.use_custom_stt;
+      obj.custom_stt_endpoint = o.custom_stt_endpoint;
+      obj.use_custom_tts = o.use_custom_tts;
+      obj.custom_tts_endpoint = o.custom_tts_endpoint;
+    }
+    else if ('wellsaid' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+    }
+    else if ('nuance' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.client_id = o.client_id;
+      obj.secret = o.secret;
+      obj.nuance_tts_uri = o.nuance_tts_uri;
+      obj.nuance_stt_uri = o.nuance_stt_uri;
+    }
+    else if ('ibm' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.tts_api_key = o.tts_api_key;
+      obj.tts_region = o.tts_region;
+      obj.stt_api_key = o.stt_api_key;
+      obj.stt_region = o.stt_region;
+    }
+    else if ('deepgram' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+    }
+    else if ('soniox' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+    }
+    else if (obj.vendor.startsWith('custom:')) {
+      const o = JSON.parse(decrypt(credential));
+      obj.auth_token = o.auth_token;
+      obj.custom_stt_url = o.custom_stt_url;
+      obj.custom_tts_url = o.custom_tts_url;
+    }
+  } catch (err) {
+    console.log(err);
+  }
+  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);
+
+    /* add service provider creds unless we have that vendor at the account level */
+    const [r3] = await pp.query(sqlSpeechCredentialsForSP, account_sid);
+    r3.forEach((s) => {
+      if (!speech.find((s2) => s2.vendor === s.vendor)) {
+        speech.push(speechMapper(s));
+      }
+    });
+
+    return {
+      ...r[0],
+      speech
+    };
+  };
+
+  const updateSpeechCredentialLastUsed = async(speech_credential_sid) => {
+    if (!speech_credential_sid) return;
+    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(process.env.ENCRYPTION_SECRET || process.env.JWT_SECRET)
+  .digest('base64')
+  .substring(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 decrypted = Buffer.concat([decipher.update(Buffer.from(hash.content, 'hex')), decipher.final()]);
+  return decrypted.toString();
+};
+
+module.exports = {
+  encrypt,
+  decrypt
+};

lib/utils/http-listener.js

@@ -0,0 +1,45 @@
+
+const express = require('express');
+const httpRoutes = require('../http-routes');
+const PORT = process.env.HTTP_PORT || 3000;
+
+const doListen = (logger, app, port, resolve) => {
+  const server = app.listen(port, () => {
+    const {srf} = app.locals;
+    logger.info(`listening for HTTP requests on port ${PORT}, serviceUrl is ${srf.locals.serviceUrl}`);
+    resolve({server, app});
+  });
+  return server;
+};
+const handleErrors = (logger, app, resolve, reject, e) => {
+  if (e.code === 'EADDRINUSE' &&
+    process.env.HTTP_PORT_MAX &&
+    e.port < process.env.HTTP_PORT_MAX) {
+
+    logger.info(`HTTP server failed to bind port on ${e.port}, will try next port`);
+    const server = doListen(logger, app, ++e.port, resolve);
+    server.on('error', handleErrors.bind(null, logger, app, resolve, reject));
+    return;
+  }
+  logger.info({err: e, port: PORT}, 'httpListener error');
+  reject(e);
+};
+
+const createHttpListener = (logger, srf) => {
+  const app = express();
+  app.locals = {...app.locals, logger, srf};
+  app.use(express.urlencoded({ extended: true }));
+  app.use(express.json());
+  app.use('/', httpRoutes);
+  app.use((err, _req, res, _next) => {
+    logger.error(err, 'burped error');
+    res.status(err.status || 500).json({msg: err.message});
+  });
+  return new Promise((resolve, reject) => {
+    const server = doListen(logger, app, PORT, resolve);
+    server.on('error', handleErrors.bind(null, logger, app, resolve, reject));
+  });
+};
+
+
+module.exports = createHttpListener;

lib/utils/http-requestor.js

@@ -0,0 +1,189 @@
+const {Client, Pool} = require('undici');
+const parseUrl = require('parse-url');
+const assert = require('assert');
+const BaseRequestor = require('./base-requestor');
+const {HookMsgTypes} = require('./constants.json');
+const snakeCaseKeys = require('./snakecase-keys');
+const pools = new Map();
+const HTTP_TIMEOUT = 10000;
+
+const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
+
+function basicAuth(username, password) {
+  if (!username || !password) return {};
+  const creds = `${username}:${password || ''}`;
+  const header = `Basic ${toBase64(creds)}`;
+  return {Authorization: header};
+}
+
+
+class HttpRequestor extends BaseRequestor {
+  constructor(logger, account_sid, hook, secret) {
+    super(logger, account_sid, hook, secret);
+
+    this.method = hook.method || 'POST';
+    this.authHeader = basicAuth(hook.username, hook.password);
+
+    assert(this._isAbsoluteUrl(this.url));
+    assert(['GET', 'POST'].includes(this.method));
+
+    const u = this._parsedUrl = parseUrl(this.url);
+    if (u.port) this._baseUrl = `${u.protocol}://${u.resource}:${u.port}`;
+    else this._baseUrl = `${u.protocol}://${u.resource}`;
+    this._protocol = u.protocol;
+    this._resource = u.resource;
+    this._port = u.port;
+    this._search = u.search;
+    this._usePools = process.env.HTTP_POOL && parseInt(process.env.HTTP_POOL);
+
+    if (this._usePools) {
+      if (pools.has(this._baseUrl)) {
+        this.client = pools.get(this._baseUrl);
+      }
+      else {
+        const connections = process.env.HTTP_POOLSIZE ? parseInt(process.env.HTTP_POOLSIZE) : 10;
+        const pipelining = process.env.HTTP_PIPELINING ? parseInt(process.env.HTTP_PIPELINING) : 1;
+        const pool = this.client = new Pool(this._baseUrl, {
+          connections,
+          pipelining
+        });
+        pools.set(this._baseUrl, pool);
+        this.logger.debug(`HttpRequestor:created pool for ${this._baseUrl}`);
+      }
+    }
+    else {
+      if (u.port) this.client = new Client(`${u.protocol}://${u.resource}:${u.port}`);
+      else this.client = new Client(`${u.protocol}://${u.resource}`);
+    }
+  }
+
+  get baseUrl() {
+    return this._baseUrl;
+  }
+
+  close() {
+    if (!this._usePools && !this.client?.closed) this.client.close();
+  }
+
+  /**
+   * Make an HTTP request.
+   * All requests use json bodies.
+   * All requests expect a 200 statusCode on success
+   * @param {object|string} hook - may be a absolute or relative url, or an object
+   * @param {string} [hook.url] - an absolute or relative url
+   * @param {string} [hook.method] - 'GET' or 'POST'
+   * @param {string} [hook.username] - if basic auth is protecting the endpoint
+   * @param {string} [hook.password] - if basic auth is protecting the endpoint
+   * @param {object} [params] - request parameters
+   */
+  async request(type, hook, params, httpHeaders = {}) {
+    /* jambonz:error only sent over ws */
+    if (type === 'jambonz:error') return;
+
+    assert(HookMsgTypes.includes(type));
+
+    const payload = params ? snakeCaseKeys(params, ['customerData', 'sip']) : null;
+    const url = hook.url || hook;
+    const method = hook.method || 'POST';
+    let buf = '';
+
+    assert.ok(url, 'HttpRequestor:request url was not provided');
+    assert.ok, (['GET', 'POST'].includes(method), `HttpRequestor:request method must be 'GET' or 'POST' not ${method}`);
+    const startAt = process.hrtime();
+
+    /* if we have an absolute url, and it is ws then do a websocket connection */
+    if (this._isAbsoluteUrl(url) && url.startsWith('ws')) {
+      const WsRequestor = require('./ws-requestor');
+      this.logger.debug({hook}, 'HttpRequestor: switching to websocket connection');
+      const h = typeof hook === 'object' ? hook : {url: hook};
+      const requestor = new WsRequestor(this.logger, this.account_sid, h, this.secret);
+      if (type === 'session:redirect') {
+        this.close();
+        this.emit('handover', requestor);
+      }
+      return requestor.request('session:new', hook, params, httpHeaders);
+    }
+
+    let newClient;
+    try {
+      let client, path, query;
+      if (this._isRelativeUrl(url)) {
+        client = this.client;
+        path = url;
+      }
+      else {
+        const u = parseUrl(url);
+        if (u.resource === this._resource && u.port === this._port && u.protocol === this._protocol) {
+          client = this.client;
+          path = u.pathname;
+          query = u.query;
+        }
+        else {
+          if (u.port) client = newClient = new Client(`${u.protocol}://${u.resource}:${u.port}`);
+          else client = newClient = new Client(`${u.protocol}://${u.resource}`);
+          path = u.pathname;
+          query = u.query;
+        }
+      }
+      const sigHeader = this._generateSigHeader(payload, this.secret);
+      const hdrs = {
+        ...sigHeader,
+        ...this.authHeader,
+        ...httpHeaders,
+        ...('POST' === method && {'Content-Type': 'application/json'})
+      };
+      const absUrl = this._isRelativeUrl(url) ? `${this.baseUrl}${url}` : url;
+      this.logger.debug({url, absUrl, hdrs}, 'send webhook');
+      const {statusCode, headers, body} =  await client.request({
+        path,
+        query,
+        method,
+        headers: hdrs,
+        ...('POST' === method && {body: JSON.stringify(payload)}),
+        timeout: HTTP_TIMEOUT,
+        followRedirects: false
+      });
+      if (![200, 202, 204].includes(statusCode)) {
+        const err = new Error();
+        err.statusCode = statusCode;
+        throw err;
+      }
+      if (headers['content-type']?.includes('application/json')) {
+        buf = await body.json();
+      }
+      if (newClient) newClient.close();
+    } catch (err) {
+      if (err.statusCode) {
+        this.logger.info({baseUrl: this.baseUrl, url},
+          `web callback returned unexpected status code ${err.statusCode}`);
+      }
+      else {
+        this.logger.error({err, baseUrl: this.baseUrl, url},
+          'web callback returned unexpected error');
+      }
+      let opts = {account_sid: this.account_sid};
+      if (err.code === 'ECONNREFUSED') {
+        opts = {...opts, alert_type: this.Alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url};
+      }
+      else if (err.name === 'StatusError') {
+        opts = {...opts, alert_type: this.Alerter.AlertType.WEBHOOK_STATUS_FAILURE, url, status: err.statusCode};
+      }
+      else {
+        opts = {...opts, alert_type: this.Alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url, detail: err.message};
+      }
+      this.Alerter.writeAlerts(opts).catch((err) => this.logger.info({err, opts}, 'Error writing alert'));
+
+      if (newClient) newClient.close();
+      throw err;
+    }
+    const rtt = this._roundTrip(startAt);
+    if (buf) this.stats.histogram('app.hook.response_time', rtt, ['hook_type:app']);
+
+    if (buf && Array.isArray(buf)) {
+      this.logger.info({response: buf}, `HttpRequestor:request ${method} ${url} succeeded in ${rtt}ms`);
+      return buf;
+    }
+  }
+}
+
+module.exports = HttpRequestor;

lib/utils/install-srf-locals.js

@@ -1,6 +1,5 @@
 const Mrf = require('drachtio-fsmrf');
 const ip = require('ip');
-const localIp = ip.address();
 const PORT = process.env.HTTP_PORT || 3000;
 const assert = require('assert');
 
@@ -20,13 +19,21 @@ function initMS(logger, wrapper, ms) {
       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 {tracer} = srf.locals.otel;
   const {getSBC, lifecycleEmitter} = require('./sbc-pinger')(logger);
-  const StatsCollector = require('jambonz-stats-collector');
+  const StatsCollector = require('@jambonz/stats-collector');
   const stats = srf.locals.stats = new StatsCollector(logger);
 
   // freeswitch connections (typically we connect to only one)
@@ -38,9 +45,16 @@ 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];
+        /* NB: originally for testing only, but for now all jambonz deployments
+          have freeswitch installed locally alongside this app
+        */
+        if (process.env.NODE_ENV === 'test') opts.listenAddress = '0.0.0.0';
+        else if (process.env.JAMBONES_ESL_LISTEN_ADDRESS) opts.listenAddress = process.env.JAMBONES_ESL_LISTEN_ADDRESS;
+        return opts;
       });
     logger.info({fsInventory}, 'freeswitch inventory');
 
@@ -52,7 +66,7 @@ function installSrfLocals(srf, logger) {
         initMS(logger, val, ms);
       }
       catch (err) {
-        logger.info(`failed connecting to freeswitch at ${fs.address}, will retry shortly`);
+        logger.info({err}, `failed connecting to freeswitch at ${fs.address}, will retry shortly: ${err.message}`);
       }
     }
     // retry to connect to any that were initially offline
@@ -64,7 +78,7 @@ function installSrfLocals(srf, logger) {
             const ms = await mrf.connect(val.opts);
             initMS(logger, val, ms);
           } catch (err) {
-            logger.info(`failed connecting to freeswitch at ${val.opts.address}, will retry shortly`);
+            logger.info({err}, `failed connecting to freeswitch at ${val.opts.address}, will retry shortly`);
           }
         }
       }
@@ -72,6 +86,7 @@ function installSrfLocals(srf, logger) {
 
     // if we have a single freeswitch (as is typical) report stats periodically
     if (mediaservers.length === 1) {
+      srf.locals.mediaservers = [mediaservers[0].ms];
       setInterval(() => {
         try {
           if (mediaservers[0].ms && mediaservers[0].active) {
@@ -99,24 +114,30 @@ function installSrfLocals(srf, logger) {
   }
 
   const {
+    pool,
     lookupAppByPhoneNumber,
+    lookupAppByRegex,
     lookupAppBySid,
     lookupAppByRealm,
     lookupAppByTeamsTenant,
-    lookupTeamsByAccount
+    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);
+  }, logger, tracer);
   const {
+    client,
     updateCallStatus,
     retrieveCall,
     listCalls,
     deleteCall,
-    synthAudio,
     createHash,
     retrieveHash,
     deleteKey,
@@ -125,23 +146,53 @@ function installSrfLocals(srf, logger) {
     retrieveSet,
     addToSet,
     removeFromSet,
+    monitorSet,
     pushBack,
     popFront,
     removeFromList,
+    getListPosition,
     lengthOfList,
-    getListPosition
-  } = require('jambonz-realtimedb-helpers')({
+  } = require('@jambonz/realtimedb-helpers')({
     host: process.env.JAMBONES_REDIS_HOST,
     port: process.env.JAMBONES_REDIS_PORT || 6379
-  }, logger);
+  }, logger, tracer);
+  const {
+    synthAudio,
+    getNuanceAccessToken,
+    getIbmAccessToken,
+  } = require('@jambonz/speech-utils')({
+    host: process.env.JAMBONES_REDIS_HOST,
+    port: process.env.JAMBONES_REDIS_PORT || 6379
+  }, logger, tracer);
+  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, {
+  let localIp;
+  try {
+    localIp = ip.address();
+  } catch (err) {
+    logger.error({err}, 'installSrfLocals - error detecting local ipv4 address');
+  }
+
+  srf.locals = {...srf.locals,
     dbHelpers: {
+      client,
+      pool,
       lookupAppByPhoneNumber,
+      lookupAppByRegex,
       lookupAppBySid,
       lookupAppByRealm,
       lookupAppByTeamsTenant,
       lookupTeamsByAccount,
+      lookupAccountBySid,
+      lookupAccountCapacitiesBySid,
+      lookupSmppGateways,
       updateCallStatus,
       retrieveCall,
       listCalls,
@@ -155,20 +206,31 @@ function installSrfLocals(srf, logger) {
       retrieveSet,
       addToSet,
       removeFromSet,
+      monitorSet,
       pushBack,
       popFront,
       removeFromList,
       lengthOfList,
-      getListPosition
+      getListPosition,
+      getNuanceAccessToken,
+      getIbmAccessToken
     },
     parentLogger: logger,
-    ipv4: localIp,
-    serviceUrl: `http://${localIp}:${PORT}`,
     getSBC,
+    getSmpp: () => {
+      return process.env.SMPP_URL;
+    },
     lifecycleEmitter,
     getFreeswitch,
-    stats: stats
-  });
+    stats: stats,
+    writeAlerts,
+    AlertType
+  };
+
+  if (localIp) {
+    srf.locals.ipv4 = localIp;
+    srf.locals.serviceUrl = `http://${localIp}:${PORT}`;
+  }
 }
 
 module.exports = installSrfLocals;

lib/utils/normalize-jambones.js

@@ -1,31 +0,0 @@
-function normalizeJambones(logger, obj) {
-  if (!Array.isArray(obj)) throw new Error('malformed jambonz payload: must be array');
-  const document = [];
-  for (const tdata of obj) {
-    if (typeof tdata !== 'object') throw new Error('malformed jambonz payload: must be array of objects');
-    if ('verb' in tdata) {
-      // {verb: 'say', text: 'foo..bar'..}
-      const name = tdata.verb;
-      const o = {};
-      Object.keys(tdata)
-        .filter((k) => k !== 'verb')
-        .forEach((k) => o[k] = tdata[k]);
-      const o2 = {};
-      o2[name] = o;
-      document.push(o2);
-    }
-    else if (Object.keys(tdata).length === 1) {
-      // {'say': {..}}
-      document.push(tdata);
-    }
-    else {
-      logger.info(tdata, 'malformed jambonz payload: missing verb property');
-      throw new Error('malformed jambonz payload: missing verb property');
-    }
-  }
-  logger.debug({document}, `normalizeJambones: returning document with ${document.length} tasks`);
-  return document;
-}
-
-module.exports = normalizeJambones;
-

lib/utils/place-outdial.js

@@ -4,32 +4,36 @@ const SipError = require('drachtio-srf').SipError;
 const {TaskPreconditions, CallDirection} = require('../utils/constants');
 const CallInfo = require('../session/call-info');
 const assert = require('assert');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+const makeTask = require('../tasks/make_task');
 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 RootSpan = require('./call-tracer');
+const uuidv4 = require('uuid-random');
 
 class SingleDialer extends Emitter {
-  constructor({logger, sbcAddress, target, opts, application, callInfo}) {
+  constructor({logger, sbcAddress, target, opts, application, callInfo, accountInfo, rootSpan, startSpan}) {
     super();
     assert(target.type);
 
     this.logger = logger;
     this.target = target;
+    this.from = target.from || {};
     this.sbcAddress = sbcAddress;
     this.opts = opts;
     this.application = application;
     this.confirmHook = target.confirmHook;
+    this.rootSpan = rootSpan;
+    this.startSpan = startSpan;
 
     this.bindings = logger.bindings();
 
     this.parentCallInfo = callInfo;
+    this.accountInfo = accountInfo;
+
     this.callGone = false;
 
     this.callSid = uuidv4();
@@ -59,7 +63,24 @@ class SingleDialer extends Emitter {
 
   async exec(srf, ms, opts) {
     opts = opts || {};
-    let uri, to;
+    opts.headers = opts.headers || {};
+    opts.headers = {
+      ...opts.headers,
+      ...(this.target.headers || {}),
+      ...(this.from.user && {'X-Preferred-From-User': this.from.user}),
+      ...(this.from.host && {'X-Preferred-From-Host': this.from.host}),
+      'X-Jambonz-Routing': this.target.type,
+      'X-Call-Sid': this.callSid,
+      ...(this.applicationSid && {'X-Application-Sid': this.applicationSid})
+    };
+    if (srf.locals.fsUUID) {
+      opts.headers = {
+        ...opts.headers,
+        'X-Jambonz-FS-UUID': srf.locals.fsUUID,
+      };
+    }
+    this.ms = ms;
+    let uri, to, inviteSpan;
     try {
       switch (this.target.type) {
         case 'phone':
@@ -69,28 +90,22 @@ class SingleDialer extends Emitter {
           to = this.target.number;
           if ('teams' === this.target.type) {
             assert(this.target.teamsInfo);
-            opts.headers = opts.headers || {};
-            Object.assign(opts.headers, {
+            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':
@@ -108,13 +123,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, {
@@ -122,25 +146,38 @@ 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, {
+      inviteSpan = this.startSpan('invite', {
+        'invite.uri': uri,
+        'invite.dest_type': this.target.type
+      });
+
+      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');
             this.emit('callCreateFail', err);
+            inviteSpan.setAttributes({
+              'invite.status_code': 500,
+              'invite.err': err.message
+            });
+            inviteSpan.end();
             return;
           }
+          inviteSpan.setAttributes({'invite.call_id': req.get('Call-ID')});
 
           /**
            * INVITE has been sent out
            *  (a) create a CallInfo for this call
            *  (a) create a logger for this call
            */
+          req.srf = srf;
           this.callInfo = new CallInfo({
             direction: CallDirection.Outbound,
             parentCallInfo: this.parentCallInfo,
             req,
             to,
-            callSid: this.callSid
+            callSid: this.callSid,
+            traceId: this.rootSpan.traceId
           });
           this.logger = srf.locals.parentLogger.child({
             callSid: this.callSid,
@@ -148,56 +185,102 @@ class SingleDialer extends Emitter {
             callId: this.callInfo.callId
           });
           this.inviteInProgress = req;
-          this.emit('callStatusChange', {callStatus: CallStatus.Trying, sipStatus: 100});
+          this.emit('callStatusChange', {
+            callStatus: CallStatus.Trying,
+            sipStatus: 100,
+            sipReason: 'Trying'
+          });
         },
         cbProvisional: (prov) => {
-          const status = {sipStatus: prov.status};
+          const status = {sipStatus: prov.status, sipReason: prov.reason};
           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.emit('callStatusChange', {
+        sipStatus: 200,
+        sipReason: 'OK',
+        callStatus: CallStatus.InProgress
+      });
       this.logger.debug(`SingleDialer:exec call connected: ${this.callSid}`);
       const connectTime = this.dlg.connectTime = moment();
+      inviteSpan.setAttributes({'invite.status_code': 200});
+      inviteSpan.end();
+
+
+      /* race condition: we were killed just as call was answered */
+      if (this.killed) {
+        this.logger.info(`SingleDialer:exec race condition - we were killed as call connected: ${this.callSid}`);
+        const duration = moment().diff(connectTime, 'seconds');
+        this.emit('callStatusChange', {
+          callStatus: CallStatus.Completed,
+          sipStatus: 487,
+          sipReason: 'Request Terminated',
+          duration
+        });
+        if (this.ep) this.ep.destroy();
+        return;
+      }
 
       this.dlg
         .on('destroy', () => {
           const duration = moment().diff(connectTime, 'seconds');
           this.logger.debug('SingleDialer:exec called party hung up');
           this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-          this.ep.destroy();
+          this.ep && this.ep.destroy();
         })
         .on('refresh', () => this.logger.info('SingleDialer:exec - dialog refreshed by uas'))
         .on('modify', async(req, res) => {
           try {
-            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');
+            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');
           }
+        })
+        .on('refer', (req, res) => {
+          this.emit('refer', this.callInfo, req, res);
         });
 
       if (this.confirmHook) this._executeApp(this.confirmHook);
       else this.emit('accept');
     } catch (err) {
+      this.inviteInProgress = null;
       const status = {callStatus: CallStatus.Failed};
       if (err instanceof SipError) {
         status.sipStatus = err.status;
+        status.sipReason = err.reason;
         if (err.status === 487) status.callStatus = CallStatus.NoAnswer;
         else if ([486, 600].includes(err.status)) status.callStatus = CallStatus.Busy;
         this.logger.info(`SingleDialer:exec outdial failure ${err.status}`);
+        inviteSpan.setAttributes({'invite.status_code': err.status});
+        inviteSpan.end();
       }
       else {
         this.logger.error(err, 'SingleDialer:exec');
         status.sipStatus = 500;
+        inviteSpan.setAttributes({
+          'invite.status_code': 500,
+          'invite.err': err.message
+        });
+        inviteSpan.end();
       }
       this.emit('callStatusChange', status);
       if (this.ep) this.ep.destroy();
@@ -208,6 +291,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');
@@ -231,8 +315,8 @@ class SingleDialer extends Emitter {
   async _executeApp(confirmHook) {
     try {
       // retrieve set of tasks
-      const tasks = await this.requestor.request(confirmHook, this.callInfo);
-
+      const json = await this.requestor.request('dial:confirm', confirmHook, this.callInfo.toJSON());
+      const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
       // verify it contains only allowed verbs
       const allowedTasks = tasks.filter((task) => {
         return [
@@ -252,7 +336,9 @@ class SingleDialer extends Emitter {
         dlg: this.dlg,
         ep: this.ep,
         callInfo: this.callInfo,
-        tasks
+        accountInfo: this.accountInfo,
+        tasks,
+        rootSpan: this.rootSpan
       });
       await cs.exec();
 
@@ -265,16 +351,68 @@ class SingleDialer extends Emitter {
     }
   }
 
-  _notifyCallStatusChange({callStatus, sipStatus, duration}) {
+  async doAdulting({logger, tasks, application}) {
+    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();
+    }
+
+    this.dlg.callSid = this.callSid;
+    this.dlg.linkedSpanId = this.rootSpan.traceId;
+    const rootSpan = new RootSpan('outbound-call', this.dlg);
+    const newLogger = logger.child({traceId: rootSpan.traceId});
+    const cs = new AdultingCallSession({
+      logger: newLogger,
+      singleDialer: this,
+      application,
+      callInfo: this.callInfo,
+      accountInfo: this.accountInfo,
+      tasks,
+      rootSpan
+    });
+    cs.exec().catch((err) => newLogger.error({err}, 'doAdulting: error executing session'));
+    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, sipReason, duration}) {
     assert((typeof duration === 'number' && callStatus === CallStatus.Completed) ||
       (!duration && callStatus !== CallStatus.Completed),
     'duration MUST be supplied when call completed AND ONLY when call completed');
 
     if (this.callInfo) {
-      this.callInfo.updateCallStatus(callStatus, sipStatus);
+      this.callInfo.updateCallStatus(callStatus, sipStatus, sipReason);
       if (typeof duration === 'number') this.callInfo.duration = duration;
       try {
-        this.requestor.request(this.application.call_status_hook, this.callInfo.toJSON());
+        this.notifier.request('call:status', this.application.call_status_hook, this.callInfo.toJSON());
       } catch (err) {
         this.logger.info(err, `SingleDialer:_notifyCallStatusChange error sending ${callStatus} ${sipStatus}`);
       }
@@ -287,9 +425,14 @@ 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, rootSpan, startSpan
+}) {
+  const myOpts = deepcopy(opts);
+  const sd = new SingleDialer({
+    logger, sbcAddress, target, myOpts, application, callInfo, accountInfo, rootSpan, startSpan
+  });
+  sd.exec(srf, ms, myOpts);
   return sd;
 }
 

lib/utils/requestor.js

@@ -1,19 +1,6 @@
-const bent = require('bent');
-const parseUrl = require('parse-url');
 const assert = require('assert');
-
-const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
-
-function basicAuth(username, password) {
-  if (!username || !password) return {};
-  const creds = `${username}:${password || ''}`;
-  const header = `Basic ${toBase64(creds)}`;
-  return {Authorization: header};
-}
-
-function isRelativeUrl(u) {
-  return typeof u === 'string' && u.startsWith('/');
-}
+const timeSeries = require('@jambonz/time-series');
+let alerter ;
 
 function isAbsoluteUrl(u) {
   return typeof u === 'string' &&
@@ -21,83 +8,42 @@ function isAbsoluteUrl(u) {
 }
 
 class Requestor {
-  constructor(logger, hook) {
+  constructor(logger, account_sid, hook, secret) {
     assert(typeof hook === 'object');
 
     this.logger = logger;
     this.url = hook.url;
     this.method = hook.method || 'POST';
-    this.authHeader = basicAuth(hook.username, hook.password);
-
-    const u = parseUrl(this.url);
-    const myPort = u.port ? `:${u.port}` : '';
-    const baseUrl = this._baseUrl = `${u.protocol}://${u.resource}${myPort}`;
-
-    this.get = bent(baseUrl, 'GET', 'buffer', 200, 201);
-    this.post = bent(baseUrl, 'POST', 'buffer', 200, 201);
 
     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() {
-    return this._baseUrl;
-  }
-
-  /**
-   * Make an HTTP request.
-   * All requests use json bodies.
-   * All requests expect a 200 statusCode on success
-   * @param {object|string} hook - may be a absolute or relative url, or an object
-   * @param {string} [hook.url] - an absolute or relative url
-   * @param {string} [hook.method] - 'GET' or 'POST'
-   * @param {string} [hook.username] - if basic auth is protecting the endpoint
-   * @param {string} [hook.password] - if basic auth is protecting the endpoint
-   * @param {object} [params] - request parameters
-   */
-  async request(hook, params) {
-    params = params || 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 startAt = process.hrtime();
-
-    let buf;
-    try {
-      buf = isRelativeUrl(url) ?
-        await this.post(url, params, this.authHeader) :
-        await bent(method, 'buffer', 200, 201, 202)(url, params, basicAuth(username, password));
-    } catch (err) {
-      this.logger.info({baseUrl: this.baseUrl, url: err.statusCode},
-        `web callback returned unexpected error code ${err.statusCode}`);
-      throw err;
-    }
-    const diff = process.hrtime(startAt);
-    const time = diff[0] * 1e3 + diff[1] * 1e-6;
-    const rtt = time.toFixed(0);
-    if (buf) this.stats.histogram('app.hook.response_time', rtt, ['hook_type:app']);
-
-    if (buf && buf.toString().length > 0) {
-      try {
-        const json = JSON.parse(buf.toString());
-        this.logger.info({response: json}, `Requestor:request ${method} ${url} succeeded in ${rtt}ms`);
-        return json;
-      }
-      catch (err) {
-        //this.logger.debug({err, url, method}, `Requestor:request returned non-JSON content: '${buf.toString()}'`);
-      }
+  get Alerter() {
+    if (!alerter) {
+      alerter = timeSeries(this.logger, {
+        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        commitSize: 50,
+        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+      });
     }
+    return alerter;
   }
 }
 

lib/utils/sbc-pinger.js

@@ -1,31 +1,41 @@
 const assert = require('assert');
-const noopLogger = {info: () => {}, error: () => {}};
-const {LifeCycleEvents} = require('./constants');
+const uuidv4 = require('uuid-random');
+const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./constants');
 const Emitter = require('events');
 const debug = require('debug')('jambonz:feature-server');
+const noopLogger = {info: () => {}, error: () => {}};
 
 module.exports = (logger) => {
   logger = logger || noopLogger;
   let idxSbc = 0;
+  let sbcs = [];
 
-  assert.ok(process.env.JAMBONES_SBCS, 'missing JAMBONES_SBCS env var');
-  const sbcs = process.env.JAMBONES_SBCS
-    .split(',')
-    .map((sbc) => sbc.trim());
-  assert.ok(sbcs.length, 'JAMBONES_SBCS env var is empty or misconfigured');
-  logger.info({sbcs}, 'SBC inventory');
+  if (process.env.JAMBONES_SBCS) {
+    sbcs = process.env.JAMBONES_SBCS
+      .split(',')
+      .map((sbc) => sbc.trim());
+    assert.ok(sbcs.length, 'JAMBONES_SBCS env var is empty or misconfigured');
+    logger.info({sbcs}, 'SBC inventory');
+  }
+  else if (process.env.K8S && process.env.K8S_SBC_SIP_SERVICE_NAME) {
+    sbcs = [`${process.env.K8S_SBC_SIP_SERVICE_NAME}:5060`];
+    logger.info({sbcs}, 'SBC inventory');
+  }
 
   // listen for SNS lifecycle changes
   let lifecycleEmitter = new Emitter();
   let dryUpCalls = false;
-  if (process.env.AWS_SNS_TOPIC_ARM &&
-    process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY && process.env.AWS_REGION) {
+  if (process.env.AWS_SNS_TOPIC_ARM && process.env.AWS_REGION) {
 
     (async function() {
       try {
         lifecycleEmitter = await require('./aws-sns-lifecycle')(logger);
 
         lifecycleEmitter
+          .on('SubscriptionConfirmation', ({publicIp}) => {
+            const {srf} = require('../..');
+            srf.locals.publicIp = publicIp;
+          })
           .on(LifeCycleEvents.ScaleIn, () => {
             logger.info('AWS scale-in notification: begin drying up calls');
             dryUpCalls = true;
@@ -65,9 +75,14 @@ module.exports = (logger) => {
       }
     })();
   }
+  else if (process.env.K8S) {
+    lifecycleEmitter.scaleIn = () => process.exit(0);
+  }
+
 
-  // send OPTIONS pings to SBCs
   async function pingProxies(srf) {
+    if (process.env.NODE_ENV === 'test') return;
+
     for (const sbc of sbcs) {
       try {
         const ms = srf.locals.getFreeswitch();
@@ -87,18 +102,46 @@ 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();
 
-  // OPTIONS ping the SBCs from each feature server every 60 seconds
-  setInterval(() => {
-    const {srf} = require('../..');
-    pingProxies(srf);
-  }, 20000);
+      /* in case redis is restarted, re-insert our key every so often */
+      setInterval(() => {
+        // eslint-disable-next-line max-len
+        addToSet(FS_UUID_SET_NAME, uuid).catch((err) => logger.info({err}, `Error adding ${uuid} to set ${FS_UUID_SET_NAME}`));
+      }, 30000);
+      // eslint-disable-next-line max-len
+      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);
 
-  // initial ping once we are up
-  setTimeout(() => {
-    const {srf} = require('../..');
-    pingProxies(srf);
-  }, 1000);
+    // 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 {
     lifecycleEmitter,

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/siprec-utils.js

@@ -0,0 +1,257 @@
+const xmlParser = require('xml2js').parseString;
+const uuidv4 = require('uuid-random');
+const parseUri = require('drachtio-srf').parseUri;
+const transform = require('sdp-transform');
+const debug = require('debug')('jambonz:feature-server');
+
+const parseCallData = (prefix, obj) => {
+  const ret = {};
+  const group = obj[`${prefix}group`];
+  if (group) {
+    const key = Object.keys(group[0]).find((k) => /:?callData$/.test(k));
+    //const o = _.find(group[0], (value, key) => /:?callData$/.test(key));
+    if (key) {
+      //const callData = o[0];
+      const callData = group[0][key];
+      for (const key of Object.keys(callData)) {
+        if (['fromhdr', 'tohdr', 'callid'].includes(key)) ret[key] = callData[key][0];
+      }
+    }
+  }
+  debug('parseCallData', prefix, obj, ret);
+  return ret;
+};
+
+/**
+ * parse a SIPREC multiparty body
+ * @param  {object} opts - options
+ * @return {Promise}
+ */
+const parseSiprecPayload = (req, logger) => {
+  const opts = {};
+  return new Promise((resolve, reject) => {
+    let sdp, meta ;
+    for (let i = 0; i < req.payload.length; i++) {
+      switch (req.payload[i].type) {
+        case 'application/sdp':
+          sdp = req.payload[i].content ;
+          break ;
+
+        case 'application/rs-metadata+xml':
+        case 'application/rs-metadata':
+          meta = opts.xml = req.payload[i].content ;
+          break ;
+
+        default:
+          break ;
+      }
+    }
+
+
+    if (!meta && sdp) {
+      const arr = /^([^]+)(m=[^]+?)(m=[^]+?)$/.exec(sdp);
+      opts.sdp1 = `${arr[1]}${arr[2]}`;
+      opts.sdp2 = `${arr[1]}${arr[3]}\r\n`;
+      opts.sessionId = uuidv4();
+      logger.info({ payload: req.payload }, 'SIPREC payload with no metadata (e.g. Cisco NBR)');
+      resolve(opts);
+    } else if (!sdp || !meta) {
+      logger.info({ payload: req.payload }, 'invalid SIPREC payload');
+      return reject(new Error('expected multipart SIPREC body'));
+    }
+
+    xmlParser(meta, (err, result) => {
+      if (err) { throw err; }
+
+      opts.recordingData = result ;
+      opts.sessionId = uuidv4() ;
+
+      const arr = /^([^]+)(m=[^]+?)(m=[^]+?)$/.exec(sdp) ;
+      opts.sdp1 = `${arr[1]}${arr[2]}` ;
+      opts.sdp2 = `${arr[1]}${arr[3]}\r\n` ;
+
+      try {
+        if (typeof result === 'object' && Object.keys(result).length === 1) {
+          const key = Object.keys(result)[0] ;
+          const arr = /^(.*:)recording/.exec(key) ;
+          const prefix = !arr ? '' : (arr[1]) ;
+          const obj = opts.recordingData[`${prefix}recording`];
+
+          // 1. collect participant data
+          const participants = {} ;
+          obj[`${prefix}participant`].forEach((p) => {
+            const partDetails = {} ;
+            participants[p.$.participant_id] = partDetails;
+            if ((`${prefix}nameID` in p) && Array.isArray(p[`${prefix}nameID`])) {
+              partDetails.aor = p[`${prefix}nameID`][0].$.aor;
+              if ('name' in p[`${prefix}nameID`][0] && Array.isArray(p[`${prefix}nameID`][0].name)) {
+                const name = p[`${prefix}nameID`][0].name[0];
+                if (typeof name === 'string') partDetails.name = name ;
+                else if (typeof name === 'object') partDetails.name = name._ ;
+              }
+            }
+          });
+
+          // 2. find the associated streams for each participant
+          if (`${prefix}participantstreamassoc` in obj) {
+            obj[`${prefix}participantstreamassoc`].forEach((ps) => {
+              const part = participants[ps.$.participant_id];
+              if (part) {
+                part.send = ps[`${prefix}send`][0];
+                part.recv = ps[`${prefix}recv`][0];
+              }
+            });
+          }
+
+          // 3. Retrieve stream data
+          opts.caller = {} ;
+          opts.callee = {} ;
+          obj[`${prefix}stream`].forEach((s) => {
+            const streamId = s.$.stream_id;
+            let sender;
+            for (const [k, v] of Object.entries(participants)) {
+              if (v.send === streamId) {
+                sender = k;
+                break;
+              }
+            }
+            //const sender = _.find(participants, { 'send': streamId});
+
+            if (!sender) return;
+
+            sender.label = s[`${prefix}label`][0];
+
+            if (-1 !== ['1', 'a_leg', 'inbound'].indexOf(sender.label)) {
+              opts.caller.aor = sender.aor ;
+              if (sender.name) opts.caller.name = sender.name;
+            }
+            else {
+              opts.callee.aor = sender.aor ;
+              if (sender.name) opts.callee.name = sender.name;
+            }
+          });
+
+          // if we dont have a participantstreamassoc then assume the first participant is the caller
+          if (!opts.caller.aor && !opts.callee.aor) {
+            let i = 0;
+            for (const part in participants) {
+              const p = participants[part];
+              if (0 === i && p.aor) {
+                opts.caller.aor = p.aor;
+                opts.caller.name = p.name;
+              }
+              else if (1 === i && p.aor) {
+                opts.callee.aor = p.aor;
+                opts.callee.name = p.name;
+              }
+              i++;
+            }
+          }
+
+          // now for Sonus (at least) we get the original from, to and call-id headers in a <callData/> element
+          // if so, this should take preference
+          const callData = parseCallData(prefix, obj);
+          if (callData) {
+            debug(`callData: ${JSON.stringify(callData)}`);
+            opts.originalCallId = callData.callid;
+
+            // caller
+            let r1 = /^(.*)(<sip.*)$/.exec(callData.fromhdr);
+            if (r1) {
+              const arr = /<(.*)>/.exec(r1[2]);
+              if (arr) {
+                const uri = parseUri(arr[1]);
+                const user = uri.user || 'anonymous';
+                opts.caller.aor = `sip:${user}@${uri.host}`;
+              }
+              const dname = r1[1].trim();
+              const arr2 = /"(.*)"/.exec(dname);
+              if (arr2) opts.caller.name = arr2[1];
+              else opts.caller.name = dname;
+            }
+            // callee
+            r1 = /^(.*)(<sip.*)$/.exec(callData.tohdr);
+            if (r1) {
+              const arr = /<(.*)>/.exec(r1[2]);
+              if (arr) {
+                const uri = parseUri(arr[1]);
+                opts.callee.aor = `sip:${uri.user}@${uri.host}`;
+              }
+              const dname = r1[1].trim();
+              const arr2 = /"(.*)"/.exec(dname);
+              if (arr2) opts.callee.name = arr2[1];
+              else opts.callee.name = dname;
+            }
+            debug(`opts.caller from callData: ${JSON.stringify(opts.caller)}`);
+            debug(`opts.callee from callData: ${JSON.stringify(opts.callee)}`);
+          }
+
+          if (opts.caller.aor && 0 !== opts.caller.aor.indexOf('sip:')) {
+            opts.caller.aor = 'sip:' + opts.caller.aor;
+          }
+          if (opts.callee.aor && 0 !== opts.callee.aor.indexOf('sip:')) {
+            opts.callee.aor = 'sip:' + opts.callee.aor;
+          }
+
+          if (opts.caller.aor) {
+            const uri = parseUri(opts.caller.aor);
+            opts.caller.number = uri.user;
+          }
+          if (opts.callee.aor) {
+            const uri = parseUri(opts.callee.aor);
+            opts.callee.number = uri.user;
+          }
+          opts.recordingSessionId = opts.recordingData[`${prefix}recording`][`${prefix}session`][0].$.session_id;
+        }
+      }
+      catch (err) {
+        reject(err);
+      }
+      debug(opts, 'payload parser results');
+      resolve(opts) ;
+    }) ;
+  }) ;
+};
+
+const createSipRecPayload = (sdp1, sdp2, logger) => {
+  const sdpObj = [];
+  sdpObj.push(transform.parse(sdp1));
+  sdpObj.push(transform.parse(sdp2));
+
+  //const arr1 = /^([^]+)(c=[^]+)t=[^]+(m=[^]+?)(a=[^]+)$/.exec(sdp1) ;
+  //const arr2 = /^([^]+)(c=[^]+)t=[^]+(m=[^]+?)(a=[^]+)$/.exec(sdp2) ;
+
+  debug(`sdp1:      ${sdp1}`);
+  debug(`objSdp[0]: ${JSON.stringify(sdpObj[0])}`);
+  debug(`sdp2:      ${sdp2}`);
+  debug(`objSdp[1]: ${JSON.stringify(sdpObj[1])}`);
+
+  if (!sdpObj[0] || !sdpObj[0].media.length) {
+    throw new Error(`Error parsing sdp1 into component parts: ${sdp1}`);
+  }
+  else if (!sdpObj[1] || !sdpObj[1].media.length)  {
+    throw new Error(`Error parsing sdp2 into component parts: ${sdp2}`);
+  }
+
+  if (!sdpObj[0].media[0].label) sdpObj[0].media[0].label = 1;
+  if (!sdpObj[1].media[0].label) sdpObj[1].media[0].label = 2;
+
+  //const aLabel = sdp1.includes('a=label:') ? '' : 'a=label:1\r\n';
+  //const bLabel = sdp2.includes('a=label:') ? '' : 'a=label:2\r\n';
+
+  sdpObj[0].media = sdpObj[0].media.concat(sdpObj[1].media);
+  const combinedSdp = transform.write(sdpObj[0])
+    .replace(/a=sendonly\r\n/g, '')
+    .replace(/a=direction:both\r\n/g, '');
+
+  debug(`combined ${combinedSdp}`);
+  /*
+  const combinedSdp = `${arr1[1]}t=0 0\r\n${arr1[2]}${arr1[3]}${arr1[4]}${aLabel}${arr2[3]}${arr2[4]}${bLabel}`
+    .replace(/a=sendonly\r\n/g, '')
+    .replace(/a=direction:both\r\n/g, '');
+  */
+
+  return combinedSdp.replace(/sendrecv/g, 'recvonly');
+};
+
+module.exports = { parseSiprecPayload, createSipRecPayload } ;

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;
+

lib/utils/summarize-tasks.js

@@ -1,3 +1,3 @@
 module.exports = function(tasks) {
-  return `[${tasks.map((t) => t.name).join(',')}]`;
+  return `[${tasks.map((t) => t.summary).join(',')}]`;
 };

lib/utils/transcription-utils.js

@@ -0,0 +1,678 @@
+const {
+  TaskName,
+  AzureTranscriptionEvents,
+  GoogleTranscriptionEvents,
+  AwsTranscriptionEvents,
+  NuanceTranscriptionEvents,
+  DeepgramTranscriptionEvents,
+  SonioxTranscriptionEvents,
+  NvidiaTranscriptionEvents,
+  JambonzTranscriptionEvents
+} = require('./constants');
+
+const stickyVars = {
+  google: [
+    'GOOGLE_SPEECH_HINTS',
+    'GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL',
+    'GOOGLE_SPEECH_PROFANITY_FILTER',
+    'GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION',
+    'GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS',
+    'GOOGLE_SPEECH_SINGLE_UTTERANCE',
+    'GOOGLE_SPEECH_SPEAKER_DIARIZATION',
+    'GOOGLE_SPEECH_USE_ENHANCED',
+    'GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES',
+    'GOOGLE_SPEECH_METADATA_INTERACTION_TYPE',
+    'GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE'
+  ],
+  microsoft: [
+    'AZURE_SPEECH_HINTS',
+    'AZURE_SERVICE_ENDPOINT_ID',
+    'AZURE_REQUEST_SNR',
+    'AZURE_PROFANITY_OPTION',
+    'AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES',
+    'AZURE_SERVICE_ENDPOINT',
+    'AZURE_INITIAL_SPEECH_TIMEOUT_MS',
+    'AZURE_USE_OUTPUT_FORMAT_DETAILED',
+  ],
+  deepgram: [
+    'DEEPGRAM_SPEECH_KEYWORDS',
+    'DEEPGRAM_API_KEY',
+    'DEEPGRAM_SPEECH_TIER',
+    'DEEPGRAM_SPEECH_MODEL',
+    'DEEPGRAM_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION',
+    'DEEPGRAM_SPEECH_PROFANITY_FILTER',
+    'DEEPGRAM_SPEECH_REDACT',
+    'DEEPGRAM_SPEECH_DIARIZE',
+    'DEEPGRAM_SPEECH_NER',
+    'DEEPGRAM_SPEECH_ALTERNATIVES',
+    'DEEPGRAM_SPEECH_NUMERALS',
+    'DEEPGRAM_SPEECH_SEARCH',
+    'DEEPGRAM_SPEECH_REPLACE',
+    'DEEPGRAM_SPEECH_ENDPOINTING',
+    'DEEPGRAM_SPEECH_VAD_TURNOFF',
+    'DEEPGRAM_SPEECH_TAG'
+  ],
+  aws: [
+    'AWS_VOCABULARY_NAME',
+    'AWS_VOCABULARY_FILTER_METHOD',
+    'AWS_VOCABULARY_FILTER_NAME'
+  ],
+  nuance: [
+    'NUANCE_ACCESS_TOKEN',
+    'NUANCE_KRYPTON_ENDPOINT',
+    'NUANCE_TOPIC',
+    'NUANCE_UTTERANCE_DETECTION_MODE',
+    'NUANCE_FILTER_PROFANITY',
+    'NUANCE_INCLUDE_TOKENIZATION',
+    'NUANCE_DISCARD_SPEAKER_ADAPTATION',
+    'NUANCE_SUPPRESS_CALL_RECORDING',
+    'NUANCE_MASK_LOAD_FAILURES',
+    'NUANCE_SUPPRESS_INITIAL_CAPITALIZATION',
+    'NUANCE_ALLOW_ZERO_BASE_LM_WEIGHT',
+    'NUANCE_FILTER_WAKEUP_WORD',
+    'NUANCE_NO_INPUT_TIMEOUT_MS',
+    'NUANCE_RECOGNITION_TIMEOUT_MS',
+    'NUANCE_UTTERANCE_END_SILENCE_MS',
+    'NUANCE_MAX_HYPOTHESES',
+    'NUANCE_SPEECH_DOMAIN',
+    'NUANCE_FORMATTING',
+    'NUANCE_RESOURCES'
+  ],
+  ibm: [
+    'IBM_ACCESS_TOKEN',
+    'IBM_SPEECH_REGION',
+    'IBM_SPEECH_INSTANCE_ID',
+    'IBM_SPEECH_MODEL',
+    'IBM_SPEECH_LANGUAGE_CUSTOMIZATION_ID',
+    'IBM_SPEECH_ACOUSTIC_CUSTOMIZATION_ID',
+    'IBM_SPEECH_BASE_MODEL_VERSION',
+    'IBM_SPEECH_WATSON_METADATA',
+    'IBM_SPEECH_WATSON_LEARNING_OPT_OUT'
+  ],
+  nvidia: [
+    'NVIDIA_HINTS'
+  ],
+  soniox: [
+    'SONIOX_PROFANITY_FILTER',
+    'SONIOX_MODEL'
+  ]
+};
+
+const compileSonioxTranscripts = (finalWordChunks, channel, language) => {
+  const words = finalWordChunks.flat();
+  const transcript = words.reduce((acc, word) => {
+    if (word.text === '<end>') return acc;
+    if ([',', '.', '?', '!'].includes(word.text)) return `${acc}${word.text}`;
+    return `${acc} ${word.text}`;
+  }, '').trim();
+  const realWords = words.filter((word) => ![',.!?;'].includes(word.text) && word.text !== '<end>');
+  const confidence = realWords.reduce((acc, word) => acc + word.confidence, 0) / realWords.length;
+  const alternatives = [{transcript, confidence}];
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: true,
+    alternatives,
+    vendor: {
+      name: 'soniox',
+      evt: words
+    }
+  };
+};
+
+const normalizeSoniox = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+
+  /* an <end> token indicates the end of an utterance */
+  const endTokenPos = evt.words.map((w) => w.text).indexOf('<end>');
+  const endpointReached = endTokenPos !== -1;
+  const words = endpointReached ? evt.words.slice(0, endTokenPos) : evt.words;
+
+  /* note: we can safely ignore words after the <end> token as they will be returned again */
+  const finalWords = words.filter((word) => word.is_final);
+  const nonFinalWords = words.filter((word) => !word.is_final);
+
+  const is_final = endpointReached && finalWords.length > 0;
+  const transcript = words.reduce((acc, word) => {
+    if ([',', '.', '?', '!'].includes(word.text)) return `${acc}${word.text}`;
+    else return `${acc} ${word.text}`;
+  }, '').trim();
+  const realWords = words.filter((word) => ![',.!?;'].includes(word.text) && word.text !== '<end>');
+  const confidence = realWords.reduce((acc, word) => acc + word.confidence, 0) / realWords.length;
+  const alternatives = [{transcript, confidence}];
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final,
+    alternatives,
+    vendor: {
+      name: 'soniox',
+      endpointReached,
+      evt: copy,
+      finalWords,
+      nonFinalWords
+    }
+  };
+};
+
+const normalizeDeepgram = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  const alternatives = (evt.channel?.alternatives || [])
+    .map((alt) => ({
+      confidence: alt.confidence,
+      transcript: alt.transcript,
+    }));
+
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.is_final,
+    alternatives: [alternatives[0]],
+    vendor: {
+      name: 'deepgram',
+      evt: copy
+    }
+  };
+};
+
+const normalizeNvidia = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  const alternatives = (evt.alternatives || [])
+    .map((alt) => ({
+      confidence: alt.confidence,
+      transcript: alt.transcript,
+    }));
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.is_final,
+    alternatives,
+    vendor: {
+      name: 'nvidia',
+      evt: copy
+    }
+  };
+};
+
+const normalizeIbm = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  //const idx = evt.result_index;
+  const result = evt.results[0];
+
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: result.final,
+    alternatives: result.alternatives,
+    vendor: {
+      name: 'ibm',
+      evt: copy
+    }
+  };
+};
+
+const normalizeGoogle = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.is_final,
+    alternatives: [evt.alternatives[0]],
+    vendor: {
+      name: 'google',
+      evt: copy
+    }
+  };
+};
+
+const normalizeCustom = (evt, channel, language) => {
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.is_final,
+    alternatives: [evt.alternatives[0]]
+  };
+};
+
+const normalizeNuance = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.is_final,
+    alternatives: [evt.alternatives[0]],
+    vendor: {
+      name: 'nuance',
+      evt: copy
+    }
+  };
+};
+
+const normalizeMicrosoft = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  const nbest = evt.NBest;
+  const language_code = evt.PrimaryLanguage?.Language || language;
+  const alternatives = nbest ? nbest.map((n) => {
+    return {
+      confidence: n.Confidence,
+      transcript: n.Display
+    };
+  }) :
+    [
+      {
+        transcript: evt.DisplayText || evt.Text
+      }
+    ];
+
+  return {
+    language_code,
+    channel_tag: channel,
+    is_final: evt.RecognitionStatus === 'Success',
+    alternatives: [alternatives[0]],
+    vendor: {
+      name: 'microsoft',
+      evt: copy
+    }
+  };
+};
+
+const normalizeAws = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt[0].is_final,
+    alternatives: evt[0].alternatives,
+    vendor: {
+      name: 'aws',
+      evt: copy
+    }
+  };
+};
+
+
+module.exports = (logger) => {
+  const normalizeTranscription = (evt, vendor, channel, language) => {
+
+    //logger.debug({ evt, vendor, channel, language }, 'normalizeTranscription');
+    switch (vendor) {
+      case 'deepgram':
+        return normalizeDeepgram(evt, channel, language);
+      case 'microsoft':
+        return normalizeMicrosoft(evt, channel, language);
+      case 'google':
+        return normalizeGoogle(evt, channel, language);
+      case 'aws':
+        return normalizeAws(evt, channel, language);
+      case 'nuance':
+        return normalizeNuance(evt, channel, language);
+      case 'ibm':
+        return normalizeIbm(evt, channel, language);
+      case 'nvidia':
+        return normalizeNvidia(evt, channel, language);
+      case 'soniox':
+        return normalizeSoniox(evt, channel, language);
+      default:
+        if (vendor.startsWith('custom:')) {
+          return normalizeCustom(evt, channel, language);
+        }
+        logger.error(`Unknown vendor ${vendor}`);
+        return evt;
+    }
+  };
+
+  const setChannelVarsForStt = (task, sttCredentials, rOpts = {}) => {
+    let opts = {};
+    const {enable, voiceMs = 0, mode = -1} = rOpts.vad || {};
+    const vad = {enable, voiceMs, mode};
+    const vendor = rOpts.vendor;
+
+    /* voice activity detection works across vendors */
+    opts = {
+      ...opts,
+      ...(vad.enable && {START_RECOGNIZING_ON_VAD: 1}),
+      ...(vad.enable && vad.voiceMs && {RECOGNIZER_VAD_VOICE_MS: vad.voiceMs}),
+      ...(vad.enable && typeof vad.mode === 'number' && {RECOGNIZER_VAD_MODE: vad.mode}),
+    };
+
+    if ('google' === vendor) {
+      const model = task.name === TaskName.Gather ? 'command_and_search' : 'latest_long';
+      opts = {
+        ...opts,
+        ...(sttCredentials && {GOOGLE_APPLICATION_CREDENTIALS: JSON.stringify(sttCredentials.credentials)}),
+        ...(rOpts.separateRecognitionPerChannel && {GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL: 1}),
+        ...(rOpts.separateRecognitionPerChanne === false && {GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL: 0}),
+        ...(rOpts.profanityFilter && {GOOGLE_SPEECH_PROFANITY_FILTER: 1}),
+        ...(rOpts.punctuation && {GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 1}),
+        ...(rOpts.words && {GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS: 1}),
+        ...(rOpts.singleUtterance && {GOOGLE_SPEECH_SINGLE_UTTERANCE: 1}),
+        ...(rOpts.diarization && {GOOGLE_SPEECH_SPEAKER_DIARIZATION: 1}),
+        ...(rOpts.diarization && rOpts.diarizationMinSpeakers > 0 &&
+          {GOOGLE_SPEECH_SPEAKER_DIARIZATION_MIN_SPEAKER_COUNT: rOpts.diarizationMinSpeakers}),
+        ...(rOpts.diarization && rOpts.diarizationMaxSpeakers > 0 &&
+          {GOOGLE_SPEECH_SPEAKER_DIARIZATION_MAX_SPEAKER_COUNT: rOpts.diarizationMaxSpeakers}),
+        ...(rOpts.enhancedModel !== false && {GOOGLE_SPEECH_USE_ENHANCED: 1}),
+        ...(rOpts.profanityFilter === false && {GOOGLE_SPEECH_PROFANITY_FILTER: 0}),
+        ...(rOpts.punctuation === false && {GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 0}),
+        ...(rOpts.words  == false && {GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS: 0}),
+        ...(rOpts.diarization === false && {GOOGLE_SPEECH_SPEAKER_DIARIZATION: 0}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {GOOGLE_SPEECH_HINTS: rOpts.hints.join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {GOOGLE_SPEECH_HINTS: JSON.stringify(rOpts.hints)}),
+        ...(typeof rOpts.hintsBoost === 'number' && {GOOGLE_SPEECH_HINTS_BOOST: rOpts.hintsBoost}),
+        ...(rOpts.altLanguages.length > 0 &&
+          {GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES: [...new Set(rOpts.altLanguages)].join(',')}),
+        ...(rOpts.interactionType &&
+          {GOOGLE_SPEECH_METADATA_INTERACTION_TYPE: rOpts.interactionType}),
+        ...{GOOGLE_SPEECH_MODEL: rOpts.model || model},
+        ...(rOpts.naicsCode > 0 && {GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE: rOpts.naicsCode}),
+        GOOGLE_SPEECH_METADATA_RECORDING_DEVICE_TYPE: 'phone_line',
+      };
+    }
+    else if (['aws', 'polly'].includes(vendor)) {
+      opts = {
+        ...opts,
+        ...(rOpts.vocabularyName && {AWS_VOCABULARY_NAME: rOpts.vocabularyName}),
+        ...(rOpts.vocabularyFilterName && {AWS_VOCABULARY_FILTER_NAME: rOpts.vocabularyFilterName}),
+        ...(rOpts.filterMethod && {AWS_VOCABULARY_FILTER_METHOD: rOpts.filterMethod}),
+        ...(sttCredentials && {
+          AWS_ACCESS_KEY_ID: sttCredentials.accessKeyId,
+          AWS_SECRET_ACCESS_KEY: sttCredentials.secretAccessKey,
+          AWS_REGION: sttCredentials.region
+        }),
+      };
+    }
+    else if ('microsoft' === vendor) {
+      opts = {
+        ...opts,
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {AZURE_SPEECH_HINTS: rOpts.hints.map((h) => h.trim()).join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {AZURE_SPEECH_HINTS: rOpts.hints.map((h) => h.phrase).join(',')}),
+        ...(rOpts.altLanguages && rOpts.altLanguages.length > 0 &&
+          {AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES: [...new Set(rOpts.altLanguages)].join(',')}),
+        ...(rOpts.requestSnr && {AZURE_REQUEST_SNR: 1}),
+        ...(rOpts.profanityOption && {AZURE_PROFANITY_OPTION: rOpts.profanityOption}),
+        ...(rOpts.azureServiceEndpoint && {AZURE_SERVICE_ENDPOINT: rOpts.azureServiceEndpoint}),
+        ...(rOpts.initialSpeechTimeoutMs > 0 &&
+          {AZURE_INITIAL_SPEECH_TIMEOUT_MS: rOpts.initialSpeechTimeoutMs}),
+        ...(rOpts.requestSnr && {AZURE_REQUEST_SNR: 1}),
+        ...(rOpts.audioLogging && {AZURE_AUDIO_LOGGING: 1}),
+        ...{AZURE_USE_OUTPUT_FORMAT_DETAILED: 1},
+        ...(sttCredentials && {
+          AZURE_SUBSCRIPTION_KEY: sttCredentials.api_key,
+          AZURE_REGION: sttCredentials.region,
+        }),
+        ...(sttCredentials.use_custom_stt && sttCredentials.custom_stt_endpoint &&
+          {AZURE_SERVICE_ENDPOINT_ID: sttCredentials.custom_stt_endpoint})
+      };
+    }
+    else if ('nuance' === vendor) {
+      /**
+       * Note: all nuance options are in recognizer.nuanceOptions, should migrate
+       * other vendor settings to similar nested structure
+       */
+      const {nuanceOptions = {}} = rOpts;
+      opts = {
+        ...opts,
+        ...(sttCredentials.access_token) && {NUANCE_ACCESS_TOKEN: sttCredentials.access_token},
+        ...(sttCredentials.nuance_stt_uri) && {NUANCE_KRYPTON_ENDPOINT: sttCredentials.nuance_stt_uri},
+        ...(nuanceOptions.topic) && {NUANCE_TOPIC: nuanceOptions.topic},
+        ...(nuanceOptions.utteranceDetectionMode) &&
+          {NUANCE_UTTERANCE_DETECTION_MODE: nuanceOptions.utteranceDetectionMode},
+        ...(nuanceOptions.punctuation || rOpts.punctuation) && {NUANCE_PUNCTUATION: nuanceOptions.punctuation},
+        ...(nuanceOptions.profanityFilter) &&
+          {NUANCE_FILTER_PROFANITY: nuanceOptions.profanityFilter},
+        ...(nuanceOptions.includeTokenization) &&
+          {NUANCE_INCLUDE_TOKENIZATION: nuanceOptions.includeTokenization},
+        ...(nuanceOptions.discardSpeakerAdaptation) &&
+          {NUANCE_DISCARD_SPEAKER_ADAPTATION: nuanceOptions.discardSpeakerAdaptation},
+        ...(nuanceOptions.suppressCallRecording) &&
+          {NUANCE_SUPPRESS_CALL_RECORDING: nuanceOptions.suppressCallRecording},
+        ...(nuanceOptions.maskLoadFailures) &&
+          {NUANCE_MASK_LOAD_FAILURES: nuanceOptions.maskLoadFailures},
+        ...(nuanceOptions.suppressInitialCapitalization) &&
+          {NUANCE_SUPPRESS_INITIAL_CAPITALIZATION: nuanceOptions.suppressInitialCapitalization},
+        ...(nuanceOptions.allowZeroBaseLmWeight)
+          && {NUANCE_ALLOW_ZERO_BASE_LM_WEIGHT: nuanceOptions.allowZeroBaseLmWeight},
+        ...(nuanceOptions.filterWakeupWord) &&
+          {NUANCE_FILTER_WAKEUP_WORD: nuanceOptions.filterWakeupWord},
+        ...(nuanceOptions.resultType) &&
+          {NUANCE_RESULT_TYPE: nuanceOptions.resultType || rOpts.interim ? 'partial' : 'final'},
+        ...(nuanceOptions.noInputTimeoutMs) &&
+          {NUANCE_NO_INPUT_TIMEOUT_MS: nuanceOptions.noInputTimeoutMs},
+        ...(nuanceOptions.recognitionTimeoutMs) &&
+          {NUANCE_RECOGNITION_TIMEOUT_MS: nuanceOptions.recognitionTimeoutMs},
+        ...(nuanceOptions.utteranceEndSilenceMs) &&
+          {NUANCE_UTTERANCE_END_SILENCE_MS: nuanceOptions.utteranceEndSilenceMs},
+        ...(nuanceOptions.maxHypotheses) &&
+          {NUANCE_MAX_HYPOTHESES: nuanceOptions.maxHypotheses},
+        ...(nuanceOptions.speechDomain) &&
+          {NUANCE_SPEECH_DOMAIN: nuanceOptions.speechDomain},
+        ...(nuanceOptions.formatting) &&
+          {NUANCE_FORMATTING: nuanceOptions.formatting},
+        ...(nuanceOptions.resources) &&
+          {NUANCE_RESOURCES: JSON.stringify(nuanceOptions.resources)},
+      };
+    }
+    else if ('deepgram' === vendor) {
+      const {deepgramOptions = {}} = rOpts;
+      opts = {
+        ...opts,
+        ...(sttCredentials.api_key) &&
+          {DEEPGRAM_API_KEY: sttCredentials.api_key},
+        ...(deepgramOptions.tier) &&
+          {DEEPGRAM_SPEECH_TIER: deepgramOptions.tier},
+        ...(deepgramOptions.model) &&
+          {DEEPGRAM_SPEECH_MODEL: deepgramOptions.model},
+        ...(deepgramOptions.punctuate) &&
+          {DEEPGRAM_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 1},
+        ...(deepgramOptions.profanityFilter) &&
+          {DEEPGRAM_SPEECH_PROFANITY_FILTER: 1},
+        ...(deepgramOptions.redact) &&
+          {DEEPGRAM_SPEECH_REDACT: 1},
+        ...(deepgramOptions.diarize) &&
+          {DEEPGRAM_SPEECH_DIARIZE: 1},
+        ...(deepgramOptions.diarizeVersion) &&
+          {DEEPGRAM_SPEECH_DIARIZE_VERSION: deepgramOptions.diarizeVersion},
+        ...(deepgramOptions.ner) &&
+          {DEEPGRAM_SPEECH_NER: 1},
+        ...(deepgramOptions.alternatives) &&
+          {DEEPGRAM_SPEECH_ALTERNATIVES: deepgramOptions.alternatives},
+        ...(deepgramOptions.numerals) &&
+          {DEEPGRAM_SPEECH_NUMERALS: deepgramOptions.numerals},
+        ...(deepgramOptions.search) &&
+          {DEEPGRAM_SPEECH_SEARCH: deepgramOptions.search.join(',')},
+        ...(deepgramOptions.replace) &&
+          {DEEPGRAM_SPEECH_REPLACE: deepgramOptions.replace.join(',')},
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {DEEPGRAM_SPEECH_KEYWORDS: rOpts.hints.map((h) => h.trim()).join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {DEEPGRAM_SPEECH_KEYWORDS: rOpts.hints.map((h) => h.phrase).join(',')}),
+        ...(deepgramOptions.keywords) &&
+          {DEEPGRAM_SPEECH_KEYWORDS: deepgramOptions.keywords.join(',')},
+        ...('endpointing' in deepgramOptions) &&
+          {DEEPGRAM_SPEECH_ENDPOINTING: deepgramOptions.endpointing},
+        ...(deepgramOptions.vadTurnoff) &&
+          {DEEPGRAM_SPEECH_VAD_TURNOFF: deepgramOptions.vadTurnoff},
+        ...(deepgramOptions.tag) &&
+          {DEEPGRAM_SPEECH_TAG: deepgramOptions.tag}
+      };
+    }
+    else if ('soniox' === vendor) {
+      const {sonioxOptions = {}} = rOpts;
+      const {storage = {}} = sonioxOptions;
+      opts = {
+        ...opts,
+        ...(sttCredentials.api_key) &&
+          {SONIOX_API_KEY: sttCredentials.api_key},
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {SONIOX_HINTS: rOpts.hints.join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {SONIOX_HINTS: JSON.stringify(rOpts.hints)}),
+        ...(typeof rOpts.hintsBoost === 'number' &&
+          {SONIOX_HINTS_BOOST: rOpts.hintsBoost}),
+        ...(sonioxOptions.model) &&
+          {SONIOX_MODEL: sonioxOptions.model},
+        ...((sonioxOptions.profanityFilter || rOpts.profanityFilter) && {SONIOX_PROFANITY_FILTER: 1}),
+        ...(storage?.id && {SONIOX_STORAGE_ID: storage.id}),
+        ...(storage?.id && storage?.title && {SONIOX_STORAGE_TITLE: storage.title}),
+        ...(storage?.id && storage?.disableStoreAudio && {SONIOX_STORAGE_DISABLE_AUDIO: 1}),
+        ...(storage?.id && storage?.disableStoreTranscript && {SONIOX_STORAGE_DISABLE_TRANSCRIPT: 1}),
+        ...(storage?.id && storage?.disableSearch && {SONIOX_STORAGE_DISABLE_SEARCH: 1})
+      };
+    }
+    else if ('ibm' === vendor) {
+      const {ibmOptions = {}} = rOpts;
+      opts = {
+        ...opts,
+        ...(sttCredentials.access_token) &&
+          {IBM_ACCESS_TOKEN: sttCredentials.access_token},
+        ...(sttCredentials.stt_region) &&
+          {IBM_SPEECH_REGION: sttCredentials.stt_region},
+        ...(sttCredentials.instance_id) &&
+          {IBM_SPEECH_INSTANCE_ID: sttCredentials.instance_id},
+        ...(ibmOptions.model) &&
+          {IBM_SPEECH_MODEL: ibmOptions.model},
+        ...(ibmOptions.language_customization_id) &&
+          {IBM_SPEECH_LANGUAGE_CUSTOMIZATION_ID: ibmOptions.language_customization_id},
+        ...(ibmOptions.acoustic_customization_id) &&
+          {IBM_SPEECH_ACOUSTIC_CUSTOMIZATION_ID: ibmOptions.acoustic_customization_id},
+        ...(ibmOptions.baseModelVersion) &&
+          {IBM_SPEECH_BASE_MODEL_VERSION: ibmOptions.baseModelVersion},
+        ...(ibmOptions.watsonMetadata) &&
+          {IBM_SPEECH_WATSON_METADATA: ibmOptions.watsonMetadata},
+        ...(ibmOptions.watsonLearningOptOut) &&
+          {IBM_SPEECH_WATSON_LEARNING_OPT_OUT: ibmOptions.watsonLearningOptOut}
+      };
+    }
+    else if ('nvidia' === vendor) {
+      const {nvidiaOptions = {}} = rOpts;
+      opts = {
+        ...opts,
+        ...((nvidiaOptions.profanityFilter || rOpts.profanityFilter) && {NVIDIA_PROFANITY_FILTER: 1}),
+        ...(!(nvidiaOptions.profanityFilter || rOpts.profanityFilter) && {NVIDIA_PROFANITY_FILTER: 0}),
+        ...((nvidiaOptions.punctuation || rOpts.punctuation) && {NVIDIA_PUNCTUATION: 1}),
+        ...(!(nvidiaOptions.punctuation || rOpts.punctuation) && {NVIDIA_PUNCTUATION: 0}),
+        ...((rOpts.words || nvidiaOptions.wordTimeOffsets) && {NVIDIA_WORD_TIME_OFFSETS: 1}),
+        ...(!(rOpts.words || nvidiaOptions.wordTimeOffsets) && {NVIDIA_WORD_TIME_OFFSETS: 0}),
+        ...(nvidiaOptions.maxAlternatives && {NVIDIA_MAX_ALTERNATIVES: nvidiaOptions.maxAlternatives}),
+        ...(!nvidiaOptions.maxAlternatives && {NVIDIA_MAX_ALTERNATIVES: 1}),
+        ...(rOpts.model && {NVIDIA_MODEL: rOpts.model}),
+        ...(nvidiaOptions.rivaUri && {NVIDIA_RIVA_URI: nvidiaOptions.rivaUri}),
+        ...(nvidiaOptions.verbatimTranscripts && {NVIDIA_VERBATIM_TRANSCRIPTS: 1}),
+        ...(rOpts.diarization && {NVIDIA_SPEAKER_DIARIZATION: 1}),
+        ...(rOpts.diarization && rOpts.diarizationMaxSpeakers > 0 &&
+          {NVIDIA_DIARIZATION_SPEAKER_COUNT: rOpts.diarizationMaxSpeakers}),
+        ...(rOpts.separateRecognitionPerChannel && {NVIDIA_SEPARATE_RECOGNITION_PER_CHANNEL: 1}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {NVIDIA_HINTS: rOpts.hints.join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {NVIDIA_HINTS: JSON.stringify(rOpts.hints)}),
+        ...(typeof rOpts.hintsBoost === 'number' &&
+          {NVIDIA_HINTS_BOOST: rOpts.hintsBoost}),
+        ...(nvidiaOptions.customConfiguration &&
+          {NVIDIA_CUSTOM_CONFIGURATION: JSON.stringify(nvidiaOptions.customConfiguration)}),
+      };
+    }
+    else if (vendor.startsWith('custom:')) {
+      let {options = {}} = rOpts;
+      const {auth_token, custom_stt_url} = sttCredentials;
+      options = {
+        ...options,
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+        {hints: rOpts.hints}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+        {hints: JSON.stringify(rOpts.hints)}),
+        ...(typeof rOpts.hintsBoost === 'number' && {hintsBoost: rOpts.hintsBoost})
+      };
+
+      opts = {
+        ...opts,
+        JAMBONZ_STT_API_KEY: auth_token,
+        JAMBONZ_STT_URL: custom_stt_url,
+        ...(Object.keys(options).length > 0 && {JAMBONZ_STT_OPTIONS: JSON.stringify(options)}),
+      };
+    }
+
+    (stickyVars[vendor] || []).forEach((key) => {
+      if (!opts[key]) opts[key] = '';
+    });
+    return opts;
+  };
+
+  const removeSpeechListeners = (ep) => {
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.EndOfUtterance);
+    ep.removeCustomEventListener(GoogleTranscriptionEvents.VadDetected);
+
+    ep.removeCustomEventListener(AwsTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(AwsTranscriptionEvents.VadDetected);
+
+    ep.removeCustomEventListener(AzureTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected);
+    ep.removeCustomEventListener(AzureTranscriptionEvents.VadDetected);
+
+    ep.removeCustomEventListener(NuanceTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(NuanceTranscriptionEvents.TranscriptionComplete);
+    ep.removeCustomEventListener(NuanceTranscriptionEvents.StartOfSpeech);
+    ep.removeCustomEventListener(NuanceTranscriptionEvents.VadDetected);
+
+    ep.removeCustomEventListener(DeepgramTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(DeepgramTranscriptionEvents.Connect);
+    ep.removeCustomEventListener(DeepgramTranscriptionEvents.ConnectFailure);
+
+    ep.removeCustomEventListener(SonioxTranscriptionEvents.Transcription);
+
+    ep.removeCustomEventListener(NvidiaTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(NvidiaTranscriptionEvents.TranscriptionComplete);
+    ep.removeCustomEventListener(NvidiaTranscriptionEvents.StartOfSpeech);
+    ep.removeCustomEventListener(NvidiaTranscriptionEvents.VadDetected);
+
+    ep.removeCustomEventListener(JambonzTranscriptionEvents.Transcription);
+    ep.removeCustomEventListener(JambonzTranscriptionEvents.Connect);
+    ep.removeCustomEventListener(JambonzTranscriptionEvents.ConnectFailure);
+
+    ep.removeCustomEventListener(JambonzTranscriptionEvents.Error);
+  };
+
+  const setSpeechCredentialsAtRuntime = (recognizer) => {
+    if (!recognizer) return;
+    if (recognizer.vendor === 'nuance') {
+      const {clientId, secret, kryptonEndpoint} = recognizer.nuanceOptions || {};
+      if (clientId && secret) return {client_id: clientId, secret};
+      if (kryptonEndpoint) return {nuance_stt_uri: kryptonEndpoint};
+    }
+    else if (recognizer.vendor === 'nvidia') {
+      const {rivaUri} = recognizer.nvidiaOptions || {};
+      if (rivaUri) return {riva_uri: rivaUri};
+    }
+    else if (recognizer.vendor === 'deepgram') {
+      const {apiKey} = recognizer.deepgramOptions || {};
+      if (apiKey) return {api_key: apiKey};
+    }
+    else if (recognizer.vendor === 'soniox') {
+      const {apiKey} = recognizer.sonioxOptions || {};
+      if (apiKey) return {api_key: apiKey};
+    }
+    else if (recognizer.vendor === 'ibm') {
+      const {ttsApiKey, ttsRegion, sttApiKey, sttRegion, instanceId} = recognizer.ibmOptions || {};
+      if (ttsApiKey || sttApiKey) return {
+        tts_api_key: ttsApiKey,
+        tts_region: ttsRegion,
+        stt_api_key: sttApiKey,
+        stt_region: sttRegion,
+        instance_id: instanceId
+      };
+    }
+  };
+
+  return {
+    normalizeTranscription,
+    setChannelVarsForStt,
+    removeSpeechListeners,
+    setSpeechCredentialsAtRuntime,
+    compileSonioxTranscripts
+  };
+};

lib/utils/ws-requestor.js

@@ -0,0 +1,354 @@
+const assert = require('assert');
+const BaseRequestor = require('./base-requestor');
+const short = require('short-uuid');
+const {HookMsgTypes} = require('./constants.json');
+const Websocket = require('ws');
+const snakeCaseKeys = require('./snakecase-keys');
+const MAX_RECONNECTS = 5;
+const RESPONSE_TIMEOUT_MS = process.env.JAMBONES_WS_API_MSG_RESPONSE_TIMEOUT || 5000;
+
+class WsRequestor extends BaseRequestor {
+  constructor(logger, account_sid, hook, secret) {
+    super(logger, account_sid, hook, secret);
+    this.connections = 0;
+    this.messagesInFlight = new Map();
+    this.maliciousClient = false;
+    this.closedGracefully = false;
+    this.backoffMs = 500;
+    this.connectInProgress = false;
+    this.queuedMsg = [];
+    this.id = short.generate();
+
+    assert(this._isAbsoluteUrl(this.url));
+
+    this.on('socket-closed', this._onSocketClosed.bind(this));
+  }
+
+  /**
+   * Send a JSON payload over the websocket.  If this is the first request,
+   * open the websocket.
+   * All requests expect an ack message in response
+   * @param {object|string} hook - may be a absolute or relative url, or an object
+   * @param {string} [hook.url] - an absolute or relative url
+   * @param {string} [hook.method] - 'GET' or 'POST'
+   * @param {string} [hook.username] - if basic auth is protecting the endpoint
+   * @param {string} [hook.password] - if basic auth is protecting the endpoint
+   * @param {object} [params] - request parameters
+   */
+  async request(type, hook, params, httpHeaders = {}) {
+    assert(HookMsgTypes.includes(type));
+    const url = hook.url || hook;
+
+    if (this.maliciousClient) {
+      this.logger.info({url: this.url}, 'WsRequestor:request - discarding msg to malicious client');
+      return;
+    }
+    if (this.closedGracefully) {
+      this.logger.debug(`WsRequestor:request - discarding ${type} because socket was closed gracefully`);
+      return;
+    }
+
+    if (type === 'session:new') this.call_sid = params.callSid;
+
+    /* if we have an absolute url, and it is http then do a standard webhook */
+    if (this._isAbsoluteUrl(url) && url.startsWith('http')) {
+      const HttpRequestor = require('./http-requestor');
+      this.logger.debug({hook}, 'WsRequestor: sending a webhook (HTTP)');
+      const h = typeof hook === 'object' ? hook : {url: hook};
+      const requestor = new HttpRequestor(this.logger, this.account_sid, h, this.secret);
+      if (type === 'session:redirect') {
+        this.close();
+        this.emit('handover', requestor);
+      }
+      return requestor.request(type, hook, params, httpHeaders);
+    }
+
+    /* connect if necessary */
+    if (!this.ws) {
+      if (this.connectInProgress) {
+        this.logger.debug(
+          `WsRequestor:request(${this.id}) - queueing ${type} message since we are connecting`);
+        this.queuedMsg.push({type, hook, params, httpHeaders});
+        return;
+      }
+      this.connectInProgress = true;
+      this.logger.debug(`WsRequestor:request(${this.id}) - connecting since we do not have a connection`);
+      if (this.connections >= MAX_RECONNECTS) {
+        return Promise.reject(`max attempts connecting to ${this.url}`);
+      }
+      try {
+        const startAt = process.hrtime();
+        await this._connect();
+        const rtt = this._roundTrip(startAt);
+        this.stats.histogram('app.hook.connect_time', rtt, ['hook_type:app']);
+      } catch (err) {
+        this.logger.info({url, err}, 'WsRequestor:request - failed connecting');
+        this.connectInProgress = false;
+        return Promise.reject(err);
+      }
+    }
+    assert(this.ws);
+
+    /* prepare and send message */
+    let payload = params ? snakeCaseKeys(params, ['customerData', 'sip']) : null;
+    if (type === 'session:new') this._sessionData = payload;
+    if (type === 'session:reconnect') payload = this._sessionData;
+    assert.ok(url, 'WsRequestor:request url was not provided');
+
+    const msgid = short.generate();
+    // save initial msgid in case we need to reconnect during initial session:new
+    if (type === 'session:new') this._initMsgId = msgid;
+
+    const b3 = httpHeaders?.b3 ? {b3: httpHeaders.b3} : {};
+    const obj = {
+      type,
+      msgid,
+      call_sid: this.call_sid,
+      hook: type === 'verb:hook' ? url : undefined,
+      data: {...payload},
+      ...b3
+    };
+
+    const sendQueuedMsgs = () => {
+      if (this.queuedMsg.length > 0) {
+        for (const {type, hook, params, httpHeaders} of this.queuedMsg) {
+          this.logger.debug(`WsRequestor:request - preparing queued ${type} for sending`);
+          setImmediate(this.request.bind(this, type, hook, params, httpHeaders));
+        }
+        this.queuedMsg.length = 0;
+      }
+    };
+
+    //this.logger.debug({obj}, `websocket: sending (${url})`);
+
+    /* special case: reconnecting before we received ack to session:new */
+    let reconnectingWithoutAck = false;
+    if (type === 'session:reconnect' && this._initMsgId) {
+      reconnectingWithoutAck = true;
+      const obj = this.messagesInFlight.get(this._initMsgId);
+      this.messagesInFlight.delete(this._initMsgId);
+      this.messagesInFlight.set(msgid, obj);
+      this._initMsgId = msgid;
+    }
+
+    /* simple notifications */
+    if (['call:status', 'verb:status', 'jambonz:error'].includes(type) || reconnectingWithoutAck) {
+      this.ws.send(JSON.stringify(obj), () => {
+        this.logger.debug({obj}, `WsRequestor:request websocket: sent (${url})`);
+        sendQueuedMsgs();
+      });
+      return;
+    }
+
+    /* messages that require an ack */
+    return new Promise((resolve, reject) => {
+      /* give the far end a reasonable amount of time to ack our message */
+      const timer = setTimeout(() => {
+        const {failure} = this.messagesInFlight.get(msgid) || {};
+        failure && failure(`timeout from far end for msgid ${msgid}`);
+        this.messagesInFlight.delete(msgid);
+      }, RESPONSE_TIMEOUT_MS);
+
+      /* save the message info for reply */
+      const startAt = process.hrtime();
+      this.messagesInFlight.set(msgid, {
+        timer,
+        success: (response) => {
+          clearTimeout(timer);
+          const rtt = this._roundTrip(startAt);
+          this.logger.debug({response}, `WsRequestor:request ${url} succeeded in ${rtt}ms`);
+          this.stats.histogram('app.hook.ws_response_time', rtt, ['hook_type:app']);
+          resolve(response);
+        },
+        failure: (err) => {
+          clearTimeout(timer);
+          reject(err);
+        }
+      });
+
+      /* send the message */
+      this.ws.send(JSON.stringify(obj), () => {
+        this.logger.debug({obj}, `WsRequestor:request websocket: sent (${url})`);
+        sendQueuedMsgs();
+      });
+    });
+  }
+
+  close() {
+    this.closedGracefully = true;
+    this.logger.debug('WsRequestor:close closing socket');
+    try {
+      if (this.ws) {
+        this.ws.close(1000);
+        this.ws.removeAllListeners();
+        this.ws = null;
+      }
+      this._clearPendingMessages();
+    } catch (err) {
+      this.logger.info({err}, 'WsRequestor: Error closing socket');
+    }
+  }
+
+  _connect() {
+    assert(!this.ws);
+    return new Promise((resolve, reject) => {
+      const handshakeTimeout = process.env.JAMBONES_WS_HANDSHAKE_TIMEOUT_MS ?
+        parseInt(process.env.JAMBONES_WS_HANDSHAKE_TIMEOUT_MS) :
+        1500;
+      let opts = {
+        followRedirects: true,
+        maxRedirects: 2,
+        handshakeTimeout,
+        maxPayload: process.env.JAMBONES_WS_MAX_PAYLOAD ? parseInt(process.env.JAMBONES_WS_MAX_PAYLOAD) : 24 * 1024,
+      };
+      if (this.username && this.password) opts = {...opts, auth: `${this.username}:${this.password}`};
+
+      this
+        .once('ready', (ws) => {
+          this.removeAllListeners('not-ready');
+          if (this.connections > 1) this.request('session:reconnect', this.url);
+          resolve();
+        })
+        .once('not-ready', (err) => {
+          this.removeAllListeners('ready');
+          reject(err);
+        });
+      const ws = new Websocket(this.url, ['ws.jambonz.org'], opts);
+      this._setHandlers(ws);
+    });
+  }
+
+  _setHandlers(ws) {
+    ws
+      .once('open', this._onOpen.bind(this, ws))
+      .once('close', this._onClose.bind(this))
+      .on('message', this._onMessage.bind(this))
+      .once('unexpected-response', this._onUnexpectedResponse.bind(this, ws))
+      .on('error', this._onError.bind(this));
+  }
+
+  _clearPendingMessages() {
+    for (const [msgid, obj] of this.messagesInFlight) {
+      const {timer} = obj;
+      clearTimeout(timer);
+      if (!this._initMsgId) obj.failure(`abandoning msgid ${msgid} since socket is closed`);
+    }
+    this.messagesInFlight.clear();
+  }
+
+  _onError(err) {
+    if (this.connections > 0) {
+      this.logger.info({url: this.url, err}, 'WsRequestor:_onError');
+    }
+    else this.emit('not-ready', err);
+  }
+
+  _onOpen(ws) {
+    this.logger.info({url: this.url}, `WsRequestor(${this.id}) - successfully connected`);
+    if (this.ws) this.logger.info({old_ws: this.ws._socket.address()}, 'WsRequestor:_onOpen');
+    assert(!this.ws);
+    this.ws = ws;
+    this.connectInProgress = false;
+    this.connections++;
+    this.emit('ready', ws);
+  }
+
+  _onClose(code) {
+    this.logger.info(`WsRequestor(${this.id}) - closed from far end ${code}`);
+    if (this.connections > 0 && code !== 1000) {
+      this.logger.info({url: this.url}, 'WsRequestor - socket closed unexpectedly from remote side');
+      this.emit('socket-closed');
+    }
+    else if (code === 1000) this.closedGracefully = true;
+    this.ws?.removeAllListeners();
+    this.ws = null;
+  }
+
+  _onUnexpectedResponse(ws, req, res) {
+    assert(!this.ws);
+    this.logger.info({
+      headers: res.headers,
+      statusCode: res.statusCode,
+      statusMessage: res.statusMessage
+    }, 'WsRequestor - unexpected response');
+    this.emit('connection-failure');
+    this.emit('not-ready', new Error(`${res.statusCode} ${res.statusMessage}`));
+    this.connections++;
+  }
+
+  _onSocketClosed() {
+    this.ws = null;
+    this.emit('connection-dropped');
+    if (this.connections > 0 && this.connections < MAX_RECONNECTS && !this.closedGracefully) {
+      if (!this._initMsgId) this._clearPendingMessages();
+      this.logger.debug(`WsRequestor:_onSocketClosed waiting ${this.backoffMs} to reconnect`);
+      setTimeout(() => {
+        this.logger.debug(
+          {haveWs: !!this.ws, connectInProgress: this.connectInProgress},
+          'WsRequestor:_onSocketClosed time to reconnect');
+        if (!this.ws && !this.connectInProgress) {
+          this.connectInProgress = true;
+          this._connect().catch((err) => this.connectInProgress = false);
+        }
+      }, this.backoffMs);
+      this.backoffMs = this.backoffMs < 2000 ? this.backoffMs * 2 : (this.backoffMs + 2000);
+    }
+  }
+
+  _onMessage(content, isBinary) {
+    if (this.isBinary) {
+      this.logger.info({url: this.url}, 'WsRequestor:_onMessage - discarding binary message');
+      this.maliciousClient = true;
+      this.ws.close();
+      return;
+    }
+
+    /* messages must be JSON format */
+    try {
+      const obj = JSON.parse(content);
+      const {type, msgid, command, call_sid = this.call_sid, queueCommand = false, data} = obj;
+
+      //this.logger.debug({obj}, 'WsRequestor:request websocket: received');
+      assert.ok(type, 'type property not supplied');
+
+      switch (type) {
+        case 'ack':
+          assert.ok(msgid, 'msgid not supplied');
+          this._recvAck(msgid, data);
+          break;
+
+        case 'command':
+          assert.ok(command, 'command property not supplied');
+          assert.ok(data, 'data property not supplied');
+          this._recvCommand(msgid, command, call_sid, queueCommand, data);
+          break;
+
+        default:
+          assert.ok(false, `invalid type property: ${type}`);
+      }
+    } catch (err) {
+      this.logger.info({err, content}, 'WsRequestor:_onMessage - invalid incoming message');
+    }
+  }
+
+  _recvAck(msgid, data) {
+    this._initMsgId = null;
+    const obj = this.messagesInFlight.get(msgid);
+    if (!obj) {
+      this.logger.info({url: this.url}, `WsRequestor:_recvAck - ack to unknown msgid ${msgid}, discarding`);
+      return;
+    }
+    //this.logger.debug({url: this.url}, `WsRequestor:_recvAck - received response to ${msgid}`);
+    this.messagesInFlight.delete(msgid);
+    const {success} = obj;
+    success && success(data);
+  }
+
+  _recvCommand(msgid, command, call_sid, queueCommand, data) {
+    // TODO: validate command
+    this.logger.debug({msgid, command, call_sid, queueCommand, data}, 'received command');
+    this.emit('command', {msgid, command, call_sid, queueCommand, data});
+  }
+}
+
+module.exports = WsRequestor;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "0.2.1",
+  "version": "v0.8.2",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -16,39 +16,62 @@
     "type": "git",
     "url": "https://github.com/jambonz/jambonz-feature-server.git"
   },
-  "bugs": {
-    "url": "https://github.com/jambonz/jambonz-feature-server/issues"
-  },
+  "bugs": {},
   "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 HTTP_POOL=1 ENCRYPTION_SECRET=foobar 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=error ENABLE_METRICS=0 HTTP_PORT=3000 JAMBONES_SBCS=172.38.0.10 JAMBONES_FREESWITCH=127.0.0.1:8022:JambonzR0ck$: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",
-    "cidr-matcher": "^2.1.1",
-    "debug": "^4.1.1",
-    "drachtio-fsmrf": "^2.0.1",
-    "drachtio-srf": "^4.4.28",
-    "express": "^4.17.1",
-    "ip": "^1.1.5",
-    "@jambonz/db-helpers": "^0.3.7",
-    "jambonz-mw-registrar": "^0.1.3",
-    "jambonz-realtimedb-helpers": "^0.2.13",
-    "jambonz-stats-collector": "^0.0.3",
-    "moment": "^2.24.0",
-    "parse-url": "^5.0.1",
-    "pino": "^5.16.0",
-    "verify-aws-sns-signature": "0.0.5",
-    "xml2js": "^0.4.23"
+    "@jambonz/db-helpers": "^0.7.4",
+    "@jambonz/http-health-check": "^0.0.1",
+    "@jambonz/realtimedb-helpers": "^0.7.0",
+    "@jambonz/speech-utils": "^0.0.12",
+    "@jambonz/stats-collector": "^0.1.8",
+    "@jambonz/time-series": "^0.2.5",
+    "@jambonz/verb-specifications": "^0.0.11",
+    "@opentelemetry/api": "^1.4.0",
+    "@opentelemetry/exporter-jaeger": "^1.9.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.35.0",
+    "@opentelemetry/exporter-zipkin": "^1.9.0",
+    "@opentelemetry/instrumentation": "^0.35.0",
+    "@opentelemetry/resources": "^1.9.0",
+    "@opentelemetry/sdk-trace-base": "^1.9.0",
+    "@opentelemetry/sdk-trace-node": "^1.9.0",
+    "@opentelemetry/semantic-conventions": "^1.9.0",
+    "aws-sdk": "^2.1313.0",
+    "bent": "^7.3.12",
+    "debug": "^4.3.4",
+    "deepcopy": "^2.1.0",
+    "drachtio-fsmrf": "^3.0.20",
+    "drachtio-srf": "^4.5.23",
+    "express": "^4.18.2",
+    "ip": "^1.1.8",
+    "moment": "^2.29.4",
+    "parse-url": "^8.1.0",
+    "pino": "^8.8.0",
+    "polly-ssml-split": "^0.1.0",
+    "proxyquire": "^2.1.3",
+    "sdp-transform": "^2.14.1",
+    "short-uuid": "^4.2.2",
+    "sinon": "^15.0.1",
+    "to-snake-case": "^1.0.0",
+    "undici": "^5.19.1",
+    "uuid-random": "^1.3.2",
+    "verify-aws-sns-signature": "^0.1.0",
+    "ws": "^8.9.0",
+    "xml2js": "^0.5.0"
   },
   "devDependencies": {
-    "blue-tape": "^1.0.0",
-    "clear-module": "^4.1.1",
-    "eslint": "^6.8.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "nyc": "^15.0.1",
-    "tap-spec": "^5.0.0"
+    "clear-module": "^4.1.2",
+    "eslint": "^7.32.0",
+    "eslint-plugin-promise": "^4.3.1",
+    "nyc": "^15.1.0",
+    "tape": "^5.6.1"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.6",
+    "utf-8-validate": "^5.0.8"
   }
 }

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/config-test.js

@@ -0,0 +1,102 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const bent = require('bent');
+const getJSON = bent('json')
+const clearModule = require('clear-module');
+const {provisionCallHook} = require('./utils')
+
+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('\'config: listen\'', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const from = "config_listen_success";
+    let verbs = [
+      {
+        "verb": "config",
+        "listen": {
+          "enable": true,
+          "url": `ws://172.38.0.60:3000/${from}`
+        }
+      },
+      {
+        "verb": "pause",
+        "length": 5
+      }
+    ];
+
+    provisionCallHook(from, verbs);
+
+    // THEN
+    await sippUac('uac-gather-account-creds-success-send-bye.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/ws_packet_count/${from}`);
+    t.pass('config: successfully started background listen');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'config: listen - stop\'', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const from = "config_listen_success";
+    let verbs = [
+      {
+        "verb": "config",
+        "listen": {
+          "enable": true,
+          "url": `ws://172.38.0.60:3000/${from}`
+        }
+      },
+      {
+        "verb": "pause",
+        "length": 1
+      },
+      {
+        "verb": "config",
+        "listen": {
+          "enable": false
+        }
+      },
+      {
+        "verb": "pause",
+        "length": 3
+      }
+    ];
+
+    provisionCallHook(from, verbs);
+
+    // THEN
+    await sippUac('uac-gather-account-creds-success-send-bye.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/ws_packet_count/${from}`);
+    t.pass('config: successfully started then stopped background listen');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/create-call-test.js

@@ -0,0 +1,108 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const bent = require('bent');
+const clearModule = require('clear-module');
+const {provisionCallHook} = require('./utils')
+const getJSON = bent('json')
+
+const waitFor = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+
+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('test create-call timeout', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // give UAS app time to come up
+    const p = sippUac('uas-timeout-cancel.xml', '172.38.0.10');
+    await waitFor(1000);
+
+    // GIVEN
+    let account_sid = '622f62e4-303a-49f2-bbe0-eb1e1714e37a';
+    const post = bent('http://127.0.0.1:3000/', 'POST', 'json', 201);
+    post('v1/createCall', {
+      'account_sid':account_sid,
+      'timeout': 1,
+      "call_hook": {
+        "url": "https://public-apps.jambonz.us/hello-world",
+        "method": "POST"
+      },
+      "from": "15083718299",
+      "to": {
+        "type": "phone",
+        "number": "15583084809"
+      }});
+    //THEN
+    await p;
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('test create-call call-hook basic authentication', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+
+    // GIVEN
+    let from = 'call_hook_basic_authentication';
+    let account_sid = '622f62e4-303a-49f2-bbe0-eb1e1714e37a';
+
+    // Give UAS app time to come up
+    const p = sippUac('uas.xml', '172.38.0.10', from);
+    await waitFor(1000);
+
+    const post = bent('http://127.0.0.1:3000/', 'POST', 'json', 201);
+    post('v1/createCall', {
+      'account_sid':account_sid,
+      "call_hook": {
+        "url": "http://127.0.0.1:3100/",
+        "method": "POST",
+        "username": "username",
+        "password": "password"
+      },
+      "from": from,
+      "to": {
+        "type": "phone",
+        "number": "15583084809"
+      }});
+
+    let verbs = [
+      {
+        "verb": "say",
+        "text": "hello"
+      }
+    ];
+    provisionCallHook(from, verbs);
+    //THEN
+    await p;
+
+    let obj = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}`)
+    t.ok(obj.headers.Authorization = 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
+      'create-call: call-hook contains basic authentication header');
+    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,49 @@ 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');
+
+    const sql = [];
+    if (process.env.GCP_JSON_KEY) {
+      const google_credential = encrypt(process.env.GCP_JSON_KEY);
+      t.pass('adding google credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${google_credential}' WHERE vendor='google';`);
+    }
+    if (process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_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,
+        aws_region: process.env.AWS_REGION
+      }));
+      t.pass('adding aws credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${aws_credential}' WHERE vendor='aws';`);
+    }
+    if (process.env.MICROSOFT_REGION && process.env.MICROSOFT_API_KEY) {
+      const microsoft_credential = encrypt(JSON.stringify({
+        region: process.env.MICROSOFT_REGION,
+        api_key: process.env.MICROSOFT_API_KEY
+      }));
+      t.pass('adding microsoft credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${microsoft_credential}' WHERE vendor='microsoft';`);
+    }
+    if (sql.length > 0) {
+      const path = `${__dirname}/.creds.sql`;
+      const cmd = sql.join('\n');
+      fs.writeFileSync(path, sql.join('\n'));
+      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)
+        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/bad/bad-say-ssml.json

@@ -0,0 +1,9 @@
+{
+  "say": {
+    "text": "<speak>I already told you <emphasis level=\"strong\">I already told you I already told you I already told you I already told you! I already told you I already told you I already told you I already told you? I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you told I already told you I already told you told I already told you I already told you. I already told you <break time=\"3s\"/> I really like that person!</emphasis> this is another long text.</speak>",
+    "synthesizer": {
+      "vendor": "google",
+      "language": "en-US"
+    }
+  }
+}

test/data/good/say-ssml.json

@@ -0,0 +1,9 @@
+{
+  "say": {
+    "text": "<speak>I already told you I already told you I already told you I already told you I already told you! I already told you I already told you I already told you I already told you? I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you I already told you told I already told you I already told you told I already told you I already told you. I already told you <break time=\"3s\"/> I <emphasis level=\"strong\">really like that person!</emphasis> this is another long text.</speak>",
+    "synthesizer": {
+      "vendor": "google",
+      "language": "en-US"
+    }
+  }
+}

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

@@ -0,0 +1,760 @@
+-- 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 ',
+  `app_json` VARCHAR(16384),
+  `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,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,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,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,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,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,NULL,'google','en-US','en-US-Standard-C','google','en-US');
+INSERT INTO `applications` VALUES ('195d9507-6a42-46a8-825f-f009e729d023','sip info',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','c9113e7a-741f-48b9-96c1-f2f78176eeb3','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,NULL,'google','en-US','en-US-Standard-C','google','en-US');
+INSERT INTO `applications` VALUES ('0dddaabf-0a30-43e3-84e8-426873b1a78c','app json',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','c71e79db-24f2-4866-a3ee-febb0f97b341','293904c1-351b-4bca-8d58-1a29b853c7db',NULL,'[{"verb": "play","url": "silence_stream://5000"}]','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);
+INSERT INTO `phone_numbers` VALUES ('964d0581-9627-44cb-be20-8118050406b2','16174000006','5145b436-2f38-4029-8d4c-fd8c67831c7a','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','195d9507-6a42-46a8-825f-f009e729d023', NULL);
+INSERT INTO `phone_numbers` VALUES ('964d0581-9627-44cb-be20-8118050406b3','16174000007','5145b436-2f38-4029-8d4c-fd8c67831c7a','bb845d4b-83a9-4cde-a6e9-50f3743bab3f','0dddaabf-0a30-43e3-84e8-426873b1a78c', 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),
+('2add347f-34f2-45c6-a016-f955d218ffb6',NULL,'bb845d4b-83a9-4cde-a6e9-50f3743bab3f','microsoft','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',1,1,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);
+INSERT INTO `webhooks` VALUES ('c9113e7a-741f-48b9-96c1-f2f78176eeb3','http://127.0.0.1:3104/','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,651 @@
 /* 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_limits;
 
-DROP TABLE IF EXISTS `queue_members`;
+DROP TABLE IF EXISTS account_products;
 
-DROP TABLE IF EXISTS `calls`;
+DROP TABLE IF EXISTS account_subscriptions;
 
-DROP TABLE IF EXISTS `phone_numbers`;
+DROP TABLE IF EXISTS beta_invite_codes;
 
-DROP TABLE IF EXISTS `applications`;
+DROP TABLE IF EXISTS call_routes;
 
-DROP TABLE IF EXISTS `conferences`;
+DROP TABLE IF EXISTS dns_records;
 
-DROP TABLE IF EXISTS `queues`;
+DROP TABLE IF EXISTS lcr_carrier_set_entry;
 
-DROP TABLE IF EXISTS `subscriptions`;
+DROP TABLE IF EXISTS lcr_routes;
 
-DROP TABLE IF EXISTS `registrations`;
+DROP TABLE IF EXISTS password_settings;
 
-DROP TABLE IF EXISTS `api_keys`;
+DROP TABLE IF EXISTS user_permissions;
 
-DROP TABLE IF EXISTS `accounts`;
+DROP TABLE IF EXISTS permissions;
 
-DROP TABLE IF EXISTS `service_providers`;
+DROP TABLE IF EXISTS predefined_sip_gateways;
 
-DROP TABLE IF EXISTS `sip_gateways`;
+DROP TABLE IF EXISTS predefined_smpp_gateways;
 
-DROP TABLE IF EXISTS `voip_carriers`;
+DROP TABLE IF EXISTS predefined_carriers;
 
-CREATE TABLE IF NOT EXISTS `applications`
+DROP TABLE IF EXISTS account_offers;
+
+DROP TABLE IF EXISTS products;
+
+DROP TABLE IF EXISTS schema_version;
+
+DROP TABLE IF EXISTS api_keys;
+
+DROP TABLE IF EXISTS sbc_addresses;
+
+DROP TABLE IF EXISTS ms_teams_tenants;
+
+DROP TABLE IF EXISTS service_provider_limits;
+
+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_limits
+(
+account_limits_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device','voice_call_minutes','voice_call_session_license', 'voice_call_minutes_license') NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (account_limits_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 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 `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 beta_invite_codes
+(
+invite_code CHAR(6) NOT NULL UNIQUE ,
+in_use BOOLEAN NOT NULL DEFAULT false,
+PRIMARY KEY (invite_code)
+);
 
-ALTER TABLE `call_routes` ADD FOREIGN KEY application_sid_idxfk (`application_sid`) REFERENCES `applications` (`application_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';
 
-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 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)
+);
 
-ALTER TABLE `conference_participants` ADD FOREIGN KEY conference_sid_idxfk (`conference_sid`) REFERENCES `conferences` (`conference_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';
 
-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 password_settings
+(
+min_password_length INTEGER NOT NULL DEFAULT 8,
+require_digit BOOLEAN NOT NULL DEFAULT false,
+require_special_character BOOLEAN NOT NULL DEFAULT false
+);
 
-ALTER TABLE `queue_members` ADD FOREIGN KEY queue_sid_idxfk (`queue_sid`) REFERENCES `queues` (`queue_sid`);
+CREATE TABLE permissions
+(
+permission_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(32) NOT NULL UNIQUE ,
+description VARCHAR(255),
+PRIMARY KEY (permission_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 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)
+);
 
-ALTER TABLE `calls` ADD FOREIGN KEY application_sid_idxfk_1 (`application_sid`) REFERENCES `applications` (`application_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)
+);
 
-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 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)
+);
 
-ALTER TABLE `calls` ADD FOREIGN KEY inbound_user_sid_idxfk (`inbound_user_sid`) REFERENCES `registrations` (`registration_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 outbound_user_sid_idxfk (`outbound_user_sid`) REFERENCES `registrations` (`registration_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 `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 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)
+);
 
-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 schema_version
+(
+version VARCHAR(16)
+);
 
-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 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';
 
-ALTER TABLE `subscriptions` ADD FOREIGN KEY registration_sid_idxfk (`registration_sid`) REFERENCES `registrations` (`registration_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 `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 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';
 
-ALTER TABLE `phone_numbers` ADD FOREIGN KEY account_sid_idxfk_3 (`account_sid`) REFERENCES `accounts` (`account_sid`);
+CREATE TABLE service_provider_limits
+(
+service_provider_limits_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device','voice_call_minutes','voice_call_session_license', 'voice_call_minutes_license') NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (service_provider_limits_sid)
+);
 
-ALTER TABLE `phone_numbers` ADD FOREIGN KEY application_sid_idxfk_2 (`application_sid`) REFERENCES `applications` (`application_sid`);
+CREATE TABLE signup_history
+(
+email VARCHAR(255) NOT NULL,
+name VARCHAR(255),
+signed_up_at DATETIME DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (email)
+);
 
-CREATE UNIQUE INDEX `sip_gateways_sip_gateway_idx_hostport` ON `sip_gateways` (`ipv4`,`port`);
+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)
+);
 
-ALTER TABLE `sip_gateways` ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (`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)
+);
+
+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,
+is_active BOOLEAN NOT NULL DEFAULT true,
+PRIMARY KEY (user_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),
+register_from_user VARCHAR(128),
+register_from_domain VARCHAR(255),
+register_public_ip_in_contact BOOLEAN NOT NULL DEFAULT false,
+PRIMARY KEY (voip_carrier_sid)
+) COMMENT='A Carrier or customer PBX that can send or receive calls';
+
+CREATE TABLE user_permissions
+(
+user_permissions_sid CHAR(36) NOT NULL UNIQUE ,
+user_sid CHAR(36) NOT NULL,
+permission_sid CHAR(36) NOT NULL,
+PRIMARY KEY (user_permissions_sid)
+);
+
+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)
+);
+
+CREATE TABLE phone_numbers
+(
+phone_number_sid CHAR(36) UNIQUE ,
+number VARCHAR(132) 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 ',
+app_json VARCHAR(16384),
+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,
+subspace_client_id VARCHAR(255),
+subspace_client_secret VARCHAR(255),
+subspace_sip_teleport_id VARCHAR(255),
+subspace_sip_teleport_destinations VARCHAR(255),
+siprec_hook_sid CHAR(36),
+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_sid_idx ON account_limits (account_sid);
+ALTER TABLE account_limits ADD FOREIGN KEY account_sid_idxfk_1 (account_sid) REFERENCES accounts (account_sid) ON DELETE CASCADE;
+
+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_2 (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_3 (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_4 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX permission_sid_idx ON permissions (permission_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_5 (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_6 (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_7 (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 service_provider_sid_idx ON service_provider_limits (service_provider_sid);
+ALTER TABLE service_provider_limits ADD FOREIGN KEY service_provider_sid_idxfk_3 (service_provider_sid) REFERENCES service_providers (service_provider_sid) ON DELETE CASCADE;
+
+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_4 (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_5 (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_8 (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_9 (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_6 (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_10 (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_7 (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 user_permissions_sid_idx ON user_permissions (user_permissions_sid);
+CREATE INDEX user_sid_idx ON user_permissions (user_sid);
+ALTER TABLE user_permissions ADD FOREIGN KEY user_sid_idxfk (user_sid) REFERENCES users (user_sid) ON DELETE CASCADE;
+
+ALTER TABLE user_permissions ADD FOREIGN KEY permission_sid_idxfk (permission_sid) REFERENCES permissions (permission_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_11 (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_8 (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_9 (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_12 (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_10 (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);
+
+ALTER TABLE accounts ADD FOREIGN KEY siprec_hook_sid_idxfk (siprec_hook_sid) REFERENCES applications (application_sid);
+
+SET FOREIGN_KEY_CHECKS=1;

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/dial-tests.js

@@ -0,0 +1,212 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const bent = require('bent');
+const getJSON = bent('json')
+const clearModule = require('clear-module');
+const {provisionCallHook} = require('./utils')
+
+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('\'dial-phone\'', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+    // wait for fs connected to drachtio server.
+    await new Promise(r => setTimeout(r, 1000));
+
+    // GIVEN
+    const from = "dial_success";
+    let verbs = [
+      {
+        "verb": "dial",
+        "callerId": from,
+        "actionHook": "/actionHook",
+        "timeLimit": 5,
+        "target": [
+            {
+                "type": "phone",
+                "number": "15083084809"
+            }
+        ]
+      }
+    ];
+
+    provisionCallHook(from, verbs);
+
+    // THEN
+    const p = sippUac('uas-dial.xml', '172.38.0.10', undefined, undefined, 2);
+
+    let account_sid = '622f62e4-303a-49f2-bbe0-eb1e1714e37a';
+    let post = bent('http://127.0.0.1:3000/', 'POST', 'json', 201);
+    post('v1/createCall', {
+      'account_sid':account_sid,
+      "call_hook": {
+        "url": "http://127.0.0.1:3100/",
+        "method": "POST",
+      },
+      "from": from,
+      "to": {
+        "type": "phone",
+        "number": "15583084808"
+    }});
+
+    await p;
+
+    obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    t.ok(obj.body.from === from,
+      'dial: succeeds actionHook');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+
+test('\'dial-sip\'', async(t) => {
+    clearModule.all();
+    const {srf, disconnect} = require('../app');
+    try {
+      await connect(srf);
+      // wait for fs connected to drachtio server.
+      await new Promise(r => setTimeout(r, 1000));
+      // GIVEN
+      const from = "dial_sip";
+      let verbs = [
+        {
+          "verb": "dial",
+          "callerId": from,
+          "actionHook": "/actionHook",
+          "dtmfCapture":["*2", "*3"],
+          "target": [
+              {
+                  "type": "sip",
+                  "sipUri": "sip:15083084809@jambonz.com"
+              }
+          ]
+        }
+      ];
+  
+      provisionCallHook(from, verbs);
+  
+      // THEN
+      const p = sippUac('uas-dial.xml', '172.38.0.10', undefined, undefined, 2);
+  
+      let account_sid = '622f62e4-303a-49f2-bbe0-eb1e1714e37a';
+  
+      let post = bent('http://127.0.0.1:3000/', 'POST', 'json', 201);
+      post('v1/createCall', {
+        'account_sid':account_sid,
+        "call_hook": {
+          "url": "http://127.0.0.1:3100/",
+          "method": "POST",
+        },
+        "from": from,
+        "to": {
+          "type": "phone",
+          "number": "15583084808"
+      }});
+  
+      await new Promise(r => setTimeout(r, 2000));
+  
+      let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}`);
+      const callSid = obj.body.call_sid;
+  
+      post = bent('http://127.0.0.1:3000/', 'POST', 202);
+      await post(`v1/updateCall/${callSid}`, {
+          "call_status": "completed"
+      });
+  
+      await p;
+  
+      obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+      t.ok(obj.body.from === from,
+        'dial: succeeds actionHook');
+  
+      disconnect();
+    } catch (err) {
+      console.log(`error received: ${err}`);
+      disconnect();
+      t.error(err);
+    }
+});
+
+test('\'dial-user\'', async(t) => {
+    clearModule.all();
+    const {srf, disconnect} = require('../app');
+    try {
+      await connect(srf);
+      // wait for fs connected to drachtio server.
+      await new Promise(r => setTimeout(r, 1000));
+      // GIVEN
+      const from = "dial_user";
+      let verbs = [
+        {
+          "verb": "dial",
+          "callerId": from,
+          "actionHook": "/actionHook",
+          "target": [
+              {
+                  "type": "user",
+                  "name": "user110@jambonz.com"
+              }
+          ]
+        }
+      ];
+  
+      provisionCallHook(from, verbs);
+  
+      // THEN
+      const p = sippUac('uas-dial.xml', '172.38.0.10', undefined, undefined, 2);
+  
+      let account_sid = '622f62e4-303a-49f2-bbe0-eb1e1714e37a';
+  
+      let post = bent('http://127.0.0.1:3000/', 'POST', 'json', 201);
+      post('v1/createCall', {
+        'account_sid':account_sid,
+        "call_hook": {
+          "url": "http://127.0.0.1:3100/",
+          "method": "POST",
+        },
+        "from": from,
+        "to": {
+          "type": "phone",
+          "number": "15583084808"
+      }});
+  
+      await new Promise(r => setTimeout(r, 2000));
+  
+      let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}`);
+      const callSid = obj.body.call_sid;
+  
+      post = bent('http://127.0.0.1:3000/', 'POST', 202);
+      await post(`v1/updateCall/${callSid}`, {
+          "call_status": "completed"
+      });
+  
+      await p;
+  
+      obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+      t.ok(obj.body.from === from,
+        'dial: succeeds actionHook');
+  
+      disconnect();
+    } catch (err) {
+      console.log(`error received: ${err}`);
+      disconnect();
+      t.error(err);
+    }
+});

test/docker-compose-testbed.yaml

@@ -1,55 +1,94 @@
-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" --mtu 4096 --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:0.4.18
+    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' ,'-p', 'JambonzR0ck$$', '-x', '"sofia status"']
+      timeout: 5s
+      retries: 15
+    networks:
+      fs:
+        ipv4_address: 172.38.0.51
+
+  webhook-scaffold:
+    image: jambonz/webhook-test-scaffold:latest
+    ports:
+      - "3100:3000/tcp"
+    volumes:
+      - ./test-apps:/tmp
+    networks:
+      fs:
+        ipv4_address: 172.38.0.60
+
+  influxdb:
+    image: influxdb:1.8
+    ports:
+      - "8086:8086"
+    networks:
+      fs:
+        ipv4_address: 172.38.0.90

test/docker_start.js

@@ -1,9 +1,9 @@
-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,259 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const bent = require('bent');
+const getJSON = bent('json')
+const clearModule = require('clear-module');
+const {provisionCallHook} = require('./utils')
+
+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\' test - google', async(t) => {
+  if (!process.env.GCP_JSON_KEY) {
+    t.pass('skipping google tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "gather",
+        "input": ["speech"],
+        "recognizer": {
+          "vendor": "google",
+          "hints": ["customer support", "sales", "human resources", "HR"]
+        },
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    provisionCallHook(from, verbs);
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    //console.log(JSON.stringify(obj));
+    t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase().startsWith('i\'d like to speak to customer support'),
+      'gather: succeeds when using google credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'gather\' test - default (google)', async(t) => {
+  if (!process.env.GCP_JSON_KEY) {
+    t.pass('skipping google tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "gather",
+        "input": ["speech"],
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    provisionCallHook(from, verbs);
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    //console.log(JSON.stringify(obj));
+    t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase() === 'i\'d like to speak to customer support',
+      'gather: succeeds when using default (google) credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'gather\' test - microsoft', async(t) => {
+  if (!process.env.MICROSOFT_REGION || !process.env.MICROSOFT_API_KEY) {
+    t.pass('skipping microsoft tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "gather",
+        "input": ["speech"],
+        "recognizer": {
+          "vendor": "microsoft",
+          "hints": ["customer support", "sales", "human resources", "HR"]
+        },
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    provisionCallHook(from, verbs);
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    //console.log(JSON.stringify(obj));
+    t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase().startsWith('i\'d like to speak to customer support'),
+      'gather: succeeds when using  microsoft credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'gather\' test - aws', async(t) => {
+  if (!process.env.AWS_ACCESS_KEY_ID || !process.env.AWS_SECRET_ACCESS_KEY) {
+    t.pass('skipping aws tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "gather",
+        "input": ["speech"],
+        "recognizer": {
+          "vendor": "aws",
+          "hints": ["customer support", "sales", "human resources", "HR"]
+        },
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    provisionCallHook(from, verbs);
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    //console.log(JSON.stringify(obj));
+    t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase().startsWith('i\'d like to speak to customer support'),
+      'gather: succeeds when using aws credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'gather\' test - deepgram', async(t) => {
+  if (!process.env.DEEPGRAM_API_KEY ) {
+    t.pass('skipping deepgram tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "gather",
+        "input": ["speech"],
+        "recognizer": {
+          "vendor": "deepgram",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "deepgramOptions": {
+            "apiKey": process.env.DEEPGRAM_API_KEY
+          }
+        },
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    provisionCallHook(from, verbs);
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    //console.log(JSON.stringify(obj));
+    t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase().startsWith('i\'d like to speak to customer support'),
+      'gather: succeeds when using deepgram credentials');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'gather\' test - soniox', async(t) => {
+  if (!process.env.SONIOX_API_KEY ) {
+    t.pass('skipping soniox tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "gather",
+        "input": ["speech"],
+        "recognizer": {
+          "vendor": "deepgram",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "deepgramOptions": {
+            "apiKey": process.env.SONIOX_API_KEY
+          }
+        },
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    provisionCallHook(from, verbs);
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    console.log(JSON.stringify(obj));
+    t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase().startsWith('i\'d like to speak to customer support'),
+      'gather: succeeds when using soniox credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/index.js

@@ -1,8 +1,18 @@
+require('./ws-requestor-unit-test');
 require('./unit-tests');
-/*
 require('./docker_start');
 require('./create-test-db');
-require('./sip-tests');
+require('./account-validation-tests');
+require('./dial-tests');
+require('./webhooks-tests');
+require('./say-tests');
+require('./gather-tests');
+require('./transcribe-tests');
+require('./sip-request-tests');
+require('./create-call-test');
+require('./play-tests');
+require('./sip-refer-tests');
+require('./listen-tests');
+require('./config-test');
 require('./remove-test-db');
-require('./docker_stop');
-*/
+require('./docker_stop');

test/listen-tests.js

@@ -0,0 +1,149 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const bent = require('bent');
+const getJSON = bent('json')
+const clearModule = require('clear-module');
+const {provisionCallHook} = require('./utils')
+
+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('\'listen-success\'', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const from = "listen_success";
+    let verbs = [
+      {
+        "verb": "listen",
+        "url": `ws://172.38.0.60:3000/${from}`,
+        "mixType" : "mono",
+        "actionHook": "/actionHook",
+        "playBeep": true,
+      }
+    ];
+
+    provisionCallHook(from, verbs);
+
+    // THEN
+    await sippUac('uac-gather-account-creds-success-send-bye.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/ws_packet_count/${from}`);
+    t.ok(38000 <= obj.count, 'listen: success incoming call audio');
+
+    obj = await getJSON(`http://127.0.0.1:3100/ws_metadata/${from}`);
+    t.ok(obj.metadata.from === from && obj.metadata.sampleRate === 8000, 'listen: success metadata');
+
+    obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    t.ok(obj.body.from === from,
+      'listen: succeeds actionHook');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'listen-maxLength\'', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+
+    // GIVEN
+    let from = "listen_timeout";
+    let verbs = [
+      {
+        "verb": "listen",
+        "url": `ws://172.38.0.60:3000/${from}`,
+        "mixType" : "mixed",
+        "timeout": 2,
+        "maxLength": 2
+      }
+    ];
+
+    provisionCallHook(from, verbs);
+
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/ws_packet_count/${from}`);
+    t.ok(30000 <= obj.count, 'listen: success maxLength incoming call audio');
+
+    obj = await getJSON(`http://127.0.0.1:3100/ws_metadata/${from}`);
+    t.ok(obj.metadata.from === from && obj.metadata.sampleRate === 8000, 'listen: success maxLength metadata');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'listen-pause-resume\'', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+
+    // GIVEN
+    let from = "listen_timeout";
+    let verbs = [
+      {
+        "verb": "listen",
+        "url": `ws://172.38.0.60:3000/${from}`,
+        "mixType" : "mixed"
+      }
+    ];
+
+    provisionCallHook(from, verbs);
+
+    // THEN
+    const p = sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    await new Promise(r => setTimeout(r, 2000));
+
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}`);
+    const callSid = obj.body.call_sid;
+
+    // GIVEN
+    // Pause listen
+    let post = bent('http://127.0.0.1:3000/', 'POST', 202);
+    await post(`v1/updateCall/${callSid}`, {
+        "listen_status": "pause"
+    });
+
+    await new Promise(r => setTimeout(r, 2000));
+
+    // Resume listen
+    post = bent('http://127.0.0.1:3000/', 'POST', 202);
+    await post(`v1/updateCall/${callSid}`, {
+        "listen_status": "resume"
+    });
+
+    // turn off the call
+    post = bent('http://127.0.0.1:3000/', 'POST', 202);
+    await post(`v1/updateCall/${callSid}`, {
+        "call_status": "completed"
+    });
+
+    await p;
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/play-tests.js

@@ -0,0 +1,254 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const clearModule = require('clear-module');
+const {provisionCallHook, provisionCustomHook} = require('./utils')
+const bent = require('bent');
+const getJSON = bent('json')
+
+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('\'play\' tests single link in plain text', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'play',
+        url: 'https://example.com/example.mp3'
+      }
+    ];
+
+    const from = 'play_single_link';
+    provisionCallHook(from, verbs)
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+    t.pass('play: succeeds when using single link');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'play\' tests multi links in array', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'play',
+        url: ['https://example.com/example.mp3', 'https://example.com/example.mp3']
+      }
+    ];
+
+    const from = 'play_multi_links_in_array';
+    provisionCallHook(from, verbs)
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+    t.pass('play: succeeds when using links in array');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'play\' tests single link in conference', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const from = 'play_single_link_in_conference';
+    const waitHookVerbs = [
+      {
+        verb: 'play',
+        url: 'https://example.com/example.mp3'
+      }
+    ];
+
+    const verbs = [
+      {
+        verb: 'conference',
+        name: `${from}`,
+        beep: true,
+        "startConferenceOnEnter": false,
+        waitHook: `/customHook`
+      }
+    ];
+    provisionCustomHook(from, waitHookVerbs)
+    provisionCallHook(from, verbs)
+
+    // THEN
+    await sippUac('uac-success-send-bye.xml', '172.38.0.10', from);
+    t.pass('play: succeeds when using in conference as single link');
+    // Make sure that waitHook is called and success
+    await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_customHook`)
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'play\' tests multi links in array in conference', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const from = 'play_multi_links_in_conference';
+    const waitHookVerbs = [
+      {
+        verb: 'play',
+        url: ['https://example.com/example.mp3', 'https://example.com/example.mp3']
+      }
+    ];
+
+    const verbs = [
+      {
+        verb: 'conference',
+        name: `${from}`,
+        beep: true,
+        "startConferenceOnEnter": false,
+        waitHook: `/customHook`
+      }
+    ];
+    provisionCustomHook(from, waitHookVerbs)
+    provisionCallHook(from, verbs)
+
+    // THEN
+    await sippUac('uac-success-send-bye.xml', '172.38.0.10', from);
+    t.pass('play: succeeds when using in conference with multi links');
+    // Make sure that waitHook is called and success
+    await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_customHook`)
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'play\' tests with seekOffset and actionHook', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'play',
+        url: 'silence_stream://5000',
+        seekOffset: 8000,
+        timeoutSecs: 2,
+        actionHook: '/customHook'
+      }
+    ];
+
+    const waitHookVerbs = [];
+
+    const from = 'play_action_hook';
+    provisionCallHook(from, verbs)
+    provisionCustomHook(from, waitHookVerbs)
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+    t.pass('play: succeeds');
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_customHook`);
+    const seconds = parseInt(obj.body.playback_seconds);
+    const milliseconds = parseInt(obj.body.playback_milliseconds);
+    const lastOffsetPos = parseInt(obj.body.playback_last_offset_pos);
+    //console.log({obj}, 'lastRequest');
+    t.ok(obj.body.reason === "playCompleted", "play: actionHook success received");
+    t.ok(seconds === 2, "playback_seconds: actionHook success received");
+    t.ok(milliseconds === 2048, "playback_milliseconds: actionHook success received");
+    t.ok(lastOffsetPos > 15500 && lastOffsetPos < 16500, "playback_last_offset_pos: actionHook success received")
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'play\' tests with earlymedia', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'play',
+        url: 'silence_stream://5000',
+        earlyMedia: true
+      }
+    ];
+
+    const from = 'play_early_media';
+    provisionCallHook(from, verbs)
+
+    // THEN
+    await sippUac('uac-invite-expect-183-cancel.xml', '172.38.0.10', from);
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_callStatus`);
+    t.ok(obj.body.sip_status === 487, "play: actionHook success received");
+    t.ok(obj.body.sip_reason === 'Request Terminated', "play: actionHook success received");
+    t.ok(obj.body.call_termination_by === 'caller', "play: actionHook success received");
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'play\' tests with initial app_json', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    const from = 'play_initial_app_json';
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from, "16174000007");
+    t.pass('application can use app_json for initial instructions');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});