avoid a pre-caching attempt if synth settings change

Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.2 to 1.15.4.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.2...v1.15.4)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/build.yml

@@ -1,16 +1,15 @@
 name: CI
 
-on:
-  push:
+on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - run: npm ci
       - run: npm run jslint
       - run: docker pull drachtio/sipp
@@ -20,3 +19,5 @@ jobs:
           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

@@ -2,16 +2,10 @@ name: Docker
 
 on:
   push:
-    # Publish `main` as Docker `latest` image.
     branches:
       - main
-
-    # Publish `v1.2.3` tags as releases.
     tags:
-      - v*
-
-env:
-  IMAGE_NAME: feature-server
+      - '*'
 
 jobs:
   push:
@@ -20,32 +14,41 @@ jobs:
     if: github.event_name == 'push'
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-      - name: Build image
-        run: docker build . --file Dockerfile --tag $IMAGE_NAME
-
-      - name: Log into registry
-        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
-
-      - name: Push image
+      - name: prepare tag 
+        id: prepare_tag
         run: |
-          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
+            IMAGE_ID=jambonz/feature-server
 
-          # Change all uppercase to lowercase
-          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+            # Strip git ref prefix from version
+            VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
 
-          # Strip 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//')
 
-          # 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
 
-          # Use Docker `latest` tag convention
-          [ "$VERSION" == "main" ] && VERSION=latest
+            echo IMAGE_ID=$IMAGE_ID
+            echo VERSION=$VERSION
 
-          echo IMAGE_ID=$IMAGE_ID
-          echo VERSION=$VERSION
+            echo "image_id=$IMAGE_ID" >> $GITHUB_OUTPUT
+            echo "version=$VERSION" >> $GITHUB_OUTPUT
 
-          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
-          docker push $IMAGE_ID:$VERSION
+      - name: Login to Docker Hub 
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.prepare_tag.outputs.image_id }}:${{ steps.prepare_tag.outputs.version }}
+          build-args: |
+            GITHUB_REPOSITORY=$GITHUB_REPOSITORY
+            GITHUB_REF=$GITHUB_REF

.gitignore

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

Dockerfile

@@ -1,4 +1,4 @@
-FROM --platform=linux/amd64 node:18.9.0-alpine3.16 as base
+FROM --platform=linux/amd64 node:18.15-alpine3.16 as base
 
 RUN apk --update --no-cache add --virtual .builds-deps build-base python3
 

README.md

@@ -1,4 +1,4 @@
-# jambones-feature-server ![Build Status](https://github.com/jambonz/jambonz-feature-server/workflows/CI/badge.svg)
+# jambonz-feature-server [![CI](https://github.com/jambonz/jambonz-feature-server/actions/workflows/build.yml/badge.svg)](https://github.com/jambonz/jambonz-feature-server/actions/workflows/build.yml)
 
 This application implements the core feature server of the jambones platform.
 
@@ -18,8 +18,10 @@ Configuration is provided via environment variables:
 |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|
@@ -35,6 +37,11 @@ Configuration is provided via environment variables:
 |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|
+|JAMBONZ_RECORD_WS_BASE_URL| recording websocket URL to send the recording audio|no|
+|JAMBONZ_RECORD_WS_USERNAME| recording websocket username|no|
+|JAMBONZ_RECORD_WS_PASSWORD| recording websocket password|no|
+|ANCHOR_MEDIA_ALWAYS| keep media on media server|no|
+|JAMBONZ_DISABLE_DIAL_PAI_HEADER| control P-Asserted-Identity header on B-Leg|no|
 
 ### 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:
@@ -87,4 +94,4 @@ module.exports = {
 
 #### Running the test suite
 
-Please [see this]](./docs/contributing.md#run-the-regression-test-suite).
+Please [see this](./docs/contributing.md#run-the-regression-test-suite).

app.js

@@ -1,21 +1,28 @@
-const assert = require('assert');
-assert.ok(process.env.JAMBONES_MYSQL_HOST &&
-  process.env.JAMBONES_MYSQL_USER &&
-  process.env.JAMBONES_MYSQL_PASSWORD &&
-  process.env.JAMBONES_MYSQL_DATABASE, 'missing JAMBONES_MYSQL_XXX env vars');
-assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env var');
-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 || process.env.K8S, 'missing JAMBONES_SUBNET env var');
+const {
+  DRACHTIO_PORT,
+  DRACHTIO_HOST,
+  DRACHTIO_SECRET,
+  JAMBONES_OTEL_SERVICE_NAME,
+  JAMBONES_LOGLEVEL,
+  JAMBONES_CLUSTER_ID,
+  JAMBONZ_CLEANUP_INTERVAL_MINS,
+  getCleanupIntervalMins,
+  K8S,
+  NODE_ENV,
+  checkEnvs,
+} = require('./lib/config');
+
+checkEnvs();
 
 const Srf = require('drachtio-srf');
 const srf = new Srf();
-const tracer = require('./tracer')(process.env.JAMBONES_OTEL_SERVICE_NAME || 'jambonz-feature-server');
+const tracer = require('./tracer')(JAMBONES_OTEL_SERVICE_NAME);
 const api = require('@opentelemetry/api');
 srf.locals = {...srf.locals, otel: {tracer, api}};
 
-const opts = {level: process.env.JAMBONES_LOGLEVEL || 'info'};
+const opts = {
+  level: JAMBONES_LOGLEVEL
+};
 const pino = require('pino');
 const logger = pino(opts, pino.destination({sync: false}));
 const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./lib/utils/constants');
@@ -35,8 +42,8 @@ const {
 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 });
+if (DRACHTIO_HOST) {
+  srf.connect({host: DRACHTIO_HOST, port: DRACHTIO_PORT, secret: DRACHTIO_SECRET });
   srf.on('connect', (err, hp) => {
     const arr = /^(.*)\/(.*)$/.exec(hp.split(',').pop());
     srf.locals.localSipAddress = `${arr[2]}`;
@@ -44,10 +51,10 @@ if (process.env.DRACHTIO_HOST) {
   });
 }
 else {
-  logger.info(`listening for drachtio requests on port ${process.env.DRACHTIO_PORT}`);
-  srf.listen({port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET});
+  logger.info(`listening for drachtio requests on port ${DRACHTIO_PORT}`);
+  srf.listen({port: DRACHTIO_PORT, secret: DRACHTIO_SECRET});
 }
-if (process.env.NODE_ENV === 'test') {
+if (NODE_ENV === 'test') {
   srf.on('error', (err) => {
     logger.info(err, 'Error connecting to drachtio');
   });
@@ -102,23 +109,37 @@ const disconnect = () => {
     httpServer?.on('close', resolve);
     httpServer?.close();
     srf.disconnect();
-    srf.locals.mediaservers.forEach((ms) => ms.disconnect());
+    srf.locals.mediaservers?.forEach((ms) => ms.disconnect());
   });
 };
 
-process.on('SIGUSR2', handle);
 process.on('SIGTERM', handle);
 
 function handle(signal) {
   const {removeFromSet} = srf.locals.dbHelpers;
-  const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
-  logger.info(`got signal ${signal}, removing ${srf.locals.localSipAddress} from set ${setName}`);
-  removeFromSet(setName, srf.locals.localSipAddress);
-  removeFromSet(FS_UUID_SET_NAME, srf.locals.fsUUID);
   srf.locals.disabled = true;
+  logger.info(`got signal ${signal}`);
+  const setName = `${(JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
+  const fsServiceUrlSetName = `${(JAMBONES_CLUSTER_ID || 'default')}:fs-service-url`;
+  if (setName && srf.locals.localSipAddress) {
+    logger.info(`got signal ${signal}, removing ${srf.locals.localSipAddress} from set ${setName}`);
+    removeFromSet(setName, srf.locals.localSipAddress);
+  }
+  if (fsServiceUrlSetName && srf.locals.serviceUrl) {
+    logger.info(`got signal ${signal}, removing ${srf.locals.serviceUrl} from set ${fsServiceUrlSetName}`);
+    removeFromSet(fsServiceUrlSetName, srf.locals.serviceUrl);
+  }
+  removeFromSet(FS_UUID_SET_NAME, srf.locals.fsUUID);
+  if (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) {
+if (JAMBONZ_CLEANUP_INTERVAL_MINS) {
   const {clearFiles} = require('./lib/utils/cron-jobs');
 
   /* cleanup orphaned files or channels every so often */
@@ -128,7 +149,7 @@ if (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS) {
     } catch (err) {
       logger.error({err}, 'app.js: error clearing files');
     }
-  }, 1000 * 60 * (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS || 60));
+  }, getCleanupIntervalMins());
 }
 
 module.exports = {srf, logger, disconnect};

bin/k8s-pre-stop-hook.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 const bent = require('bent');
 const getJSON = bent('json');
-const PORT = process.env.HTTP_PORT || 3000;
+const {PORT} = require('../lib/config')
 
 const sleep = (ms) => {
   return new Promise((resolve) => setTimeout(resolve, ms));

data/example-voicemail-greetings.json

@@ -5,14 +5,11 @@
     "at the tone",
     "leave a message",
     "leave me a message",
-    "not available right now",
-    "not available to take your call",
+    "not available",
     "can't take your call",
-    "I will get back to you",
+    "will get back to you",
     "I'll get back to you",
-    "we will get back to you",
-    "we are unable",
-    "we are not available"
+    "we are unable"
   ],
   "es-ES": [
     "le pasamos la llamada",
@@ -48,5 +45,18 @@
     "ens posarem en contacto",
     "ara no estem disponibles",
     "no hi som"
+  ],
+  "de-DE": [
+    "nicht erreichbar",
+    "nnruf wurde weitergeleitet",
+    "beim piepsen",
+    "am ton",
+    "eine nachricht hinterlassen",
+    "hinterlasse mir eine Nachricht",
+    "nicht verfügbar",
+    "kann ihren anruf nicht entgegennehmen",
+    "wird sich bei Ihnen melden",
+    "ich melde mich bei dir",
+    "wir können nicht"
   ]
 }

docs/contributing.md

@@ -45,7 +45,7 @@ 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.
+The test suite also requires [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:
 

lib/config.js

@@ -0,0 +1,217 @@
+const assert = require('assert');
+
+const checkEnvs = () => {
+  assert.ok(process.env.JAMBONES_MYSQL_HOST &&
+		process.env.JAMBONES_MYSQL_USER &&
+		process.env.JAMBONES_MYSQL_PASSWORD &&
+		process.env.JAMBONES_MYSQL_DATABASE, 'missing JAMBONES_MYSQL_XXX env vars');
+  assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env var');
+  assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
+  assert.ok(process.env.JAMBONES_FREESWITCH, 'missing JAMBONES_FREESWITCH env var');
+  if (process.env.JAMBONES_REDIS_SENTINELS) {
+    assert.ok(process.env.JAMBONES_REDIS_SENTINEL_MASTER_NAME,
+      'missing JAMBONES_REDIS_SENTINEL_MASTER_NAME env var, JAMBONES_REDIS_SENTINEL_PASSWORD env var is optional');
+  } else {
+    assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
+  }
+  assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_SUBNET env var');
+};
+
+const NODE_ENV = process.env.NODE_ENV;
+
+/* database mySQL */
+const JAMBONES_MYSQL_HOST = process.env.JAMBONES_MYSQL_HOST;
+const JAMBONES_MYSQL_USER = process.env.JAMBONES_MYSQL_USER;
+const JAMBONES_MYSQL_PASSWORD = process.env.JAMBONES_MYSQL_PASSWORD;
+const JAMBONES_MYSQL_DATABASE = process.env.JAMBONES_MYSQL_DATABASE;
+const JAMBONES_MYSQL_PORT = parseInt(process.env.JAMBONES_MYSQL_PORT, 10) || 3306;
+const JAMBONES_MYSQL_REFRESH_TTL = parseInt(process.env.JAMBONES_MYSQL_REFRESH_TTL, 10) || 0;
+const JAMBONES_MYSQL_CONNECTION_LIMIT = parseInt(process.env.JAMBONES_MYSQL_CONNECTION_LIMIT, 10) || 10;
+
+/* gather and hints */
+const JAMBONES_GATHER_EARLY_HINTS_MATCH = process.env.JAMBONES_GATHER_EARLY_HINTS_MATCH;
+const JAMBONZ_GATHER_EARLY_HINTS_MATCH = process.env.JAMBONZ_GATHER_EARLY_HINTS_MATCH;
+const JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS = process.env.JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS;
+
+const SMPP_URL = process.env.SMPP_URL;
+
+/* drachtio */
+const DRACHTIO_PORT = process.env.DRACHTIO_PORT;
+const DRACHTIO_HOST = process.env.DRACHTIO_HOST;
+const DRACHTIO_SECRET = process.env.DRACHTIO_SECRET;
+
+/* freeswitch */
+const JAMBONES_API_BASE_URL = process.env.JAMBONES_API_BASE_URL;
+const JAMBONES_FREESWITCH = process.env.JAMBONES_FREESWITCH;
+const JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS = parseInt(process.env.JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS, 10)
+	|| 180;
+
+
+const JAMBONES_SBCS = process.env.JAMBONES_SBCS;
+
+/* websockets */
+const JAMBONES_WS_HANDSHAKE_TIMEOUT_MS = parseInt(process.env.JAMBONES_WS_HANDSHAKE_TIMEOUT_MS, 10) || 1500;
+const JAMBONES_WS_MAX_PAYLOAD = parseInt(process.env.JAMBONES_WS_MAX_PAYLOAD, 10) || 24 * 1024;
+const JAMBONES_WS_PING_INTERVAL_MS = parseInt(process.env.JAMBONES_WS_PING_INTERVAL_MS, 10) || 0;
+const MAX_RECONNECTS = 5;
+const RESPONSE_TIMEOUT_MS = parseInt(process.env.JAMBONES_WS_API_MSG_RESPONSE_TIMEOUT, 10) || 5000;
+
+const JAMBONES_NETWORK_CIDR = process.env.JAMBONES_NETWORK_CIDR;
+const JAMBONES_TIME_SERIES_HOST = process.env.JAMBONES_TIME_SERIES_HOST;
+const JAMBONES_CLUSTER_ID = process.env.JAMBONES_CLUSTER_ID || 'default';
+const JAMBONES_ESL_LISTEN_ADDRESS = process.env.JAMBONES_ESL_LISTEN_ADDRESS;
+
+/* tracing */
+const JAMBONES_OTEL_ENABLED = process.env.JAMBONES_OTEL_ENABLED;
+const JAMBONES_OTEL_SERVICE_NAME = process.env.JAMBONES_OTEL_SERVICE_NAME || 'jambonz-feature-server';
+const OTEL_EXPORTER_JAEGER_AGENT_HOST = process.env.OTEL_EXPORTER_JAEGER_AGENT_HOST;
+const OTEL_EXPORTER_JAEGER_ENDPOINT = process.env.OTEL_EXPORTER_JAEGER_ENDPOINT;
+const OTEL_EXPORTER_ZIPKIN_URL = process.env.OTEL_EXPORTER_ZIPKIN_URL;
+const OTEL_EXPORTER_COLLECTOR_URL = process.env.OTEL_EXPORTER_COLLECTOR_URL;
+
+const JAMBONES_LOGLEVEL = process.env.JAMBONES_LOGLEVEL || 'info';
+const JAMBONES_INJECT_CONTENT = process.env.JAMBONES_INJECT_CONTENT;
+
+const PORT = parseInt(process.env.HTTP_PORT, 10) || 3000;
+const HTTP_PORT_MAX = parseInt(process.env.HTTP_PORT_MAX, 10);
+
+const K8S = process.env.K8S;
+const K8S_SBC_SIP_SERVICE_NAME = process.env.K8S_SBC_SIP_SERVICE_NAME;
+
+const JAMBONES_SUBNET = process.env.JAMBONES_SUBNET;
+
+/* clean up */
+const JAMBONZ_CLEANUP_INTERVAL_MINS = process.env.JAMBONZ_CLEANUP_INTERVAL_MINS;
+const getCleanupIntervalMins = () => {
+  const interval = parseInt(JAMBONZ_CLEANUP_INTERVAL_MINS, 10) || 60;
+  return 1000 * 60 * interval;
+};
+
+/* speech vendors */
+const AWS_REGION = process.env.AWS_REGION;
+const AWS_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID;
+const AWS_SECRET_ACCESS_KEY = process.env.AWS_SECRET_ACCESS_KEY;
+const AWS_SNS_PORT = parseInt(process.env.AWS_SNS_PORT, 10) || 3001;
+const AWS_SNS_TOPIC_ARM = process.env.AWS_SNS_TOPIC_ARM;
+const AWS_SNS_PORT_MAX = parseInt(process.env.AWS_SNS_PORT_MAX, 10) || 3005;
+
+const GCP_JSON_KEY = process.env.GCP_JSON_KEY;
+
+const MICROSOFT_REGION = process.env.MICROSOFT_REGION;
+const MICROSOFT_API_KEY = process.env.MICROSOFT_API_KEY;
+
+const SONIOX_API_KEY = process.env.SONIOX_API_KEY;
+
+const DEEPGRAM_API_KEY = process.env.DEEPGRAM_API_KEY;
+
+const ANCHOR_MEDIA_ALWAYS = process.env.ANCHOR_MEDIA_ALWAYS;
+const VMD_HINTS_FILE = process.env.VMD_HINTS_FILE;
+
+/* security, secrets */
+const LEGACY_CRYPTO = !!process.env.LEGACY_CRYPTO;
+const JWT_SECRET = process.env.JWT_SECRET;
+const ENCRYPTION_SECRET = process.env.ENCRYPTION_SECRET;
+
+/* HTTP/1 pool dispatcher */
+const HTTP_POOL = process.env.HTTP_POOL && parseInt(process.env.HTTP_POOL);
+const HTTP_POOLSIZE = parseInt(process.env.HTTP_POOLSIZE, 10) || 10;
+const HTTP_PIPELINING = parseInt(process.env.HTTP_PIPELINING, 10) || 1;
+const HTTP_TIMEOUT = 10000;
+const HTTP_PROXY_IP = process.env.JAMBONES_HTTP_PROXY_IP;
+const HTTP_PROXY_PORT = process.env.JAMBONES_HTTP_PROXY_PORT;
+const HTTP_PROXY_PROTOCOL = process.env.JAMBONES_HTTP_PROXY_PROTOCOL || 'http';
+const HTTP_USER_AGENT_HEADER = process.env.JAMBONES_HTTP_USER_AGENT_HEADER || 'jambonz';
+
+const OPTIONS_PING_INTERVAL = parseInt(process.env.OPTIONS_PING_INTERVAL, 10) || 30000;
+
+const JAMBONZ_RECORD_WS_BASE_URL = process.env.JAMBONZ_RECORD_WS_BASE_URL || process.env.JAMBONES_RECORD_WS_BASE_URL;
+const JAMBONZ_RECORD_WS_USERNAME = process.env.JAMBONZ_RECORD_WS_USERNAME || process.env.JAMBONES_RECORD_WS_USERNAME;
+const JAMBONZ_RECORD_WS_PASSWORD = process.env.JAMBONZ_RECORD_WS_PASSWORD || process.env.JAMBONES_RECORD_WS_PASSWORD;
+const JAMBONZ_DISABLE_DIAL_PAI_HEADER = process.env.JAMBONZ_DISABLE_DIAL_PAI_HEADER || false;
+const JAMBONES_DISABLE_DIRECT_P2P_CALL = process.env.JAMBONES_DISABLE_DIRECT_P2P_CALL || false;
+
+const JAMBONES_EAGERLY_PRE_CACHE_AUDIO = process.env.JAMBONES_EAGERLY_PRE_CACHE_AUDIO;
+
+module.exports = {
+  JAMBONES_MYSQL_HOST,
+  JAMBONES_MYSQL_USER,
+  JAMBONES_MYSQL_PASSWORD,
+  JAMBONES_MYSQL_DATABASE,
+  JAMBONES_MYSQL_REFRESH_TTL,
+  JAMBONES_MYSQL_CONNECTION_LIMIT,
+  JAMBONES_MYSQL_PORT,
+
+  DRACHTIO_PORT,
+  DRACHTIO_HOST,
+  DRACHTIO_SECRET,
+
+  JAMBONES_GATHER_EARLY_HINTS_MATCH,
+  JAMBONZ_GATHER_EARLY_HINTS_MATCH,
+  JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS,
+  JAMBONES_FREESWITCH,
+  SMPP_URL,
+  JAMBONES_NETWORK_CIDR,
+  JAMBONES_API_BASE_URL,
+  JAMBONES_TIME_SERIES_HOST,
+  JAMBONES_INJECT_CONTENT,
+  JAMBONES_EAGERLY_PRE_CACHE_AUDIO,
+  JAMBONES_ESL_LISTEN_ADDRESS,
+  JAMBONES_SBCS,
+  JAMBONES_OTEL_ENABLED,
+  JAMBONES_OTEL_SERVICE_NAME,
+  OTEL_EXPORTER_JAEGER_AGENT_HOST,
+  OTEL_EXPORTER_JAEGER_ENDPOINT,
+  OTEL_EXPORTER_ZIPKIN_URL,
+  OTEL_EXPORTER_COLLECTOR_URL,
+
+  JAMBONES_LOGLEVEL,
+  JAMBONES_CLUSTER_ID,
+  PORT,
+  HTTP_PORT_MAX,
+  K8S,
+  K8S_SBC_SIP_SERVICE_NAME,
+  JAMBONES_SUBNET,
+  NODE_ENV,
+  JAMBONZ_CLEANUP_INTERVAL_MINS,
+  getCleanupIntervalMins,
+  checkEnvs,
+
+  AWS_REGION,
+  AWS_ACCESS_KEY_ID,
+  AWS_SECRET_ACCESS_KEY,
+  AWS_SNS_PORT,
+  AWS_SNS_TOPIC_ARM,
+  AWS_SNS_PORT_MAX,
+
+  ANCHOR_MEDIA_ALWAYS,
+  VMD_HINTS_FILE,
+  JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS,
+
+  LEGACY_CRYPTO,
+  JWT_SECRET,
+  ENCRYPTION_SECRET,
+  HTTP_POOL,
+  HTTP_POOLSIZE,
+  HTTP_PIPELINING,
+  HTTP_TIMEOUT,
+  HTTP_PROXY_IP,
+  HTTP_PROXY_PORT,
+  HTTP_PROXY_PROTOCOL,
+  HTTP_USER_AGENT_HEADER,
+  OPTIONS_PING_INTERVAL,
+  RESPONSE_TIMEOUT_MS,
+  JAMBONES_WS_HANDSHAKE_TIMEOUT_MS,
+  JAMBONES_WS_MAX_PAYLOAD,
+  JAMBONES_WS_PING_INTERVAL_MS,
+  MAX_RECONNECTS,
+  GCP_JSON_KEY,
+  MICROSOFT_REGION,
+  MICROSOFT_API_KEY,
+  SONIOX_API_KEY,
+  DEEPGRAM_API_KEY,
+  JAMBONZ_RECORD_WS_BASE_URL,
+  JAMBONZ_RECORD_WS_USERNAME,
+  JAMBONZ_RECORD_WS_PASSWORD,
+  JAMBONZ_DISABLE_DIAL_PAI_HEADER,
+  JAMBONES_DISABLE_DIRECT_P2P_CALL
+};

lib/dynamic-apps.js

@@ -0,0 +1,54 @@
+const appsMap = {
+  queue: {
+    // Dummy hook to follow later feature server logic.
+    call_hook: {
+      url: 'https://jambonz.org',
+      method: 'GET'
+    },
+    account_sid: '',
+    app_json: [{
+      verb: 'dequeue',
+      name: '',
+      timeout: 5
+    }]
+  },
+  user: {
+    // Dummy hook to follow later feature server logic.
+    call_hook: {
+      url: 'https://jambonz.org',
+      method: 'GET'
+    },
+    account_sid: '',
+    app_json: [{
+      verb: 'dial',
+      callerId: '',
+      answerOnBridge: true,
+      target: [
+        {
+          type: 'user',
+          name: ''
+        }
+      ]
+    }]
+  }
+};
+
+const createJambonzApp = (type, {account_sid, name, caller_id}) => {
+  const app = {...appsMap[type]};
+  app.account_sid = account_sid;
+  switch (type) {
+    case 'queue':
+      app.app_json[0].name = name;
+      break;
+    case 'user':
+      app.app_json[0].callerId = caller_id;
+      app.app_json[0].target[0].name = name;
+      break;
+  }
+  app.app_json = JSON.stringify(app.app_json);
+  return app;
+};
+
+module.exports = {
+  createJambonzApp
+};

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

@@ -3,249 +3,339 @@ const makeTask = require('../../tasks/make_task');
 const RestCallSession = require('../../session/rest-call-session');
 const CallInfo = require('../../session/call-info');
 const {CallDirection, CallStatus} = require('../../utils/constants');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const SipError = require('drachtio-srf').SipError;
+const { validationResult, body } = require('express-validator');
+const { validate } = require('@jambonz/verb-specifications');
 const sysError = require('./error');
 const HttpRequestor = require('../../utils/http-requestor');
 const WsRequestor = require('../../utils/ws-requestor');
 const RootSpan = require('../../utils/call-tracer');
 const dbUtils = require('../../utils/db-utils');
+const { mergeSdpMedia, extractSdpMedia } = require('../../utils/sdp-utils');
+const { createCallSchema, customSanitizeFunction } = require('../schemas/create-call');
 
-router.post('/', async(req, res) => {
-  const {logger} = req.app.locals;
-  const accountSid = req.body.account_sid;
-  const {srf} = require('../../..');
+const removeNullProperties = (obj) => (Object.keys(obj).forEach((key) => obj[key] === null && delete obj[key]), obj);
+const removeNulls = (req, res, next) => {
+  req.body = removeNullProperties(req.body);
+  next();
+};
 
-  logger.debug({body: req.body}, 'got createCall request');
-  try {
-    let uri, cs, to;
-    const restDial = makeTask(logger, {'rest:dial': req.body});
-    const {lookupAccountDetails} = dbUtils(logger, srf);
-    const {getSBC, getFreeswitch} = srf.locals;
-    const sbcAddress = getSBC();
-    if (!sbcAddress) throw new Error('no available SBCs for outbound call creation');
-    const target = restDial.to;
-    const opts = {
-      callingNumber: restDial.from,
-      headers: req.body.headers || {}
-    };
+router.post('/',
+  removeNulls,
+  createCallSchema,
+  body('tag').custom((value) => {
+    if (value) {
+      customSanitizeFunction(value);
+    }
+    return true;
+  }),
+  async(req, res) => {
+    const {logger} = req.app.locals;
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) {
+      logger.info({errors: errors.array()}, 'POST /Calls: validation errors');
+      return res.status(400).json({ errors: errors.array() });
+    }
+    const accountSid = req.body.account_sid;
+    const {srf} = require('../../..');
 
-
-    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;
-        to = uri;
-        break;
+    const app_json = req.body['app_json'];
+    try {
+    // app_json is created only by api-server.
+      if (app_json) {
+        // if available, delete from req before creating task
+        delete req.body.app_json;
+        // validate possible app_json via verb-specifications
+        validate(logger, JSON.parse(app_json));
+      }
+    } catch (err) {
+      logger.debug({ err }, `invalid app_json: ${err.message}`);
     }
 
-    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;
+    logger.debug({body: req.body}, 'got createCall request');
+    try {
+      let uri, cs, to;
+
+      const restDial = makeTask(logger, { 'rest:dial': req.body });
+      restDial.appJson = app_json;
+
+      const {lookupAccountDetails, lookupCarrierByPhoneNumber, lookupCarrier} = dbUtils(logger, srf);
+      const {
+        lookupAppBySid
+      }  = srf.locals.dbHelpers;
+      const {getSBC, getFreeswitch} = srf.locals;
+      const sbcAddress = getSBC();
+      if (!sbcAddress) throw new Error('no available SBCs for outbound call creation');
+      const target = restDial.to;
+      const opts = {
+        callingNumber: restDial.from,
+        ...(restDial.callerName && {callingName: restDial.callerName}),
+        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();
+      const application = req.body.application_sid ? await lookupAppBySid(req.body.application_sid) : null;
+      const record_all_calls = account.record_all_calls || (application && application.record_all_calls);
+      const recordOutputFormat = account.record_format || 'mp3';
+      const rootSpan = new RootSpan('rest-call', {
+        callSid,
+        accountSid,
+        ...(req.body?.application_sid && {'X-Application-Sid': req.body.application_sid})
+      });
+
+      opts.headers = {
+        ...opts.headers,
+        'X-Jambonz-Routing': target.type,
+        'X-Jambonz-FS-UUID': srf.locals.fsUUID,
+        'X-Call-Sid': callSid,
+        'X-Account-Sid': accountSid,
+        'X-Trace-ID': rootSpan.traceId,
+        ...(req.body?.application_sid && {'X-Application-Sid': req.body.application_sid}),
+        ...(restDial.fromHost && {'X-Preferred-From-Host': restDial.fromHost}),
+        ...(record_all_calls && {'X-Record-All-Calls': recordOutputFormat})
+      };
+
+      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;
+          to = uri;
+          break;
       }
-    }
 
-    /* create endpoint for outdial */
-    const ms = getFreeswitch();
-    if (!ms) throw new Error('no available Freeswitch for outbound call creation');
-    const ep = await ms.createEndpoint();
-    logger.debug(`createCall: successfully allocated endpoint, sending INVITE to ${sbcAddress}`);
-
-    /* launch outdial */
-    let sdp, sipLogger;
-    const connectStream = async(remoteSdp) => {
-      if (remoteSdp !== sdp) {
-        ep.modify(sdp = remoteSdp);
-        return true;
+      if (target.type === 'phone' && target.trunk) {
+        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;
+        }
       }
-      return false;
-    };
-    Object.assign(opts, {
-      proxy: `sip:${sbcAddress}`,
-      localSdp: ep.local.sdp
-    });
-    if (target.auth) opts.auth = this.target.auth;
+
+      /**
+     * trunk isn't specified,
+     * check if from-number matches any existing numbers on Jambonz
+     *  */
+      if (target.type === 'phone' && !target.trunk) {
+        const str = restDial.from || '';
+        const callingNumber = str.startsWith('+') ? str.substring(1) : str;
+        const voip_carrier_sid = await lookupCarrierByPhoneNumber(req.body.account_sid, callingNumber);
+        logger.info(
+          `createCall: selected ${voip_carrier_sid} for requested phone number: ${callingNumber || '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');
+      const ep = await ms.createEndpoint();
+      logger.debug(`createCall: successfully allocated endpoint, sending INVITE to ${sbcAddress}`);
+
+      /* launch outdial */
+      let sdp, sipLogger;
+      let dualEp;
+      let localSdp = ep.local.sdp;
+
+      if (req.body.dual_streams) {
+        dualEp = await ms.createEndpoint();
+        localSdp = mergeSdpMedia(localSdp, dualEp.local.sdp);
+      }
+
+      const connectStream = async(remoteSdp) => {
+        if (remoteSdp !== sdp) {
+          sdp = remoteSdp;
+          if (req.body.dual_streams) {
+            const [sdpLegA, sdpLebB] = extractSdpMedia(remoteSdp);
+
+            await ep.modify(sdpLegA);
+            await dualEp.modify(sdpLebB);
+            await ep.bridge(dualEp);
+          } else {
+            ep.modify(sdp);
+          }
+          return true;
+        }
+        return false;
+      };
+      Object.assign(opts, {
+        proxy: `sip:${sbcAddress}`,
+        localSdp
+      });
+      if (target.auth) opts.auth = target.auth;
 
 
-    /**
+      /**
      * create our application object -
      * not from the database as per an inbound call,
      * but from the provided params in the request
      */
-    const app = req.body;
+      const app = req.body;
 
-    /**
+      /**
      * attach our requestor and notifier objects
      * these will be used for all http requests we make during this call
      */
-    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;
+      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: () => {}};
       }
-    }
-    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: () => {}};
-    }
 
-    /* now launch the outdial */
-    try {
-      const dlg = await srf.createUAC(uri, {...opts,  followRedirects: true, keepUriOnRedirect: true}, {
-        cbRequest: (err, inviteReq) => {
+      /* now launch the outdial */
+      try {
+        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 (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];
+            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,
+              traceId: rootSpan.traceId
+            });
+            cs = new RestCallSession({
+              logger: sipLogger,
+              application: app,
+              srf,
+              req: inviteReq,
+              ep,
+              ep2: dualEp,
+              tasks,
+              callInfo,
+              accountInfo,
+              rootSpan
+            });
+            cs.exec(req);
+
+            res.status(201).json({sid: cs.callSid, callId: inviteReq.get('Call-ID')});
+
+            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;
+            if ([180, 183].includes(prov.status) && prov.body) connectStream(prov.body);
+            restDial.emit('callStatus', prov.status, !!prov.body);
+            cs.emit('callStatusChange', {callStatus, sipStatus: prov.status});
           }
-
-          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
+        });
+        connectStream(dlg.remote.sdp);
+        cs.emit('callStatusChange', {
+          callStatus: CallStatus.InProgress,
+          sipStatus: 200,
+          sipReason: 'OK'
+        });
+        restDial.emit('callStatus', 200);
+        restDial.emit('connect', dlg);
+      }
+      catch (err) {
+        let callStatus = CallStatus.Failed;
+        if (err instanceof SipError) {
+          if ([486, 603].includes(err.status)) callStatus = CallStatus.Busy;
+          else if (487 === err.status) callStatus = CallStatus.NoAnswer;
+          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
           });
-          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,
-            traceId: rootSpan.traceId
-          });
-          cs = new RestCallSession({
-            logger: sipLogger,
-            application: app,
-            srf,
-            req: inviteReq,
-            ep,
-            tasks,
-            callInfo,
-            accountInfo,
-            rootSpan
-          });
-          cs.exec(req);
-
-          res.status(201).json({sid: cs.callSid, callId: inviteReq.get('Call-ID')});
-
-          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;
-          if ([180, 183].includes(prov.status) && prov.body) connectStream(prov.body);
-          restDial.emit('callStatus', prov.status, !!prov.body);
-          cs.emit('callStatusChange', {callStatus, sipStatus: prov.status});
+          cs.callGone = true;
         }
-      });
-      connectStream(dlg.remote.sdp);
-      cs.emit('callStatusChange', {
-        callStatus: CallStatus.InProgress,
-        sipStatus: 200,
-        sipReason: 'OK'
-      });
-      restDial.emit('callStatus', 200);
-      restDial.emit('connect', dlg);
-    }
-    catch (err) {
-      let callStatus = CallStatus.Failed;
-      if (err instanceof SipError) {
-        if ([486, 603].includes(err.status)) callStatus = CallStatus.Busy;
-        else if (487 === err.status) callStatus = CallStatus.NoAnswer;
-        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 {
+          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();
+        if (dualEp) {
+          dualEp.destroy();
+        }
+        setTimeout(restDial.kill.bind(restDial, cs), 5000);
       }
-      else {
-        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);
     }
-  } catch (err) {
-    sysError(logger, res, err);
-  }
-});
+  });
 
 module.exports = router;

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

@@ -2,7 +2,7 @@ const router = require('express').Router();
 const CallInfo = require('../../session/call-info');
 const {CallDirection} = require('../../utils/constants');
 const SmsSession = require('../../session/sms-call-session');
-const normalizeJambones = require('../../utils/normalize-jambones');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 const makeTask = require('../../tasks/make_task');
 
 router.post('/:sid', async(req, res) => {

lib/http-routes/api/messaging.js

@@ -4,7 +4,7 @@ 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('../../utils/normalize-jambones');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 const {TaskPreconditions} = require('../../utils/constants');
 const makeTask = require('../../tasks/make_task');
 
@@ -34,6 +34,7 @@ router.post('/:partner', async(req, res) => {
     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,

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

@@ -9,25 +9,29 @@ const {CallStatus, CallDirection} = require('../../utils/constants');
  */
 function retrieveCallSession(callSid, opts) {
   if (opts.call_status_hook && !opts.call_hook) {
-    throw new DbErrorBadRequest('call_status_hook can be updated only when call_hook is also being updated');
+    throw new DbErrorBadRequest(
+      `call_status_hook can be updated only when call_hook is also being updated for call_sid ${callSid}`);
   }
   const cs = sessionTracker.get(callSid);
   if (!cs) {
-    throw new DbErrorUnprocessableRequest('call session is gone');
+    throw new DbErrorUnprocessableRequest(`call session is gone for call_sid ${callSid}`);
   }
 
   if (opts.call_status === CallStatus.Completed && !cs.hasStableDialog) {
-    throw new DbErrorUnprocessableRequest('current call state is incompatible with requested action');
+    throw new DbErrorUnprocessableRequest(
+      `current call state is incompatible with requested action for call_sid ${callSid}`);
   }
   else if (opts.call_status === CallStatus.NoAnswer) {
     if (cs.direction === CallDirection.Outbound) {
       if (!cs.isOutboundCallRinging) {
-        throw new DbErrorUnprocessableRequest('current call state is incompatible with requested action');
+        throw new DbErrorUnprocessableRequest(
+          `current call state is incompatible with requested action for call_sid ${callSid}`);
       }
     }
     else {
       if (cs.isInboundCallAnswered) {
-        throw new DbErrorUnprocessableRequest('current call state is incompatible with requested action');
+        throw new DbErrorUnprocessableRequest(
+          `current call state is incompatible with requested action for call_sid ${callSid}`);
       }
     }
   }
@@ -41,7 +45,7 @@ function retrieveCallSession(callSid, opts) {
 router.post('/:callSid', async(req, res) => {
   const logger = req.app.locals.logger;
   const callSid = req.params.callSid;
-  logger.debug({body: req.body}, 'got upateCall request');
+  logger.debug({body: req.body}, 'got updateCall request');
   try {
     const cs = retrieveCallSession(callSid, req.body);
     if (!cs) {

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

@@ -0,0 +1,134 @@
+const { checkSchema } = require('express-validator');
+
+/**
+ * @path api-server {{base_url}}/v1/Accounts/:account_sid/Calls
+ * @see https://api.jambonz.org/#243a2edd-7999-41db-bd0d-08082bbab401
+ */
+const createCallSchema = checkSchema({
+  application_sid: {
+    isString: true,
+    optional: true,
+    isLength: { options: { min: 36, max: 36 } },
+    errorMessage: 'Invalid application_sid',
+  },
+  answerOnBridge: {
+    isBoolean: true,
+    optional: true,
+    errorMessage: 'Invalid answerOnBridge',
+  },
+  from: {
+    errorMessage: 'Invalid from',
+    isString: true,
+    isLength: {
+      options: { min: 1, max: 256 },
+    },
+  },
+  fromHost: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid fromHost',
+  },
+  to: {
+    errorMessage: 'Invalid to',
+    isObject: true,
+  },
+  callerName: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid callerName',
+  },
+  amd: {
+    isObject: true,
+    optional: true,
+  },
+  tag: {
+    isObject: true,
+    optional: true,
+    errorMessage: 'Invalid tag',
+  },
+  app_json: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid app_json',
+  },
+  account_sid: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid account_sid',
+    isLength: { options: { min: 36, max: 36 } },
+  },
+  timeout: {
+    isInt: true,
+    optional: true,
+    errorMessage: 'Invalid timeout',
+  },
+  timeLimit: {
+    isInt: true,
+    optional: true,
+    errorMessage: 'Invalid timeLimit',
+  },
+  call_hook: {
+    isObject: true,
+    optional: true,
+    errorMessage: 'Invalid call_hook',
+  },
+  call_status_hook: {
+    isObject: true,
+    optional: true,
+    errorMessage: 'Invalid call_status_hook',
+  },
+  speech_synthesis_vendor: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid speech_synthesis_vendor',
+  },
+  speech_synthesis_language: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid speech_synthesis_language',
+  },
+  speech_synthesis_voice: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid speech_synthesis_voice',
+  },
+  speech_recognizer_vendor: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid speech_recognizer_vendor',
+  },
+  speech_recognizer_language: {
+    isString: true,
+    optional: true,
+    errorMessage: 'Invalid speech_recognizer_language',
+  }
+}, ['body']);
+
+const customSanitizeFunction = (value) => {
+  try {
+    if (Array.isArray(value)) {
+      value = value.map((item) => customSanitizeFunction(item));
+    } else if (typeof value === 'object') {
+      Object.keys(value).forEach((key) => {
+        value[key] = customSanitizeFunction(value[key]);
+      });
+    } else if (typeof value === 'string') {
+      /* trims characters at the beginning and at the end of a string */
+      value = value.trim();
+
+      /* Verify strings including 'http' via new URL */
+      if (value.includes('http')) {
+        value = new URL(value).toString();
+      }
+    }
+  } catch (error) {
+    value = `Error: ${error.message}`;
+  }
+
+  return value;
+};
+
+module.exports = {
+  createCallSchema,
+  customSanitizeFunction
+};

lib/middleware.js

@@ -1,4 +1,4 @@
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const {CallDirection, AllowedSipRecVerbs} = require('./utils/constants');
 const {parseSiprecPayload} = require('./utils/siprec-utils');
 const CallInfo = require('./session/call-info');
@@ -6,10 +6,15 @@ 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');
+const {
+  JAMBONES_MYSQL_REFRESH_TTL,
+  JAMBONES_DISABLE_DIRECT_P2P_CALL
+} = require('./config');
+const { createJambonzApp } = require('./dynamic-apps');
 
 module.exports = function(srf, logger) {
   const {
@@ -17,17 +22,25 @@ module.exports = function(srf, logger) {
     lookupAppByRegex,
     lookupAppBySid,
     lookupAppByRealm,
-    lookupAppByTeamsTenant
+    lookupAppByTeamsTenant,
+    registrar,
+    lookupClientByAccountAndUsername
   }  = srf.locals.dbHelpers;
   const {
     writeAlerts,
     AlertType
   } = srf.locals;
-  const {lookupAccountDetails} = dbUtils(logger, srf);
+  const {lookupAccountDetails, lookupGoogleCustomVoice} = dbUtils(logger, srf);
 
-  function initLocals(req, res, next) {
+  async function initLocals(req, res, next) {
     const callId = req.get('Call-ID');
-    logger.info({callId}, 'new incoming call');
+    const uri = parseUri(req.uri);
+    logger.info({
+      uri,
+      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);
@@ -35,14 +48,63 @@ module.exports = function(srf, logger) {
     const callSid = req.has('X-Retain-Call-Sid') ? req.get('X-Retain-Call-Sid') : uuidv4();
     const account_sid = req.get('X-Account-Sid');
     req.locals = {callSid, account_sid, callId};
-    if (req.has('X-Application-Sid')) {
+
+    let clientDb = null;
+    if (req.has('X-Authenticated-User')) {
+      req.locals.originatingUser = req.get('X-Authenticated-User');
+      let clientSettings;
+      const arr = /^(.*)@(.*)/.exec(req.locals.originatingUser);
+      if (arr) {
+        [clientSettings] = await lookupClientByAccountAndUsername(account_sid, arr[1]);
+      }
+      clientDb = await registrar.query(req.locals.originatingUser);
+      clientDb = {
+        ...clientDb,
+        ...clientSettings,
+      };
+    }
+
+    // check for call to application
+    if (uri.user?.startsWith('app-') && req.locals.originatingUser && clientDb?.allow_direct_app_calling) {
+      const application_sid = uri.user.match(/app-(.*)/)[1];
+      logger.debug(`got application from Request URI header: ${application_sid}`);
+      req.locals.application_sid = application_sid;
+    } else if (req.has('X-Application-Sid')) {
       const application_sid = req.get('X-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');
+    // check for call to queue
+    if (uri.user?.startsWith('queue-') && req.locals.originatingUser && clientDb?.allow_direct_queue_calling) {
+      const queue_name = uri.user.match(/queue-(.*)/)[1];
+      logger.debug(`got Queue from Request URI header: ${queue_name}`);
+      req.locals.queue_name = queue_name;
+    }
+    // check for call to registered user
+    if (!JAMBONES_DISABLE_DIRECT_P2P_CALL && req.locals.originatingUser && clientDb?.allow_direct_user_calling) {
+      const arr = /^(.*)@(.*)/.exec(req.locals.originatingUser);
+      if (arr) {
+        const sipRealm = arr[2];
+        const called_user = `${req.calledNumber}@${sipRealm}`;
+        const reg = await registrar.query(called_user);
+        if (reg) {
+          logger.debug(`got called Number is a registered user: ${called_user}`);
+          req.locals.called_user = called_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();
   }
 
@@ -90,8 +152,10 @@ module.exports = function(srf, logger) {
           .find((p) => p.type === 'application/sdp')
           .content;
         const {sdp1, sdp2, ...metadata} = await parseSiprecPayload(req, logger);
-        req.locals.calledNumber = metadata.caller.number;
-        req.locals.callingNumber = metadata.callee.number;
+        if (!req.locals.calledNumber && !req.locals.calledNumber) {
+          req.locals.calledNumber = metadata.caller.number;
+          req.locals.callingNumber = metadata.callee.number;
+        }
         req.locals = {
           ...req.locals,
           siprec: {
@@ -102,7 +166,7 @@ module.exports = function(srf, logger) {
         };
         logger.info({callId, metadata, sdp}, 'successfully parsed SIPREC payload');
       } catch (err) {
-        logger.info({callId}, 'Error parsing multipart payload');
+        logger.info({err, callId}, 'Error parsing multipart payload');
         return res.send(503);
       }
     }
@@ -118,6 +182,7 @@ module.exports = function(srf, logger) {
     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}`);
@@ -165,15 +230,24 @@ module.exports = function(srf, logger) {
     const {span} = rootSpan.startChildSpan('lookupApplication');
     try {
       let app;
-      if (req.locals.application_sid) app = await lookupAppBySid(req.locals.application_sid);
-      else if (req.locals.originatingUser) {
+      if (req.locals.queue_name) {
+        logger.debug(`calling to queue ${req.locals.queue_name}, generating queue app`);
+        app = createJambonzApp('queue', {account_sid, name: req.locals.queue_name});
+      } else if (req.locals.called_user) {
+        logger.debug(`calling to registered user ${req.locals.called_user}, generating dial app`);
+        app = createJambonzApp('user',
+          {account_sid, name: req.locals.called_user, caller_id: req.locals.callingNumber});
+      } else if (req.locals.application_sid) {
+        app = await lookupAppBySid(req.locals.application_sid);
+      } else if (req.locals.originatingUser) {
         const arr = /^(.*)@(.*)/.exec(req.locals.originatingUser);
         if (arr) {
           const sipRealm = arr[2];
           logger.debug(`looking for device calling app for realm ${sipRealm}`);
           app = await lookupAppByRealm(sipRealm);
-          if (app) logger.debug({app}, `retrieved device calling app for realm ${sipRealm}`);
-
+          if (app) {
+            logger.debug({app}, `retrieved device calling app for realm ${sipRealm}`);
+          }
         }
       }
       else if (req.locals.msTeamsTenant) {
@@ -224,29 +298,48 @@ 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).
       */
+
+      /* allow for caching data - when caching treat retrieved data as immutable */
+      const app2 = 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://')) {
-        app.requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
-        app.notifier = app.requestor;
-        app.call_hook.method = 'WS';
+        const requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
+        app2.requestor = requestor;
+        app2.notifier = requestor;
+        app2.call_hook.method = 'WS';
       }
       else {
-        app.requestor = new HttpRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
-        if (app.call_status_hook) app.notifier = new HttpRequestor(logger, account_sid, app.call_status_hook,
+        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 app.notifier = {request: () => {}};
+        else app2.notifier = {request: () => {}, close: () => {}};
       }
 
-      req.locals.application = app;
-      const obj = Object.assign({}, app);
-      delete obj.requestor;
-      delete obj.notifier;
+      // Resolve application.speech_synthesis_voice if it's custom voice
+      if (app2.speech_synthesis_vendor === 'google' && app2.speech_synthesis_voice.startsWith('custom_')) {
+        const arr = /custom_(.*)/.exec(app2.speech_synthesis_voice);
+        if (arr) {
+          const google_custom_voice_sid = arr[1];
+          const [custom_voice] = await lookupGoogleCustomVoice(google_custom_voice_sid);
+          if (custom_voice) {
+            app2.speech_synthesis_voice = {
+              reportedUsage: custom_voice.reported_usage,
+              model: custom_voice.model
+            };
+          }
+        }
+      }
+
+      req.locals.application = app2;
+
       // eslint-disable-next-line no-unused-vars
-      const {call_hook, call_status_hook, ...appInfo} = obj;  // mask sensitive data like user/pass on webhook
-      logger.info({app: appInfo}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
+      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,
+        app: app2,
         direction: CallDirection.Inbound,
         traceId: rootSpan.traceId
       });
@@ -266,38 +359,54 @@ module.exports = function(srf, logger) {
     const {rootSpan, siprec, application:app} = req.locals;
     let span;
     try {
-      if (app.tasks && !process.env.JAMBONES_MYSQL_REFRESH_TTL) {
+      if (app.tasks && !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(['POST', 'WS'].includes(app.call_hook.method) ? {sip: req.msg} : {},
-        req.locals.callInfo, {
-          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
-            }
+      let json;
+      if (app.app_json) {
+        json = JSON.parse(app.app_json);
+      } else {
+        const defaults = {
+          synthesizer: {
+            vendor: app.speech_synthesis_vendor,
+            ...(app.speech_synthesis_label && {label: app.speech_synthesis_label}),
+            language: app.speech_synthesis_language,
+            voice: app.speech_synthesis_voice,
+            ...(app.fallback_speech_synthesis_vendor && {fallback_vendor: app.fallback_speech_synthesis_vendor}),
+            ...(app.fallback_speech_synthesis_label && {fallback_label: app.fallback_speech_synthesis_label}),
+            ...(app.fallback_speech_synthesis_language && {fallback_language: app.fallback_speech_synthesis_language}),
+            ...(app.fallback_speech_synthesis_voice && {fallback_voice: app.fallback_speech_synthesis_voice})
+          },
+          recognizer: {
+            vendor: app.speech_recognizer_vendor,
+            ...(app.speech_recognizer_label && {label: app.speech_recognizer_label}),
+            language: app.speech_recognizer_language,
+            ...(app.fallback_speech_recognizer_vendor && {fallback_vendor: app.fallback_speech_recognizer_vendor}),
+            ...(app.fallback_speech_recognizer_label && {fallback_label: app.fallback_speech_recognizer_label}),
+            ...(app.fallback_speech_recognizer_language && {fallback_language: app.fallback_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};
-      const json = await app.requestor.request('session:new', app.call_hook, params, httpHeaders);
+        };
+        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 });
+        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({
+      span?.setAttributes({
         'http.statusCode': 200,
         'app.tasks': listTaskNames(app.tasks)
       });
-      span.end();
+      span?.end();
       if (0 === app.tasks.length) throw new Error('no application provided');
 
       if (siprec) {

lib/session/adulting-call-session.js

@@ -1,4 +1,6 @@
 const CallSession = require('./call-session');
+const {CallStatus} = require('../utils/constants');
+const moment = require('moment');
 
 /**
  * @classdesc Subclass of CallSession.  Represents a CallSession
@@ -19,12 +21,14 @@ class AdultingCallSession extends CallSession {
       rootSpan
     });
     this.sd = singleDialer;
+    this.req = callInfo.req;
 
     this.sd.dlg.on('destroy', () => {
       this.logger.info('AdultingCallSession: called party hung up');
       this._callReleased();
     });
     this.sd.emit('adulting');
+    this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
   }
 
   get dlg() {
@@ -49,6 +53,18 @@ class AdultingCallSession extends CallSession {
   }
 
   _callerHungup() {
+    if (this.dlg.connectTime) {
+      const duration = moment().diff(this.dlg.connectTime, 'seconds');
+      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/call-info.js

@@ -1,6 +1,7 @@
 const {CallDirection, CallStatus} = require('../utils/constants');
 const parseUri = require('drachtio-srf').parseUri;
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
+const {JAMBONES_API_BASE_URL} = require('../config');
 /**
  * @classdesc Represents the common information for all calls
  * that is provided in call status webhooks
@@ -33,6 +34,23 @@ class CallInfo {
       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
@@ -129,8 +147,8 @@ class CallInfo {
       Object.assign(obj, {customerData: this._customerData});
     }
 
-    if (process.env.JAMBONES_API_BASE_URL) {
-      Object.assign(obj, {apiBaseUrl: process.env.JAMBONES_API_BASE_URL});
+    if (JAMBONES_API_BASE_URL) {
+      Object.assign(obj, {apiBaseUrl: JAMBONES_API_BASE_URL});
     }
     if (this.publicIp) {
       Object.assign(obj, {fsPublicIp: this.publicIp});

lib/session/rest-call-session.js

@@ -8,7 +8,7 @@ const moment = require('moment');
  * @extends CallSession
  */
 class RestCallSession extends CallSession {
-  constructor({logger, application, srf, req, ep, tasks, callInfo, accountInfo, rootSpan}) {
+  constructor({logger, application, srf, req, ep, ep2, tasks, callInfo, accountInfo, rootSpan}) {
     super({
       logger,
       application,
@@ -21,6 +21,11 @@ class RestCallSession extends CallSession {
     });
     this.req = req;
     this.ep = ep;
+    this.ep2 = ep2;
+    // keep restDialTask reference for closing AMD
+    if (tasks.length) {
+      this.restDialTask = tasks[0];
+    }
 
     this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
     this._notifyCallStatusChange({
@@ -44,6 +49,9 @@ class RestCallSession extends CallSession {
    * This is invoked when the called party hangs up, in order to calculate the call duration.
    */
   _callerHungup() {
+    if (this.restDialTask) {
+      this.restDialTask.turnOffAmd();
+    }
     this.callInfo.callTerminationBy = 'caller';
     const duration = moment().diff(this.dlg.connectTime, 'seconds');
     this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});

lib/session/siprec-call-session.js

@@ -1,6 +1,7 @@
 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.
@@ -16,6 +17,32 @@ class SipRecCallSession extends InboundCallSession {
     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();

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');
@@ -48,7 +48,7 @@ class Conference extends Task {
     this.confName = this.data.name;
     [
       'beep', 'startConferenceOnEnter', 'endConferenceOnExit', 'joinMuted',
-      'maxParticipants', 'waitHook', 'statusHook', 'endHook', 'enterHook'
+      'maxParticipants', 'waitHook', 'statusHook', 'endHook', 'enterHook', 'endConferenceDuration'
     ].forEach((attr) => this[attr] = this.data[attr]);
     this.record = this.data.record || {};
     this.statusEvents = [];
@@ -108,9 +108,18 @@ 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::*') ;
+    if (this.ep && this.ep.connected) {
+      this.ep.conn.removeAllListeners('esl::event::CUSTOM::*');
+      this.ep.api(`conference ${this.confName} kick ${this.memberId}`)
+        .catch((err) => this.logger.info({err}, 'Error kicking participant'));
+    }
+    cs.clearConferenceDetails();
     this.notifyTaskDone();
   }
 
@@ -335,9 +344,13 @@ 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}});
+    if (this.endConferenceOnExit || this.startConferenceOnEnter || this.joinMuted) {
+      Object.assign(opts, {flags: {
+        ...(this.endConferenceOnExit && {endconf: true}),
+        ...(this.startConferenceOnEnter && {moderator: true}),
+        ...(this.joinMuted && {joinMuted: true}),
+      }});
+    }
 
     try {
       const {memberId, confUuid} = await this.ep.join(this.confName, opts);
@@ -380,6 +393,11 @@ class Conference extends Task {
       this.ep.api('conference', `${this.confName} set max_members ${this.maxParticipants}`)
         .catch((err) => this.logger.error(err, `Error setting max participants to ${this.maxParticipants}`));
     }
+
+    if (typeof this.endConferenceDuration === 'number' && this.endConferenceDuration >= 0) {
+      this.ep.api('conference', `${this.confName} set endconference_grace_time ${this.endConferenceDuration}`)
+        .catch((err) => this.logger.error(err, `Error setting end conference time to ${this.endConferenceDuration}`));
+    }
   }
 
   /**
@@ -427,13 +445,19 @@ class Conference extends Task {
         .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 (wait_hook && this.conf_hold_status === 'hold') {
+    if (this.wait_hook?.url && this.conf_hold_status === 'hold') {
       const {dlg} = cs;
-      this._doWaitHookWhileOnHold(cs, dlg, wait_hook);
+      this._doWaitHookWhileOnHold(cs, dlg, this.wait_hook);
     }
     else if (this.conf_hold_status !== 'hold' && this._playSession) {
       this._playSession.kill();
@@ -444,7 +468,9 @@ class Conference extends Task {
   async _doWaitHookWhileOnHold(cs, dlg, wait_hook) {
     do {
       try {
-        const tasks = await this._playHook(cs, dlg, wait_hook);
+        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) {
@@ -571,6 +597,10 @@ 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);
   }
 

lib/tasks/config.js

@@ -8,9 +8,15 @@ class TaskConfig extends Task {
       'synthesizer',
       'recognizer',
       'bargeIn',
-      'record'
+      'record',
+      'listen',
+      'transcribe'
     ].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',
@@ -25,20 +31,45 @@ class TaskConfig extends Task {
         if (this.bargeIn[k]) this.gatherOpts[k] = this.bargeIn[k];
       });
     }
+    if (this.transcribe?.enable) {
+      this.transcribeOpts = {
+        verb: 'transcribe',
+        ...this.transcribe
+      };
+      delete this.transcribeOpts.enable;
+    }
+
+    if (this.data.reset) {
+      if (typeof this.data.reset === 'string') this.data.reset = [this.data.reset];
+    }
+    else this.data.reset = [];
+
     if (this.bargeIn.sticky) this.autoEnable = true;
-    this.preconditions = (this.bargeIn.enable || this.record?.action || this.data.amd) ?
+    this.preconditions = (this.bargeIn.enable ||
+      this.record?.action ||
+      this.listen?.url ||
+      this.data.amd ||
+      this.transcribe?.enable) ?
       TaskPreconditions.Endpoint :
       TaskPreconditions.None;
+
+    this.onHoldMusic = this.data.onHoldMusic;
   }
 
   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 hasTranscribe() { return Object.keys(this.transcribe).length; }
 
   get summary() {
     const phrase = [];
+
+    /* reset recognizer and/or synthesizer to default values? */
+    if (this.data.reset.length) phrase.push(`reset ${this.data.reset.join(',')}`);
+
     if (this.bargeIn.enable) phrase.push('enable barge-in');
     if (this.hasSynthesizer) {
       const {vendor:v, language:l, voice} = this.synthesizer;
@@ -50,13 +81,31 @@ class TaskConfig extends Task {
       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.hasTranscribe) {
+      phrase.push(this.transcribe.enable ? `transcribe ${this.transcribe.transcriptionHook}` : 'stop transcribe');
+    }
     if (this.data.amd) phrase.push('enable amd');
-    return  `${this.name}{${phrase.join(',')}`;
+    if (this.notifyEvents) phrase.push(`event notification ${this.notifyEvents ? 'on' : 'off'}`);
+    if (this.onHoldMusic) phrase.push(`onHoldMusic: ${this.onHoldMusic}`);
+    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.onHoldMusic) {
+      cs.onHoldMusic = this.onHoldMusic;
+    }
+
     if (this.data.amd) {
       this.startAmd = cs.startAmd;
       this.stopAmd = cs.stopAmd;
@@ -70,25 +119,64 @@ class TaskConfig extends Task {
       }
     }
 
+    this.data.reset.forEach((k) => {
+      if (k === 'synthesizer') cs.resetSynthesizer();
+      else if (k === 'recognizer') cs.resetRecognizer();
+    });
+
     if (this.hasSynthesizer) {
+      cs.synthesizer = this.synthesizer;
       cs.speechSynthesisVendor = this.synthesizer.vendor !== 'default'
         ? this.synthesizer.vendor
         : cs.speechSynthesisVendor;
+      cs.speechSynthesisLabel = this.synthesizer.label !== 'default'
+        ? this.synthesizer.label
+        : cs.speechSynthesisLabel;
       cs.speechSynthesisLanguage = this.synthesizer.language !== 'default'
         ?  this.synthesizer.language
         : cs.speechSynthesisLanguage;
       cs.speechSynthesisVoice = this.synthesizer.voice !== 'default'
         ? this.synthesizer.voice
         : cs.speechSynthesisVoice;
+
+      // fallback vendor
+      cs.fallbackSpeechSynthesisVendor = this.synthesizer.fallbackVendor !== 'default'
+        ? this.synthesizer.fallbackVendor
+        : cs.fallbackSpeechSynthesisVendor;
+      cs.fallbackSpeechSynthesisLabel = this.synthesizer.fallbackLabel !== 'default'
+        ? this.synthesizer.fallbackLabel
+        : cs.fallbackSpeechSynthesisLabel;
+      cs.fallbackSpeechSynthesisLanguage = this.synthesizer.fallbackLanguage !== 'default'
+        ?  this.synthesizer.fallbackLanguage
+        : cs.fallbackSpeechSynthesisLanguage;
+      cs.fallbackSpeechSynthesisVoice = this.synthesizer.fallbackVoice !== 'default'
+        ? this.synthesizer.fallbackVoice
+        : cs.fallbackSpeechSynthesisVoice;
       this.logger.info({synthesizer: this.synthesizer}, 'Config: updated synthesizer');
     }
     if (this.hasRecognizer) {
+      cs.recognizer = this.recognizer;
       cs.speechRecognizerVendor = this.recognizer.vendor !== 'default'
         ? this.recognizer.vendor
         : cs.speechRecognizerVendor;
+      cs.speechRecognizerLabel = this.recognizer.label !== 'default'
+        ? this.recognizer.label
+        : cs.speechRecognizerLabel;
       cs.speechRecognizerLanguage = this.recognizer.language !== 'default'
         ? this.recognizer.language
         : cs.speechRecognizerLanguage;
+
+      //fallback
+      cs.fallbackSpeechRecognizerVendor = this.recognizer.fallbackVendor !== 'default'
+        ? this.recognizer.fallbackVendor
+        : cs.fallbackSpeechRecognizerVendor;
+      cs.fallbackSpeechRecognizerLabel = this.recognizer.fallbackLabel !== 'default'
+        ? this.recognizer.fallbackLabel
+        : cs.fallbackSpeechRecognizerLabel;
+      cs.fallbackSpeechRecognizerLanguage = this.recognizer.fallbackLanguage !== 'default'
+        ? this.recognizer.fallbackLanguage
+        : cs.fallbackSpeechRecognizerLanguage;
+
       cs.isContinuousAsr = typeof this.recognizer.asrTimeout === 'number' ? true : false;
       if (cs.isContinuousAsr) {
         cs.asrTimeout = this.recognizer.asrTimeout;
@@ -136,17 +224,49 @@ class TaskConfig extends Task {
         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.startBackgroundTask('listen', {verb: 'listen', ...opts});
+      } else {
+        this.logger.info('Config: disabling listen');
+        cs.stopBackgroundTask('listen');
+      }
+    }
+    if (this.hasTranscribe) {
+      if (this.transcribe.enable) {
+        this.transcribeOpts.recognizer = this.hasRecognizer ?
+          this.recognizer :
+          {
+            vendor: cs.speechRecognizerVendor,
+            language: cs.speechRecognizerLanguage
+          };
+        this.logger.debug(this.transcribeOpts, 'Config: enabling transcribe');
+        cs.startBackgroundTask('transcribe', this.transcribeOpts);
+      } else {
+        this.logger.info('Config: disabling transcribe');
+        cs.stopBackgroundTask('transcribe');
+      }
+    }
+    if (this.data.sipRequestWithinDialogHook) {
+      cs.sipRequestWithinDialogHook = this.data.sipRequestWithinDialogHook;
+    }
   }
 
   async kill(cs) {
     super.kill(cs);
-    if (this.ep && this.stopAmd) this.stopAmd(this.ep, this);
+    //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);
+    this.performHook(cs, actionHook, evt)
+      .catch((err) => {
+        this.logger.error({err}, 'Config:_onAmdEvent - error calling actionHook');
+      });
+
   }
 }
 

lib/tasks/dequeue.js

@@ -16,6 +16,7 @@ class TaskDequeue extends Task {
     this.queueName = this.data.name;
     this.timeout = this.data.timeout || 0;
     this.beep = this.data.beep === true;
+    this.callSid = this.data.callSid;
 
     this.emitter = new Emitter();
     this.state = DequeueResults.Timeout;
@@ -53,7 +54,7 @@ class TaskDequeue extends Task {
   }
 
   _getMemberFromQueue(cs) {
-    const {popFront} = cs.srf.locals.dbHelpers;
+    const {retrieveFromSortedSet, retrieveByPatternSortedSet} = cs.srf.locals.dbHelpers;
 
     return new Promise(async(resolve) => {
       let timer;
@@ -70,7 +71,12 @@ class TaskDequeue extends Task {
 
       do {
         try {
-          const url = await popFront(this.queueName);
+          let url;
+          if (this.callSid) {
+            url = await retrieveByPatternSortedSet(this.queueName, `*${this.callSid}`);
+          } else {
+            url = await retrieveFromSortedSet(this.queueName);
+          }
           if (url) {
             found = true;
             clearTimeout(timer);
@@ -78,7 +84,7 @@ class TaskDequeue extends Task {
             resolve(url);
           }
         } catch (err) {
-          this.logger.debug({err}, 'TaskDequeue:_getMemberFromQueue error popFront');
+          this.logger.debug({err}, 'TaskDequeue:_getMemberFromQueue error Sorted Set');
         }
         await sleepFor(5000);
       } while (!this.killed && !timedout && !found);

lib/tasks/dial.js

@@ -12,9 +12,13 @@ const assert = require('assert');
 const placeCall = require('../utils/place-outdial');
 const sessionTracker = require('../session/session-tracker');
 const DtmfCollector = require('../utils/dtmf-collector');
+const ConfirmCallSession = require('../session/confirm-call-session');
 const dbUtils = require('../utils/db-utils');
 const debug = require('debug')('jambonz:feature-server');
 const {parseUri} = require('drachtio-srf');
+const {ANCHOR_MEDIA_ALWAYS, JAMBONZ_DISABLE_DIAL_PAI_HEADER} = require('../config');
+const { isOnhold, isOpusFirst } = require('../utils/sdp-utils');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 
 function parseDtmfOptions(logger, dtmfCapture) {
   let parentDtmfCollector, childDtmfCollector;
@@ -84,6 +88,7 @@ class TaskDial extends Task {
 
     this.earlyMedia = this.data.answerOnBridge === true;
     this.callerId = this.data.callerId;
+    this.callerName = this.data.callerName;
     this.dialMusic = this.data.dialMusic;
     this.headers = this.data.headers || {};
     this.method = this.data.method || 'POST';
@@ -133,11 +138,19 @@ class TaskDial extends Task {
 
   get name() { return TaskName.Dial; }
 
+  get isOnHold() {
+    return this.isIncomingLegHold || this.isOutgoingLegHold;
+  }
+
   get canReleaseMedia() {
-    return !process.env.ANCHOR_MEDIA_ALWAYS &&
-      !this.listenTask &&
-      !this.transcribeTask &&
-      !this.startAmd;
+    const keepAnchor = this.data.anchorMedia ||
+    this.cs.isBackGroundListen ||
+    ANCHOR_MEDIA_ALWAYS ||
+    this.listenTask ||
+    this.transcribeTask ||
+    this.startAmd;
+
+    return !keepAnchor;
   }
 
   get summary() {
@@ -161,6 +174,16 @@ class TaskDial extends Task {
   async exec(cs) {
     await super.exec(cs);
     try {
+      if (this.listenTask) {
+        const {span, ctx} = this.startChildSpan(`nested:${this.listenTask.summary}`);
+        this.listenTask.span = span;
+        this.listenTask.ctx = ctx;
+      }
+      if (this.transcribeTask) {
+        const {span, ctx} = this.startChildSpan(`nested:${this.transcribeTask.summary}`);
+        this.transcribeTask.span = span;
+        this.transcribeTask.ctx = ctx;
+      }
       if (this.data.amd) {
         this.startAmd = cs.startAmd;
         this.stopAmd = cs.stopAmd;
@@ -181,6 +204,7 @@ class TaskDial extends Task {
       await this.performAction(this.results, this.killReason !== KillReason.Replaced);
       this._removeDtmfDetection(cs.dlg);
       this._removeDtmfDetection(this.dlg);
+      this._removeSipIndialogRequestListener(this.dlg);
     } catch (err) {
       this.logger.error({err}, 'TaskDial:exec terminating with error');
       this.kill(cs);
@@ -209,7 +233,7 @@ class TaskDial extends Task {
     }
     this._removeDtmfDetection(cs.dlg);
     this._removeDtmfDetection(this.dlg);
-    this._killOutdials();
+    await this._killOutdials();
     if (this.sd) {
       this.sd.kill();
       this.sd.removeAllListeners();
@@ -218,10 +242,12 @@ class TaskDial extends Task {
     if (this.callSid) sessionTracker.remove(this.callSid);
     if (this.listenTask) {
       await this.listenTask.kill(cs);
+      this.listenTask.span.end();
       this.listenTask = null;
     }
     if (this.transcribeTask) {
       await this.transcribeTask.kill(cs);
+      this.transcribeTask.span.end();
       this.transcribeTask = null;
     }
     this.notifyTaskDone();
@@ -296,18 +322,41 @@ class TaskDial extends Task {
         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,
+        const json = await cs.requestor.request('verb:hook', this.referHook, {
+          ...(callInfo.toJSON()),
           refer_details: {
             sip_refer_to: req.get('Refer-To'),
             sip_referred_by: req.get('Referred-By'),
             sip_user_agent: req.get('User-Agent'),
-            refer_to_user: to.user,
-            referred_by_user: by.user,
+            refer_to_user: to.scheme === 'tel' ? to.number : to.user,
+            referred_by_user: by.scheme === 'tel' ? by.number : by.user,
             referring_call_sid,
             referred_call_sid
           }
         }, httpHeaders);
+        if (json && Array.isArray(json)) {
+          try {
+            const logger = isChild ? this.logger : this.sd.logger;
+            const tasks = normalizeJambones(logger, json).map((tdata) => makeTask(this.logger, tdata));
+            if (tasks && tasks.length > 0) {
+              const legs = isChild ? ['child', 'parent'] : ['parent', 'child'];
+              logger.info(`Dial:handleRefer received REFER on ${legs[0]} leg, setting new app on ${legs[1]} leg`);
+              if (isChild) this.redirect(cs, tasks);
+              else {
+                logger.info({tasks: json}, 'Dial:handleRefer - new application for for child leg');
+                const adultingSession = await this.sd.doAdulting({
+                  logger,
+                  application: cs.application,
+                  tasks
+                });
+                /* need to update the callSid of the child with its own (new) AdultingCallSession */
+                sessionTracker.add(adultingSession.callSid, adultingSession);
+              }
+            }
+          } catch (err) {
+            this.logger.info(err, 'Dial:handleRefer - error setting new application after receiving REFER');
+          }
+        }
         res.send(202);
         this.logger.info('DialTask:handleRefer - sent 202 Accepted');
       } catch (err) {
@@ -328,11 +377,16 @@ class TaskDial extends Task {
     sd.removeAllListeners('callCreateFail');
   }
 
-  _killOutdials() {
+  async _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}`));
+      try {
+        await sd.kill();
+      } catch (err) {
+        this.logger.info(err, `Dial:_killOutdials Error killing ${callSid}`);
+      }
       this._removeHandlers(sd);
+      this.logger.debug(`Dial:_killOutdials killed callSid ${callSid}`);
     }
     this.dials.clear();
   }
@@ -345,8 +399,14 @@ class TaskDial extends Task {
   }
 
   _onInfo(cs, dlg, req, res) {
+    // SIP Indialog will be handled by another handler
+    if (cs.sipRequestWithinDialogHook) {
+      return;
+    }
     res.send(200);
-    if (req.get('Content-Type') !== 'application/dtmf-relay') return;
+    if (req.get('Content-Type') !== 'application/dtmf-relay') {
+      return;
+    }
 
     const dtmfDetector = dlg === cs.dlg ? this.parentDtmfCollector : this.childDtmfCollector;
     if (!dtmfDetector) return;
@@ -375,6 +435,20 @@ class TaskDial extends Task {
     }
   }
 
+  _initSipIndialogRequestListener(cs, dlg) {
+    dlg.on('info', this._onRequestWithinDialog.bind(this, cs));
+    dlg.on('message', this._onRequestWithinDialog.bind(this, cs));
+  }
+
+  _removeSipIndialogRequestListener(dlg) {
+    dlg && dlg.removeAllListeners('message');
+    dlg && dlg.removeAllListeners('info');
+  }
+
+  async _onRequestWithinDialog(cs, req, res) {
+    cs._onRequestWithinDialog(req, res);
+  }
+
   async _initializeInbound(cs) {
     const {ep} = await cs._evalEndpointPrecondition(this);
     this.epOther = ep;
@@ -394,20 +468,28 @@ class TaskDial extends Task {
     const {req, srf} = cs;
     const {getSBC} = srf.locals;
     const {lookupTeamsByAccount, lookupAccountBySid} = srf.locals.dbHelpers;
-    const {lookupCarrier} = dbUtils(this.logger, cs.srf);
+    const {lookupCarrier, lookupCarrierByPhoneNumber} = 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');
-    const opts = {
-      headers: req && req.has('X-CID') ? Object.assign(this.headers, {'X-CID': req.get('X-CID')}) : this.headers,
-      proxy: `sip:${sbcAddress}`,
-      callingNumber: this.callerId || req.callingNumber
+    this.headers = {
+      'X-Account-Sid': cs.accountSid,
+      ...(req && req.has('X-CID') && {'X-CID': req.get('X-CID')}),
+      ...(req && req.has('P-Asserted-Identity') && !JAMBONZ_DISABLE_DIAL_PAI_HEADER &&
+        {'P-Asserted-Identity': req.get('P-Asserted-Identity')}),
+      ...(req && req.has('X-Voip-Carrier-Sid') && {'X-Voip-Carrier-Sid': req.get('X-Voip-Carrier-Sid')}),
+      // Put headers at the end to make sure opt.headers override all default behavior.
+      ...this.headers
     };
-    opts.headers = {
-      ...opts.headers,
-      'X-Account-Sid': cs.accountSid
+
+    const opts = {
+      headers: this.headers,
+      proxy: `sip:${sbcAddress}`,
+      callingNumber: this.callerId || req.callingNumber,
+      ...(this.callerName && {callingName: this.callerName}),
+      opusFirst: isOpusFirst(this.cs.ep.remote.sdp)
     };
 
     const t = this.target.find((t) => t.type === 'teams');
@@ -418,10 +500,14 @@ class TaskDial extends Task {
     }
 
     const ms = await cs.getMS();
-    this.timerRing = setTimeout(() => {
+    this.timerRing = setTimeout(async() => {
       this.logger.info(`Dial:_attemptCall: ring no answer timer ${this.timeout}s exceeded`);
       this.timerRing = null;
-      this._killOutdials();
+      try {
+        await this._killOutdials();
+      } catch (err) {
+        this.logger.info(err, 'Dial:_attemptCall - error killing outdials');
+      }
       this.result = {
         dialCallStatus: CallStatus.NoAnswer,
         dialSipStatus: 487
@@ -449,7 +535,22 @@ class TaskDial extends Task {
         }
         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})`);
+          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;
+          }
+        }
+
+        /**
+         * trunk isn't specified,
+         * check if number matches any existing numbers
+         *  */
+        if (t.type === 'phone' && !t.trunk) {
+          const str = this.callerId || req.callingNumber || '';
+          const callingNumber = str.startsWith('+') ? str.substring(1) : str;
+          const voip_carrier_sid = await lookupCarrierByPhoneNumber(cs.accountSid, callingNumber);
+          this.logger.info(
+            `Dial:_attemptCalls: selected ${voip_carrier_sid} for requested phone number: ${callingNumber}`);
           if (voip_carrier_sid) {
             opts.headers['X-Requested-Carrier-Sid'] = voip_carrier_sid;
           }
@@ -468,7 +569,8 @@ class TaskDial extends Task {
           callInfo: cs.callInfo,
           accountInfo: cs.accountInfo,
           rootSpan: cs.rootSpan,
-          startSpan: this.startSpan.bind(this)
+          startSpan: this.startSpan.bind(this),
+          dialTask: this
         });
         this.dials.set(sd.callSid, sd);
 
@@ -484,7 +586,8 @@ class TaskDial extends Task {
             }
           })
           .on('callStatusChange', (obj) => {
-            if (this.results.dialCallStatus !== CallStatus.Completed) {
+            if (this.results.dialCallStatus !== CallStatus.Completed &&
+              this.results.dialCallStatus !== CallStatus.NoAnswer) {
               Object.assign(this.results, {
                 dialCallStatus: obj.callStatus,
                 dialSipStatus: obj.sipStatus,
@@ -537,11 +640,7 @@ class TaskDial extends Task {
             }
           })
           .on('reinvite', (req, res) => {
-            try {
-              cs.handleReinviteAfterMediaReleased(req, res);
-            } catch (err) {
-              this.logger.error(err, 'Error in dial einvite from B leg');
-            }
+            this._onReinvite(req, res);
           })
           .on('refer', (callInfo, req, res) => {
 
@@ -577,6 +676,35 @@ class TaskDial extends Task {
     this._killOutdials();       // NB: order is important
   }
 
+  async _onReinvite(req, res) {
+    try {
+      let isHandled = false;
+      if (this.cs.onHoldMusic) {
+        if (isOnhold(req.body) && !this.epOther && !this.ep) {
+          await this.cs.handleReinviteAfterMediaReleased(req, res);
+          // Onhold but media is already released
+          // reconnect A Leg and Response B leg
+          await this.reAnchorMedia(this.cs, this.sd);
+          this.isOutgoingLegHold = true;
+          isHandled = true;
+          this._onHoldHook();
+        } else if (!isOnhold(req.body) && this.epOther && this.ep && this.isOutgoingLegHold && this.canReleaseMedia) {
+          // Offhold, time to release media
+          const newSdp = await this.ep.modify(req.body);
+          await res.send(200, {body: newSdp});
+          await this._releaseMedia(this.cs, this.sd);
+          isHandled = true;
+          this.isOutgoingLegHold = false;
+        }
+      }
+      if (!isHandled) {
+        this.cs.handleReinviteAfterMediaReleased(req, res);
+      }
+    } catch (err) {
+      this.logger.error(err, 'Error in dial einvite from B leg');
+    }
+  }
+
   _onMaxCallDuration(cs) {
     this.logger.info(`Dial:_onMaxCallDuration tearing down call as it has reached ${this.timeLimit}s`);
     this.ep && this.ep.unbridge();
@@ -629,8 +757,9 @@ class TaskDial extends Task {
 
     if (this.parentDtmfCollector) this._installDtmfDetection(cs, cs.dlg);
     if (this.childDtmfCollector) this._installDtmfDetection(cs, this.dlg);
+    if (cs.sipRequestWithinDialogHook) this._initSipIndialogRequestListener(cs, this.dlg);
 
-    if (this.transcribeTask) this.transcribeTask.exec(cs, {ep2: this.epOther, ep:this.ep});
+    if (this.transcribeTask) this.transcribeTask.exec(cs, {ep: this.epOther, ep2:this.ep});
     if (this.listenTask) this.listenTask.exec(cs, {ep: this.epOther});
     if (this.startAmd) {
       try {
@@ -662,9 +791,11 @@ class TaskDial extends Task {
     assert(cs.ep && sd.ep);
 
     try {
+      // Wait until we got new SDP from B leg to ofter to A Leg
       const aLegSdp = cs.ep.remote.sdp;
+      await sd.releaseMediaToSBC(aLegSdp, cs.ep.local.sdp);
       const bLegSdp = sd.dlg.remote.sdp;
-      await Promise.all[sd.releaseMediaToSBC(aLegSdp, cs.ep.local.sdp), cs.releaseMediaToSBC(bLegSdp)];
+      await cs.releaseMediaToSBC(bLegSdp);
       this.epOther = null;
       this.logger.info('Dial:_releaseMedia - successfully released media from freewitch');
     } catch (err) {
@@ -681,15 +812,80 @@ class TaskDial extends Task {
   }
 
   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});
+    let isHandled = false;
+    if (isOnhold(req.body) && !this.epOther && !this.ep) {
+      const sdp = await this.dlg.modify(req.body);
+      res.send(200, {body: sdp});
+      // Onhold but media is already released
+      await this.reAnchorMedia(this.cs, this.sd);
+      isHandled = true;
+      this.isIncomingLegHold = true;
+      this._onHoldHook();
+    } else if (!isOnhold(req.body) && this.epOther && this.ep && this.isIncomingLegHold && this.canReleaseMedia) {
+      // Offhold, time to release media
+      const newSdp = await this.epOther.modify(req.body);
+      await res.send(200, {body: newSdp});
+      await this._releaseMedia(this.cs, this.sd);
+      isHandled = true;
+      this.isIncomingLegHold = false;
+    }
+
+    if (!isHandled) {
+      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);
+    this.performHook(cs, actionHook, evt)
+      .catch((err) => {
+        this.logger.error({err}, 'Dial:_onAmdEvent - error calling actionHook');
+      });
+  }
+
+  async _onHoldHook(allowed = [TaskName.Play, TaskName.Say, TaskName.Pause]) {
+    if (this.data.onHoldHook) {
+      // send silence for keep Voice quality
+      await this.epOther.play('silence_stream://500');
+      let allowedTasks;
+      do {
+        try {
+          const b3 = this.getTracingPropagation();
+          const httpHeaders = b3 && {b3};
+          const json = await this.cs.application.requestor.
+            request('verb:hook', this.data.onHoldHook, this.cs.callInfo.toJSON(), httpHeaders);
+          const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
+          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(`DialTask:_onHoldHook: executing ${tasks.length} tasks`);
+          if (tasks.length) {
+            this._playSession = new ConfirmCallSession({
+              logger: this.logger,
+              application: this.cs.application,
+              dlg: this.isIncomingLegHold ? this.dlg : this.cs.dlg,
+              ep: this.isIncomingLegHold ? this.ep : this.cs.ep,
+              callInfo: this.cs.callInfo,
+              accountInfo: this.cs.accountInfo,
+              tasks,
+              rootSpan: this.cs.rootSpan
+            });
+            await this._playSession.exec();
+            this._playSession = null;
+          }
+        } catch (error) {
+          this.logger.info(error, 'DialTask:_onHoldHook: failed retrieving waitHook');
+          this._playSession = null;
+          break;
+        }
+      } while (allowedTasks && allowedTasks.length > 0 && !this.killed && this.isOnHold);
+      this.logger.info('Finish onHoldHook');
+    }
   }
 }
 

lib/tasks/dialogflow/index.js

@@ -3,7 +3,7 @@ const {TaskName, TaskPreconditions} = require('../../utils/constants');
 const Intent = require('./intent');
 const DigitBuffer = require('./digit-buffer');
 const Transcription = require('./transcription');
-const normalizeJambones = require('../../utils/normalize-jambones');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 
 class Dialogflow extends Task {
   constructor(logger, opts) {
@@ -58,6 +58,13 @@ class Dialogflow extends Task {
       this.vendor = this.data.tts.vendor || 'default';
       this.language = this.data.tts.language || 'default';
       this.voice = this.data.tts.voice || 'default';
+      this.speechSynthesisLabel = this.data.tts.label;
+
+      // fallback tts
+      this.fallbackVendor = this.data.tts.fallbackVendor || 'default';
+      this.fallbackLanguage = this.data.tts.fallbackLanguage || 'default';
+      this.fallbackVoice = this.data.tts.fallbackLanguage || 'default';
+      this.fallbackLabel = this.data.tts.fallbackLabel;
     }
     this.bargein = this.data.bargein;
   }
@@ -118,8 +125,15 @@ class Dialogflow extends Task {
         this.vendor = cs.speechSynthesisVendor;
         this.language = cs.speechSynthesisLanguage;
         this.voice = cs.speechSynthesisVoice;
+        this.speechSynthesisLabel = cs.speechSynthesisLabel;
       }
-      this.ttsCredentials = cs.getSpeechCredentials(this.vendor, 'tts');
+      if (this.fallbackVendor === 'default') {
+        this.fallbackVendor = cs.fallbackSpeechSynthesisVendor;
+        this.fallbackLanguage = cs.fallbackSpeechSynthesisLanguage;
+        this.fallbackVoice = cs.fallbackSpeechSynthesisVoice;
+        this.fallbackLabel = cs.fallbackSpeechSynthesisLabel;
+      }
+      this.ttsCredentials = cs.getSpeechCredentials(this.vendor, 'tts', this.speechSynthesisLabel);
 
       this.ep.addCustomEventListener('dialogflow::intent', this._onIntent.bind(this, ep, cs));
       this.ep.addCustomEventListener('dialogflow::transcription', this._onTranscription.bind(this, ep, cs));
@@ -221,18 +235,8 @@ class Dialogflow extends Task {
       }
 
       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);
+        const {filePath} = await this._fallbackSynthAudio(cs, intent, stats, synthAudio);
         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'));
@@ -276,6 +280,46 @@ class Dialogflow extends Task {
     }
   }
 
+  async _fallbackSynthAudio(cs, intent, stats, synthAudio) {
+    try {
+      const obj = {
+        account_sid: cs.accountSid,
+        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');
+
+      return await synthAudio(stats, obj);
+    } catch (error) {
+      this.logger.info({error}, 'Failed to synthesize audio from primary vendor');
+
+      try {
+        if (this.fallbackVendor) {
+          const credentials = cs.getSpeechCredentials(this.fallbackVendor, 'tts', this.fallbackLabel);
+          const obj = {
+            account_sid: cs.accountSid,
+            text: intent.fulfillmentText,
+            vendor: this.fallbackVendor,
+            language: this.fallbackLanguage,
+            voice: this.fallbackVoice,
+            salt: cs.callSid,
+            credentials
+          };
+          this.logger.debug({obj}, 'Dialogflow:_onIntent - playing message via fallback tts');
+          return await synthAudio(stats, obj);
+        }
+      } catch (err) {
+        this.logger.info({err}, 'Failed to synthesize audio from falllback vendor');
+        throw err;
+      }
+      throw error;
+    }
+  }
+
   /**
    * 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.

lib/tasks/enqueue.js

@@ -1,7 +1,7 @@
 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, KillReason} = require('../utils/constants');
 const bent = require('bent');
@@ -18,6 +18,7 @@ class TaskEnqueue extends Task {
     this.preconditions = TaskPreconditions.Endpoint;
 
     this.queueName = this.data.name;
+    this.priority = this.data.priority;
     this.waitHook = this.data.waitHook;
 
     this.emitter = new Emitter();
@@ -70,12 +71,22 @@ class TaskEnqueue extends Task {
   }
 
   async _addToQueue(cs, dlg) {
-    const {pushBack} = cs.srf.locals.dbHelpers;
+    const {addToSortedSet, sortedSetLength} = cs.srf.locals.dbHelpers;
     const url = getUrl(cs);
     this.waitStartTime = Date.now();
     this.logger.debug({queue: this.queueName, url}, 'pushing url onto queue');
-    const members = await pushBack(this.queueName, url);
-    this.logger.info(`TaskEnqueue:_addToQueue: added to queue, length now ${members}`);
+    if (this.priority < 0) {
+      this.logger.warn(`priority ${this.priority} is invalid, need to be non-negative integer,
+      999 will be used for priority`);
+    }
+    let members = await addToSortedSet(this.queueName, url, this.priority);
+    if (members === 1) {
+      this.logger.info('TaskEnqueue:_addToQueue: added to queue');
+    } else {
+      this.logger.info('TaskEnqueue:_addToQueue: failed to add to queue');
+    }
+    members = await sortedSetLength(this.queueName);
+
     this.notifyUrl = url;
 
     /* invoke account-level webhook for queue event notifications */
@@ -90,9 +101,9 @@ class TaskEnqueue extends Task {
   }
 
   async _removeFromQueue(cs) {
-    const {removeFromList, lengthOfList} = cs.srf.locals.dbHelpers;
-    await removeFromList(this.queueName, getUrl(cs));
-    return await lengthOfList(this.queueName);
+    const {retrieveByPatternSortedSet, sortedSetLength} = cs.srf.locals.dbHelpers;
+    await retrieveByPatternSortedSet(this.queueName, `*${getUrl(cs)}`);
+    return await sortedSetLength(this.queueName);
   }
 
   async performAction() {
@@ -279,13 +290,13 @@ class TaskEnqueue extends Task {
       this.emitter.emit('dequeue', opts);
 
       try {
-        const {lengthOfList} = cs.srf.locals.dbHelpers;
-        const members = await lengthOfList(this.queueName);
+        const {sortedSetLength} = cs.srf.locals.dbHelpers;
+        const members = await sortedSetLength(this.queueName);
         this.dequeued = true;
         cs.performQueueWebhook({
           event: 'leave',
           queue: this.data.name,
-          length: Math.max(members - 1, 0),
+          length: Math.max(members, 0),
           leaveReason: 'dequeued',
           leaveTime: Date.now(),
           dequeuer: opts.dequeuer
@@ -300,8 +311,9 @@ 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;
+  async _playHook(cs, dlg, hook,
+    allowed = [TaskName.Play, TaskName.Say, TaskName.Pause, TaskName.Leave, TaskName.Tag]) {
+    const {sortedSetLength, sortedSetPositionByPattern} = cs.srf.locals.dbHelpers;
     const b3 = this.getTracingPropagation();
     const httpHeaders = b3 && {b3};
 
@@ -313,9 +325,15 @@ class TaskEnqueue extends Task {
       queueTime: getElapsedTime(this.waitStartTime)
     };
     try {
-      const queueSize = await lengthOfList(this.queueName);
-      const queuePosition = await getListPosition(this.queueName, this.notifyUrl);
-      Object.assign(params, {queueSize, queuePosition});
+      const queueSize = await sortedSetLength(this.queueName);
+      const queuePosition = await sortedSetPositionByPattern(this.queueName, `*${this.notifyUrl}`);
+      Object.assign(params, {
+        queueSize,
+        queuePosition: queuePosition.length ? queuePosition[0] : 0,
+        callSid: this.cs.callSid,
+        callId: this.cs.callId,
+        customerData: this.cs.callInfo.customerData
+      });
     } catch (err) {
       this.logger.error({err}, `TaskEnqueue:_playHook error retrieving list info for queue ${this.queueName}`);
     }

lib/tasks/gather.js

@@ -1,36 +1,31 @@
-const Task = require('./task');
 const {
   TaskName,
-  TaskPreconditions,
   GoogleTranscriptionEvents,
+  NuanceTranscriptionEvents,
   AwsTranscriptionEvents,
-  AzureTranscriptionEvents
-} = require('../utils/constants');
-
+  AzureTranscriptionEvents,
+  DeepgramTranscriptionEvents,
+  SonioxTranscriptionEvents,
+  CobaltTranscriptionEvents,
+  IbmTranscriptionEvents,
+  NvidiaTranscriptionEvents,
+  JambonzTranscriptionEvents,
+  AssemblyAiTranscriptionEvents
+} = require('../utils/constants.json');
+const {
+  JAMBONES_GATHER_EARLY_HINTS_MATCH,
+  JAMBONZ_GATHER_EARLY_HINTS_MATCH,
+  JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS,
+} = require('../config');
 const makeTask = require('./make_task');
 const assert = require('assert');
-//const GATHER_STABILITY_THRESHOLD =  Number(process.env.JAMBONZ_GATHER_STABILITY_THRESHOLD || 0.7);
+const SttTask = require('./stt-task');
 
-const compileTranscripts = (logger, evt, arr) => {
-  //logger.debug({arr, evt}, 'compile transcripts');
-  if (!Array.isArray(arr) || arr.length === 0) return;
-  let t = '';
-  for (const a of arr) {
-    //logger.debug(`adding ${a.alternatives[0].transcript}`);
-    t += ` ${a.alternatives[0].transcript}`;
-  }
-  t += ` ${evt.alternatives[0].transcript}`;
-  evt.alternatives[0].transcript = t.trim();
-  //logger.debug(`compiled transcript: ${evt.alternatives[0].transcript}`);
-};
-
-class TaskGather extends Task {
+class TaskGather extends SttTask {
   constructor(logger, opts, parentTask) {
-    super(logger, opts);
-    this.preconditions = TaskPreconditions.Endpoint;
-
+    super(logger, opts, parentTask);
     [
-      'finishOnKey', 'hints', 'input', 'numDigits', 'minDigits', 'maxDigits',
+      'finishOnKey', 'input', 'numDigits', 'minDigits', 'maxDigits',
       'interDigitTimeout', 'partialResultHook', 'bargein', 'dtmfBargein',
       'speechTimeout', 'timeout', 'say', 'play'
     ].forEach((k) => this[k] = this.data[k]);
@@ -40,53 +35,26 @@ class TaskGather extends Task {
 
     /* timeout of zero means no timeout */
     this.timeout = this.timeout === 0 ? 0 : (this.timeout || 15) * 1000;
-    this.interim = !!this.partialResultHook || this.bargein;
+    this.interim = !!this.partialResultHook || this.bargein || (this.timeout > 0);
     this.listenDuringPrompt = this.data.listenDuringPrompt === false ? false : true;
-    this.minBargeinWordCount = this.data.minBargeinWordCount || 0;
+    this.minBargeinWordCount = this.data.minBargeinWordCount || 1;
     if (this.data.recognizer) {
-      const recognizer = this.data.recognizer;
-      this.vendor = recognizer.vendor;
-      this.language = recognizer.language;
-      this.hints = recognizer.hints || [];
-      this.hintsBoost = recognizer.hintsBoost;
-      this.profanityFilter = recognizer.profanityFilter;
-      this.punctuation = !!recognizer.punctuation;
-      this.enhancedModel = !!recognizer.enhancedModel;
-      this.model = recognizer.model || 'command_and_search';
-      this.words = !!recognizer.words;
-      this.singleUtterance = recognizer.singleUtterance || true;
-      this.diarization = !!recognizer.diarization;
-      this.diarizationMinSpeakers = recognizer.diarizationMinSpeakers || 0;
-      this.diarizationMaxSpeakers = recognizer.diarizationMaxSpeakers || 0;
-      this.interactionType = recognizer.interactionType || 'unspecified';
-      this.naicsCode = recognizer.naicsCode || 0;
-      this.altLanguages = recognizer.altLanguages || [];
-
       /* 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;
+      this.asrTimeout = typeof this.data.recognizer.asrTimeout === 'number' ?
+        this.data.recognizer.asrTimeout * 1000 : 0;
+      if (this.asrTimeout > 0) {
+        this.isContinuousAsr = true;
+        this.asrDtmfTerminationDigit = this.data.recognizer.asrDtmfTerminationDigit;
+      }
 
-      /* vad: if provided, we dont connect to recognizer until voice activity is detected */
-      const {enable, voiceMs = 0, mode = -1} = recognizer.vad || {};
-      this.vad = {enable, voiceMs, mode};
-
-      /* aws options */
-      this.vocabularyName = recognizer.vocabularyName;
-      this.vocabularyFilterName = recognizer.vocabularyFilterName;
-      this.filterMethod = recognizer.filterMethod;
-
-      /* microsoft options */
-      this.outputFormat = recognizer.outputFormat || 'simple';
-      this.profanityOption = recognizer.profanityOption || 'raw';
-      this.requestSnr = recognizer.requestSnr || false;
-      this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
-      this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
-      this.azureSttEndpointId = recognizer.azureSttEndpointId;
-    }
-    else {
-      this.hints = [];
-      this.altLanguages = [];
+      if (Array.isArray(this.data.recognizer.hints) &&
+        0 == this.data.recognizer.hints.length && 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;
+      }
+      // fast Recognition, fire event after a specified time after the last hypothesis.
+      this.fastRecognitionTimeout =  typeof this.data.recognizer.fastRecognitionTimeout === 'number' ?
+        this.data.recognizer.fastRecognitionTimeout * 1000 : 0;
     }
 
     this.digitBuffer = '';
@@ -102,14 +70,18 @@ class TaskGather extends Task {
 
     /* buffer speech for continuous asr */
     this._bufferedTranscripts = [];
-
-    this.parentTask = parentTask;
+    this.partialTranscriptsCount = 0;
+    this.bugname_prefix = 'gather_';
   }
 
   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);
@@ -131,25 +103,20 @@ class TaskGather extends Task {
   }
 
   async exec(cs, {ep}) {
-    this.logger.debug('Gather:exec');
-    await super.exec(cs);
+    this.logger.debug({options: this.data}, 'Gather:exec');
+    await super.exec(cs, {ep});
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
 
-    if (cs.hasGlobalSttHints) {
+    if (cs.hasGlobalSttHints && !this.maskGlobalSttHints) {
       const {hints, hintsBoost} = cs.globalSttHints;
-      this.hints = this.hints.concat(hints);
-      if (!this.hintsBoost && hintsBoost) this.hintsBoost = hintsBoost;
-      this.logger.debug({hints: this.hints, hintsBoost: this.hintsBoost},
+      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.altLanguages = this.altLanguages.concat(cs.altLanguages);
-      this.logger.debug({altLanguages: this.altLanguages},
-        'Gather:exec - applying altLanguages');
-    }
-    if (cs.hasGlobalSttPunctuation) {
-      this.punctuation = cs.globalSttPunctuation;
-    }
     if (!this.isContinuousAsr && cs.isContinuousAsr) {
       this.isContinuousAsr = true;
       this.asrTimeout = cs.asrTimeout * 1000;
@@ -159,32 +126,34 @@ class TaskGather extends Task {
         asrDtmfTerminationDigit: this.asrDtmfTerminationDigit
       }, 'Gather:exec - enabling continuous ASR since it is turned on for the session');
     }
-    this.ep = ep;
-    if ('default' === this.vendor || !this.vendor) this.vendor = cs.speechRecognizerVendor;
-    if ('default' === this.language || !this.language) this.language = cs.speechRecognizerLanguage;
-    this.sttCredentials = cs.getSpeechCredentials(this.vendor, 'stt');
-    if (this.needsStt && !this.sttCredentials) {
-      const {writeAlerts, AlertType} = cs.srf.locals;
-      this.logger.info(`TaskGather:exec - ERROR stt using ${this.vendor} requested but creds not supplied`);
-      writeAlerts({
-        account_sid: cs.accountSid,
-        alert_type: AlertType.STT_NOT_PROVISIONED,
-        vendor: this.vendor
-      }).catch((err) => this.logger.info({err}, 'Error generating alert for no stt'));
 
-      throw new Error(`no speech-to-text service credentials for ${this.vendor} have been configured`);
+    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');
     }
-
-    const startListening = (cs, ep) => {
+    const startListening = async(cs, ep) => {
       this._startTimer();
       if (this.isContinuousAsr && 0 === this.timeout) this._startAsrTimer();
       if (this.input.includes('speech') && !this.listenDuringPrompt) {
-        this._initSpeech(cs, ep)
-          .then(() => {
-            this._startTranscribing(ep);
-            return updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid);
-          })
-          .catch(() => {});
+        try {
+          await this._setSpeechHandlers(cs, ep);
+          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 (e) {
+          if (this.fallbackVendor && this.isHandledByPrimaryProvider) {
+            await this._fallback();
+            startListening(cs, ep);
+          } else {
+            this.logger.error({error: e}, 'error in initSpeech');
+          }
+        }
       }
     };
 
@@ -198,7 +167,15 @@ class TaskGather extends Task {
           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.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) {
@@ -210,13 +187,27 @@ class TaskGather extends Task {
           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.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 startListening(cs, 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('speech') && this.listenDuringPrompt) {
-        await this._initSpeech(cs, ep);
+        await this._setSpeechHandlers(cs, ep);
         this._startTranscribing(ep);
         updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid)
           .catch(() => {/*already logged error */});
@@ -230,14 +221,7 @@ class TaskGather extends Task {
     } catch (err) {
       this.logger.error(err, 'TaskGather:exec error');
     }
-    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);
+    this.removeCustomEventListeners();
   }
 
   kill(cs) {
@@ -245,15 +229,21 @@ class TaskGather extends Task {
     this._killAudio(cs);
     this.ep.removeAllListeners('dtmf');
     clearTimeout(this.interDigitTimer);
+    this._clearAsrTimer();
     this.playTask?.span.end();
     this.sayTask?.span.end();
     this._resolve('killed');
   }
 
-  updateTimeout(timeout) {
-    this.logger.info(`TaskGather:updateTimeout - updating timeout to ${timeout}`);
+  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
+    }
+    const {timeout} = opts;
     this.timeout = timeout;
     this._startTimer();
+    return true;
   }
 
   _onDtmf(cs, ep, evt) {
@@ -269,6 +259,16 @@ class TaskGather extends Task {
       this._resolve('dtmf-terminator-key');
     }
     else if (this.input.includes('digits')) {
+      if (this.digitBuffer.length === 0 && this.needsStt) {
+        // DTMF is higher priority than STT.
+        this.removeCustomEventListeners();
+        ep.stopTranscription({
+          vendor: this.vendor,
+          bugname: this.bugname,
+        })
+          .catch((err) => this.logger.error({err},
+            ` Received DTMF, Error stopping transcription for vendor ${this.vendor}`));
+      }
       this.digitBuffer += evt.dtmf;
       const len = this.digitBuffer.length;
       if (len === this.numDigits || len === this.maxDigits) {
@@ -291,107 +291,162 @@ class TaskGather extends Task {
     }
   }
 
-  async _initSpeech(cs, ep) {
-    const opts = {};
+  async _setSpeechHandlers(cs, ep) {
+    if (this._speechHandlersSet) return;
+    this._speechHandlersSet = true;
 
-    if (this.vad?.enable) {
-      opts.START_RECOGNIZING_ON_VAD = 1;
-      if (this.vad.voiceMs) opts.RECOGNIZER_VAD_VOICE_MS = this.vad.voiceMs;
-      else opts.RECOGNIZER_VAD_VOICE_MS = 125;
-      if (this.vad.mode >= 0 && this.vad.mode <= 3) opts.RECOGNIZER_VAD_MODE = this.vad.mode;
+    /* some special deepgram logic */
+    if (this.vendor === 'deepgram') {
+      if (this.isContinuousAsr) this._doContinuousAsrWithDeepgram(this.asrTimeout);
+      if (this.data.recognizer?.deepgramOptions?.shortUtterance) this.shortUtterance = true;
     }
 
-    if ('google' === this.vendor) {
-      this.bugname = 'google_transcribe';
-      if (this.sttCredentials) opts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(this.sttCredentials.credentials);
-      [
-        ['enhancedModel', 'GOOGLE_SPEECH_USE_ENHANCED'],
-        ['separateRecognitionPerChannel', 'GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL'],
-        ['profanityFilter', 'GOOGLE_SPEECH_PROFANITY_FILTER'],
-        ['punctuation', 'GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION'],
-        ['words', 'GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS'],
-        ['singleUtterance', 'GOOGLE_SPEECH_SINGLE_UTTERANCE'],
-        ['diarization', 'GOOGLE_SPEECH_PROFANITY_FILTER']
-      ].forEach((arr) => {
-        if (this[arr[0]]) opts[arr[1]] = true;
-        else if (this[arr[0]] === false) opts[arr[1]] = false;
-      });
-      if (this.hints.length > 0) {
-        opts.GOOGLE_SPEECH_HINTS = this.hints.join(',');
-        if (typeof this.hintsBoost === 'number') {
-          opts.GOOGLE_SPEECH_HINTS_BOOST = this.hintsBoost;
+    const opts = this.setChannelVarsForStt(this, this.sttCredentials, this.data.recognizer);
+    switch (this.vendor) {
+      case 'google':
+        this.bugname = `${this.bugname_prefix}google_transcribe`;
+        this.addCustomEventListener(
+          ep, GoogleTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(
+          ep, GoogleTranscriptionEvents.EndOfUtterance, this._onEndOfUtterance.bind(this, cs, ep));
+        this.addCustomEventListener(
+          ep, GoogleTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
+        break;
+
+      case 'aws':
+      case 'polly':
+        this.bugname = `${this.bugname_prefix}aws_transcribe`;
+        this.addCustomEventListener(ep, AwsTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(ep, AwsTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
+        break;
+      case 'microsoft':
+        this.bugname = `${this.bugname_prefix}azure_transcribe`;
+        this.addCustomEventListener(
+          ep, AzureTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(ep, AzureTranscriptionEvents.NoSpeechDetected,
+          this._onNoSpeechDetected.bind(this, cs, ep));
+        this.addCustomEventListener(ep, AzureTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
+        break;
+      case 'nuance':
+        this.bugname = `${this.bugname_prefix}nuance_transcribe`;
+        this.addCustomEventListener(ep, NuanceTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(ep, NuanceTranscriptionEvents.StartOfSpeech,
+          this._onStartOfSpeech.bind(this, cs, ep));
+        this.addCustomEventListener(ep, NuanceTranscriptionEvents.TranscriptionComplete,
+          this._onTranscriptionComplete.bind(this, cs, ep));
+        this.addCustomEventListener(ep, 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;
         }
-      }
-      if (this.altLanguages.length > 0) opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
-      else opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
-      if ('unspecified' !== this.interactionType) {
-        opts.GOOGLE_SPEECH_METADATA_INTERACTION_TYPE = this.interactionType;
-      }
-      opts.GOOGLE_SPEECH_MODEL = this.model;
-      if (this.diarization && this.diarizationMinSpeakers > 0) {
-        opts.GOOGLE_SPEECH_SPEAKER_DIARIZATION_MIN_SPEAKER_COUNT = this.diarizationMinSpeakers;
-      }
-      if (this.diarization && this.diarizationMaxSpeakers > 0) {
-        opts.GOOGLE_SPEECH_SPEAKER_DIARIZATION_MAX_SPEAKER_COUNT = this.diarizationMaxSpeakers;
-      }
-      if (this.naicsCode > 0) opts.GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE = this.naicsCode;
-      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));
-    }
-    else if (['aws', 'polly'].includes(this.vendor)) {
-      this.bugname = 'aws_transcribe';
-      if (this.vocabularyName) opts.AWS_VOCABULARY_NAME = this.vocabularyName;
-      if (this.vocabularyFilterName) {
-        opts.AWS_VOCABULARY_NAME = this.vocabularyFilterName;
-        opts.AWS_VOCABULARY_FILTER_METHOD = this.filterMethod || 'mask';
-      }
-      if (this.sttCredentials) {
-        Object.assign(opts, {
-          AWS_ACCESS_KEY_ID: this.sttCredentials.accessKeyId,
-          AWS_SECRET_ACCESS_KEY: this.sttCredentials.secretAccessKey,
-          AWS_REGION: this.sttCredentials.region
-        });
-      }
-      ep.addCustomEventListener(AwsTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
-      ep.addCustomEventListener(AwsTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
-    }
-    else if ('microsoft' === this.vendor) {
-      this.bugname = 'azure_transcribe';
-      if (this.sttCredentials) {
-        const {api_key, region, use_custom_stt, custom_stt_endpoint} = this.sttCredentials;
+        break;
 
-        Object.assign(opts, {
-          'AZURE_SUBSCRIPTION_KEY': api_key,
-          'AZURE_REGION': region
-        });
-        if (this.azureSttEndpointId) {
-          Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': this.azureSttEndpointId});
-        }
-        else if (use_custom_stt && custom_stt_endpoint) {
-          Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': custom_stt_endpoint});
-        }
-      }
-      if (this.hints && this.hints.length > 0) {
-        opts.AZURE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
-      }
-      if (this.altLanguages && this.altLanguages.length > 0) {
-        opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
-      }
-      else {
-        opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
-      }
-      if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
-      if (this.profanityOption && this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
-      if (this.azureServiceEndpoint) opts.AZURE_SERVICE_ENDPOINT = this.azureServiceEndpoint;
-      if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;
-      else if (this.timeout === 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = 120000;  // lengthy
-      opts.AZURE_USE_OUTPUT_FORMAT_DETAILED = 1;
+      case 'deepgram':
+        this.bugname = `${this.bugname_prefix}deepgram_transcribe`;
+        this.addCustomEventListener(
+          ep, DeepgramTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(ep, DeepgramTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, DeepgramTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep));
 
-      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));
+        /* if app sets deepgramOptions.utteranceEndMs they essentially want continuous asr */
+        if (opts.DEEPGRAM_SPEECH_UTTERANCE_END_MS) this.isContinuousAsr = true;
+        break;
+
+      case 'soniox':
+        this.bugname = `${this.bugname_prefix}soniox_transcribe`;
+        this.addCustomEventListener(
+          ep, SonioxTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        break;
+
+      case 'cobalt':
+        this.bugname = `${this.bugname_prefix}cobalt_transcribe`;
+        this.addCustomEventListener(
+          ep, CobaltTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+
+        /* cobalt doesnt have language, it has model, which is required */
+        if (!this.data.recognizer.model) {
+          throw new Error('Cobalt requires a model to be specified');
+        }
+        this.language = this.data.recognizer.model;
+
+        /* special case: if using hints with cobalt we need to compile them */
+        this.hostport = opts.COBALT_SERVER_URI;
+        if (this.vendor === 'cobalt' && opts.COBALT_SPEECH_HINTS) {
+          try {
+            const context = await this.compileHintsForCobalt(
+              ep,
+              this.hostport,
+              this.data.recognizer.model,
+              opts.COBALT_CONTEXT_TOKEN,
+              opts.COBALT_SPEECH_HINTS
+            );
+            if (context) opts.COBALT_COMPILED_CONTEXT_DATA = context;
+            delete opts.COBALT_SPEECH_HINTS;
+          } catch (err) {
+            this.logger.error({err}, 'Error compiling hints for cobalt');
+          }
+        }
+        delete opts.COBALT_SERVER_URI;
+        break;
+
+      case 'ibm':
+        this.bugname = `${this.bugname_prefix}ibm_transcribe`;
+        this.addCustomEventListener(ep, IbmTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(ep, IbmTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, IbmTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep));
+        break;
+
+      case 'nvidia':
+        this.bugname = `${this.bugname_prefix}nvidia_transcribe`;
+        this.addCustomEventListener(ep, NvidiaTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(ep, NvidiaTranscriptionEvents.StartOfSpeech,
+          this._onStartOfSpeech.bind(this, cs, ep));
+        this.addCustomEventListener(ep, NvidiaTranscriptionEvents.TranscriptionComplete,
+          this._onTranscriptionComplete.bind(this, cs, ep));
+        this.addCustomEventListener(ep, 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;
+
+      case 'assemblyai':
+        this.bugname = `${this.bugname_prefix}assemblyai_transcribe`;
+        this.addCustomEventListener(ep, AssemblyAiTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(
+          ep, AssemblyAiTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, AssemblyAiTranscriptionEvents.Error, this._onVendorError.bind(this, cs, ep));
+        this.addCustomEventListener(ep, AssemblyAiTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep));
+        break;
+      default:
+        if (this.vendor.startsWith('custom:')) {
+          this.bugname = `${this.bugname_prefix}${this.vendor}_transcribe`;
+          this.addCustomEventListener(
+            ep, JambonzTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+          this.addCustomEventListener(ep, JambonzTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
+          this.addCustomEventListener(ep, JambonzTranscriptionEvents.ConnectFailure,
+            this._onVendorConnectFailure.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 */
+    this.addCustomEventListener(ep, JambonzTranscriptionEvents.Error, this._onJambonzError.bind(this, cs, ep));
     await ep.set(opts)
       .catch((err) => this.logger.info(err, 'Error setting channel variables'));
   }
@@ -403,11 +458,18 @@ class TaskGather extends Task {
       interim: this.interim,
       bugname: this.bugname
     }, 'Gather:_startTranscribing');
+
+    /**
+     * Note: we don't need to ask deepgram for interim results, because they
+     * already send us words as they are finalized (is_final=true) even before
+     * the utterance is finalized (speech_final=true)
+     */
     ep.startTranscription({
       vendor: this.vendor,
       locale: this.language,
       interim: this.interim,
       bugname: this.bugname,
+      hostport: this.hostport,
     }).catch((err) => {
       const {writeAlerts, AlertType} = this.cs.srf.locals;
       this.logger.error(err, 'TaskGather:_startTranscribing error');
@@ -425,7 +487,11 @@ class TaskGather extends Task {
     this._clearTimer();
     this._timeoutTimer = setTimeout(() => {
       if (this.isContinuousAsr) this._startAsrTimer();
-      else this._resolve(this.digitBuffer.length >= this.minDigits ? 'dtmf-num-digits' : 'timeout');
+      else if (this.interDigitTimeout <= 0 ||
+        this.digitBuffer.length < this.minDigits ||
+        this.needsStt && this.digitBuffer.length === 0) {
+        this._resolve(this.digitBuffer.length >= this.minDigits ? 'dtmf-num-digits' : 'timeout');
+      }
     }, this.timeout);
   }
 
@@ -437,11 +503,13 @@ class TaskGather extends Task {
   }
 
   _startAsrTimer() {
+    if (this.vendor === 'deepgram') return; // no need
     assert(this.isContinuousAsr);
     this._clearAsrTimer();
     this._asrTimer = setTimeout(() => {
       this.logger.debug('_startAsrTimer - asr timer went off');
-      this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout');
+      const evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language);
+      this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout', evt);
     }, this.asrTimeout);
     this.logger.debug(`_startAsrTimer: set for ${this.asrTimeout}ms`);
   }
@@ -451,11 +519,28 @@ class TaskGather extends Task {
     this._asrTimer = null;
   }
 
+  _startFastRecognitionTimer(evt) {
+    assert(this.fastRecognitionTimeout > 0);
+    this._clearFastRecognitionTimer();
+    this._fastRecognitionTimer = setTimeout(() => {
+      evt.is_final = true;
+      this._resolve('speech', evt);
+    }, this.fastRecognitionTimeout);
+  }
+
+  _clearFastRecognitionTimer() {
+    if (this._fastRecognitionTimer) {
+      clearTimeout(this._fastRecognitionTimer);
+    }
+    this._fastRecognitionTimer = null;
+  }
+
   _startFinalAsrTimer() {
     this._clearFinalAsrTimer();
     this._finalAsrTimer = setTimeout(() => {
       this.logger.debug('_startFinalAsrTimer - final asr timer went off');
-      this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout');
+      const evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language);
+      this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout', evt);
     }, 1000);
     this.logger.debug('_startFinalAsrTimer: set for 1 second');
   }
@@ -491,56 +576,71 @@ class TaskGather extends Task {
     // 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 ('aws' === this.vendor && Array.isArray(evt) && evt.length > 0) evt = evt[0];
-    if ('microsoft' === this.vendor) {
-      const final = evt.RecognitionStatus === 'Success';
-      if (final) {
-        // don't sort based on confidence: https://github.com/Azure-Samples/cognitive-services-speech-sdk/issues/1463
-        //const nbest = evt.NBest.sort((a, b) => b.Confidence - a.Confidence);
-        const nbest = evt.NBest;
-        const language_code = evt.PrimaryLanguage?.Language || this.language;
-        evt = {
-          is_final: true,
-          language_code,
-          alternatives: [
-            {
-              confidence: nbest[0].Confidence,
-              transcript: nbest[0].Display
-            }
-          ]
-        };
+    if (this.vendor === 'ibm' && evt?.state === 'listening') return;
+
+    if (this.vendor === 'deepgram' && evt.type === 'UtteranceEnd') {
+      /* we will only get this when we have set utterance_end_ms */
+      if (this._bufferedTranscripts.length === 0) {
+        this.logger.debug('Gather:_onTranscription - got UtteranceEnd event from deepgram but no buffered transcripts');
       }
       else {
-        evt = {
-          is_final: false,
-          alternatives: [
-            {
-              transcript: evt.Text
-            }
-          ]
-        };
+        this.logger.debug('Gather:_onTranscription - got UtteranceEnd event from deepgram, return buffered transcript');
+        evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language);
+        this._bufferedTranscripts = [];
+        this._resolve('speech', evt);
+      }
+      return;
+    }
+
+    evt = this.normalizeTranscription(evt, this.vendor, 1, this.language,
+      this.shortUtterance, this.data.recognizer.punctuation);
+    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._bufferedTranscripts.reduce((count, e) => {
-      return count + e.alternatives[0].transcript.split(' ').length;
-    }, 0);
+    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);
 
+    let emptyTranscript = false;
     if (evt.is_final) {
       if (evt.alternatives[0].transcript === '' && !this.callSession.callGone && !this.killed) {
-        if ('microsoft' === this.vendor && finished === 'true') {
+        emptyTranscript = true;
+        if (finished === 'true' && ['microsoft', 'deepgram'].includes(this.vendor)) {
           this.logger.debug({evt}, 'TaskGather:_onTranscription - got empty transcript from old gather, disregarding');
+          return;
         }
-        else {
-          this.logger.info({evt}, 'TaskGather:_onTranscription - got empty transcript, listen again');
-          this._startTranscribing(ep);
+        else if (this.vendor !== 'deepgram') {
+          this.logger.info({evt}, 'TaskGather:_onTranscription - got empty transcript, continue listening');
+          return;
+        }
+        else if (this.isContinuousAsr) {
+          this.logger.info({evt},
+            'TaskGather:_onTranscription - got empty deepgram transcript during continous asr, continue listening');
+          return;
+        }
+        else if (this.vendor === 'deepgram' && this._bufferedTranscripts.length > 0) {
+          this.logger.info({evt},
+            'TaskGather:_onTranscription - got empty transcript from deepgram, return the buffered transcripts');
         }
-        return;
       }
+
       if (this.isContinuousAsr) {
         /* append the transcript and start listening again for asrTimeout */
         const t = evt.alternatives[0].transcript;
@@ -550,17 +650,19 @@ class TaskGather extends Task {
             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');
+          const evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language);
+          return this._resolve(this._bufferedTranscripts.length > 0 ? 'speech' : 'timeout', evt);
         }
         this._startAsrTimer();
-        return this._startTranscribing(ep);
+
+        /* 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) {
@@ -571,16 +673,33 @@ class TaskGather extends Task {
           return;
         }
         else {
+          if (this.vendor === 'soniox') {
+            /* compile transcripts into one */
+            this._sonioxTranscripts.push(evt.vendor.finalWords);
+            evt = this.compileSonioxTranscripts(this._sonioxTranscripts, 1, this.language);
+            this._sonioxTranscripts = [];
+          }
+          else if (this.vendor === 'deepgram') {
+            /* compile transcripts into one */
+            if (!emptyTranscript) this._bufferedTranscripts.push(evt);
+            if (this.data.recognizer?.deepgramOptions?.utteranceEndMs) {
+              this.logger.debug('TaskGather:_onTranscription - got speech_final waiting for UtteranceEnd event');
+              return;
+            }
+            this.logger.debug({evt}, 'TaskGather:_onTranscription - compiling deepgram transcripts');
+            evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language);
+            this._bufferedTranscripts = [];
+            this.logger.debug({evt}, 'TaskGather:_onTranscription - compiled deepgram transcripts');
+          }
+
+          /* here is where we return a final transcript */
           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');
@@ -588,12 +707,30 @@ class TaskGather extends Task {
         }
         this._killAudio(cs);
       }
+      if (this.fastRecognitionTimeout) {
+        this._startFastRecognitionTimer(evt);
+      }
       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);
+        }
+      }
+      /* deepgram can send a non-final transcript but with words that are final, so we need to buffer */
+      if (this.vendor === 'deepgram') {
+        const originalEvent = evt.vendor.evt;
+        if (originalEvent.is_final && evt.alternatives[0].transcript !== '') {
+          this.logger.debug({evt}, 'Gather:_onTranscription - buffering a completed (partial) deepgram transcript');
+          this._bufferedTranscripts.push(evt);
+        }
+      }
     }
   }
   _onEndOfUtterance(cs, ep) {
@@ -602,11 +739,75 @@ class TaskGather extends Task {
       this._killAudio(cs);
     }
 
-    if (!this.resolved && !this.killed && !this._bufferedTranscripts.length) {
+    /**
+     * 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 user 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');
+  }
+  async _onJambonzError(cs, ep, evt) {
+    this.logger.info({evt}, 'TaskGather:_onJambonzError');
+    if (this.isHandledByPrimaryProvider && this.fallbackVendor) {
+      ep.stopTranscription({
+        vendor: this.vendor,
+        bugname: this.bugname
+      })
+        .catch((err) => this.logger.error({err}, `Error stopping transcription for primary vendor ${this.vendor}`));
+      const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
+      try {
+        await this._fallback();
+        await this._initSpeech(cs, ep);
+        this._startTranscribing(ep);
+        updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid);
+        return;
+      } catch (error) {
+        this.logger.info({error}, `There is error while falling back to ${this.fallbackVendor}`);
+      }
+    }
+    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}`});
+  }
+
+  _onVendorConnectFailure(cs, _ep, evt) {
+    super._onVendorConnectFailure(cs, _ep, evt);
+    this.notifyTaskDone();
+  }
+
+  _onVendorError(cs, _ep, evt) {
+    super._onVendorError(cs, _ep, evt);
+    this._resolve('stt-error', evt);
+  }
+
   _onVadDetected(cs, ep) {
     if (this.bargein && this.minBargeinWordCount === 0) {
       this.logger.debug('TaskGather:_onVadDetected');
@@ -634,24 +835,24 @@ class TaskGather extends Task {
     if (this.resolved) return;
 
     this.resolved = true;
+    // Clear dtmf event
+    if (this.dtmfBargein) {
+      this.ep.removeAllListeners('dtmf');
+    }
     clearTimeout(this.interDigitTimer);
     this._clearTimer();
+    this._clearFastRecognitionTimer();
 
-    if (this.isContinuousAsr && reason.startsWith('speech')) {
-      evt = {
-        is_final: true,
-        transcripts: this._bufferedTranscripts
-      };
-      this.logger.debug({evt}, 'TaskGather:resolve continuous asr');
-    }
-    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)});
+    this.span.setAttributes({
+      channel: 1,
+      'stt.resolve': reason,
+      'stt.result': JSON.stringify(evt)
+    });
     if (this.needsStt && this.ep && this.ep.connected) {
-      this.ep.stopTranscription({vendor: this.vendor})
+      this.ep.stopTranscription({
+        vendor: this.vendor,
+        bugname: this.bugname
+      })
         .catch((err) => this.logger.error({err}, 'Error stopping transcription'));
     }
 
@@ -683,6 +884,13 @@ class TaskGather extends Task {
           await this.performAction({reason: 'timeout'});
         }
       }
+      else if (reason.startsWith('stt-error')) {
+        if (this.parentTask) this.parentTask.emit('stt-error', evt);
+        else {
+          this.emit('stt-error', evt);
+          await this.performAction({reason: 'error', details: evt.error});
+        }
+      }
     } catch (err) {  /*already logged error*/ }
     this.notifyTaskDone();
   }

lib/tasks/hangup.js

@@ -18,6 +18,7 @@ class TaskHangup extends Task {
     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/lex.js

@@ -1,6 +1,6 @@
 const Task = require('./task');
 const {TaskName, TaskPreconditions} = require('../utils/constants');
-const normalizeJambones = require('../utils/normalize-jambones');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 
 class Lex extends Task {
   constructor(logger, opts) {
@@ -25,6 +25,13 @@ class Lex extends Task {
       this.vendor = this.data.tts.vendor || 'default';
       this.language = this.data.tts.language || 'default';
       this.voice = this.data.tts.voice || 'default';
+      this.speechCredentialLabel = this.data.tts.label || 'default';
+
+      // fallback tts
+      this.fallbackVendor = this.data.tts.fallbackVendor || 'default';
+      this.fallbackLanguage = this.data.tts.fallbackLanguage || 'default';
+      this.fallbackVoice = this.data.tts.fallbackLanguage || 'default';
+      this.fallbackLabel = this.data.tts.fallbackLabel || 'default';
     }
 
     this.botName = `${this.bot}:${this.alias}:${this.region}`;
@@ -102,8 +109,16 @@ class Lex extends Task {
         this.vendor = cs.speechSynthesisVendor;
         this.language = cs.speechSynthesisLanguage;
         this.voice = cs.speechSynthesisVoice;
+        this.speechCredentialLabel = cs.speechSynthesisLabel;
       }
-      this.ttsCredentials = cs.getSpeechCredentials(this.vendor, 'tts');
+      if (this.fallbackVendor === 'default') {
+        this.fallbackVendor = cs.fallbackSpeechSynthesisVendor;
+        this.fallbackLanguage = cs.fallbackSpeechSynthesisLanguage;
+        this.fallbackVoice = cs.fallbackSpeechSynthesisVoice;
+        this.fallbackLabel = cs.fallbackSpeechSynthesisLabel;
+      }
+
+      this.ttsCredentials = cs.getSpeechCredentials(this.vendor, 'tts', this.speechCredentialLabel);
 
       this.ep.addCustomEventListener('lex::intent', this._onIntent.bind(this, ep, cs));
       this.ep.addCustomEventListener('lex::transcription', this._onTranscription.bind(this, ep, cs));
@@ -168,6 +183,41 @@ class Lex extends Task {
     }
   }
 
+  async _fallbackSynthAudio(cs, msg, stats, synthAudio) {
+    try {
+      const {filePath} = await synthAudio(stats, {
+        account_sid: cs.accountSid,
+        text: msg,
+        vendor: this.vendor,
+        language: this.language,
+        voice: this.voice,
+        salt: cs.callSid,
+        credentials: this.ttsCredentials
+      });
+
+      return filePath;
+    } catch (error) {
+      this.logger.info({error}, 'failed to synth audio from primary vendor');
+      if (this.fallbackVendor) {
+        try {
+          const credential = cs.getSpeechCredentials(this.fallbackVendor, 'tts', this.fallbackLabel);
+          const {filePath} = await synthAudio(stats, {
+            account_sid: cs.accountSid,
+            text: msg,
+            vendor: this.fallbackVendor,
+            language: this.fallbackLanguage,
+            voice: this.fallbackVoice,
+            salt: cs.callSid,
+            credentials: credential
+          });
+          return filePath;
+        } catch (err) {
+          this.logger.info({err}, 'failed to synth audio from fallback vendor');
+        }
+      }
+    }
+  }
+
   /**
    * @param {*} evt - event data
    */
@@ -187,15 +237,7 @@ class Lex extends Task {
 
         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
-          });
+          const filePath = await this._fallbackSynthAudio(cs, msg, stats, synthAudio);
           if (filePath) cs.trackTmpFile(filePath);
 
           if (this.events.includes('start-play')) {

lib/tasks/listen.js

@@ -2,15 +2,18 @@ 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;
+const DTMF_SPAN_NAME = 'dtmf';
 
 class TaskListen extends Task {
   constructor(logger, opts, parentTask) {
     super(logger, opts);
+    this.disableBidirectionalAudio = opts.disableBidirectionalAudio;
     this.preconditions = TaskPreconditions.Endpoint;
 
     [
       '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,12 +23,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);
   }
 
   get name() { return TaskName.Listen; }
 
+  set bugname(name) { this._bugname = name; }
+
+  set ignoreCustomerData(val) { this._ignoreCustomerData = val; }
+
   async exec(cs, {ep}) {
     await super.exec(cs);
     this.ep = ep;
@@ -58,10 +67,12 @@ 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');
       try {
-        await this.ep.forkAudioStop();
+        const args = this._bugname ? [this._bugname] : [];
+        await this.ep.forkAudioStop(...args);
         this.logger.debug('TaskListen:kill successfully closed websocket');
       } catch (err) {
         this.logger.info(err, 'TaskListen:kill');
@@ -81,13 +92,16 @@ class TaskListen extends Task {
 
   async updateListen(status) {
     if (!this.killed && this.ep && this.ep.connected) {
+      const args = this._bugname ? [this._bugname] : [];
       this.logger.info(`TaskListen:updateListen status ${status}`);
       switch (status) {
         case ListenStatus.Pause:
-          await this.ep.forkAudioPause().catch((err) => this.logger.info(err, 'TaskListen: error pausing audio'));
+          await this.ep.forkAudioPause(...args)
+            .catch((err) => this.logger.info(err, 'TaskListen: error pausing audio'));
           break;
         case ListenStatus.Resume:
-          await this.ep.forkAudioResume().catch((err) => this.logger.info(err, 'TaskListen: error resuming audio'));
+          await this.ep.forkAudioResume(...args)
+            .catch((err) => this.logger.info(err, 'TaskListen: error resuming audio'));
           break;
       }
     }
@@ -100,9 +114,13 @@ class TaskListen extends Task {
 
   async _startListening(cs, ep) {
     this._initListeners(ep);
+    const ci = this.nested ? this.parentTask.sd.callInfo : cs.callInfo.toJSON();
+    if (this._ignoreCustomerData) {
+      delete ci.customerData;
+    }
     const metadata = Object.assign(
       {sampleRate: this.sampleRate, mixType: this.mixType},
-      this.nested ? this.parentTask.sd.callInfo : cs.callInfo.toJSON(),
+      ci,
       this.metadata);
     if (this.hook.auth) {
       this.logger.debug({username: this.hook.auth.username, password: this.hook.auth.password},
@@ -116,6 +134,7 @@ class TaskListen extends Task {
       wsUrl: this.hook.url,
       mixType: this.mixType,
       sampling: this.sampleRate,
+      ...(this._bugname && {bugname: this._bugname}),
       metadata
     });
     this.recordStartTime = moment();
@@ -136,7 +155,9 @@ class TaskListen extends Task {
     }
 
     /* support bi-directional audio */
-    ep.addCustomEventListener(ListenEvents.PlayAudio, this._onPlayAudio.bind(this, ep));
+    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));
   }
@@ -155,12 +176,25 @@ class TaskListen extends Task {
   }
 
   _onDtmf(ep, evt) {
-    this.logger.debug({evt}, `TaskListen:_onDtmf received dtmf ${evt.dtmf}`);
+    const {dtmf, duration} = evt;
+    this.logger.debug({evt}, `TaskListen:_onDtmf received dtmf ${dtmf}`);
     if (this.passDtmf && this.ep?.connected) {
-      const obj = {event: 'dtmf', dtmf: evt.dtmf, duration: evt.duration};
-      this.ep.forkAudioSendText(obj)
+      const obj = {event: 'dtmf', dtmf, duration};
+      const args = this._bugname ? [this._bugname, obj] : [obj];
+      this.ep.forkAudioSendText(...args)
         .catch((err) => this.logger.info({err}, 'TaskListen:_onDtmf error sending dtmf'));
     }
+
+    /* add a child span for the dtmf event */
+    const msDuration = Math.floor((duration / 8000) * 1000);
+    const {span} = this.startChildSpan(`${DTMF_SPAN_NAME}:${dtmf}`);
+    span.setAttributes({
+      channel: 1,
+      dtmf,
+      duration: `${msDuration}ms`
+    });
+    span.end();
+
     if (evt.dtmf === this.finishOnKey) {
       this.logger.info(`TaskListen:_onDtmf terminating task due to dtmf ${evt.dtmf}`);
       this.results.digits = evt.dtmf;
@@ -182,16 +216,44 @@ class TaskListen extends Task {
     this.notifyTaskDone();
   }
 
-  async _onPlayAudio(ep, evt) {
-    this.logger.info(`received play_audio event: ${JSON.stringify(evt)}`);
+  async _playAudio(ep, evt, logger) {
     try {
       const results = await ep.play(evt.file);
-      this.logger.debug(`Finished playing file, result: ${JSON.stringify(results)}`);
-      ep.forkAudioSendText({type: 'playDone', data: Object.assign({id: evt.id}, results)});
+      logger.debug(`Finished playing file, result: ${JSON.stringify(results)}`);
+      const obj = {
+        type: 'playDone',
+        data: {
+          id: evt.id,
+          ...results
+        }
+      };
+      const args = this._bugname ? [this._bugname, obj] : [obj];
+      ep.forkAudioSendText(...args);
+    } catch (err) {
+      logger.error({err}, 'Error playing file');
     }
-    catch (err) {
-      this.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) {

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,7 +12,7 @@ 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');

lib/tasks/message.js

@@ -1,8 +1,8 @@
 const Task = require('./task');
 const {TaskName, TaskPreconditions} = require('../utils/constants');
 const bent = require('bent');
-const { v4: uuidv4 } = require('uuid');
-
+const uuidv4 = require('uuid-random');
+const {K8S} = require('../config');
 class TaskMessage extends Task {
   constructor(logger, opts) {
     super(logger, opts);
@@ -42,7 +42,7 @@ class TaskMessage extends Task {
       }
       if (gw) {
         this.logger.info({gw, accountSid}, 'Message:exec - using smpp to send message');
-        url = process.env.K8S ? 'http://smpp' : getSmpp();
+        url = K8S ? 'http://smpp' : getSmpp();
         relativeUrl = '/sms';
         payload = {
           ...payload,

lib/tasks/play.js

@@ -22,7 +22,22 @@ class TaskPlay extends Task {
   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 {
+      this.notifyStatus({event: 'start-playback'});
       while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep.connected) {
         if (cs.isInConference) {
           const {memberId, confName, confUuid} = cs;
@@ -34,14 +49,24 @@ class TaskPlay extends Task {
             await this.playToConfMember(this.ep, memberId, confName, confUuid, this.url);
           }
         } else {
-          const file = (this.timeoutSecs >= 0 || this.seekOffset >= 0) ?
-            {file: this.url, seekOffset: this.seekOffset, timeoutSecs: this.timeoutSecs} : this.url;
+          let file = this.url;
+          if (this.seekOffset >= 0) {
+            file = {file: this.url, seekOffset: this.seekOffset};
+            this.seekOffset = -1;
+          }
           const result = await ep.play(file);
-          await this.performAction(Object.assign(result, {reason: 'playCompleted'}),
-            !(this.parentTask || cs.isConfirmCallSession));
+          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');
@@ -56,7 +81,8 @@ class TaskPlay extends Task {
         this.killPlayToConfMember(this.ep, memberId, confName);
       }
       else {
-        await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+        this.notifyStatus({event: 'kill-playback'});
+        this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
       }
     }
   }

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,10 +11,12 @@ class TaskRestDial extends Task {
     super(logger, opts);
 
     this.from = this.data.from;
+    this.callerName = this.data.callerName;
     this.fromHost = this.data.fromHost;
     this.to = this.data.to;
     this.call_hook = this.data.call_hook;
     this.timeout = this.data.timeout || 60;
+    this.sipRequestWithinDialogHook = this.data.sipRequestWithinDialogHook;
 
     this.on('connect', this._onConnect.bind(this));
     this.on('callStatus', this._onCallStatus.bind(this));
@@ -22,37 +24,53 @@ class TaskRestDial extends Task {
 
   get name() { return TaskName.RestDial; }
 
+  set appJson(app_json) {
+    this.app_json = app_json;
+  }
+
   /**
    * INVITE has just been sent at this point
   */
   async exec(cs) {
     await super.exec(cs);
-    this.req = cs.req;
+    this.cs = cs;
+    this.canCancel = true;
+
+    if (this.data.amd) {
+      this.startAmd = cs.startAmd;
+      this.stopAmd = cs.stopAmd;
+      this.on('amd', this._onAmdEvent.bind(this, cs));
+    }
 
     this._setCallTimer();
     await this.awaitTaskDone();
   }
 
+  turnOffAmd() {
+    if (this.callSession.ep && this.callSession.ep.amd) this.stopAmd(this.callSession.ep, this);
+  }
+
   kill(cs) {
     super.kill(cs);
     this._clearCallTimer();
-    if (this.req) {
-      this.req.cancel();
-      this.req = null;
+    if (this.canCancel) {
+      this.canCancel = false;
+      cs?.req?.cancel();
     }
     this.notifyTaskDone();
   }
 
   async _onConnect(dlg) {
-    this.req = null;
+    this.canCancel = false;
     const cs = this.callSession;
     cs.setDialog(dlg);
-
+    this.logger.debug('TaskRestDial:_onConnect - call connected');
+    if (this.sipRequestWithinDialogHook) this._initSipRequestWithinDialogHandler(cs, dlg);
     try {
       const b3 = this.getTracingPropagation();
       const httpHeaders = b3 && {b3};
       const params = {
-        ...cs.callInfo,
+        ...(cs.callInfo.toJSON()),
         defaults: {
           synthesizer: {
             vendor: cs.speechSynthesisVendor,
@@ -65,7 +83,21 @@ class TaskRestDial extends Task {
           }
         }
       };
-      const tasks = await cs.requestor.request('session:new', this.call_hook, params, httpHeaders);
+      if (this.startAmd) {
+        try {
+          this.startAmd(this.callSession, this.callSession.ep, this, this.data.amd);
+        } catch (err) {
+          this.logger.info({err}, 'Rest:dial:Call established - Error calling startAmd');
+        }
+      }
+      let tasks;
+      if (this.app_json) {
+        this.logger.debug('TaskRestDial: using app_json from task data');
+        tasks = JSON.parse(this.app_json);
+      } else {
+        this.logger.debug({call_hook: this.call_hook}, 'TaskRestDial: retrieving application');
+        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)));
@@ -79,7 +111,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();
     }
@@ -97,7 +129,29 @@ class TaskRestDial extends Task {
   _onCallTimeout() {
     this.logger.debug('TaskRestDial: timeout expired without answer, killing task');
     this.timer = null;
-    this.kill();
+    if (this.canCancel) {
+      this.canCancel = false;
+      this.cs?.req?.cancel();
+    }
+  }
+
+  _onAmdEvent(cs, evt) {
+    this.logger.info({evt}, 'Rest:dial:_onAmdEvent');
+    const {actionHook} = this.data.amd;
+    this.performHook(cs, actionHook, evt)
+      .catch((err) => {
+        this.logger.error({err}, 'Rest:dial:_onAmdEvent - error calling actionHook');
+      });
+  }
+
+  _initSipRequestWithinDialogHandler(cs, dlg) {
+    cs.sipRequestWithinDialogHook = this.sipRequestWithinDialogHook;
+    dlg.on('info', this._onRequestWithinDialog.bind(this, cs));
+    dlg.on('message', this._onRequestWithinDialog.bind(this, cs));
+  }
+
+  async _onRequestWithinDialog(cs, req, res) {
+    cs._onRequestWithinDialog(req, res);
   }
 }
 

lib/tasks/say.js

@@ -1,96 +1,26 @@
 const Task = require('./task');
 const {TaskName, TaskPreconditions} = require('../utils/constants');
+const pollySSMLSplit = require('polly-ssml-split');
 
 const breakLengthyTextIfNeeded = (logger,  text) => {
   const chunkSize = 1000;
-  if (text.length <= chunkSize) return [text];
-
-  const result = [];
   const isSSML = text.startsWith('<speak>');
-  let startPos = 0;
-  let charPos = isSSML ? 7 : 0;  // skip <speak>
-  let tag;
-  //logger.debug({isSSML}, `breakLengthyTextIfNeeded: handling text of length ${text.length}`);
-  while (startPos + charPos < text.length) {
-    if (isSSML && !tag && text[startPos + charPos] === '<') {
-      const tagStartPos = ++charPos;
-      while (startPos + charPos < text.length) {
-        if (text[startPos + charPos] === '>') {
-          if (text[startPos + charPos - 1] === '\\') tag = null;
-          else if (!tag) tag = text.substring(startPos + tagStartPos, startPos + charPos - 1);
-          break;
-        }
-        if (!tag) {
-          const c = text[startPos + charPos];
-          if (c === ' ') {
-            tag = text.substring(startPos + tagStartPos, startPos + charPos);
-            //logger.debug(`breakLengthyTextIfNeeded: enter tag ${tag} (space)`);
-            break;
-          }
-        }
-        charPos++;
-      }
-      if (tag) {
-        //search for end of tag
-        //logger.debug(`breakLengthyTextIfNeeded: searching forward for </${tag}>`);
-        const e1 = text.indexOf(`</${tag}>`, startPos + charPos);
-        const e2 = text.indexOf('/>', startPos + charPos);
-        const tagEndPos = e1 === -1 ? e2 : e2 === -1 ? e1 : Math.min(e1, e2);
-        if (tagEndPos === -1) {
-          //logger.debug(`breakLengthyTextIfNeeded: exit tag ${tag} not found, exiting`);
-        } else {
-          //logger.debug(`breakLengthyTextIfNeeded: exit tag ${tag} found at ${tagEndPos}`);
-          charPos = tagEndPos + 1;
-        }
-        tag = null;
-      }
-      continue;
-    }
-
-    if (charPos < chunkSize) {
-      charPos++;
-      continue;
-    }
-
-    // start looking for a good break point
-    let chunkIt = false;
-    const a = text[startPos + charPos];
-    const b = text[startPos + charPos + 1];
-    if (/[\.!\?]/.test(a) && /\s/.test(b)) {
-      //logger.debug('breakLengthyTextIfNeeded: breaking at sentence end');
-      chunkIt = true;
-    }
-    if (chunkIt) {
-      charPos++;
-      const chunk = text.substr(startPos, charPos);
-      if (isSSML) {
-        result.push(0 === startPos ? `${chunk}</speak>` : `<speak>${chunk}</speak>`);
-      }
-      else result.push(chunk);
-      charPos = 0;
-      startPos += chunk.length;
-
-      //logger.debug({chunk: result[result.length - 1]},
-      //  `breakLengthyTextIfNeeded: chunked; new starting pos ${startPos}`);
-
-    }
-    else charPos++;
+  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];
   }
-
-  // final chunk
-  if (startPos < text.length) {
-    const chunk = text.substr(startPos);
-    if (isSSML) {
-      result.push(0 === startPos ? `${chunk}</speak>` : `<speak>${chunk}`);
-    }
-    else result.push(chunk);
-
-    //logger.debug({chunk: result[result.length - 1]},
-    //  `breakLengthyTextIfNeeded: final chunk; starting pos ${startPos} length ${chunk.length}`);
-
-  }
-
-  return result;
 };
 
 class TaskSay extends Task {
@@ -105,6 +35,9 @@ class TaskSay extends Task {
     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;
+    this.options = this.synthesizer.options || {};
+    this.isHandledByPrimaryProvider = true;
   }
 
   get name() { return TaskName.Say; }
@@ -117,28 +50,54 @@ class TaskSay extends Task {
     return `${this.name}{${this.text[0]}}`;
   }
 
-  async exec(cs, {ep}) {
-    await super.exec(cs);
+  _validateURL(urlString) {
+    try {
+      new URL(urlString);
+      return true;
+    } catch (e) {
+      return false;
+    }
+  }
 
+  async _synthesizeWithSpecificVendor(cs, ep, {vendor, language, voice, label, preCache = false}) {
     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 ;
-    const 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');
 
-    this.logger.info({vendor, language, voice}, 'TaskSay:exec');
-    this.ep = ep;
+    let credentials = cs.getSpeechCredentials(vendor, 'tts', label);
+    /* parse Nuance voices into name and model */
+    let model;
+    if (vendor === 'nuance' && voice) {
+      const arr = /([A-Za-z-]*)\s+-\s+(enhanced|standard)/.exec(voice);
+      if (arr) {
+        voice = arr[1];
+        model = arr[2];
+      }
+    } else if (vendor === 'deepgram') {
+      model = voice;
+    }
+
+    /* allow for microsoft custom region voice and api_key to be specified as an override */
+    if (vendor === 'microsoft' && this.options.deploymentId) {
+      credentials = credentials || {};
+      credentials.use_custom_tts = true;
+      credentials.custom_tts_endpoint = this.options.deploymentId;
+      credentials.api_key = this.options.apiKey || credentials.apiKey;
+      credentials.region = this.options.region || credentials.region;
+      voice = this.options.voice || voice;
+    } else if (vendor === 'elevenlabs') {
+      credentials = credentials || {};
+      credentials.model_id = this.options.model_id || credentials.model_id;
+      credentials.voice_settings = this.options.voice_settings || {};
+      credentials.optimize_streaming_latency = this.options.optimize_streaming_latency
+      || credentials.optimize_streaming_latency;
+      voice = this.options.voice_id || voice;
+    }
+
+    if (!preCache) this.logger.info({vendor, language, voice, model}, 'TaskSay:exec');
     try {
       if (!credentials) {
         writeAlerts({
@@ -146,7 +105,10 @@ class TaskSay extends Task {
           alert_type: AlertType.TTS_NOT_PROVISIONED,
           vendor
         }).catch((err) => this.logger.info({err}, 'Error generating alert for no tts'));
-        this.notifyError(`No speech credentials have been provisioned for ${vendor}`);
+        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
@@ -158,20 +120,28 @@ class TaskSay extends Task {
         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
-        });
+        let otelSpan;
+        if (!preCache)  {
+          const {span} = this.startChildSpan('tts-generation', {
+            'tts.vendor': vendor,
+            'tts.language': language,
+            'tts.voice': voice
+          });
+          otelSpan = span;
+        }
         try {
-          const {filePath, servedFromCache} = await synthAudio(stats, {
+          const {filePath, servedFromCache, rtt} = await synthAudio(stats, {
+            account_sid: cs.accountSid,
             text,
             vendor,
             language,
             voice,
             engine,
+            model,
             salt,
-            credentials
+            credentials,
+            options: this.options,
+            disableTtsCache : this.disableTtsCache
           });
           this.logger.debug(`file ${filePath}, served from cache ${servedFromCache}`);
           if (filePath) cs.trackTmpFile(filePath);
@@ -180,44 +150,105 @@ class TaskSay extends Task {
             updateSpeechCredentialLastUsed(credentials.speech_credential_sid)
               .catch(() => {/*already logged error */});
           }
-          span.setAttributes({'tts.cached': servedFromCache});
-          span.end();
+          if (otelSpan) otelSpan.setAttributes({'tts.cached': servedFromCache});
+          if (otelSpan) otelSpan.end();
+          if (!servedFromCache && rtt && !preCache) {
+            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();
+          if (otelSpan) otelSpan.end();
           writeAlerts({
             account_sid: cs.accountSid,
-            alert_type: AlertType.TTS_NOT_PROVISIONED,
+            alert_type: AlertType.TTS_FAILURE,
             vendor,
             detail: err.message
           }).catch((err) => this.logger.info({err}, 'Error generating alert for tts failure'));
-          this.notifyError(err.message || err);
-          return;
+          this.notifyError({msg: 'TTS error', details: err.message || err});
+          throw err;
         }
       };
 
-      const arr = this.text.map((t) => generateAudio(t));
-      const filepath = (await Promise.all(arr)).filter((fp) => fp && fp.length);
-      this.logger.debug({filepath}, 'synthesized files for tts');
-
-      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep?.connected) {
-        let segment = 0;
-        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++;
-        }
-      }
+      const arr = this.text.map((t) => (this._validateURL(t) ? t : generateAudio(t)));
+      return (await Promise.all(arr)).filter((fp) => fp && fp.length);
     } catch (err) {
       this.logger.info(err, 'TaskSay:exec error');
+      throw err;
+    }
+
+  }
+
+  async exec(cs, {ep}) {
+    await super.exec(cs);
+    this.ep = ep;
+
+    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 ;
+    const voice =  this.synthesizer.voice && this.synthesizer.voice !== 'default' ?
+      this.synthesizer.voice :
+      cs.speechSynthesisVoice;
+    const label = this.synthesizer.label && this.synthesizer.label !== 'default' ?
+      this.synthesizer.label :
+      cs.speechSynthesisLabel;
+
+    const fallbackVendor = this.synthesizer.fallbackVendor && this.synthesizer.fallbackVendor !== 'default' ?
+      this.synthesizer.fallbackVendor :
+      cs.fallbackSpeechSynthesisVendor;
+    const fallbackLanguage = this.synthesizer.fallbackLanguage && this.synthesizer.fallbackLanguage !== 'default' ?
+      this.synthesizer.fallbackLanguage :
+      cs.fallbackSpeechSynthesisLanguage ;
+    const fallbackVoice =  this.synthesizer.fallbackVoice && this.synthesizer.fallbackVoice !== 'default' ?
+      this.synthesizer.fallbackVoice :
+      cs.fallbackSpeechSynthesisVoice;
+    const fallbackLabel = this.synthesizer.fallbackLabel && this.synthesizer.fallbackLabel !== 'default' ?
+      this.synthesizer.fallbackLabel :
+      cs.fallbackSpeechSynthesisLabel;
+
+    let filepath;
+    try {
+      filepath = await this._synthesizeWithSpecificVendor(cs, ep, {vendor, language, voice, label});
+    } catch (error) {
+      if (fallbackVendor && this.isHandledByPrimaryProvider) {
+        this.isHandledByPrimaryProvider = false;
+        this.logger.info(`Synthesize error, fallback to ${fallbackVendor}`);
+        filepath = await this._synthesizeWithSpecificVendor(cs, ep,
+          {
+            vendor: fallbackVendor,
+            language: fallbackLanguage,
+            voice: fallbackVoice,
+            label: fallbackLabel
+          });
+      } else {
+        throw error;
+      }
+    }
+    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++;
+      }
     }
     this.emit('playDone');
   }
@@ -231,6 +262,7 @@ class TaskSay extends Task {
         this.killPlayToConfMember(this.ep, memberId, confName);
       }
       else {
+        this.notifyStatus({event: 'kill-playback'});
         this.ep.api('uuid_break', this.ep.uuid);
       }
     }

lib/tasks/sip_refer.js

@@ -36,6 +36,7 @@ class TaskSipRefer extends Task {
         method: 'REFER',
         headers: {
           ...this.headers,
+          ...(this.referToIsUri && {'X-Refer-To-Leave-Untouched': true}),
           'Refer-To': referTo,
           'Referred-By': referredBy
         }
@@ -46,7 +47,17 @@ class TaskSipRefer extends Task {
 
       /* 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});
@@ -70,10 +81,10 @@ class TaskSipRefer extends Task {
     const contentType = req.get('Content-Type');
     this.logger.debug({body: req.body}, `TaskSipRefer:_handleNotify got ${contentType}`);
 
-    if (contentType === 'message/sipfrag') {
+    if (contentType?.includes('message/sipfrag')) {
       const arr = /SIP\/2\.0\s+(\d+)/.exec(req.body);
       if (arr) {
-        const status = arr[1];
+        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();
@@ -100,6 +111,7 @@ class TaskSipRefer extends Task {
       /* 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;

lib/tasks/specs.json

@@ -1,556 +0,0 @@
-{
-  "sip:decline": {
-    "properties": {
-      "status": "number",
-      "reason": "string",
-      "headers": "object"
-    },
-    "required": [
-      "status"
-    ]
-  },
-  "sip:request": {
-    "properties": {
-      "method": "string",
-      "body": "string",
-      "headers": "object",
-      "actionHook": "object|string"
-    },
-    "required": [
-      "method"
-    ]
-  },
-  "sip:refer": {
-    "properties": {
-      "referTo": "string",
-      "referredBy": "string",
-      "headers": "object",
-      "actionHook": "object|string",
-      "eventHook": "object|string"
-    },
-    "required": [
-      "referTo"
-    ]
-  },
-  "config": {
-    "properties": {
-      "synthesizer": "#synthesizer",
-      "recognizer": "#recognizer",
-      "bargeIn": "#bargeIn",
-      "record": "#recordOptions",
-      "amd": "#amd"
-    },
-    "required": []
-  },
-  "bargeIn": {
-    "properties": {
-      "enable": "boolean",
-      "sticky": "boolean",
-      "actionHook": "object|string",
-      "input": "array",
-      "finishOnKey": "string",
-      "numDigits": "number",
-      "minDigits": "number",
-      "maxDigits": "number",
-      "interDigitTimeout": "number",
-      "dtmfBargein": "boolean",
-      "minBargeinWordCount": "number"
-    },
-    "required": [
-      "enable"
-    ]
-  },
-  "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|array",
-      "loop": "number|string",
-      "earlyMedia": "boolean",
-      "seekOffset": "number|string",
-      "timeoutSecs": "number|string",
-      "actionHook": "object|string"
-    },
-    "required": [
-      "url"
-    ]
-  },
-  "say": {
-    "properties": {
-      "text": "string|array",
-      "loop": "number|string",
-      "synthesizer": "#synthesizer",
-      "earlyMedia": "boolean"
-    },
-    "required": [
-      "text"
-    ]
-  },
-  "gather": {
-    "properties": {
-      "actionHook": "object|string",
-      "finishOnKey": "string",
-      "input": "array",
-      "numDigits": "number",
-      "minDigits": "number",
-      "maxDigits": "number",
-      "interDigitTimeout": "number",
-      "partialResultHook": "object|string",
-      "speechTimeout": "number",
-      "listenDuringPrompt": "boolean",
-      "dtmfBargein": "boolean",
-      "bargein": "boolean",
-      "minBargeinWordCount": "number",
-      "timeout": "number",
-      "recognizer": "#recognizer",
-      "play": "#play",
-      "say": "#say"
-    },
-    "required": [
-    ]
-  },
-  "conference": {
-    "properties": {
-      "name": "string",
-      "beep": "boolean",
-      "startConferenceOnEnter": "boolean",
-      "endConferenceOnExit": "boolean",
-      "maxParticipants": "number",
-      "joinMuted": "boolean",
-      "actionHook": "object|string",
-      "waitHook": "object|string",
-      "statusEvents": "array",
-      "statusHook": "object|string",
-      "enterHook": "object|string",
-      "record": "#record"
-    },
-    "required": [
-      "name"
-    ]
-  },
-  "dial": {
-    "properties": {
-      "actionHook": "object|string",
-      "answerOnBridge": "boolean",
-      "callerId": "string",
-      "confirmHook": "object|string",
-      "referHook": "object|string",
-      "dialMusic": "string",
-      "dtmfCapture": "object",
-      "dtmfHook": "object|string",
-      "headers": "object",
-      "listen": "#listen",
-      "target": ["#target"],
-      "timeLimit": "number",
-      "timeout": "number",
-      "proxy": "string",
-      "transcribe": "#transcribe",
-      "amd": "#amd"
-    },
-    "required": [
-      "target"
-    ]
-  },
-  "dialogflow": {
-    "properties": {
-      "credentials": "object|string",
-      "project": "string",
-      "environment": "string",
-      "region": {
-        "type": "string",
-        "enum": ["europe-west1", "europe-west2", "australia-southeast1", "asia-northeast1"]
-      },
-      "lang": "string",
-      "actionHook": "object|string",
-      "eventHook": "object|string",
-      "events": "[string]",
-      "welcomeEvent": "string",
-      "welcomeEventParams": "object",
-      "noInputTimeout": "number",
-      "noInputEvent": "string",
-      "passDtmfAsTextInput": "boolean",
-      "thinkingMusic": "string",
-      "tts": "#synthesizer",
-      "bargein": "boolean"
-    },
-    "required": [
-      "project",
-      "credentials",
-      "lang"
-    ]
-  },
-  "dtmf": {
-    "properties": {
-      "dtmf": "string",
-      "duration": "number"
-    },
-    "required": [
-      "dtmf"
-    ]
-  },
-  "lex": {
-    "properties": {
-      "botId": "string",
-      "botAlias": "string",
-      "credentials": "object",
-      "region": "string",
-      "locale": "string",
-      "intent": "#lexIntent",
-      "welcomeMessage": "string",
-      "metadata": "object",
-      "bargein": "boolean",
-      "passDtmf": "boolean",
-      "actionHook": "object|string",
-      "eventHook": "object|string",
-      "noInputTimeout": "number",
-      "tts": "#synthesizer"
-    },
-    "required": [
-      "botId",
-      "botAlias",
-      "region",
-      "credentials"
-    ]
-  },
-  "listen": {
-    "properties": {
-      "actionHook": "object|string",
-      "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"
-    ]
-  },
-  "message": {
-    "properties": {
-      "carrier": "string",
-      "account_sid": "string",
-      "message_sid": "string",
-      "to": "string",
-      "from": "string",
-      "text": "string",
-      "media": "string|array",
-      "actionHook": "object|string"
-    },
-    "required": [
-      "to",
-      "from"
-    ]
-  },
-  "pause": {
-    "properties": {
-      "length": "number"
-    },
-    "required": [
-      "length"
-    ]
-  },
-  "rasa": {
-    "properties": {
-      "url": "string",
-      "recognizer": "#recognizer",
-      "tts": "#synthesizer",
-      "prompt": "string",
-      "actionHook": "object|string",
-      "eventHook": "object|string"
-    },
-    "required": [
-      "url"
-    ]
-  },
-  "record": {
-    "properties": {
-      "path": "string"
-    },
-    "required": [
-      "path"
-    ]
-  },
-  "recordOptions": {
-    "properties": {
-      "action": {
-        "type": "string",
-        "enum": ["startCallRecording", "stopCallRecording", "pauseCallRecording", "resumeCallRecording"]
-      },
-      "recordingID": "string",
-      "siprecServerURL": "string"
-    },
-    "required": [
-      "action"
-    ]
-  },
-  "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",
-      "fromHost": "string",
-      "speech_synthesis_vendor": "string",
-      "speech_synthesis_voice": "string",
-      "speech_synthesis_language": "string",
-      "speech_recognizer_vendor": "string",
-      "speech_recognizer_language": "string",
-      "tag": "object",
-      "to": "#target",
-      "headers": "object",
-      "timeout": "number"
-    },
-    "required": [
-      "call_hook",
-      "from",
-      "to"
-    ]
-  },
-  "tag": {
-    "properties": {
-      "data": "object"
-    },
-    "required": [
-      "data"
-    ]
-  },
-  "transcribe": {
-    "properties": {
-      "transcriptionHook": "string",
-      "recognizer": "#recognizer",
-      "earlyMedia": "boolean"
-    },
-    "required": [
-      "recognizer"
-    ]
-  },
-  "target": {
-    "properties": {
-      "type": {
-        "type": "string",
-        "enum": ["phone", "sip", "user", "teams"]
-      },
-      "confirmHook": "object|string",
-      "method": {
-        "type": "string",
-        "enum": ["GET", "POST"]
-      },
-      "headers": "object",
-      "from": "#dialFrom",
-      "name": "string",
-      "number": "string",
-      "sipUri": "string",
-      "auth": "#auth",
-      "vmail": "boolean",
-      "tenant": "string",
-      "trunk": "string",
-      "overrideTo": "string"
-    },
-    "required": [
-      "type"
-    ]
-  },
-  "dialFrom": {
-    "properties": {
-      "user": "string",
-      "host": "string"
-    },
-    "required": [
-    ]
-  },
-  "auth": {
-    "properties": {
-      "username": "string",
-      "password": "string"
-    },
-    "required": [
-      "username",
-      "password"
-    ]
-  },
-  "synthesizer": {
-    "properties": {
-      "vendor": {
-        "type": "string",
-        "enum": ["google", "aws", "polly", "microsoft", "default"]
-      },
-      "language": "string",
-      "voice": "string",
-      "engine": {
-        "type": "string",
-        "enum": ["standard", "neural"]
-      },
-      "gender": {
-        "type": "string",
-        "enum": ["MALE", "FEMALE", "NEUTRAL"]
-      }
-    },
-    "required": [
-      "vendor"
-    ]
-  },
-  "recognizer": {
-    "properties": {
-      "vendor": {
-        "type": "string",
-        "enum": ["google", "aws", "microsoft", "default"]
-      },
-      "language": "string",
-      "vad": "#vad",
-      "hints": "array",
-      "hintsBoost": "number",
-      "altLanguages": "array",
-      "profanityFilter": "boolean",
-      "interim": "boolean",
-      "singleUtterance": "boolean",
-      "dualChannel": "boolean",
-      "separateRecognitionPerChannel": "boolean",
-      "punctuation": "boolean",
-      "enhancedModel": "boolean",
-      "words": "boolean",
-      "diarization": "boolean",
-      "diarizationMinSpeakers": "number",
-      "diarizationMaxSpeakers": "number",
-      "interactionType": {
-        "type": "string",
-        "enum": [
-          "unspecified",
-          "discussion",
-          "presentation",
-          "phone_call",
-          "voicemail",
-          "voice_search",
-          "voice_command",
-          "dictation"
-        ]
-      },
-      "naicsCode": "number",
-      "identifyChannels": "boolean",
-      "vocabularyName": "string",
-      "vocabularyFilterName": "string",
-      "filterMethod": {
-        "type": "string",
-        "enum": [
-          "remove",
-          "mask",
-          "tag"
-        ]
-      },
-      "model": "string",
-      "outputFormat": {
-        "type": "string",
-        "enum": [
-          "simple",
-          "detailed"
-        ]
-      },
-      "profanityOption": {
-        "type": "string",
-        "enum": [
-          "masked",
-          "removed",
-          "raw"
-        ]
-      },
-      "requestSnr": "boolean",
-      "initialSpeechTimeoutMs": "number",
-      "azureServiceEndpoint": "string",
-      "azureSttEndpointId": "string",
-      "asrDtmfTerminationDigit": "string",
-      "asrTimeout": "number"
-    },
-    "required": [
-      "vendor"
-    ]
-  },
-  "lexIntent": {
-    "properties": {
-      "name": "string",
-      "slots": "object"
-    },
-    "required": [
-      "name"
-    ]
-  },
-  "vad": {
-    "properties": {
-      "enable": "boolean",
-      "voiceMs": "number",
-      "mode": "number"
-    },
-    "required": [
-      "enable"
-    ]
-  },
-  "amd": {
-    "properties": {
-      "actionHook": "object|string",
-      "thresholdWordCount": "number",
-      "timers": "#amdTimers",
-      "recognizer": "#recognizer"
-    },
-    "required": [
-      "actionHook"
-    ]
-  },
-  "amdTimers": {
-    "properties": {
-      "noSpeechTimeoutMs": "number",
-      "decisionTimeoutMs": "number",
-      "toneTimeoutMs": "number",
-      "greetingCompletionTimeoutMs": "number"
-    }
-  }
-}

lib/tasks/stt-task.js

@@ -0,0 +1,278 @@
+const Task = require('./task');
+const assert = require('assert');
+const crypto = require('crypto');
+const { TaskPreconditions, CobaltTranscriptionEvents } = require('../utils/constants');
+
+class SttTask extends Task {
+
+  constructor(logger, data, parentTask) {
+    super(logger, data);
+    this.parentTask = parentTask;
+
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    const {
+      setChannelVarsForStt,
+      normalizeTranscription,
+      setSpeechCredentialsAtRuntime,
+      compileSonioxTranscripts,
+      consolidateTranscripts
+    } = require('../utils/transcription-utils')(logger);
+    this.setChannelVarsForStt = setChannelVarsForStt;
+    this.normalizeTranscription = normalizeTranscription;
+    this.compileSonioxTranscripts = compileSonioxTranscripts;
+    this.consolidateTranscripts = consolidateTranscripts;
+    this.eventHandlers = [];
+    this.isHandledByPrimaryProvider = true;
+    if (this.data.recognizer) {
+      const recognizer = this.data.recognizer;
+      this.vendor = recognizer.vendor;
+      this.language = recognizer.language;
+      this.label = recognizer.label;
+
+      //fallback
+      this.fallbackVendor = recognizer.fallbackVendor || 'default';
+      this.fallbackLanguage = recognizer.fallbackLanguage || 'default';
+      this.fallbackLabel = recognizer.fallbackLabel || 'default';
+
+      /* let credentials be supplied in the recognizer object at runtime */
+      this.sttCredentials = setSpeechCredentialsAtRuntime(recognizer);
+
+      if (!Array.isArray(this.data.recognizer.altLanguages)) {
+        this.data.recognizer.altLanguages = [];
+      }
+    } else {
+      this.data.recognizer = {hints: [], altLanguages: []};
+    }
+
+    /* buffer for soniox transcripts */
+    this._sonioxTranscripts = [];
+    /*bug name prefix */
+    this.bugname_prefix = '';
+
+  }
+
+  async exec(cs, {ep, ep2}) {
+    super.exec(cs);
+    this.ep = ep;
+    this.ep2 = ep2;
+    // copy all value from config verb to this object.
+    if (cs.recognizer) {
+      for (const k in cs.recognizer) {
+        if (Array.isArray(this.data.recognizer[k]) ||
+        Array.isArray(cs.recognizer[k])) {
+          this.data.recognizer[k] = [
+            ...this.data.recognizer[k],
+            ...cs.recognizer[k]
+          ];
+        } else if (typeof this.data.recognizer[k] === 'object' ||
+        typeof cs.recognizer[k] === 'object'
+        ) {
+          this.data.recognizer[k] = {
+            ...this.data.recognizer[k],
+            ...cs.recognizer[k]
+          };
+        } else {
+          this.data.recognizer[k] = cs.recognizer[k] || this.data.recognizer[k];
+        }
+      }
+    }
+    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 ('default' === this.label || !this.label) {
+      this.label = cs.speechRecognizerLabel;
+      if (this.data.recognizer) this.data.recognizer.label = this.label;
+    }
+    // Fallback options
+    if ('default' === this.fallbackVendor || !this.fallbackVendor) {
+      this.fallbackVendor = cs.fallbackSpeechRecognizerVendor;
+      if (this.data.recognizer) this.data.recognizer.fallbackVendor = this.fallbackVendor;
+    }
+    if ('default' === this.fallbackLanguage || !this.fallbackLanguage) {
+      this.fallbackLanguage = cs.fallbackSpeechRecognizerLanguage;
+      if (this.data.recognizer) this.data.recognizer.fallbackLanguage = this.fallbackLanguage;
+    }
+    if ('default' === this.fallbackLabel || !this.fallbackLabel) {
+      this.fallbackLabel = cs.fallbackSpeechRecognizerLabel;
+      if (this.data.recognizer) this.data.recognizer.fallbackLabel = this.fallbackLabel;
+    }
+    if (!this.data.recognizer.vendor) {
+      this.data.recognizer.vendor = this.vendor;
+    }
+    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
+      // By default, application saves cobalt model in language
+      this.data.recognizer.model = cs.speechRecognizerLanguage;
+    }
+
+    if (!this.sttCredentials) {
+      try {
+        this.sttCredentials = await this._initSpeechCredentials(this.cs, this.vendor, this.label);
+      } catch (error) {
+        if (this.fallbackVendor && this.isHandledByPrimaryProvider) {
+          await this._fallback();
+        } else {
+          throw error;
+        }
+      }
+    }
+
+    /* when using cobalt model is required */
+    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
+      this.notifyError({ msg: 'ASR error', details:'Cobalt requires a model to be specified'});
+      throw new Error('Cobalt requires a model to be specified');
+    }
+
+    if (cs.hasAltLanguages) {
+      this.data.recognizer.altLanguages = this.data.recognizer.altLanguages.concat(cs.altLanguages);
+      this.logger.debug({altLanguages: this.altLanguages},
+        'STT:exec - applying altLanguages');
+    }
+    if (cs.hasGlobalSttPunctuation && !this.data.recognizer.punctuation) {
+      this.data.recognizer.punctuation = cs.globalSttPunctuation;
+    }
+  }
+
+  addCustomEventListener(ep, event, handler) {
+    this.eventHandlers.push({ep, event, handler});
+    ep.addCustomEventListener(event, handler);
+  }
+
+  removeCustomEventListeners() {
+    this.eventHandlers.forEach((h) => h.ep.removeCustomEventListener(h.event, h.handler));
+  }
+
+  async _initSpeechCredentials(cs, vendor, label) {
+    const {getNuanceAccessToken, getIbmAccessToken} = cs.srf.locals.dbHelpers;
+    let credentials = cs.getSpeechCredentials(vendor, 'stt', label);
+
+    if (!credentials) {
+      const {writeAlerts, AlertType} = cs.srf.locals;
+      this.logger.info(`ERROR stt using ${vendor} requested but creds not supplied`);
+      writeAlerts({
+        account_sid: cs.accountSid,
+        alert_type: AlertType.STT_NOT_PROVISIONED,
+        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 ${vendor} have been configured`
+      });
+      this.notifyTaskDone();
+      throw new Error(`No speech-to-text service credentials for ${vendor} have been configured`);
+    }
+
+    if (vendor === 'nuance' && credentials.client_id) {
+      /* get nuance access token */
+      const {client_id, secret} = credentials;
+      const {access_token, servedFromCache} = await getNuanceAccessToken(client_id, secret, 'asr tts');
+      this.logger.debug({client_id}, `got nuance access token ${servedFromCache ? 'from cache' : ''}`);
+      credentials = {...credentials, access_token};
+    }
+    else if (vendor == 'ibm' && credentials.stt_api_key) {
+      /* get ibm access token */
+      const {stt_api_key, stt_region} = credentials;
+      const {access_token, servedFromCache} = await getIbmAccessToken(stt_api_key);
+      this.logger.debug({stt_api_key}, `got ibm access token ${servedFromCache ? 'from cache' : ''}`);
+      credentials = {...credentials, access_token, stt_region};
+    }
+    return credentials;
+  }
+
+  async _fallback() {
+    assert(this.fallbackVendor, 'fallback failed without fallbackVendor configuration');
+    this.isHandledByPrimaryProvider = false;
+    this.logger.info(`Failed to use primary STT provider, fallback to ${this.fallbackVendor}`);
+    this.vendor = this.fallbackVendor;
+    this.language = this.fallbackLanguage;
+    this.label = this.fallbackLabel;
+    this.data.recognizer.vendor = this.vendor;
+    this.data.recognizer.language = this.language;
+    this.data.recognizer.label = this.label;
+    this.sttCredentials = await this._initSpeechCredentials(this.cs, this.vendor, this.label);
+  }
+
+  async compileHintsForCobalt(ep, hostport, model, token, hints) {
+    const {retrieveKey} = this.cs.srf.locals.dbHelpers;
+    const hash = crypto.createHash('sha1');
+    hash.update(`${model}:${hints}`);
+    const key = `cobalt:${hash.digest('hex')}`;
+    this.context = await retrieveKey(key);
+    if (this.context) {
+      this.logger.debug({model, hints}, 'found cached cobalt context for supplied hints');
+      return this.context;
+    }
+
+    this.logger.debug({model, hints}, 'compiling cobalt context for supplied hints');
+
+    return new Promise((resolve, reject) => {
+      this.cobaltCompileResolver = resolve;
+      ep.addCustomEventListener(CobaltTranscriptionEvents.CompileContext, this._onCompileContext.bind(this, ep, key));
+      ep.api('uuid_cobalt_compile_context', [ep.uuid, hostport, model, token, hints], (err, evt) => {
+        if (err || 0 !== evt.getBody().indexOf('+OK')) {
+          ep.removeCustomEventListener(CobaltTranscriptionEvents.CompileContext);
+          return reject(err);
+        }
+      });
+    });
+  }
+
+  _onCompileContext(ep, key, evt) {
+    const {addKey} = this.cs.srf.locals.dbHelpers;
+    this.logger.debug({evt}, `received cobalt compile context event, will cache under ${key}`);
+
+    this.cobaltCompileResolver(evt.compiled_context);
+    ep.removeCustomEventListener(CobaltTranscriptionEvents.CompileContext);
+    this.cobaltCompileResolver = null;
+
+    //cache the compiled context
+    addKey(key, evt.compiled_context, 3600 * 12)
+      .catch((err) => this.logger.info({err}, `Error caching cobalt context for ${key}`));
+  }
+
+  _doContinuousAsrWithDeepgram(asrTimeout) {
+    /* deepgram has an utterance_end_ms property that simplifies things */
+    assert(this.vendor === 'deepgram');
+    this.logger.debug(`_doContinuousAsrWithDeepgram - setting utterance_end_ms to ${asrTimeout}`);
+    const dgOptions = this.data.recognizer.deepgramOptions = this.data.recognizer.deepgramOptions || {};
+    dgOptions.utteranceEndMs = dgOptions.utteranceEndMs || asrTimeout;
+  }
+
+  _onVendorConnect(_cs, _ep) {
+    this.logger.debug(`TaskGather:_on${this.vendor}Connect`);
+  }
+
+  _onVendorError(cs, _ep, evt) {
+    this.logger.info({evt}, `${this.name}:_on${this.vendor}Error`);
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: 'STT failure reported by vendor',
+      detail: evt.error,
+      vendor: this.vendor,
+    }).catch((err) => this.logger.info({err}, `Error generating alert for ${this.vendor} connection failure`));
+    this.notifyError({msg: 'ASR error', details:`Failed connecting to speech vendor ${this.vendor}: ${evt.error}`});
+  }
+
+  _onVendorConnectFailure(cs, _ep, evt) {
+    const {reason} = evt;
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    this.logger.info({evt}, `${this.name}:_on${this.vendor}ConnectFailure`);
+    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 ${this.vendor} connection failure`));
+    this.notifyError({msg: 'ASR error', details:`Failed connecting to speech vendor ${this.vendor}: ${reason}`});
+  }
+}
+
+module.exports = SttTask;

lib/tasks/tag.js

@@ -12,7 +12,7 @@ class TaskTag extends Task {
   async exec(cs) {
     super.exec(cs);
     cs.callInfo.customerData = this.data;
-    //this.logger.debug({callInfo: cs.callInfo.toJSON()}, 'TaskTag:exec set customer data in callInfo');
+    this.logger.debug({customerData: cs.callInfo.customerData}, 'TaskTag:exec set customer data in callInfo');
   }
 }
 

lib/tasks/task.js

@@ -1,13 +1,10 @@
 const Emitter = require('events');
-const { v4: uuidv4 } = require('uuid');
-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 { normalizeJambones } = require('@jambonz/verb-specifications');
+const WsRequestor = require('../utils/ws-requestor');
+const {TaskName} = require('../utils/constants');
 const {trace} = require('@opentelemetry/api');
-const specs = new Map();
-const _specData = require('./specs');
-for (const key in _specData) {specs.set(key, _specData[key]);}
 
 /**
  * @classdesc Represents a jambonz verb. This is a superclass that is extended
@@ -21,6 +18,7 @@ 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);
@@ -137,21 +135,32 @@ class Task extends Emitter {
     return this.callSession.normalizeUrl(url, method, auth);
   }
 
-  notifyError(errMsg) {
-    const params = {error: errMsg, verb: this.name};
-    this.cs.requestor.request('jambonz:error', '/error', params)
-      .catch((err) => this.logger.info({err}, 'Task:notifyError error sending error'));
+  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 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('verb:hook', {'hook.url': this.actionHook});
+      const span = this.startSpan(`${type} (${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('verb:hook', this.actionHook, params, httpHeaders);
+        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)) {
@@ -273,77 +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 if (dKey === '_') {
-        /* no op: allow arbitrary info to be carried here, used by conference e.g in transfer */
-      }
-      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,101 +1,72 @@
-const Task = require('./task');
+const assert = require('assert');
 const {
   TaskName,
-  TaskPreconditions,
   GoogleTranscriptionEvents,
+  NuanceTranscriptionEvents,
+  AwsTranscriptionEvents,
   AzureTranscriptionEvents,
-  AwsTranscriptionEvents
-} = require('../utils/constants');
+  DeepgramTranscriptionEvents,
+  SonioxTranscriptionEvents,
+  CobaltTranscriptionEvents,
+  IbmTranscriptionEvents,
+  NvidiaTranscriptionEvents,
+  JambonzTranscriptionEvents,
+  TranscribeStatus,
+  AssemblyAiTranscriptionEvents
+} = require('../utils/constants.json');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+const SttTask = require('./stt-task');
 
-class TaskTranscribe extends Task {
+const STT_LISTEN_SPAN_NAME = 'stt-listen';
+
+class TaskTranscribe extends SttTask {
   constructor(logger, opts, parentTask) {
-    super(logger, opts);
-    this.preconditions = TaskPreconditions.Endpoint;
-    this.parentTask = parentTask;
+    super(logger, opts, parentTask);
 
     this.transcriptionHook = this.data.transcriptionHook;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
 
-    const recognizer = this.data.recognizer;
-    this.vendor = recognizer.vendor;
-    this.language = recognizer.language;
-    this.interim = !!recognizer.interim;
-    this.separateRecognitionPerChannel = recognizer.separateRecognitionPerChannel;
+    if (this.data.recognizer) {
+      this.interim = !!this.data.recognizer.interim;
+      this.separateRecognitionPerChannel = this.data.recognizer.separateRecognitionPerChannel;
+    }
 
-    /* vad: if provided, we dont connect to recognizer until voice activity is detected */
-    const {enable, voiceMs = 0, mode = -1} = recognizer.vad || {};
-    this.vad = {enable, voiceMs, mode};
+    this.childSpan = [null, null];
 
-    /* google-specific options */
-    this.hints = recognizer.hints || [];
-    this.hintsBoost = recognizer.hintsBoost;
-    this.profanityFilter = recognizer.profanityFilter;
-    this.punctuation = !!recognizer.punctuation;
-    this.enhancedModel = !!recognizer.enhancedModel;
-    this.model = recognizer.model || 'phone_call';
-    this.words = !!recognizer.words;
-    this.singleUtterance = recognizer.singleUtterance || false;
-    this.diarization = !!recognizer.diarization;
-    this.diarizationMinSpeakers = recognizer.diarizationMinSpeakers || 0;
-    this.diarizationMaxSpeakers = recognizer.diarizationMaxSpeakers || 0;
-    this.interactionType = recognizer.interactionType || 'unspecified';
-    this.naicsCode = recognizer.naicsCode || 0;
-    this.altLanguages = recognizer.altLanguages || [];
-
-    /* aws-specific options */
-    this.identifyChannels = !!recognizer.identifyChannels;
-    this.vocabularyName = recognizer.vocabularyName;
-    this.vocabularyFilterName = recognizer.vocabularyFilterName;
-    this.filterMethod = recognizer.filterMethod;
-
-    /* microsoft options */
-    this.outputFormat = recognizer.outputFormat || 'simple';
-    this.profanityOption = recognizer.profanityOption || 'raw';
-    this.requestSnr = recognizer.requestSnr || false;
-    this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
-    this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
-    this.azureSttEndpointId = recognizer.azureSttEndpointId;
+    // Continuous asr timeout
+    this.asrTimeout = typeof this.data.recognizer.asrTimeout === 'number' ? this.data.recognizer.asrTimeout * 1000 : 0;
+    if (this.asrTimeout > 0) {
+      this.isContinuousAsr = true;
+    }
+    /* buffer speech for continuous asr */
+    this._bufferedTranscripts = [];
+    this.bugname_prefix = 'transcribe_';
   }
 
   get name() { return TaskName.Transcribe; }
 
   async exec(cs, {ep, ep2}) {
-    super.exec(cs);
+    await super.exec(cs, {ep, ep2});
+
+    if (this.data.recognizer.vendor === 'nuance') {
+      this.data.recognizer.nuanceOptions = {
+        // by default, nuance STT will recognize only 1st utterance.
+        // enable multiple allow nuance detact all utterances
+        utteranceDetectionMode: 'multiple',
+        ...this.data.recognizer.nuanceOptions
+      };
+    }
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
 
     if (cs.hasGlobalSttHints) {
       const {hints, hintsBoost} = cs.globalSttHints;
-      this.hints = this.hints.concat(hints);
-      if (!this.hintsBoost && hintsBoost) this.hintsBoost = hintsBoost;
-      this.logger.debug({hints: this.hints, hintsBoost: this.hintsBoost},
-        'Transcribe:exec - applying global `sttHints');
+      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.altLanguages = this.altLanguages.concat(cs.altLanguages);
-      this.logger.debug({altLanguages: this.altLanguages},
-        'Gather:exec - applying altLanguages');
-    }
-    if (cs.hasGlobalSttPunctuation) {
-      this.punctuation = cs.globalSttPunctuation;
-    }
-
-    this.ep = ep;
-    this.ep2 = ep2;
-    if ('default' === this.vendor || !this.vendor) this.vendor = cs.speechRecognizerVendor;
-    if ('default' === this.language || !this.language) this.language = cs.speechRecognizerLanguage;
-    this.sttCredentials = cs.getSpeechCredentials(this.vendor, 'stt');
 
     try {
-      if (!this.sttCredentials) {
-        const {writeAlerts, AlertType} = cs.srf.locals;
-        this.logger.info(`TaskTranscribe:exec - ERROR stt using ${this.vendor} requested but creds not supplied`);
-        writeAlerts({
-          account_sid: cs.accountSid,
-          alert_type: AlertType.STT_NOT_PROVISIONED,
-          vendor: this.vendor
-        }).catch((err) => this.logger.info({err}, 'Error generating alert for no stt'));
-        throw new Error('no provisioned speech credentials for TTS');
-      }
       await this._startTranscribing(cs, ep, 1);
       if (this.separateRecognitionPerChannel && ep2) {
         await this._startTranscribing(cs, ep2, 2);
@@ -109,22 +80,17 @@ class TaskTranscribe extends Task {
       this.logger.info(err, 'TaskTranscribe:exec - error');
       this.parentTask && this.parentTask.emit('error', err);
     }
-    ep.removeCustomEventListener(GoogleTranscriptionEvents.Transcription);
-    ep.removeCustomEventListener(GoogleTranscriptionEvents.NoAudioDetected);
-    ep.removeCustomEventListener(GoogleTranscriptionEvents.MaxDurationExceeded);
-    ep.removeCustomEventListener(AwsTranscriptionEvents.Transcription);
-    ep.removeCustomEventListener(AwsTranscriptionEvents.NoAudioDetected);
-    ep.removeCustomEventListener(AwsTranscriptionEvents.MaxDurationExceeded);
-    ep.removeCustomEventListener(AzureTranscriptionEvents.Transcription);
-    ep.removeCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected);
+    this.removeCustomEventListeners();
   }
 
-  async kill(cs) {
-    super.kill(cs);
+  async _stopTranscription() {
     let stopTranscription = false;
     if (this.ep?.connected) {
       stopTranscription = true;
-      this.ep.stopTranscription({vendor: this.vendor})
+      this.ep.stopTranscription({
+        vendor: this.vendor,
+        bugname: this.bugname
+      })
         .catch((err) => this.logger.info(err, 'Error TaskTranscribe:kill'));
     }
     if (this.separateRecognitionPerChannel && this.ep2 && this.ep2.connected) {
@@ -132,6 +98,13 @@ class TaskTranscribe extends Task {
       this.ep2.stopTranscription({vendor: this.vendor})
         .catch((err) => this.logger.info(err, 'Error TaskTranscribe:kill'));
     }
+
+    return stopTranscription;
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    const stopTranscription = this._stopTranscription();
     // hangup after 1 sec if we don't get a final transcription
     if (stopTranscription) this._timer = setTimeout(() => this.notifyTaskDone(), 1500);
     else this.notifyTaskDone();
@@ -139,182 +112,276 @@ class TaskTranscribe extends Task {
     await this.awaitTaskDone();
   }
 
-  async _startTranscribing(cs, ep, channel) {
-    const opts = {};
+  async updateTranscribe(status) {
+    if (!this.killed && this.ep && this.ep.connected) {
+      this.logger.info(`TaskTranscribe:updateTranscribe status ${status}`);
+      switch (status) {
+        case TranscribeStatus.Pause:
+          await this._stopTranscription();
+          break;
+        case TranscribeStatus.Resume:
+          await this._startTranscribing(this.cs, this.ep, 1);
+          if (this.separateRecognitionPerChannel && this.ep2) {
+            await this._startTranscribing(this.cs, this.ep2, 2);
+          }
+          break;
+      }
+    }
+  }
 
-    if (this.vad.enable) {
-      opts.START_RECOGNIZING_ON_VAD = 1;
-      if (this.vad.voiceMs) opts.RECOGNIZER_VAD_VOICE_MS = this.vad.voiceMs;
-      if (this.vad.mode >= 0 && this.vad.mode <= 3) opts.RECOGNIZER_VAD_MODE = this.vad.mode;
+  async _setSpeechHandlers(cs, ep, channel) {
+    if (this[`_speechHandlersSet_${channel}`]) return;
+    this[`_speechHandlersSet_${channel}`] = true;
+
+    /* some special deepgram logic */
+    if (this.vendor === 'deepgram') {
+      if (this.isContinuousAsr) this._doContinuousAsrWithDeepgram(this.asrTimeout);
     }
 
-    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));
-    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));
-    ep.addCustomEventListener(AzureTranscriptionEvents.Transcription,
-      this._onTranscription.bind(this, cs, ep, channel));
-    ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected, this._onNoAudio.bind(this, cs, ep, channel));
+    const opts = this.setChannelVarsForStt(this, this.sttCredentials, this.data.recognizer);
+    switch (this.vendor) {
+      case 'google':
+        this.bugname = `${this.bugname_prefix}google_transcribe`;
+        this.addCustomEventListener(ep, GoogleTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, GoogleTranscriptionEvents.NoAudioDetected,
+          this._onNoAudio.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, GoogleTranscriptionEvents.MaxDurationExceeded,
+          this._onMaxDurationExceeded.bind(this, cs, ep, channel));
+        break;
 
-    if (this.vendor === 'google') {
-      this.bugname = 'google_transcribe';
-      if (this.sttCredentials) opts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(this.sttCredentials.credentials);
-      [
-        ['enhancedModel', 'GOOGLE_SPEECH_USE_ENHANCED'],
-        //['separateRecognitionPerChannel', 'GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL'],
-        ['profanityFilter', 'GOOGLE_SPEECH_PROFANITY_FILTER'],
-        ['punctuation', 'GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION'],
-        ['words', 'GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS'],
-        ['singleUtterance', 'GOOGLE_SPEECH_SINGLE_UTTERANCE'],
-        ['diarization', 'GOOGLE_SPEECH_PROFANITY_FILTER']
-      ].forEach((arr) => {
-        if (this[arr[0]]) opts[arr[1]] = true;
-        else if (this[arr[0]] === false) opts[arr[1]] = false;
-      });
-      if (this.hints.length > 0) {
-        opts.GOOGLE_SPEECH_HINTS = this.hints.join(',');
-        if (typeof this.hintsBoost === 'number') {
-          opts.GOOGLE_SPEECH_HINTS_BOOST = this.hintsBoost;
+      case 'aws':
+      case 'polly':
+        this.bugname = `${this.bugname_prefix}aws_transcribe`;
+        this.addCustomEventListener(ep, AwsTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, AwsTranscriptionEvents.NoAudioDetected,
+          this._onNoAudio.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, AwsTranscriptionEvents.MaxDurationExceeded,
+          this._onMaxDurationExceeded.bind(this, cs, ep, channel));
+        break;
+      case 'microsoft':
+        this.bugname = `${this.bugname_prefix}azure_transcribe`;
+        this.addCustomEventListener(ep, AzureTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, AzureTranscriptionEvents.NoSpeechDetected,
+          this._onNoAudio.bind(this, cs, ep, channel));
+        break;
+      case 'nuance':
+        this.bugname = `${this.bugname_prefix}nuance_transcribe`;
+        this.addCustomEventListener(ep, NuanceTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        break;
+      case 'deepgram':
+        this.bugname = `${this.bugname_prefix}deepgram_transcribe`;
+        this.addCustomEventListener(ep, DeepgramTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, DeepgramTranscriptionEvents.Connect,
+          this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, DeepgramTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep, channel));
+
+        /* if app sets deepgramOptions.utteranceEndMs they essentially want continuous asr */
+        if (opts.DEEPGRAM_SPEECH_UTTERANCE_END_MS) this.isContinuousAsr = true;
+
+        break;
+      case 'soniox':
+        this.bugname = `${this.bugname_prefix}soniox_transcribe`;
+        this.addCustomEventListener(ep, SonioxTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        break;
+      case 'cobalt':
+        this.bugname = `${this.bugname_prefix}cobalt_transcribe`;
+        this.addCustomEventListener(ep, CobaltTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+
+        /* cobalt doesnt have language, it has model, which is required */
+        if (!this.data.recognizer.model) {
+          throw new Error('Cobalt requires a model to be specified');
         }
-      }
-      if (this.altLanguages.length > 0) opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
-      else opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
-      if ('unspecified' !== this.interactionType) {
-        opts.GOOGLE_SPEECH_METADATA_INTERACTION_TYPE = this.interactionType;
-      }
-      opts.GOOGLE_SPEECH_MODEL = this.model;
-      if (this.diarization && this.diarizationMinSpeakers > 0) {
-        opts.GOOGLE_SPEECH_SPEAKER_DIARIZATION_MIN_SPEAKER_COUNT = this.diarizationMinSpeakers;
-      }
-      if (this.diarization && this.diarizationMaxSpeakers > 0) {
-        opts.GOOGLE_SPEECH_SPEAKER_DIARIZATION_MAX_SPEAKER_COUNT = this.diarizationMaxSpeakers;
-      }
-      if (this.naicsCode > 0) opts.GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE = this.naicsCode;
+        this.language = this.data.recognizer.model;
 
-      await ep.set(opts)
-        .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with google'));
+        /* special case: if using hints with cobalt we need to compile them */
+        this.hostport = opts.COBALT_SERVER_URI;
+        if (this.vendor === 'cobalt' && opts.COBALT_SPEECH_HINTS) {
+          try {
+            const context = await this.compileHintsForCobalt(
+              ep,
+              opts.COBALT_SERVER_URI,
+              this.data.recognizer.model,
+              opts.COBALT_CONTEXT_TOKEN,
+              opts.COBALT_SPEECH_HINTS
+            );
+            if (context) opts.COBALT_COMPILED_CONTEXT_DATA = context;
+            delete opts.COBALT_SPEECH_HINTS;
+          } catch (err) {
+            this.logger.error({err}, 'Error compiling hints for cobalt');
+          }
+        }
+        break;
+
+      case 'ibm':
+        this.bugname = `${this.bugname_prefix}ibm_transcribe`;
+        this.addCustomEventListener(ep, IbmTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, IbmTranscriptionEvents.Connect,
+          this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, IbmTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep, channel));
+        break;
+
+      case 'nvidia':
+        this.bugname = `${this.bugname_prefix}nvidia_transcribe`;
+        this.addCustomEventListener(ep, NvidiaTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        break;
+
+      case 'assemblyai':
+        this.bugname = `${this.bugname_prefix}assemblyai_transcribe`;
+        this.addCustomEventListener(ep, AssemblyAiTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep,
+          AssemblyAiTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, AssemblyAiTranscriptionEvents.Error, this._onVendorError.bind(this, cs, ep));
+        this.addCustomEventListener(ep, AssemblyAiTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep, channel));
+        break;
+
+      default:
+        if (this.vendor.startsWith('custom:')) {
+          this.bugname = `${this.bugname_prefix}${this.vendor}_transcribe`;
+          this.addCustomEventListener(ep, JambonzTranscriptionEvents.Transcription,
+            this._onTranscription.bind(this, cs, ep, channel));
+          this.addCustomEventListener(ep, JambonzTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
+          this.addCustomEventListener(ep, JambonzTranscriptionEvents.ConnectFailure,
+            this._onVendorConnectFailure.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}`);
+        }
     }
-    else if (this.vendor === 'aws') {
-      this.bugname = 'aws_transcribe';
-      [
-        ['diarization', 'AWS_SHOW_SPEAKER_LABEL'],
-        ['identifyChannels', 'AWS_ENABLE_CHANNEL_IDENTIFICATION']
-      ].forEach((arr) => {
-        if (this[arr[0]]) opts[arr[1]] = true;
-      });
-      if (this.vocabularyName) opts.AWS_VOCABULARY_NAME = this.vocabularyName;
-      if (this.vocabularyFilterName) {
-        opts.AWS_VOCABULARY_NAME = this.vocabularyFilterName;
-        opts.AWS_VOCABULARY_FILTER_METHOD = this.filterMethod || 'mask';
-      }
 
-      if (this.sttCredentials) {
-        Object.assign(opts, {
-          AWS_ACCESS_KEY_ID: this.sttCredentials.accessKeyId,
-          AWS_SECRET_ACCESS_KEY: this.sttCredentials.secretAccessKey,
-          AWS_REGION: this.sttCredentials.region
-        });
-      }
-      else {
-        Object.assign(opts, {
-          AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID,
-          AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY,
-          AWS_REGION: process.env.AWS_REGION
-        });
-      }
+    /* common handler for all stt engine errors */
+    this.addCustomEventListener(ep, JambonzTranscriptionEvents.Error, this._onJambonzError.bind(this, cs, ep));
+    await ep.set(opts)
+      .catch((err) => this.logger.info(err, 'Error setting channel variables'));
+  }
 
-      await ep.set(opts)
-        .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with aws'));
-    }
-    else if (this.vendor === 'microsoft') {
-      this.bugname = 'azure_transcribe';
-      const {api_key, region, use_custom_stt, custom_stt_endpoint} = this.sttCredentials;
-      Object.assign(opts, {
-        'AZURE_SUBSCRIPTION_KEY': api_key,
-        'AZURE_REGION': region
-      });
-      if (this.azureSttEndpointId) {
-        Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': this.azureSttEndpointId});
-      }
-      else if (use_custom_stt && custom_stt_endpoint) {
-        Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': custom_stt_endpoint});
-      }
-      if (this.hints && this.hints.length > 0) {
-        opts.AZURE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
-      }
-      if (this.altLanguages.length > 0) opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
-      else opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
-      if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
-      if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
-      if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;
-      if (this.outputFormat !== 'simple') opts.AZURE_USE_OUTPUT_FORMAT_DETAILED = 1;
-      if (this.azureServiceEndpoint) opts.AZURE_SERVICE_ENDPOINT = this.azureServiceEndpoint;
-
-      await ep.set(opts)
-        .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with azure'));
-    }
+  async _startTranscribing(cs, ep, channel) {
+    await this._setSpeechHandlers(cs, ep, channel);
     await this._transcribe(ep);
+
+    /* start child span for this channel */
+    const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
+    this.childSpan[channel - 1] = {span, ctx};
   }
 
   async _transcribe(ep) {
+    this.logger.debug(
+      `TaskTranscribe:_transcribe - starting transcription vendor ${this.vendor} bugname ${this.bugname}`);
     await ep.startTranscription({
       vendor: this.vendor,
       interim: this.interim ? true : false,
       locale: this.language,
       channels: /*this.separateRecognitionPerChannel ? 2 : */ 1,
-      bugname: this.bugname
+      bugname: this.bugname,
+      hostport: this.hostport
     });
   }
 
-  _onTranscription(cs, ep, channel, evt, fsEvent) {
+  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;
 
-    this.logger.debug({evt, channel}, 'TaskTranscribe:_onTranscription');
-    if ('aws' === this.vendor && Array.isArray(evt) && evt.length > 0) evt = evt[0];
-    if ('microsoft' === this.vendor) {
-      const nbest = evt.NBest;
-      const language_code = evt.PrimaryLanguage?.Language || this.language;
-      const alternatives = nbest ? nbest.map((n) => {
-        return {
-          confidence: n.Confidence,
-          transcript: n.Display
-        };
-      }) :
-        [
-          {
-            transcript: evt.DisplayText || evt.Text
-          }
-        ];
+    if (this.vendor === 'ibm' && evt?.state === 'listening') return;
 
-      const newEvent = {
-        is_final: evt.RecognitionStatus === 'Success',
+    if (this.vendor === 'deepgram' && evt.type === 'UtteranceEnd') {
+      /* we will only get this when we have set utterance_end_ms */
+      if (this._bufferedTranscripts.length === 0) {
+        this.logger.debug('Gather:_onTranscription - got UtteranceEnd event from deepgram but no buffered transcripts');
+      }
+      else {
+        this.logger.debug('Gather:_onTranscription - got UtteranceEnd event from deepgram, return buffered transcript');
+        evt = this.consolidateTranscripts(this._bufferedTranscripts, 1, this.language);
+        this._bufferedTranscripts = [];
+        this._resolve('speech', evt);
+      }
+      return;
+    }
+    this.logger.debug({evt}, 'TaskTranscribe:_onTranscription - before normalization');
+
+    evt = this.normalizeTranscription(evt, this.vendor, channel, this.language, undefined,
+      this.data.recognizer.punctuation);
+    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.isContinuousAsr && evt.is_final) {
+      this._bufferedTranscripts.push(evt);
+      this._startAsrTimer(channel);
+    } else {
+      await this._resolve(channel, evt);
+    }
+  }
+
+  async _resolve(channel, evt) {
+    /* we've got a transcript, so end the otel child span for this channel */
+    if (this.childSpan[channel - 1] && this.childSpan[channel - 1].span) {
+      this.childSpan[channel - 1].span.setAttributes({
         channel,
-        language_code,
-        alternatives
-      };
-      evt = newEvent;
+        'stt.resolve': 'transcript',
+        'stt.result': JSON.stringify(evt)
+      });
+      this.childSpan[channel - 1].span.end();
     }
 
-    if (evt.alternatives[0].transcript === '' && !cs.callGone && !this.killed) {
-      this.logger.info({evt}, 'TaskGather:_onTranscription - got empty transcript, listen again');
-      return this._transcribe(ep);
-    }
-
-    evt.channel_tag = channel;
-
     if (this.transcriptionHook) {
       const b3 = this.getTracingPropagation();
       const httpHeaders = b3 && {b3};
-      this.cs.requestor.request('verb:hook', this.transcriptionHook,
-        Object.assign({speech: evt}, this.cs.callInfo), httpHeaders)
-        .catch((err) => this.logger.info(err, 'TranscribeTask:_onTranscription error'));
+      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);
@@ -324,16 +391,44 @@ class TaskTranscribe extends Task {
       this._clearTimer();
       this.notifyTaskDone();
     }
+    else {
+      /* start another child span for this channel */
+      const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
+      this.childSpan[channel - 1] = {span, ctx};
+    }
   }
 
   _onNoAudio(cs, ep, channel) {
     this.logger.debug(`TaskTranscribe:_onNoAudio restarting transcription on channel ${channel}`);
+    if (this.childSpan[channel - 1] && this.childSpan[channel - 1].span) {
+      this.childSpan[channel - 1].span.setAttributes({
+        channel,
+        'stt.resolve': 'timeout'
+      });
+      this.childSpan[channel - 1].span.end();
+    }
     this._transcribe(ep);
+
+    /* start new child span for this channel */
+    const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
+    this.childSpan[channel - 1] = {span, ctx};
   }
 
   _onMaxDurationExceeded(cs, ep, channel) {
     this.logger.debug(`TaskTranscribe:_onMaxDurationExceeded restarting transcription on channel ${channel}`);
+    if (this.childSpan[channel - 1] && this.childSpan[channel - 1].span) {
+      this.childSpan[channel - 1].span.setAttributes({
+        channel,
+        'stt.resolve': 'max duration exceeded'
+      });
+      this.childSpan[channel - 1].span.end();
+    }
+
     this._transcribe(ep);
+
+    /* start new child span for this channel */
+    const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
+    this.childSpan[channel - 1] = {span, ctx};
   }
 
   _clearTimer() {
@@ -342,6 +437,76 @@ class TaskTranscribe extends Task {
       this._timer = null;
     }
   }
+
+  async _onJambonzError(cs, _ep, evt) {
+    this.logger.info({evt}, 'TaskTranscribe:_onJambonzError');
+    if (this.isHandledByPrimaryProvider && this.fallbackVendor) {
+      _ep.stopTranscription({
+        vendor: this.vendor,
+        bugname: this.bugname
+      })
+        .catch((err) => this.logger.error({err}, `Error stopping transcription for primary vendor ${this.vendor}`));
+      const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
+      try {
+        await this._fallback();
+        let channel = 1;
+        if (this.ep !== _ep) {
+          channel = 2;
+        }
+        this._startTranscribing(cs, _ep, channel);
+        updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid);
+        return;
+      } catch (error) {
+        this.logger.info({error}, `There is error while falling back to ${this.fallbackVendor}`);
+      }
+    } else {
+      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}`});
+    }
+  }
+
+  _onVendorConnectFailure(cs, _ep, channel, evt) {
+    super._onVendorConnectFailure(cs, _ep, evt);
+    if (this.childSpan[channel - 1] && this.childSpan[channel - 1].span) {
+      this.childSpan[channel - 1].span.setAttributes({
+        channel,
+        'stt.resolve': 'connection failure'
+      });
+      this.childSpan[channel - 1].span.end();
+    }
+    this.notifyTaskDone();
+  }
+
+  _startAsrTimer(channel) {
+    if (this.vendor === 'deepgram') return; // no need
+    assert(this.isContinuousAsr);
+    this._clearAsrTimer(channel);
+    this._asrTimer = setTimeout(() => {
+      this.logger.debug(`TaskTranscribe:_startAsrTimer - asr timer went off for channel: ${channel}`);
+      const evt = this.consolidateTranscripts(this._bufferedTranscripts, channel, this.language);
+      this._bufferedTranscripts = [];
+      this._resolve(channel, evt);
+    }, this.asrTimeout);
+    this.logger.debug(`TaskTranscribe:_startAsrTimer: set for ${this.asrTimeout}ms for channel ${channel}`);
+  }
+
+  _clearAsrTimer(channel) {
+    if (this._asrTimer) clearTimeout(this._asrTimer);
+    this._asrTimer = null;
+  }
 }
 
 module.exports = TaskTranscribe;

lib/utils/amd-utils.js

@@ -1,14 +1,22 @@
 const Emitter = require('events');
 const {readFile} = require('fs');
 const {
+  TaskName,
   GoogleTranscriptionEvents,
   AwsTranscriptionEvents,
   AzureTranscriptionEvents,
+  NuanceTranscriptionEvents,
+  NvidiaTranscriptionEvents,
+  IbmTranscriptionEvents,
+  SonioxTranscriptionEvents,
+  CobaltTranscriptionEvents,
+  DeepgramTranscriptionEvents,
+  JambonzTranscriptionEvents,
   AmdEvents,
   AvmdEvents
 } = require('./constants');
 const bugname = 'amd_bug';
-const {VMD_HINTS_FILE} = process.env;
+const {VMD_HINTS_FILE} = require('../config');
 let voicemailHints = [];
 
 const updateHints = async(file, callback) => {
@@ -47,13 +55,19 @@ class Amd extends Emitter {
     this.language = opts.recognizer?.language || cs.speechRecognizerLanguage;
     if ('default' === this.language) this.language = cs.speechRecognizerLanguage;
 
-    this.sttCredentials = cs.getSpeechCredentials(this.vendor, 'stt');
+    this.sttCredentials = cs.getSpeechCredentials(this.vendor, 'stt',
+      opts.recognizer?.label || cs.speechRecognizerLabel);
 
     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 {getNuanceAccessToken, getIbmAccessToken} = cs.srf.locals.dbHelpers;
+    this.getNuanceAccessToken = getNuanceAccessToken;
+    this.getIbmAccessToken = getIbmAccessToken;
+    const {setChannelVarsForStt} = require('./transcription-utils')(logger);
+    this.setChannelVarsForStt = setChannelVarsForStt;
 
     const {
       noSpeechTimeoutMs = 5000,
@@ -184,7 +198,7 @@ module.exports = (logger) => {
     const {vendor, language} = ep.amd;
     ep.startTranscription({
       vendor,
-      language,
+      locale: language,
       interim: true,
       bugname
     }).catch((err) => {
@@ -229,70 +243,134 @@ module.exports = (logger) => {
 
   const startAmd = async(cs, ep, task, opts) => {
     const amd = ep.amd = new Amd(logger, cs, opts);
-    const {vendor, language, sttCredentials} = amd;
-    const sttOpts = {};
+    const {vendor, language} = amd;
+    let sttCredentials = amd.sttCredentials;
     const hints = voicemailHints[language] || [];
 
+    if (vendor === 'nuance' && sttCredentials.client_id) {
+      /* get nuance access token */
+      const {getNuanceAccessToken} = amd;
+      const {client_id, secret} = sttCredentials;
+      const {access_token, servedFromCache} = await getNuanceAccessToken(client_id, secret, 'asr tts');
+      logger.debug({client_id}, `Gather:exec - got nuance access token ${servedFromCache ? 'from cache' : ''}`);
+      sttCredentials = {...sttCredentials, access_token};
+    }
+    else if (vendor == 'ibm' && sttCredentials.stt_api_key) {
+      /* get ibm access token */
+      const {getIbmAccessToken} = amd;
+      const {stt_api_key, stt_region} = sttCredentials;
+      const {access_token, servedFromCache} = await getIbmAccessToken(stt_api_key);
+      logger.debug({stt_api_key}, `Gather:exec - got ibm access token ${servedFromCache ? 'from cache' : ''}`);
+      sttCredentials = {...sttCredentials, access_token, stt_region};
+    }
+
     /* 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;
+    const sttOpts = amd.setChannelVarsForStt({name: TaskName.Gather}, sttCredentials, {
+      vendor,
+      hints,
+      enhancedModel: true,
+      altLanguages: opts.recognizer?.altLanguages || [],
+      initialSpeechTimeoutMs: opts.resolveTimeoutMs,
+    });
 
-      ep.addCustomEventListener(AzureTranscriptionEvents.Transcription, onTranscription.bind(null, cs, ep, task));
-      ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected, onNoSpeechDetected.bind(null, cs, ep, task));
-    }
-    logger.debug({sttOpts}, 'startAmd: setting channel vars');
     await ep.set(sttOpts).catch((err) => logger.info(err, 'Error setting channel variables'));
 
+    amd.transcriptionHandler = onTranscription.bind(null, cs, ep, task);
+    amd.EndOfUtteranceHandler = onEndOfUtterance.bind(null, cs, ep, task);
+    amd.noSpeechHandler = onNoSpeechDetected.bind(null, cs, ep, task);
+
+    switch (vendor) {
+      case 'google':
+        ep.addCustomEventListener(GoogleTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        ep.addCustomEventListener(GoogleTranscriptionEvents.EndOfUtterance, amd.EndOfUtteranceHandler);
+        break;
+
+      case 'aws':
+      case 'polly':
+        ep.addCustomEventListener(AwsTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        break;
+      case 'microsoft':
+        ep.addCustomEventListener(AzureTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected, amd.noSpeechHandler);
+        break;
+      case 'nuance':
+        ep.addCustomEventListener(NuanceTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        break;
+
+      case 'deepgram':
+        ep.addCustomEventListener(DeepgramTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        break;
+
+      case 'soniox':
+        amd.bugname = 'soniox_amd_transcribe';
+        ep.addCustomEventListener(SonioxTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        break;
+
+      case 'ibm':
+        ep.addCustomEventListener(IbmTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        break;
+
+      case 'nvidia':
+        ep.addCustomEventListener(NvidiaTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        break;
+
+      case 'cobalt':
+        ep.addCustomEventListener(CobaltTranscriptionEvents.Transcription, amd.transcriptionHandler);
+        break;
+
+      default:
+        if (vendor.startsWith('custom:')) {
+          ep.addCustomEventListener(JambonzTranscriptionEvents.Transcription, amd.transcriptionHandler);
+          break;
+        }
+        else {
+          throw new Error(`Invalid vendor ${this.vendor}`);
+        }
+    }
     amd
       .on(AmdEvents.NoSpeechDetected, (evt) => {
         task.emit('amd', {type: AmdEvents.NoSpeechDetected, ...evt});
-        ep.stopTranscription({vendor, bugname});
+        try {
+          stopAmd(ep, task);
+        } catch (err) {
+          logger.info({err}, 'Error stopping transcription');
+        }
       })
       .on(AmdEvents.HumanDetected, (evt) => {
         task.emit('amd', {type: AmdEvents.HumanDetected, ...evt});
-        ep.stopTranscription({vendor, bugname});
+        try {
+          stopAmd(ep, task);
+        } 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});
-        ep.stopTranscription({vendor, bugname});
+        try {
+          stopAmd(ep, task);
+        } catch (err) {
+          logger.info({err}, 'Error stopping transcription');
+        }
       })
       .on(AmdEvents.ToneTimeout, (evt) => {
         //task.emit('amd', {type: AmdEvents.ToneTimeout, ...evt});
-        ep.execute('avmd_stop').catch((err) => logger.info(err, 'Error stopping avmd'));
+        try {
+          stopAmd(ep, task);
+        } catch (err) {
+          logger.info({err}, 'Error stopping avmd');
+        }
       })
       .on(AmdEvents.MachineStoppedSpeaking, () => {
         task.emit('amd', {type: AmdEvents.MachineStoppedSpeaking});
-        ep.stopTranscription({vendor, bugname});
+        try {
+          stopAmd(ep, task);
+        } catch (err) {
+          logger.info({err}, 'Error stopping transcription');
+        }
       });
 
     /* start transcribing, and also listening for beep */
@@ -308,6 +386,19 @@ module.exports = (logger) => {
     if (ep.amd) {
       vendor = ep.amd.vendor;
       ep.amd.stopAllTimers();
+
+      ep.removeListener(GoogleTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(GoogleTranscriptionEvents.EndOfUtterance, ep.amd.EndOfUtteranceHandler);
+      ep.removeListener(AwsTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(AzureTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(AzureTranscriptionEvents.NoSpeechDetected, ep.amd.noSpeechHandler);
+      ep.removeListener(NuanceTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(DeepgramTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(SonioxTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(IbmTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(NvidiaTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+      ep.removeListener(JambonzTranscriptionEvents.Transcription, ep.amd.transcriptionHandler);
+
       ep.amd = null;
     }
 

lib/utils/aws-sns-lifecycle.js

@@ -1,20 +1,30 @@
 const Emitter = require('events');
 const bent = require('bent');
 const assert = require('assert');
-const PORT = process.env.AWS_SNS_PORT || 3010;
+const {
+  AWS_REGION,
+  AWS_SNS_PORT: PORT,
+  AWS_SNS_TOPIC_ARM,
+  AWS_SNS_PORT_MAX,
+} = require('../config');
 const {LifeCycleEvents} = require('./constants');
 const express = require('express');
 const app = express();
 const getString = bent('string');
-const AWS = require('aws-sdk');
-const sns = new AWS.SNS({apiVersion: '2010-03-31'});
-const autoscaling = new AWS.AutoScaling({apiVersion: '2011-01-01'});
+const {
+  SNSClient,
+  SubscribeCommand,
+  UnsubscribeCommand } = require('@aws-sdk/client-sns');
+const snsClient = new SNSClient({ region: AWS_REGION, apiVersion: '2010-03-31' });
+const {
+  AutoScalingClient,
+  DescribeAutoScalingGroupsCommand,
+  CompleteLifecycleActionCommand } = require('@aws-sdk/client-auto-scaling');
+const autoScalingClient = new AutoScalingClient({ region: AWS_REGION, apiVersion: '2011-01-01' });
 const {Parser} = require('xml2js');
 const parser = new Parser();
 const {validatePayload} = require('verify-aws-sns-signature');
 
-AWS.config.update({region: process.env.AWS_REGION});
-
 class SnsNotifier extends Emitter {
   constructor(logger) {
     super();
@@ -31,12 +41,12 @@ class SnsNotifier extends Emitter {
 
   _handleErrors(logger, app, resolve, reject, e) {
     if (e.code === 'EADDRINUSE' &&
-      process.env.AWS_SNS_PORT_MAX &&
-      e.port < process.env.AWS_SNS_PORT_MAX) {
+      AWS_SNS_PORT_MAX &&
+      e.port < 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(null, logger, app, resolve, reject));
+      server.on('error', this._handleErrors.bind(this, logger, app, resolve, reject));
       return;
     }
     reject(e);
@@ -64,7 +74,7 @@ class SnsNotifier extends Emitter {
             subscriptionRequestId: this.subscriptionRequestId
           }, 'response from SNS SubscribeURL');
           const data = await this.describeInstance();
-          this.lifecycleState = data.AutoScalingInstances[0].LifecycleState;
+          this.lifecycleState = data.AutoScalingGroups[0].Instances[0].LifecycleState;
           this.emit('SubscriptionConfirmation', {publicIp: this.publicIp});
           break;
 
@@ -120,7 +130,7 @@ class SnsNotifier extends Emitter {
       });
       return new Promise((resolve, reject) => {
         const server = this._doListen(this.logger, app, PORT, resolve);
-        server.on('error', this._handleErrors.bind(null, this.logger, app, resolve, reject));
+        server.on('error', this._handleErrors.bind(this, this.logger, app, resolve, reject));
       });
 
     } catch (err) {
@@ -130,51 +140,56 @@ class SnsNotifier extends Emitter {
 
   async subscribe() {
     try {
-      const response = await sns.subscribe({
+      const params = {
         Protocol: 'http',
-        TopicArn: process.env.AWS_SNS_TOPIC_ARM,
+        TopicArn: AWS_SNS_TOPIC_ARM,
         Endpoint: this.snsEndpoint
-      }).promise();
-      this.logger.info({response}, `response to SNS subscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+      };
+      const response = await snsClient.send(new SubscribeCommand(params));
+      this.logger.info({response}, `response to SNS subscribe to ${AWS_SNS_TOPIC_ARM}`);
     } catch (err) {
-      this.logger.error({err}, `Error subscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+      this.logger.error({err}, `Error subscribing to SNS topic arn ${AWS_SNS_TOPIC_ARM}`);
     }
   }
 
   async unsubscribe() {
     if (!this.subscriptionArn) throw new Error('SnsNotifier#unsubscribe called without an active subscription');
     try {
-      const response = await sns.unsubscribe({
+      const params = {
         SubscriptionArn: this.subscriptionArn
-      }).promise();
-      this.logger.info({response}, `response to SNS unsubscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+      };
+      const response = await snsClient.send(new UnsubscribeCommand(params));
+      this.logger.info({response}, `response to SNS unsubscribe to ${AWS_SNS_TOPIC_ARM}`);
     } catch (err) {
-      this.logger.error({err}, `Error unsubscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+      this.logger.error({err}, `Error unsubscribing to SNS topic arn ${AWS_SNS_TOPIC_ARM}`);
     }
   }
 
   completeScaleIn() {
     assert(this.scaleInParams);
-    autoscaling.completeLifecycleAction(this.scaleInParams, (err, response) => {
-      if (err) return this.logger.error({err}, 'Error completing scale-in');
-      this.logger.info({response}, 'Successfully completed scale-in action');
-    });
+    autoScalingClient.send(new CompleteLifecycleActionCommand(this.scaleInParams))
+      .then((data) => {
+        return this.logger.info({data}, 'Successfully completed scale-in action');
+      })
+      .catch((err) => {
+        this.logger.error({err}, 'Error completing scale-in');
+      });
   }
 
   describeInstance() {
     return new Promise((resolve, reject) => {
       if (!this.instanceId) return reject('instance-id unknown');
-      autoscaling.describeAutoScalingInstances({
+      autoScalingClient.send(new DescribeAutoScalingGroupsCommand({
         InstanceIds: [this.instanceId]
-      }, (err, data) => {
-        if (err) {
+      }))
+        .then((data) => {
+          this.logger.info({data}, 'SnsNotifier: describeInstance');
+          return resolve(data);
+        })
+        .catch((err) => {
           this.logger.error({err}, 'Error describing instances');
           reject(err);
-        } else {
-          this.logger.info({data}, 'SnsNotifier: describeInstance');
-          resolve(data);
-        }
-      });
+        });
     });
   }
 
@@ -188,7 +203,7 @@ module.exports = async function(logger) {
   process.on('SIGHUP', async() => {
     try {
       const data = await notifier.describeInstance();
-      const state = data.AutoScalingInstances[0].LifecycleState;
+      const state = data.AutoScalingGroups[0].Instances[0].LifecycleState;
       if (state !== notifier.lifecycleState) {
         notifier.lifecycleState = state;
         switch (state) {

lib/utils/background-task-manager.js

@@ -0,0 +1,197 @@
+const { normalizeJambones } = require('@jambonz/verb-specifications');
+const makeTask = require('../tasks/make_task');
+const { JAMBONZ_RECORD_WS_BASE_URL, JAMBONZ_RECORD_WS_USERNAME, JAMBONZ_RECORD_WS_PASSWORD } = require('../config');
+const Emitter = require('events');
+
+class BackgroundTaskManager extends Emitter {
+  constructor({cs, logger, rootSpan}) {
+    super();
+    this.tasks = new Map();
+    this.cs = cs;
+    this.logger = logger;
+    this.rootSpan = rootSpan;
+  }
+
+  isTaskRunning(type) {
+    return this.tasks.has(type);
+  }
+
+  getTask(type) {
+    if (this.tasks.has(type)) {
+      return this.tasks.get(type);
+    }
+  }
+
+  count() {
+    return this.tasks.size;
+  }
+
+  async newTask(type, taskOpts) {
+    this.logger.info({taskOpts}, `initiating Background task ${type}`);
+    if (this.tasks.has(type)) {
+      this.logger.info(`Background task ${type} is running, skiped`);
+      return;
+    }
+    let task;
+    switch (type) {
+      case 'listen':
+        task = await this._initListen(taskOpts);
+        break;
+      case 'bargeIn':
+        task = await this._initBargeIn(taskOpts);
+        break;
+      case 'record':
+        task = await this._initRecord();
+        break;
+      case 'transcribe':
+        task = await this._initTranscribe(taskOpts);
+        break;
+      default:
+        break;
+    }
+    if (task) {
+      this.tasks.set(type, task);
+    }
+    return task;
+  }
+
+  stop(type) {
+    const task = this.getTask(type);
+    if (task) {
+      this.logger.info(`stopping background task: ${type}`);
+      task.removeAllListeners();
+      task.span.end();
+      task.kill();
+      // Remove task from managed List
+      this.tasks.delete(type);
+    } else {
+      this.logger.info(`stopping background task, ${type} is not running, skipped`);
+    }
+  }
+
+  stopAll() {
+    this.logger.info('BackgroundTaskManager:stopAll');
+    for (const key of this.tasks.keys()) {
+      this.stop(key);
+    }
+  }
+
+  // Initiate Task
+  // Initiate Listen
+  async _initListen(opts, bugname = 'jambonz-background-listen', ignoreCustomerData = false, type = 'listen') {
+    let task;
+    try {
+      const t = normalizeJambones(this.logger, [opts]);
+      task = makeTask(this.logger, t[0]);
+      task.bugname = bugname;
+      task.ignoreCustomerData = ignoreCustomerData;
+      const resources = await this.cs._evaluatePreconditions(task);
+      const {span, ctx} = this.rootSpan.startChildSpan(`background-${type}:${task.summary}`);
+      task.span = span;
+      task.ctx = ctx;
+      task.exec(this.cs, resources)
+        .then(this._taskCompleted.bind(this, type, task))
+        .catch(this._taskError.bind(this, type, task));
+    } catch (err) {
+      this.logger.info({err, opts}, `BackgroundTaskManager:_initListen - Error creating ${bugname} task`);
+    }
+    return task;
+  }
+
+  // Initiate Gather
+  async _initBargeIn(opts) {
+    let task;
+    try {
+      const t = normalizeJambones(this.logger, [opts]);
+      task = makeTask(this.logger, t[0]);
+      task
+        .once('dtmf', this._bargeInTaskCompleted.bind(this))
+        .once('vad', this._bargeInTaskCompleted.bind(this))
+        .once('transcription', this._bargeInTaskCompleted.bind(this))
+        .once('timeout', this._bargeInTaskCompleted.bind(this));
+      const resources = await this.cs._evaluatePreconditions(task);
+      const {span, ctx} = this.rootSpan.startChildSpan(`background-bargeIn:${task.summary}`);
+      task.span = span;
+      task.ctx = ctx;
+      task.bugname_prefix = 'background_bargeIn_';
+      task.exec(this.cs, resources)
+        .then(() => {
+          this._taskCompleted('bargeIn', task);
+          if (task.sticky && !this.cs.callGone && !this.cs._stopping) {
+            this.logger.info('BackgroundTaskManager:_initBargeIn: restarting background bargeIn');
+            this.newTask('bargeIn', opts);
+          }
+          return;
+        })
+        .catch(this._taskError.bind(this, 'bargeIn', task));
+    } catch (err) {
+      this.logger.info(err, 'BackgroundTaskManager:_initGather - Error creating bargeIn task');
+    }
+    return task;
+  }
+
+  // Initiate Record
+  async _initRecord() {
+    if (this.cs.accountInfo.account.record_all_calls || this.cs.application.record_all_calls) {
+      if (!JAMBONZ_RECORD_WS_BASE_URL || !this.cs.accountInfo.account.bucket_credential) {
+        this.logger.error(`_initRecord: invalid configuration,
+ missing JAMBONZ_RECORD_WS_BASE_URL or bucket configuration`);
+        return undefined;
+      }
+      const listenOpts = {
+        url: `${JAMBONZ_RECORD_WS_BASE_URL}/record/${this.cs.accountInfo.account.bucket_credential.vendor}`,
+        disableBidirectionalAudio: true,
+        mixType : 'stereo',
+        passDtmf: true
+      };
+      if (JAMBONZ_RECORD_WS_USERNAME && JAMBONZ_RECORD_WS_PASSWORD) {
+        listenOpts.wsAuth = {
+          username: JAMBONZ_RECORD_WS_USERNAME,
+          password: JAMBONZ_RECORD_WS_PASSWORD
+        };
+      }
+      this.logger.debug({listenOpts}, '_initRecord: enabling listen');
+      return await this._initListen({verb: 'listen', ...listenOpts}, 'jambonz-session-record', true, 'record');
+    }
+  }
+
+  // Initiate Transcribe
+  async _initTranscribe(opts) {
+    let task;
+    try {
+      const t = normalizeJambones(this.logger, [opts]);
+      task = makeTask(this.logger, t[0]);
+      const resources = await this.cs._evaluatePreconditions(task);
+      const {span, ctx} = this.rootSpan.startChildSpan(`background-transcribe:${task.summary}`);
+      task.span = span;
+      task.ctx = ctx;
+      task.bugname_prefix = 'background_transcribe_';
+      task.exec(this.cs, resources)
+        .then(this._taskCompleted.bind(this, 'transcribe', task))
+        .catch(this._taskError.bind(this, 'transcribe', task));
+    } catch (err) {
+      this.logger.info(err, 'BackgroundTaskManager:_initTranscribe - Error creating transcribe task');
+    }
+    return task;
+  }
+
+  _taskCompleted(type, task) {
+    this.logger.info({type, task}, 'BackgroundTaskManager:_taskCompleted: task completed');
+    task.removeAllListeners();
+    task.span.end();
+    this.tasks.delete(type);
+  }
+  _taskError(type, task, error) {
+    this.logger.info({type, task, error}, 'BackgroundTaskManager:_taskError: task Error');
+    task.removeAllListeners();
+    task.span.end();
+    this.tasks.delete(type);
+  }
+
+  _bargeInTaskCompleted(evt) {
+    this.logger.info({evt}, 'BackgroundTaskManager:_bargeInTaskCompleted on event from background bargeIn');
+    this.emit('bargeIn-done', evt);
+  }
+}
+
+module.exports = BackgroundTaskManager;

lib/utils/base-requestor.js

@@ -2,6 +2,7 @@ const assert = require('assert');
 const Emitter = require('events');
 const crypto = require('crypto');
 const timeSeries = require('@jambonz/time-series');
+const {NODE_ENV, JAMBONES_TIME_SERIES_HOST} = require('../config');
 let alerter ;
 
 class BaseRequestor extends Emitter {
@@ -22,9 +23,9 @@ class BaseRequestor extends Emitter {
 
     if (!alerter) {
       alerter = timeSeries(logger, {
-        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        host: JAMBONES_TIME_SERIES_HOST,
         commitSize: 50,
-        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+        commitInterval: 'test' === NODE_ENV ? 7 : 20
       });
     }
   }

lib/utils/call-tracer.js

@@ -2,17 +2,24 @@ const {context, trace} = require('@opentelemetry/api');
 const {Dialog} = require('drachtio-srf');
 class RootSpan {
   constructor(callType, req) {
-    let tracer, callSid, linkedSpanId;
+    const {srf} = require('../../');
+    const tracer = srf.locals.otel.tracer;
+    let callSid, accountSid, applicationSid, 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;
+    else if (req.srf) {
       callSid = req.locals.callSid;
+      accountSid = req.get('X-Account-Sid'),
+      applicationSid = req.locals.application_sid;
+    }
+    else {
+      callSid = req.callSid;
+      accountSid = req.accountSid;
+      applicationSid = req.applicationSid;
     }
     this._span = tracer.startSpan(callType || 'incoming-call');
     if (req instanceof Dialog) {
@@ -22,13 +29,20 @@ class RootSpan {
         callId: dlg.sip.callId
       });
     }
+    else if (req.srf) {
+      this._span.setAttributes({
+        callSid,
+        accountSid,
+        applicationSid,
+        callId: req.get('Call-ID'),
+        externalCallId: req.get('X-CID')
+      });
+    }
     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')
+        accountSid,
+        applicationSid
       });
     }
 

lib/utils/constants.json

@@ -29,7 +29,7 @@
     "Tag": "tag",
     "Transcribe": "transcribe"
   },
-  "AllowedSipRecVerbs": ["config", "gather", "transcribe", "listen"],
+  "AllowedSipRecVerbs": ["config", "gather", "transcribe", "listen", "tag"],
   "CallStatus": {
     "Trying": "trying",
     "Ringing": "ringing",
@@ -51,6 +51,11 @@
     "Silence": "silence",
     "Resume": "resume"
   },
+  "TranscribeStatus": {
+    "Pause": "pause",
+    "Silence": "silence",
+    "Resume": "resume"
+  },
   "TaskPreconditions": {
     "None": "none",
     "Endpoint": "endpoint",
@@ -67,6 +72,40 @@
     "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"
+  },
+  "CobaltTranscriptionEvents": {
+    "Transcription": "cobalt_speech::transcription",
+    "CompileContext": "cobalt_speech::compile_context_response",
+    "Error": "cobalt_speech::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",
@@ -81,6 +120,18 @@
     "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"
+  },
+  "AssemblyAiTranscriptionEvents": {
+    "Transcription": "assemblyai_transcribe::transcription",
+    "Error": "assemblyai_transcribe::error",
+    "ConnectFailure": "assemblyai_transcribe::connect_failed",
+    "Connect": "assemblyai_transcribe::connect"
+  },
   "ListenEvents": {
     "Connect": "mod_audio_fork::connect",
     "ConnectFailure": "mod_audio_fork::connect_failed",
@@ -122,6 +173,7 @@
     "queue:status",
     "dial:confirm",
     "verb:hook",
+    "verb:status",
     "jambonz:error"
   ],
   "RecordState": {

lib/utils/cron-jobs.js

@@ -1,19 +1,24 @@
 const {execSync} = require('child_process');
+const {
+  JAMBONES_FREESWITCH,
+  NODE_ENV,
+  JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS,
+} = require('../config');
 const now = Date.now();
-const fsInventory = process.env.JAMBONES_FREESWITCH
+const fsInventory = 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';
+    if (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 maxDurationMins = JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS;
 
   const calls = execSync(`/usr/local/freeswitch/bin/fs_cli -p ${pwd} -x "show calls"`, {encoding: 'utf8'})
     .split('\n')

lib/utils/db-utils.js

@@ -3,13 +3,10 @@ const {decrypt} = require('./encrypt-decrypt');
 const sqlAccountDetails = `SELECT * 
 FROM accounts account 
 WHERE account.account_sid = ?`;
-const sqlSpeechCredentials = `SELECT * 
+const sqlSpeechCredentialsForAccount = `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 = ?)`;
+WHERE account_sid = ? OR (account_sid is NULL AND 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 = ? 
@@ -20,6 +17,19 @@ WHERE vc.account_sid IS NULL
 AND vc.service_provider_sid = 
 (SELECT service_provider_sid from accounts where account_sid = ?) 
 AND vc.name = ?`;
+const sqlQueryAccountPhoneNumber = `SELECT voip_carrier_sid 
+FROM phone_numbers pn
+WHERE pn.account_sid = ?
+AND pn.number = ?`;
+const sqlQuerySPPhoneNumber = `SELECT voip_carrier_sid  
+FROM phone_numbers pn 
+WHERE pn.account_sid IS NULL 
+AND pn.service_provider_sid = 
+(SELECT service_provider_sid from accounts where account_sid = ?) 
+AND pn.number = ?`;
+const sqlQueryGoogleCustomVoices = `SELECT *
+FROM google_custom_voices
+WHERE google_custom_voice_sid = ?`;
 
 const speechMapper = (cred) => {
   const {credential, ...obj} = cred;
@@ -39,61 +49,96 @@ const speechMapper = (cred) => {
       obj.region = o.region;
       obj.use_custom_stt = o.use_custom_stt;
       obj.custom_stt_endpoint = o.custom_stt_endpoint;
+      obj.custom_stt_endpoint_url = o.custom_stt_endpoint_url;
+      obj.use_custom_tts = o.use_custom_tts;
+      obj.custom_tts_endpoint = o.custom_tts_endpoint;
+      obj.custom_tts_endpoint_url = o.custom_tts_endpoint_url;
     }
     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 ('nvidia' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.riva_server_uri = o.riva_server_uri;
+    }
+    else if ('cobalt' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.cobalt_server_uri = o.cobalt_server_uri;
+    } else if ('elevenlabs' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+      obj.model_id = o.model_id;
+      obj.options = o.options;
+    } else if ('assemblyai' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+    } else if ('whisper' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+      obj.model_id = o.model_id;
+    } 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;
 };
 
+const bucketCredentialDecrypt = (account) => {
+  const { bucket_credential } = account.account;
+  if (!bucket_credential || bucket_credential.vendor) return;
+  account.account.bucket_credential = JSON.parse(decrypt(bucket_credential));
+};
+
 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);
+    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 [r2] = await pp.query(sqlSpeechCredentialsForAccount, [account_sid, account_sid]);
     const speech = r2.map(speechMapper);
 
-    /* search at the service provider level if we don't find it at the account level */
-    const haveGoogle = speech.find((s) => s.vendor === 'google');
-    const haveAws = speech.find((s) => s.vendor === 'aws');
-    const haveMicrosoft = speech.find((s) => s.vendor === 'microsoft');
-    const haveWellsaid = speech.find((s) => s.vendor === 'wellsaid');
-    if (!haveGoogle || !haveAws || !haveMicrosoft) {
-      const [r3] = await pp.query(sqlSpeechCredentialsForSP, account_sid);
-      if (r3.length) {
-        if (!haveGoogle) {
-          const google = r3.find((s) => s.vendor === 'google');
-          if (google) speech.push(speechMapper(google));
-        }
-        if (!haveAws) {
-          const aws = r3.find((s) => s.vendor === 'aws');
-          if (aws) speech.push(speechMapper(aws));
-        }
-        if (!haveMicrosoft) {
-          const ms = r3.find((s) => s.vendor === 'microsoft');
-          if (ms) speech.push(speechMapper(ms));
-        }
-        if (!haveWellsaid) {
-          const wellsaid = r3.find((s) => s.vendor === 'wellsaid');
-          if (wellsaid) speech.push(speechMapper(wellsaid));
-        }
-      }
-    }
+    const account = r[0];
+    bucketCredentialDecrypt(account);
 
     return {
-      ...r[0],
+      ...account,
       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 {
@@ -115,9 +160,34 @@ module.exports = (logger, srf) => {
     }
   };
 
+  const lookupCarrierByPhoneNumber = async(account_sid, phoneNumber) => {
+    const pp = pool.promise();
+    try {
+      const [r] = await pp.query(sqlQueryAccountPhoneNumber, [account_sid, phoneNumber]);
+      if (r.length) return r[0].voip_carrier_sid;
+      const [r2] = await pp.query(sqlQuerySPPhoneNumber, [account_sid, phoneNumber]);
+      if (r2.length) return r2[0].voip_carrier_sid;
+    } catch (err) {
+      logger.error({err}, `lookupPhoneNumber: Error ${account_sid}:${phoneNumber}`);
+    }
+  };
+
+  const lookupGoogleCustomVoice = async(google_custom_voice_sid) => {
+    const pp = pool.promise();
+    try {
+      const [r] = await pp.query(sqlQueryGoogleCustomVoices, [google_custom_voice_sid]);
+      return r;
+
+    } catch (err) {
+      logger.error({err}, `lookupGoogleCustomVoices: Error ${google_custom_voice_sid}`);
+    }
+  };
+
   return {
     lookupAccountDetails,
     updateSpeechCredentialLastUsed,
-    lookupCarrier
+    lookupCarrier,
+    lookupCarrierByPhoneNumber,
+    lookupGoogleCustomVoice
   };
 };

lib/utils/encrypt-decrypt.js

@@ -1,10 +1,11 @@
 const crypto = require('crypto');
-const algorithm = process.env.LEGACY_CRYPTO ? 'aes-256-ctr' : 'aes-256-cbc';
+const {LEGACY_CRYPTO, ENCRYPTION_SECRET, JWT_SECRET} = require('../config');
+const algorithm = LEGACY_CRYPTO ? 'aes-256-ctr' : 'aes-256-cbc';
 const iv = crypto.randomBytes(16);
 const secretKey = crypto.createHash('sha256')
-  .update(String(process.env.JWT_SECRET))
+  .update(ENCRYPTION_SECRET || JWT_SECRET)
   .digest('base64')
-  .substr(0, 32);
+  .substring(0, 32);
 
 const encrypt = (text) => {
   const cipher = crypto.createCipheriv(algorithm, secretKey, iv);
@@ -25,8 +26,8 @@ const decrypt = (data) => {
     throw err;
   }
   const decipher = crypto.createDecipheriv(algorithm, secretKey, Buffer.from(hash.iv, 'hex'));
-  const decrpyted = Buffer.concat([decipher.update(Buffer.from(hash.content, 'hex')), decipher.final()]);
-  return decrpyted.toString();
+  const decrypted = Buffer.concat([decipher.update(Buffer.from(hash.content, 'hex')), decipher.final()]);
+  return decrypted.toString();
 };
 
 module.exports = {

lib/utils/http-listener.js

@@ -1,26 +1,28 @@
 
 const express = require('express');
 const httpRoutes = require('../http-routes');
-const PORT = process.env.HTTP_PORT || 3000;
+const {PORT, HTTP_PORT_MAX} = require('../config');
 
 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}`);
+    srf.locals.serviceUrl = `http://${srf.locals.ipv4}:${port}`;
+    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) {
+    HTTP_PORT_MAX &&
+    e.port < 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);
 };
 
@@ -30,7 +32,7 @@ const createHttpListener = (logger, srf) => {
   app.use(express.urlencoded({ extended: true }));
   app.use(express.json());
   app.use('/', httpRoutes);
-  app.use((err, req, res, next) => {
+  app.use((err, _req, res, _next) => {
     logger.error(err, 'burped error');
     res.status(err.status || 500).json({msg: err.message});
   });

lib/utils/http-requestor.js

@@ -1,11 +1,21 @@
-const {Client, Pool} = require('undici');
+const {request, getGlobalDispatcher, setGlobalDispatcher, Dispatcher, ProxyAgent, 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 {
+  HTTP_POOL,
+  HTTP_POOLSIZE,
+  HTTP_PIPELINING,
+  HTTP_TIMEOUT,
+  HTTP_PROXY_IP,
+  HTTP_PROXY_PORT,
+  HTTP_PROXY_PROTOCOL,
+  NODE_ENV,
+  HTTP_USER_AGENT_HEADER,
+} = require('../config');
 
 const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
 
@@ -16,6 +26,15 @@ function basicAuth(username, password) {
   return {Authorization: header};
 }
 
+const defaultDispatcher = HTTP_PROXY_IP ?
+  new ProxyAgent(`${HTTP_PROXY_PROTOCOL}://${HTTP_PROXY_IP}${HTTP_PROXY_PORT ? `:${HTTP_PROXY_PORT}` : ''}`) :
+  getGlobalDispatcher();
+
+setGlobalDispatcher(new class extends Dispatcher {
+  dispatch(options, handler) {
+    return defaultDispatcher.dispatch(options, handler);
+  }
+}());
 
 class HttpRequestor extends BaseRequestor {
   constructor(logger, account_sid, hook, secret) {
@@ -31,16 +50,18 @@ class HttpRequestor extends BaseRequestor {
     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);
+    this._usePools = HTTP_POOL && parseInt(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 connections = HTTP_POOLSIZE ? parseInt(HTTP_POOLSIZE) : 10;
+        const pipelining = HTTP_PIPELINING ? parseInt(HTTP_PIPELINING) : 1;
         const pool = this.client = new Pool(this._baseUrl, {
           connections,
           pipelining
@@ -53,6 +74,18 @@ class HttpRequestor extends BaseRequestor {
       if (u.port) this.client = new Client(`${u.protocol}://${u.resource}:${u.port}`);
       else this.client = new Client(`${u.protocol}://${u.resource}`);
     }
+
+    if (NODE_ENV == 'test' && process.env.JAMBONES_HTTP_PROXY_IP) {
+      const defDispatcher =
+        new ProxyAgent(`${process.env.JAMBONES_HTTP_PROXY_PROTOCOL}://${process.env.JAMBONES_HTTP_PROXY_IP}${
+          process.env.JAMBONES_HTTP_PROXY_PORT ? `:${process.env.JAMBONES_HTTP_PROXY_PORT}` : ''}`);
+
+      setGlobalDispatcher(new class extends Dispatcher {
+        dispatch(options, handler) {
+          return defDispatcher.dispatch(options, handler);
+        }
+      }());
+    }
   }
 
   get baseUrl() {
@@ -84,11 +117,28 @@ class HttpRequestor extends BaseRequestor {
     const url = hook.url || hook;
     const method = hook.method || 'POST';
     let buf = '';
+    httpHeaders = {
+      ...httpHeaders,
+      ...(HTTP_USER_AGENT_HEADER && {'user-agent' : HTTP_USER_AGENT_HEADER})
+    };
 
     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;
@@ -98,7 +148,7 @@ class HttpRequestor extends BaseRequestor {
       }
       else {
         const u = parseUrl(url);
-        if (u.resource === this._resource && u.protocol === this._protocol) {
+        if (u.resource === this._resource && u.port === this._port && u.protocol === this._protocol) {
           client = this.client;
           path = u.pathname;
           query = u.query;
@@ -119,7 +169,18 @@ class HttpRequestor extends BaseRequestor {
       };
       const absUrl = this._isRelativeUrl(url) ? `${this.baseUrl}${url}` : url;
       this.logger.debug({url, absUrl, hdrs}, 'send webhook');
-      const {statusCode, headers, body} =  await client.request({
+      const {statusCode, headers, body} =  HTTP_PROXY_IP ? await request(
+        this.baseUrl,
+        {
+          path,
+          query,
+          method,
+          headers: hdrs,
+          ...('POST' === method && {body: JSON.stringify(payload)}),
+          timeout: HTTP_TIMEOUT,
+          followRedirects: false
+        }
+      ) : await client.request({
         path,
         query,
         method,

lib/utils/install-srf-locals.js

@@ -1,6 +1,20 @@
 const Mrf = require('drachtio-fsmrf');
 const ip = require('ip');
-const PORT = process.env.HTTP_PORT || 3000;
+const {
+  JAMBONES_MYSQL_HOST,
+  JAMBONES_MYSQL_USER,
+  JAMBONES_MYSQL_PASSWORD,
+  JAMBONES_MYSQL_DATABASE,
+  JAMBONES_MYSQL_CONNECTION_LIMIT,
+  JAMBONES_MYSQL_PORT,
+  JAMBONES_FREESWITCH,
+  SMPP_URL,
+  JAMBONES_TIME_SERIES_HOST,
+  JAMBONES_ESL_LISTEN_ADDRESS,
+  PORT,
+  NODE_ENV,
+} = require('../config');
+const Registrar = require('@jambonz/mw-registrar');
 const assert = require('assert');
 
 function initMS(logger, wrapper, ms) {
@@ -42,18 +56,18 @@ function installSrfLocals(srf, logger) {
   let idxStart = 0;
 
   (async function() {
-    const fsInventory = process.env.JAMBONES_FREESWITCH
+    const fsInventory = JAMBONES_FREESWITCH
       .split(',')
       .map((fs) => {
         const arr = /^([^:]*):([^:]*):([^:]*)(?::([^:]*))?/.exec(fs);
-        assert.ok(arr, `Invalid syntax JAMBONES_FREESWITCH: ${process.env.JAMBONES_FREESWITCH}`);
+        assert.ok(arr, `Invalid syntax JAMBONES_FREESWITCH: ${JAMBONES_FREESWITCH}`);
         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;
+        if (NODE_ENV === 'test') opts.listenAddress = '0.0.0.0';
+        else if (JAMBONES_ESL_LISTEN_ADDRESS) opts.listenAddress = JAMBONES_ESL_LISTEN_ADDRESS;
         return opts;
       });
     logger.info({fsInventory}, 'freeswitch inventory');
@@ -123,22 +137,22 @@ function installSrfLocals(srf, logger) {
     lookupTeamsByAccount,
     lookupAccountBySid,
     lookupAccountCapacitiesBySid,
-    lookupSmppGateways
+    lookupSmppGateways,
+    lookupClientByAccountAndUsername
   } = 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, tracer);
+    host: JAMBONES_MYSQL_HOST,
+    user: JAMBONES_MYSQL_USER,
+    port: JAMBONES_MYSQL_PORT || 3306,
+    password: JAMBONES_MYSQL_PASSWORD,
+    database: JAMBONES_MYSQL_DATABASE,
+    connectionLimit: JAMBONES_MYSQL_CONNECTION_LIMIT || 10
+  }, logger);
   const {
     client,
     updateCallStatus,
     retrieveCall,
     listCalls,
     deleteCall,
-    synthAudio,
     createHash,
     retrieveHash,
     deleteKey,
@@ -151,19 +165,27 @@ function installSrfLocals(srf, logger) {
     pushBack,
     popFront,
     removeFromList,
+    getListPosition,
     lengthOfList,
-    getListPosition
-  } = require('@jambonz/realtimedb-helpers')({
-    host: process.env.JAMBONES_REDIS_HOST,
-    port: process.env.JAMBONES_REDIS_PORT || 6379
-  }, logger, tracer);
+    addToSortedSet,
+    retrieveFromSortedSet,
+    retrieveByPatternSortedSet,
+    sortedSetLength,
+    sortedSetPositionByPattern
+  } = require('@jambonz/realtimedb-helpers')({}, logger, tracer);
+  const registrar = new Registrar(logger, client);
+  const {
+    synthAudio,
+    getNuanceAccessToken,
+    getIbmAccessToken,
+  } = require('@jambonz/speech-utils')({}, logger);
   const {
     writeAlerts,
     AlertType
   } = require('@jambonz/time-series')(logger, {
-    host: process.env.JAMBONES_TIME_SERIES_HOST,
+    host: JAMBONES_TIME_SERIES_HOST,
     commitSize: 50,
-    commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+    commitInterval: 'test' === NODE_ENV ? 7 : 20
   });
 
   let localIp;
@@ -176,6 +198,7 @@ function installSrfLocals(srf, logger) {
   srf.locals = {...srf.locals,
     dbHelpers: {
       client,
+      registrar,
       pool,
       lookupAppByPhoneNumber,
       lookupAppByRegex,
@@ -186,6 +209,7 @@ function installSrfLocals(srf, logger) {
       lookupAccountBySid,
       lookupAccountCapacitiesBySid,
       lookupSmppGateways,
+      lookupClientByAccountAndUsername,
       updateCallStatus,
       retrieveCall,
       listCalls,
@@ -204,12 +228,19 @@ function installSrfLocals(srf, logger) {
       popFront,
       removeFromList,
       lengthOfList,
-      getListPosition
+      getListPosition,
+      getNuanceAccessToken,
+      getIbmAccessToken,
+      addToSortedSet,
+      retrieveFromSortedSet,
+      retrieveByPatternSortedSet,
+      sortedSetLength,
+      sortedSetPositionByPattern
     },
     parentLogger: logger,
     getSBC,
     getSmpp: () => {
-      return process.env.SMPP_URL;
+      return SMPP_URL;
     },
     lifecycleEmitter,
     getFreeswitch,

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,7 +4,7 @@ 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('../utils/normalize-jambones');
+const { normalizeJambones } = require('@jambonz/verb-specifications');
 const makeTask = require('../tasks/make_task');
 const ConfirmCallSession = require('../session/confirm-call-session');
 const AdultingCallSession = require('../session/adulting-call-session');
@@ -12,10 +12,13 @@ const deepcopy = require('deepcopy');
 const moment = require('moment');
 const stripCodecs = require('./strip-ancillary-codecs');
 const RootSpan = require('./call-tracer');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
+const HttpRequestor = require('./http-requestor');
+const WsRequestor = require('./ws-requestor');
+const {makeOpusFirst} = require('./sdp-utils');
 
 class SingleDialer extends Emitter {
-  constructor({logger, sbcAddress, target, opts, application, callInfo, accountInfo, rootSpan, startSpan}) {
+  constructor({logger, sbcAddress, target, opts, application, callInfo, accountInfo, rootSpan, startSpan, dialTask}) {
     super();
     assert(target.type);
 
@@ -37,6 +40,7 @@ class SingleDialer extends Emitter {
     this.callGone = false;
 
     this.callSid = uuidv4();
+    this.dialTask = dialTask;
 
     this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
   }
@@ -45,6 +49,10 @@ class SingleDialer extends Emitter {
     return this.callInfo.callStatus;
   }
 
+  get applicationSid() {
+    return this.application?.application_sid || this.callInfo?.applicationSid;
+  }
+
   /**
    * can be used for all http requests within this session
    */
@@ -71,7 +79,8 @@ class SingleDialer extends Emitter {
       ...(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})
+      ...(this.applicationSid && {'X-Application-Sid': this.applicationSid}),
+      ...(this.target.proxy && {'X-SIP-Proxy': this.target.proxy})
     };
     if (srf.locals.fsUUID) {
       opts.headers = {
@@ -143,7 +152,7 @@ class SingleDialer extends Emitter {
 
       Object.assign(opts, {
         proxy: `sip:${this.sbcAddress}`,
-        localSdp: this.ep.local.sdp
+        localSdp: opts.opusFirst ? makeOpusFirst(this.ep.local.sdp) : this.ep.local.sdp
       });
       if (this.target.auth) opts.auth = this.target.auth;
       inviteSpan = this.startSpan('invite', {
@@ -171,6 +180,7 @@ class SingleDialer extends Emitter {
            *  (a) create a logger for this call
            */
           req.srf = srf;
+          this.req = req;
           this.callInfo = new CallInfo({
             direction: CallDirection.Outbound,
             parentCallInfo: this.parentCallInfo,
@@ -243,9 +253,14 @@ class SingleDialer extends Emitter {
         .on('modify', async(req, res) => {
           try {
             if (this.ep) {
-              const newSdp = await this.ep.modify(req.body);
-              res.send(200, {body: newSdp});
-              this.logger.info({offer: req.body, answer: newSdp}, 'SingleDialer:exec: handling reINVITE');
+              if (this.dialTask && this.dialTask.isOnHold) {
+                this.logger.info('dial is onhold, emit event');
+                this.emit('reinvite', req, res);
+              } else {
+                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');
@@ -316,10 +331,15 @@ class SingleDialer extends Emitter {
     try {
       // retrieve set of tasks
       const json = await this.requestor.request('dial:confirm', confirmHook, this.callInfo.toJSON());
+      if (!json || (Array.isArray(json) && json.length === 0)) {
+        this.logger.info('SingleDialer:_executeApp: no tasks returned from confirm hook');
+        return;
+      }
       const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
       // verify it contains only allowed verbs
       const allowedTasks = tasks.filter((task) => {
         return [
+          TaskPreconditions.None,
           TaskPreconditions.StableCall,
           TaskPreconditions.Endpoint
         ].includes(task.preconditions);
@@ -367,15 +387,35 @@ class SingleDialer extends Emitter {
     this.dlg.linkedSpanId = this.rootSpan.traceId;
     const rootSpan = new RootSpan('outbound-call', this.dlg);
     const newLogger = logger.child({traceId: rootSpan.traceId});
+    //clone application from parent call with new requestor
+    //parrent application will be closed in case the parent hangup
+    const app = {...application};
+    if ('WS' === app.call_hook?.method ||
+      app.call_hook?.url.startsWith('ws://') || app.call_hook?.url.startsWith('wss://')) {
+      const requestor = new WsRequestor(logger, this.accountInfo.account.account_sid,
+        app.call_hook, this.accountInfo.account.webhook_secret);
+      app.requestor = requestor;
+      app.notifier = requestor;
+      app.call_hook.method = 'WS';
+    }
+    else {
+      app.requestor = new HttpRequestor(logger, this.accountInfo.account.account_sid,
+        app.call_hook, this.accountInfo.account.webhook_secret);
+      if (app.call_status_hook) app.notifier = new HttpRequestor(logger,
+        this.accountInfo.account.account_sid, app.call_status_hook,
+        this.accountInfo.account.webhook_secret);
+      else app.notifier = {request: () => {}, close: () => {}};
+    }
     const cs = new AdultingCallSession({
       logger: newLogger,
       singleDialer: this,
-      application,
+      application: app,
       callInfo: this.callInfo,
       accountInfo: this.accountInfo,
       tasks,
       rootSpan
     });
+    cs.req = this.req;
     cs.exec().catch((err) => newLogger.error({err}, 'doAdulting: error executing session'));
     return cs;
   }
@@ -412,7 +452,7 @@ class SingleDialer extends Emitter {
       this.callInfo.updateCallStatus(callStatus, sipStatus, sipReason);
       if (typeof duration === 'number') this.callInfo.duration = duration;
       try {
-        this.requestor.request('call:status', 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}`);
       }
@@ -426,11 +466,11 @@ class SingleDialer extends Emitter {
 }
 
 function placeOutdial({
-  logger, srf, ms, sbcAddress, target, opts, application, callInfo, accountInfo, rootSpan, startSpan
+  logger, srf, ms, sbcAddress, target, opts, application, callInfo, accountInfo, rootSpan, startSpan, dialTask
 }) {
   const myOpts = deepcopy(opts);
   const sd = new SingleDialer({
-    logger, sbcAddress, target, myOpts, application, callInfo, accountInfo, rootSpan, startSpan
+    logger, sbcAddress, target, myOpts, application, callInfo, accountInfo, rootSpan, startSpan, dialTask
   });
   sd.exec(srf, ms, myOpts);
   return sd;

lib/utils/requestor.js

@@ -1,5 +1,9 @@
 const assert = require('assert');
 const timeSeries = require('@jambonz/time-series');
+const {
+  NODE_ENV,
+  JAMBONES_TIME_SERIES_HOST
+} = require('../config');
 let alerter ;
 
 function isAbsoluteUrl(u) {
@@ -28,9 +32,9 @@ class Requestor {
 
     if (!alerter) {
       alerter = timeSeries(logger, {
-        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        host: JAMBONES_TIME_SERIES_HOST,
         commitSize: 50,
-        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+        commitInterval: 'test' === NODE_ENV ? 7 : 20
       });
     }
   }
@@ -38,9 +42,9 @@ class Requestor {
   get Alerter() {
     if (!alerter) {
       alerter = timeSeries(this.logger, {
-        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        host: JAMBONES_TIME_SERIES_HOST,
         commitSize: 50,
-        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+        commitInterval: 'test' === NODE_ENV ? 7 : 20
       });
     }
     return alerter;

lib/utils/sbc-pinger.js

@@ -1,31 +1,41 @@
 const assert = require('assert');
-const { v4: uuidv4 } = require('uuid');
+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: () => {}};
+const {
+  JAMBONES_SBCS,
+  K8S,
+  K8S_SBC_SIP_SERVICE_NAME,
+  AWS_SNS_TOPIC_ARM,
+  OPTIONS_PING_INTERVAL,
+  AWS_REGION,
+  NODE_ENV,
+  JAMBONES_CLUSTER_ID,
+} = require('../config');
 
 module.exports = (logger) => {
   logger = logger || noopLogger;
   let idxSbc = 0;
   let sbcs = [];
 
-  if (process.env.JAMBONES_SBCS) {
-    sbcs = process.env.JAMBONES_SBCS
+  if (JAMBONES_SBCS) {
+    sbcs = 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`];
+  else if (K8S && K8S_SBC_SIP_SERVICE_NAME) {
+    sbcs = [`${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_REGION) {
+  if (AWS_SNS_TOPIC_ARM && AWS_REGION) {
 
     (async function() {
       try {
@@ -75,9 +85,13 @@ module.exports = (logger) => {
       }
     })();
   }
+  else if (K8S) {
+    lifecycleEmitter.scaleIn = () => process.exit(0);
+  }
+
 
   async function pingProxies(srf) {
-    if (process.env.NODE_ENV === 'test') return;
+    if (NODE_ENV === 'test') return;
 
     for (const sbc of sbcs) {
       try {
@@ -87,7 +101,8 @@ module.exports = (logger) => {
           method: 'OPTIONS',
           headers: {
             'X-FS-Status': ms && !dryUpCalls ? 'open' : 'closed',
-            'X-FS-Calls': srf.locals.sessionTracker.count
+            'X-FS-Calls': srf.locals.sessionTracker.count,
+            'X-FS-ServiceUrl': srf.locals.serviceUrl
           }
         });
         req.on('response', (res) => {
@@ -98,7 +113,7 @@ module.exports = (logger) => {
       }
     }
   }
-  if (process.env.K8S) {
+  if (K8S) {
     setImmediate(() => {
       logger.info('disabling OPTIONS pings since we are running as a kubernetes service');
       const {srf} = require('../..');
@@ -119,16 +134,16 @@ module.exports = (logger) => {
     setInterval(() => {
       const {srf} = require('../..');
       pingProxies(srf);
-    }, process.env.OPTIONS_PING_INTERVAL || 30000);
+    }, OPTIONS_PING_INTERVAL);
 
     // 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) {
+      if (!JAMBONES_SBCS) {
         const {monitorSet} = srf.locals.dbHelpers;
-        const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-sip`;
+        const setName = `${(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}`);

lib/utils/sdp-utils.js

@@ -0,0 +1,58 @@
+const sdpTransform = require('sdp-transform');
+
+const isOnhold = (sdp) => {
+  return sdp && (sdp.includes('a=sendonly') || sdp.includes('a=inactive'));
+};
+
+const mergeSdpMedia = (sdp1, sdp2) => {
+  const parsedSdp1 = sdpTransform.parse(sdp1);
+  const parsedSdp2 = sdpTransform.parse(sdp2);
+
+  parsedSdp1.media.push(...parsedSdp2.media);
+  return sdpTransform.write(parsedSdp1);
+};
+
+const getCodecPlacement = (parsedSdp, codec) => parsedSdp?.media[0]?.rtp?.findIndex((e) => e.codec === codec);
+
+const isOpusFirst = (sdp) => {
+  return getCodecPlacement(sdpTransform.parse(sdp), 'opus') === 0;
+};
+
+const makeOpusFirst = (sdp) => {
+  const parsedSdp = sdpTransform.parse(sdp);
+  // Find the index of the OPUS codec
+  const opusIndex = getCodecPlacement(parsedSdp, 'opus');
+
+  // Move OPUS codec to the beginning
+  if (opusIndex > 0) {
+    const opusEntry = parsedSdp.media[0].rtp.splice(opusIndex, 1)[0];
+    parsedSdp.media[0].rtp.unshift(opusEntry);
+
+    // Also move the corresponding payload type in the "m" line
+    const opusPayloadType = parsedSdp.media[0].payloads.split(' ')[opusIndex];
+    const otherPayloadTypes = parsedSdp.media[0].payloads.split(' ').filter((pt) => pt != opusPayloadType);
+    parsedSdp.media[0].payloads = [opusPayloadType, ...otherPayloadTypes].join(' ');
+  }
+  return sdpTransform.write(parsedSdp);
+};
+
+const extractSdpMedia = (sdp) => {
+  const parsedSdp1 = sdpTransform.parse(sdp);
+  if (parsedSdp1.media.length > 1) {
+    parsedSdp1.media = [parsedSdp1.media[0]];
+    const parsedSdp2 = sdpTransform.parse(sdp);
+    parsedSdp2.media = [parsedSdp2.media[1]];
+
+    return [sdpTransform.write(parsedSdp1), sdpTransform.write(parsedSdp2)];
+  } else {
+    return [sdp, sdp];
+  }
+};
+
+module.exports = {
+  isOnhold,
+  mergeSdpMedia,
+  extractSdpMedia,
+  isOpusFirst,
+  makeOpusFirst
+};

lib/utils/siprec-utils.js

@@ -1,5 +1,5 @@
 const xmlParser = require('xml2js').parseString;
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const parseUri = require('drachtio-srf').parseUri;
 const transform = require('sdp-transform');
 const debug = require('debug')('jambonz:feature-server');
@@ -47,8 +47,16 @@ const parseSiprecPayload = (req, logger) => {
       }
     }
 
-    if (!sdp || !meta) {
-      logger.info({payload: req.payload}, 'invalid SIPREC payload');
+
+    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'));
     }
 
@@ -89,8 +97,12 @@ const parseSiprecPayload = (req, logger) => {
             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];
+                if (ps.hasOwnProperty(`${prefix}send`)) {
+                  part.send = ps[`${prefix}send`][0];
+                }
+                if (ps.hasOwnProperty(`${prefix}recv`)) {
+                  part.recv = ps[`${prefix}recv`][0];
+                }
               }
             });
           }
@@ -101,9 +113,9 @@ const parseSiprecPayload = (req, logger) => {
           obj[`${prefix}stream`].forEach((s) => {
             const streamId = s.$.stream_id;
             let sender;
-            for (const [k, v] of Object.entries(participants)) {
+            for (const v of Object.values(participants)) {
               if (v.send === streamId) {
-                sender = k;
+                sender = v;
                 break;
               }
             }
@@ -113,9 +125,15 @@ const parseSiprecPayload = (req, logger) => {
 
             sender.label = s[`${prefix}label`][0];
 
-            if (-1 !== ['1', 'a_leg', 'inbound'].indexOf(sender.label)) {
-              opts.caller.aor = sender.aor ;
+            if (-1 !== ['1', 'a_leg', 'inbound', '10'].indexOf(sender.label)) {
+              opts.caller.aor = sender.aor;
               if (sender.name) opts.caller.name = sender.name;
+              // Remap the sdp stream base on sender label
+              if (!opts.sdp1.includes(`a=label:${sender.label}`)) {
+                const tmp = opts.sdp1;
+                opts.sdp1 = opts.sdp2;
+                opts.sdp2 = tmp;
+              }
             }
             else {
               opts.callee.aor = sender.aor ;
@@ -242,7 +260,8 @@ const createSipRecPayload = (sdp1, sdp2, logger) => {
     .replace(/a=sendonly\r\n/g, '')
     .replace(/a=direction:both\r\n/g, '');
   */
-  return combinedSdp;
+
+  return combinedSdp.replace(/sendrecv/g, 'recvonly');
 };
 
 module.exports = { parseSiprecPayload, createSipRecPayload } ;

lib/utils/transcription-utils.js

@@ -1,33 +1,790 @@
-module.exports = (logger) => {
-  const normalizeTranscription = (evt, vendor, channel) => {
-    if ('aws' === vendor && Array.isArray(evt) && evt.length > 0) evt = evt[0];
-    if ('microsoft' === vendor) {
-      const nbest = evt.NBest;
-      const language_code = evt.PrimaryLanguage?.Language || this.language;
-      const alternatives = nbest ? nbest.map((n) => {
-        return {
-          confidence: n.Confidence,
-          transcript: n.Display
-        };
-      }) :
-        [
-          {
-            transcript: evt.DisplayText || evt.Text
-          }
-        ];
+const {
+  TaskName,
+} = require('./constants.json');
 
-      const newEvent = {
-        is_final: evt.RecognitionStatus === 'Success',
-        channel,
-        language_code,
-        alternatives
-      };
-      evt = newEvent;
+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',
+    'AZURE_SPEECH_SEGMENTATION_SILENCE_TIMEOUT_MS'
+  ],
+  deepgram: [
+    'DEEPGRAM_SPEECH_KEYWORDS',
+    'DEEPGRAM_API_KEY',
+    'DEEPGRAM_SPEECH_TIER',
+    'DEEPGRAM_SPEECH_MODEL',
+    'DEEPGRAM_SPEECH_ENABLE_SMART_FORMAT',
+    '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_UTTERANCE_END_MS',
+    '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'
+  ],
+  cobalt: [
+    'COBALT_SPEECH_HINTS',
+    'COBALT_COMPILED_CONTEXT_DATA',
+    'COBALT_METADATA'
+  ],
+  soniox: [
+    'SONIOX_PROFANITY_FILTER',
+    'SONIOX_MODEL'
+  ],
+  assemblyai: [
+    'ASSEMBLYAI_API_KEY',
+    'ASSEMBLYAI_WORD_BOOST'
+  ]
+};
+
+const consolidateTranscripts = (bufferedTranscripts, channel, language) => {
+  if (bufferedTranscripts.length === 1) return bufferedTranscripts[0];
+  let totalConfidence = 0;
+  const finalTranscript = bufferedTranscripts.reduce((acc, evt) => {
+    totalConfidence += evt.alternatives[0].confidence;
+
+    let newTranscript = evt.alternatives[0].transcript;
+
+    // If new transcript consists only of digits, spaces, and a trailing comma or period
+    if (newTranscript.match(/^[\d\s]+[,.]?$/)) {
+      newTranscript = newTranscript.replace(/\s/g, '');  // Remove all spaces
+      if (newTranscript.endsWith(',')) {
+        newTranscript = newTranscript.slice(0, -1);  // Remove the trailing comma
+      } else if (newTranscript.endsWith('.')) {
+        newTranscript = newTranscript.slice(0, -1);  // Remove the trailing period
+      }
+    }
+
+    const lastChar = acc.alternatives[0].transcript.slice(-1);
+    const firstChar = newTranscript.charAt(0);
+
+    if (lastChar.match(/\d/) && firstChar.match(/\d/)) {
+      acc.alternatives[0].transcript += newTranscript;
+    } else {
+      acc.alternatives[0].transcript += ` ${newTranscript}`;
+    }
+
+    return acc;
+  }, {
+    language_code: language,
+    channel_tag: channel,
+    is_final: true,
+    alternatives: [{
+      transcript: ''
+    }]
+  });
+  finalTranscript.alternatives[0].confidence = bufferedTranscripts.length === 1 ?
+    bufferedTranscripts[0].alternatives[0].confidence :
+    totalConfidence / bufferedTranscripts.length;
+  finalTranscript.alternatives[0].transcript = finalTranscript.alternatives[0].transcript.trim();
+  finalTranscript.vendor = {
+    name: 'deepgram',
+    evt: bufferedTranscripts
+  };
+  return finalTranscript;
+};
+
+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, shortUtterance) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  const alternatives = (evt.channel?.alternatives || [])
+    .map((alt) => ({
+      confidence: alt.confidence,
+      transcript: alt.transcript,
+    }));
+
+  /**
+   * note difference between is_final and speech_final in Deepgram:
+   * https://developers.deepgram.com/docs/understand-endpointing-interim-results
+   */
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: shortUtterance ? evt.is_final : evt.speech_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 normalizeCobalt = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  const alternatives = (evt.alternatives || [])
+    .map((alt) => ({
+      confidence: alt.confidence,
+      transcript: alt.transcript_formatted,
+    }));
+
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.is_final,
+    alternatives,
+    vendor: {
+      name: 'cobalt',
+      evt: copy
+    }
+  };
+};
+
+const normalizeCustom = (evt, channel, language, vendor) => {
+  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: vendor,
+      evt: copy
+    }
+  };
+};
+
+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, punctuation = true) => {
+  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,
+      // remove all puntuation if needed
+      transcript: punctuation ? n.Display : n.Display.replace(/\p{P}/gu, '')
+    };
+  }) :
+    [
+      {
+        transcript: punctuation ? evt.DisplayText || evt.Text : (evt.DisplayText || evt.Text).replace(/\p{P}/gu, '')
+      }
+    ];
+
+  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
+    }
+  };
+};
+
+const normalizeAssemblyAi = (evt, channel, language) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.message_type === 'FinalTranscript',
+    alternatives: [
+      {
+        confidence: evt.confidence,
+        transcript: evt.text,
+      }
+    ],
+    vendor: {
+      name: 'ASSEMBLYAI',
+      evt: copy
+    }
+  };
+};
+
+module.exports = (logger) => {
+  const normalizeTranscription = (evt, vendor, channel, language, shortUtterance, punctuation) => {
+
+    //logger.debug({ evt, vendor, channel, language }, 'normalizeTranscription');
+    switch (vendor) {
+      case 'deepgram':
+        return normalizeDeepgram(evt, channel, language, shortUtterance);
+      case 'microsoft':
+        return normalizeMicrosoft(evt, channel, language, punctuation);
+      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);
+      case 'cobalt':
+        return normalizeCobalt(evt, channel, language);
+      case 'assemblyai':
+        return normalizeAssemblyAi(evt, channel, language, shortUtterance);
+      default:
+        if (vendor.startsWith('custom:')) {
+          return normalizeCustom(evt, channel, language, vendor);
+        }
+        logger.error(`Unknown vendor ${vendor}`);
+        return evt;
     }
-    evt.channel_tag = channel;
-    //logger.debug({evt}, 'normalized transcription');
-    return evt;
   };
 
-  return {normalizeTranscription};
+  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}),
+        // When altLanguages is emptylist, we have to send value to freeswitch to clear the previous settings
+        ...(rOpts.altLanguages &&
+          {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) {
+      const {azureOptions = {}} = rOpts;
+      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(',')}),
+        // When altLanguages is emptylist, we have to send value to freeswitch to clear the previous settings
+        ...(rOpts.altLanguages &&
+          {AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES: [...new Set(rOpts.altLanguages)].join(',')}),
+        ...(rOpts.requestSnr && {AZURE_REQUEST_SNR: 1}),
+        ...(rOpts.profanityOption && {AZURE_PROFANITY_OPTION: rOpts.profanityOption}),
+        ...(sttCredentials.use_custom_stt && sttCredentials.custom_stt_endpoint_url &&
+          {AZURE_SERVICE_ENDPOINT: sttCredentials.custom_stt_endpoint_url}),
+        ...(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},
+        ...(azureOptions.speechSegmentationSilenceTimeoutMs &&
+          {AZURE_SPEECH_SEGMENTATION_SILENCE_TIMEOUT_MS: azureOptions.speechSegmentationSilenceTimeoutMs}),
+        ...(sttCredentials && {
+          ...(sttCredentials.api_key && {AZURE_SUBSCRIPTION_KEY: sttCredentials.api_key}),
+          ...(sttCredentials.region && {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.smartFormatting) &&
+          {DEEPGRAM_SPEECH_ENABLE_SMART_FORMAT: 1},
+        ...(deepgramOptions.profanityFilter) &&
+          {DEEPGRAM_SPEECH_PROFANITY_FILTER: 1},
+        ...(deepgramOptions.redact) &&
+          {DEEPGRAM_SPEECH_REDACT: deepgramOptions.redact},
+        ...(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 && rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {DEEPGRAM_SPEECH_KEYWORDS: rOpts.hints.map((h) => h.trim()).join(',')}),
+        ...(rOpts.hints && 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 === false ? 'false' : deepgramOptions.endpointing},
+        ...(deepgramOptions.utteranceEndMs) &&
+          {DEEPGRAM_SPEECH_UTTERANCE_END_MS: deepgramOptions.utteranceEndMs},
+        ...(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;
+      const rivaUri = nvidiaOptions.rivaUri || sttCredentials.riva_server_uri;
+      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}),
+        ...(rivaUri && {NVIDIA_RIVA_URI: 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 ('cobalt' === vendor) {
+      const {cobaltOptions = {}} = rOpts;
+      const cobaltUri = cobaltOptions.serverUri || sttCredentials.cobalt_server_uri;
+      opts = {
+        ...opts,
+        ...(rOpts.words && {COBALT_WORD_TIME_OFFSETS: 1}),
+        ...(!rOpts.words && {COBALT_WORD_TIME_OFFSETS: 0}),
+        ...(rOpts.model && {COBALT_MODEL: rOpts.model}),
+        ...(cobaltUri && {COBALT_SERVER_URI: cobaltUri}),
+        ...(rOpts.hints?.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {COBALT_SPEECH_HINTS: rOpts.hints.join(',')}),
+        ...(rOpts.hints?.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {COBALT_SPEECH_HINTS: JSON.stringify(rOpts.hints)}),
+        ...(rOpts.hints?.length > 0 &&
+          {COBALT_CONTEXT_TOKEN: cobaltOptions.contextToken || 'unk:default'}),
+        ...(cobaltOptions.metadata && {COBALT_METADATA: cobaltOptions.metadata}),
+        ...(cobaltOptions.enableConfusionNetwork && {COBALT_ENABLE_CONFUSION_NETWORK: 1}),
+        ...(cobaltOptions.compiledContextData && {COBALT_COMPILED_CONTEXT_DATA: cobaltOptions.compiledContextData}),
+      };
+    } else if ('assemblyai' === vendor) {
+      opts = {
+        ...opts,
+        ...(sttCredentials.api_key) &&
+          {ASSEMBLYAI_API_KEY: sttCredentials.api_key},
+        ...(rOpts.hints?.length > 0 &&
+          {ASSEMBLYAI_WORD_BOOST: JSON.stringify(rOpts.hints)})
+      };
+    }
+    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,
+        ...(auth_token && {JAMBONZ_STT_API_KEY: auth_token}),
+        JAMBONZ_STT_URL: custom_stt_url,
+        ...(Object.keys(options).length > 0 && {JAMBONZ_STT_OPTIONS: JSON.stringify(options)}),
+      };
+    }
+
+    (stickyVars[vendor] || []).forEach((key) => {
+      if (!opts[key]) opts[key] = '';
+    });
+    return opts;
+  };
+
+  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 === 'cobalt') {
+      const {serverUri} = recognizer.cobaltOptions || {};
+      if (serverUri) return {cobalt_server_uri: serverUri};
+    }
+    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,
+    setSpeechCredentialsAtRuntime,
+    compileSonioxTranscripts,
+    consolidateTranscripts
+  };
 };

lib/utils/ws-requestor.js

@@ -4,9 +4,14 @@ const short = require('short-uuid');
 const {HookMsgTypes} = require('./constants.json');
 const Websocket = require('ws');
 const snakeCaseKeys = require('./snakecase-keys');
-const HttpRequestor = require('./http-requestor');
-const MAX_RECONNECTS = 5;
-const RESPONSE_TIMEOUT_MS = process.env.JAMBONES_WS_API_MSG_RESPONSE_TIMEOUT || 5000;
+const {
+  RESPONSE_TIMEOUT_MS,
+  JAMBONES_WS_PING_INTERVAL_MS,
+  MAX_RECONNECTS,
+  JAMBONES_WS_HANDSHAKE_TIMEOUT_MS,
+  JAMBONES_WS_MAX_PAYLOAD,
+  HTTP_USER_AGENT_HEADER
+} = require('../config');
 
 class WsRequestor extends BaseRequestor {
   constructor(logger, account_sid, hook, secret) {
@@ -39,13 +44,14 @@ class WsRequestor extends BaseRequestor {
   async request(type, hook, params, httpHeaders = {}) {
     assert(HookMsgTypes.includes(type));
     const url = hook.url || hook;
+    const wantsAck = !['call:status', 'verb:status', 'jambonz:error'].includes(type);
 
     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 we closed the socket`);
+      this.logger.debug(`WsRequestor:request - discarding ${type} because socket was closed gracefully`);
       return;
     }
 
@@ -53,8 +59,14 @@ class WsRequestor extends BaseRequestor {
 
     /* 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 requestor = new HttpRequestor(this.logger, this.account_sid, hook, this.secret);
+      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);
     }
 
@@ -63,13 +75,21 @@ class WsRequestor extends BaseRequestor {
       if (this.connectInProgress) {
         this.logger.debug(
           `WsRequestor:request(${this.id}) - queueing ${type} message since we are connecting`);
-        this.queuedMsg.push({type, hook, params, httpHeaders});
+        if (wantsAck) {
+          const p = new Promise((resolve, reject) => {
+            this.queuedMsg.push({type, hook, params, httpHeaders, promise: {resolve, reject}});
+          });
+          return p;
+        }
+        else {
+          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`);
+      this.logger.debug(`WsRequestor:request(${this.id}) - connecting since we do not have a connection for ${type}`);
       if (this.connections >= MAX_RECONNECTS) {
-        throw new Error(`max attempts connecting to ${this.url}`);
+        return Promise.reject(`max attempts connecting to ${this.url}`);
       }
       try {
         const startAt = process.hrtime();
@@ -79,7 +99,7 @@ class WsRequestor extends BaseRequestor {
       } catch (err) {
         this.logger.info({url, err}, 'WsRequestor:request - failed connecting');
         this.connectInProgress = false;
-        throw err;
+        return Promise.reject(err);
       }
     }
     assert(this.ws);
@@ -91,6 +111,9 @@ class WsRequestor extends BaseRequestor {
     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,
@@ -103,9 +126,14 @@ class WsRequestor extends BaseRequestor {
 
     const sendQueuedMsgs = () => {
       if (this.queuedMsg.length > 0) {
-        for (const {type, hook, params, httpHeaders} of this.queuedMsg) {
+        for (const {type, hook, params, httpHeaders, promise} of this.queuedMsg) {
           this.logger.debug(`WsRequestor:request - preparing queued ${type} for sending`);
-          setImmediate(this.request.bind(this, type, hook, params, httpHeaders));
+          if (promise) {
+            this.request(type, hook, params, httpHeaders)
+              .then((res) => promise.resolve(res))
+              .catch((err) => promise.reject(err));
+          }
+          else setImmediate(this.request.bind(this, type, hook, params, httpHeaders));
         }
         this.queuedMsg.length = 0;
       }
@@ -113,9 +141,19 @@ class WsRequestor extends BaseRequestor {
 
     //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', 'jambonz:error', 'session:reconnect'].includes(type)) {
-      this.ws.send(JSON.stringify(obj), () => {
+    if (!wantsAck || reconnectingWithoutAck) {
+      this.ws?.send(JSON.stringify(obj), () => {
         this.logger.debug({obj}, `WsRequestor:request websocket: sent (${url})`);
         sendQueuedMsgs();
       });
@@ -126,7 +164,7 @@ class WsRequestor extends BaseRequestor {
     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);
+        const {failure} = this.messagesInFlight.get(msgid) || {};
         failure && failure(`timeout from far end for msgid ${msgid}`);
         this.messagesInFlight.delete(msgid);
       }, RESPONSE_TIMEOUT_MS);
@@ -156,22 +194,24 @@ class WsRequestor extends BaseRequestor {
     });
   }
 
+  _stopPingTimer() {
+    if (this._pingTimer) {
+      clearInterval(this._pingTimer);
+      this._pingTimer = null;
+    }
+  }
+
   close() {
     this.closedGracefully = true;
     this.logger.debug('WsRequestor:close closing socket');
+    this._stopPingTimer();
     try {
       if (this.ws) {
-        this.ws.close();
+        this.ws.close(1000);
         this.ws.removeAllListeners();
+        this.ws = null;
       }
-
-      for (const [msgid, obj] of this.messagesInFlight) {
-        const {timer} = obj;
-        clearTimeout(timer);
-        obj.failure(`abandoning msgid ${msgid} since we have closed the socket`);
-      }
-      this.messagesInFlight.clear();
-
+      this._clearPendingMessages();
     } catch (err) {
       this.logger.info({err}, 'WsRequestor: Error closing socket');
     }
@@ -179,15 +219,19 @@ class WsRequestor extends BaseRequestor {
 
   _connect() {
     assert(!this.ws);
+    this._stopPingTimer();
     return new Promise((resolve, reject) => {
-      const handshakeTimeout = process.env.JAMBONES_WS_HANDSHAKE_TIMEOUT_MS ?
-        parseInt(process.env.JAMBONES_WS_HANDSHAKE_TIMEOUT_MS) :
+      const handshakeTimeout = JAMBONES_WS_HANDSHAKE_TIMEOUT_MS ?
+        parseInt(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,
+        maxPayload: JAMBONES_WS_MAX_PAYLOAD ? parseInt(JAMBONES_WS_MAX_PAYLOAD) : 24 * 1024,
+        headers: {
+          ...(HTTP_USER_AGENT_HEADER && {'user-agent' : HTTP_USER_AGENT_HEADER})
+        }
       };
       if (this.username && this.password) opts = {...opts, auth: `${this.username}:${this.password}`};
 
@@ -207,7 +251,6 @@ class WsRequestor extends BaseRequestor {
   }
 
   _setHandlers(ws) {
-    this.logger.debug('WsRequestor:_setHandlers');
     ws
       .once('open', this._onOpen.bind(this, ws))
       .once('close', this._onClose.bind(this))
@@ -216,6 +259,15 @@ class WsRequestor extends BaseRequestor {
       .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');
@@ -231,10 +283,15 @@ class WsRequestor extends BaseRequestor {
     this.connectInProgress = false;
     this.connections++;
     this.emit('ready', ws);
+
+    if (JAMBONES_WS_PING_INTERVAL_MS > 15000) {
+      this._pingTimer = setInterval(() => this.ws?.ping(), JAMBONES_WS_PING_INTERVAL_MS);
+    }
   }
 
   _onClose(code) {
     this.logger.info(`WsRequestor(${this.id}) - closed from far end ${code}`);
+    this._stopPingTimer();
     if (this.connections > 0 && code !== 1000) {
       this.logger.info({url: this.url}, 'WsRequestor - socket closed unexpectedly from remote side');
       this.emit('socket-closed');
@@ -253,12 +310,15 @@ class WsRequestor extends BaseRequestor {
     }, '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');
+    this._stopPingTimer();
     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(
@@ -310,12 +370,13 @@ class WsRequestor extends BaseRequestor {
   }
 
   _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.logger.debug({url: this.url}, `WsRequestor:_recvAck - received response to ${msgid}`);
     this.messagesInFlight.delete(msgid);
     const {success} = obj;
     success && success(data);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "v0.7.7",
+  "version": "0.8.5",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -19,52 +19,60 @@
   "bugs": {},
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test JAMBONES_HOSTING=1 HTTP_POOL=1 DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 DRACHTIO_SECRET=cymru JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=127.0.0.1 JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=error ENABLE_METRICS=0 HTTP_PORT=3000 JAMBONES_SBCS=172.38.0.10 JAMBONES_FREESWITCH=127.0.0.1:8022:ClueCon:docker-host JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_NETWORK_CIDR=172.38.0.0/16 node test/ ",
+    "test": "NODE_ENV=test JAMBONES_HOSTING=1 HTTP_POOL=1 JAMBONES_TTS_TRIM_SILENCE=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"
+    "jslint": "eslint app.js tracer.js lib",
+    "jslint:fix": "eslint app.js tracer.js lib --fix"
   },
   "dependencies": {
+    "@aws-sdk/client-auto-scaling": "^3.360.0",
+    "@aws-sdk/client-sns": "^3.360.0",
+    "@jambonz/db-helpers": "^0.9.1",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/db-helpers": "^0.6.19",
-    "@jambonz/realtimedb-helpers": "^0.4.35",
-    "@jambonz/stats-collector": "^0.1.6",
-    "@jambonz/time-series": "^0.2.5",
-    "@opentelemetry/api": "^1.1.0",
-    "@opentelemetry/exporter-jaeger": "^1.3.1",
-    "@opentelemetry/exporter-trace-otlp-http": "^0.27.0",
-    "@opentelemetry/exporter-zipkin": "^1.3.1",
-    "@opentelemetry/instrumentation": "^0.27.0",
-    "@opentelemetry/resources": "^1.3.1",
-    "@opentelemetry/sdk-trace-base": "^1.3.1",
-    "@opentelemetry/sdk-trace-node": "^1.3.1",
-    "@opentelemetry/semantic-conventions": "^1.3.1",
-    "aws-sdk": "^2.1152.0",
+    "@jambonz/mw-registrar": "^0.2.4",
+    "@jambonz/realtimedb-helpers": "^0.8.7",
+    "@jambonz/speech-utils": "^0.0.33",
+    "@jambonz/stats-collector": "^0.1.9",
+    "@jambonz/time-series": "^0.2.8",
+    "@jambonz/verb-specifications": "^0.0.50",
+    "@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",
     "bent": "^7.3.12",
     "debug": "^4.3.4",
     "deepcopy": "^2.1.0",
-    "drachtio-fsmrf": "^3.0.3",
-    "drachtio-srf": "^4.5.1",
-    "express": "^4.18.1",
-    "helmet": "^5.1.0",
+    "drachtio-fsmrf": "^3.0.33",
+    "drachtio-srf": "^4.5.31",
+    "express": "^4.18.2",
+    "express-validator": "^7.0.1",
     "ip": "^1.1.8",
     "moment": "^2.29.4",
     "parse-url": "^8.1.0",
-    "pino": "^6.14.0",
+    "pino": "^8.8.0",
+    "polly-ssml-split": "^0.1.0",
+    "proxyquire": "^2.1.3",
     "sdp-transform": "^2.14.1",
-    "short-uuid": "^4.2.0",
+    "short-uuid": "^4.2.2",
+    "sinon": "^15.0.1",
     "to-snake-case": "^1.0.0",
-    "undici": "^5.8.2",
-    "uuid": "^8.3.2",
+    "undici": "^5.26.2",
+    "uuid-random": "^1.3.2",
     "verify-aws-sns-signature": "^0.1.0",
-    "ws": "^8.8.0",
-    "xml2js": "^0.4.23"
+    "ws": "^8.9.0",
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "clear-module": "^4.1.2",
     "eslint": "^7.32.0",
     "eslint-plugin-promise": "^4.3.1",
     "nyc": "^15.1.0",
-    "tape": "^5.5.3"
+    "tape": "^5.6.1"
   },
   "optionalDependencies": {
     "bufferutil": "^4.0.6",

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
+      }
+    ];
+
+    await 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
+      }
+    ];
+
+    await 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/configuration/squid.conf

@@ -0,0 +1,86 @@
+#
+# Recommended minimum configuration:
+#
+
+# Example rule allowing access from your local networks.
+# Adapt to list your (internal) IP networks from where browsing
+# should be allowed
+acl localnet src 0.0.0.1-0.255.255.255	# RFC 1122 "this" network (LAN)
+acl localnet src 10.0.0.0/8		# RFC 1918 local private network (LAN)
+acl localnet src 100.64.0.0/10		# RFC 6598 shared address space (CGN)
+acl localnet src 169.254.0.0/16 	# RFC 3927 link-local (directly plugged) machines
+acl localnet src 172.16.0.0/12		# RFC 1918 local private network (LAN)
+acl localnet src 172.38.0.0/12		# RFC 1918 local private network (LAN)
+acl localnet src 192.168.0.0/16		# RFC 1918 local private network (LAN)
+acl localnet src fc00::/7       	# RFC 4193 local private network range
+acl localnet src fe80::/10      	# RFC 4291 link-local (directly plugged) machines
+
+acl SSL_ports port 443
+acl Safe_ports port 80		# http
+acl Safe_ports port 21		# ftp
+acl Safe_ports port 443		# https
+acl Safe_ports port 70		# gopher
+acl Safe_ports port 210		# wais
+acl Safe_ports port 1025-65535	# unregistered ports
+acl Safe_ports port 280		# http-mgmt
+acl Safe_ports port 488		# gss-http
+acl Safe_ports port 591		# filemaker
+acl Safe_ports port 777		# multiling http
+
+#
+# Recommended minimum Access Permission configuration:
+#
+# Deny requests to certain unsafe ports
+http_access allow !Safe_ports
+
+# Deny CONNECT to other than secure SSL ports
+http_access allow CONNECT !SSL_ports
+
+# Only allow cachemgr access from localhost
+http_access allow localhost manager
+http_access allow manager
+
+# This default configuration only allows localhost requests because a more
+# permissive Squid installation could introduce new attack vectors into the
+# network by proxying external TCP connections to unprotected services.
+http_access allow localhost
+
+# The two deny rules below are unnecessary in this default configuration
+# because they are followed by a "deny all" rule. However, they may become
+# critically important when you start allowing external requests below them.
+
+# Protect web applications running on the same server as Squid. They often
+# assume that only local users can access them at "localhost" ports.
+http_access allow to_localhost
+
+# Protect cloud servers that provide local users with sensitive info about
+# their server via certain well-known link-local (a.k.a. APIPA) addresses.
+# http_access deny to_linklocal
+
+#
+# INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
+#
+
+# For example, to allow access from your local networks, you may uncomment the
+# following rule (and/or add rules that match your definition of "local"):
+# http_access allow localnet
+
+# And finally deny all other access to this proxy
+http_access allow all
+
+# Squid normally listens to port 3128
+http_port 3128
+
+# Uncomment and adjust the following to add a disk cache directory.
+#cache_dir ufs /usr/local/var/cache/squid 100 16 256
+
+# Leave coredumps in the first cache dir
+coredump_dir /usr/local/var/cache/squid
+
+#
+# Add any of your own refresh_pattern entries above these.
+#
+refresh_pattern ^ftp:		1440	20%	10080
+refresh_pattern ^gopher:	1440	0%	1440
+refresh_pattern -i (/cgi-bin/|\?) 0	0%	0
+refresh_pattern .		0	20%	4320

test/create-call-test.js

@@ -37,7 +37,7 @@ test('test create-call timeout', async(t) => {
       'account_sid':account_sid,
       'timeout': 1,
       "call_hook": {
-        "url": "https://public-apps.jambonz.us/hello-world",
+        "url": "https://public-apps.jambonz.cloud/hello-world",
         "method": "POST"
       },
       "from": "15083718299",
@@ -88,17 +88,133 @@ test('test create-call call-hook basic authentication', async(t) => {
 
     let verbs = [
       {
-        "verb": "say",
-        "text": "hello"
+        "verb": "pause",
+        "length": 1
       }
     ];
-    provisionCallHook(from, verbs);
+    await 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');
+    t.ok(obj.headers['user-agent'] = 'jambonz',
+    'create-call: call-hook contains user-agent header');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('test create-call amd', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+
+    // GIVEN
+    let from = 'create-call-amd';
+    let account_sid = 'bb845d4b-83a9-4cde-a6e9-50f3743bab3f';
+
+    // 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"
+      },
+      "amd": {
+        "actionHook": "/actionHook"
+      },
+      "speech_recognizer_vendor": "google",
+      "speech_recognizer_language": "en"
+    });
+
+    let verbs = [
+      {
+        "verb": "pause",
+        "length": 7
+      }
+    ];
+    await provisionCallHook(from, verbs);
+    //THEN
+    await p;
+
+    let obj = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_actionHook`)
+    t.ok(obj.body.type = 'amd_no_speech_detected',
+      'create-call: AMD detected');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('test create-call app_json', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+
+    // GIVEN
+    let from = 'create-call-app-json';
+    let account_sid = 'bb845d4b-83a9-4cde-a6e9-50f3743bab3f';
+
+    // Give UAS app time to come up
+    const p = sippUac('uas.xml', '172.38.0.10', from);
+    await waitFor(1000);
+
+    const app_json = `[
+      {
+        "verb": "pause",
+        "length": 7
+      }
+    ]`;
+
+    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"
+      },
+      app_json,
+      "from": from,
+      "to": {
+        "type": "phone",
+        "number": "15583084809"
+      },
+      "amd": {
+        "actionHook": "/actionHook"
+      },
+      "speech_recognizer_vendor": "google",
+      "speech_recognizer_language": "en"
+    });
+
+    //THEN
+    await p;
+
     disconnect();
   } catch (err) {
     console.log(`error received: ${err}`);

test/create-test-db.js

@@ -2,6 +2,14 @@ const test = require('tape') ;
 const exec = require('child_process').exec ;
 const fs = require('fs');
 const {encrypt} = require('../lib/utils/encrypt-decrypt');
+const {
+  GCP_JSON_KEY,
+  AWS_ACCESS_KEY_ID,
+  AWS_SECRET_ACCESS_KEY,
+  AWS_REGION,
+  MICROSOFT_REGION,
+  MICROSOFT_API_KEY,
+} = require('../lib/config');
 
 test('creating jambones_test database', (t) => {
   exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360 < ${__dirname}/db/create_test_db.sql`, (err, stdout, stderr) => {
@@ -18,24 +26,38 @@ test('creating schema', (t) => {
     if (err) return t.end(err);
     t.pass('schema and test data successfully created');
 
-    if (process.env.GCP_JSON_KEY && process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY) {
-      const google_credential = encrypt(process.env.GCP_JSON_KEY);
+    const sql = [];
+    if (GCP_JSON_KEY) {
+      const google_credential = encrypt(GCP_JSON_KEY);
+      t.pass('adding google credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${google_credential}' WHERE vendor='google';`);
+    }
+    if (AWS_ACCESS_KEY_ID && 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
+        access_key_id: AWS_ACCESS_KEY_ID,
+        secret_access_key: AWS_SECRET_ACCESS_KEY,
+        aws_region: AWS_REGION
       }));
-      const cmd = `
-UPDATE speech_credentials SET credential='${google_credential}' WHERE vendor='google';
-UPDATE speech_credentials SET credential='${aws_credential}' WHERE vendor='aws';
-`;
+      t.pass('adding aws credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${aws_credential}' WHERE vendor='aws';`);
+    }
+    if (MICROSOFT_REGION && MICROSOFT_API_KEY) {
+      const microsoft_credential = encrypt(JSON.stringify({
+        region: MICROSOFT_REGION,
+        api_key: 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`;
-      fs.writeFileSync(path, cmd);
+      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)
-        fs.writeFileSync(`${__dirname}/credentials/gcp.json`, process.env.GCP_JSON_KEY);
         t.pass('set account-level speech credentials');
         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/jambones-sql.sql

@@ -1,9 +1,10 @@
 /* SQLEditor (MySQL (2))*/
-
 SET FOREIGN_KEY_CHECKS=0;
 
 DROP TABLE IF EXISTS account_static_ips;
 
+DROP TABLE IF EXISTS account_limits;
+
 DROP TABLE IF EXISTS account_products;
 
 DROP TABLE IF EXISTS account_subscriptions;
@@ -12,12 +13,22 @@ DROP TABLE IF EXISTS beta_invite_codes;
 
 DROP TABLE IF EXISTS call_routes;
 
+DROP TABLE IF EXISTS clients;
+
 DROP TABLE IF EXISTS dns_records;
 
+DROP TABLE IF EXISTS lcr;
+
 DROP TABLE IF EXISTS lcr_carrier_set_entry;
 
 DROP TABLE IF EXISTS lcr_routes;
 
+DROP TABLE IF EXISTS password_settings;
+
+DROP TABLE IF EXISTS user_permissions;
+
+DROP TABLE IF EXISTS permissions;
+
 DROP TABLE IF EXISTS predefined_sip_gateways;
 
 DROP TABLE IF EXISTS predefined_smpp_gateways;
@@ -36,12 +47,16 @@ 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 system_information;
+
 DROP TABLE IF EXISTS users;
 
 DROP TABLE IF EXISTS smpp_gateways;
@@ -69,6 +84,15 @@ private_ipv4 VARBINARY(16) NOT NULL UNIQUE ,
 PRIMARY KEY (account_static_ip_sid)
 );
 
+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 TABLE account_subscriptions
 (
 account_subscription_sid CHAR(36) NOT NULL UNIQUE ,
@@ -105,6 +129,16 @@ application_sid CHAR(36) NOT NULL,
 PRIMARY KEY (call_route_sid)
 ) COMMENT='a regex-based pattern match for call routing';
 
+CREATE TABLE clients
+(
+client_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+is_active BOOLEAN NOT NULL DEFAULT 1,
+username VARCHAR(64),
+password VARCHAR(1024),
+PRIMARY KEY (client_sid)
+);
+
 CREATE TABLE dns_records
 (
 dns_record_sid CHAR(36) NOT NULL UNIQUE ,
@@ -117,11 +151,38 @@ PRIMARY KEY (dns_record_sid)
 CREATE TABLE lcr_routes
 (
 lcr_route_sid CHAR(36),
+lcr_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),
-priority INTEGER NOT NULL UNIQUE  COMMENT 'lower priority routes are attempted first',
+priority INTEGER NOT NULL COMMENT 'lower priority routes are attempted first',
 PRIMARY KEY (lcr_route_sid)
-) COMMENT='Least cost routing table';
+) COMMENT='An ordered list of  digit patterns in an LCR table.  The patterns are tested in sequence until one matches';
+
+CREATE TABLE lcr
+(
+lcr_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) COMMENT 'User-assigned name for this LCR table',
+is_active BOOLEAN NOT NULL DEFAULT 1,
+default_carrier_set_entry_sid CHAR(36) COMMENT 'default carrier/route to use when no digit match based results are found.',
+service_provider_sid CHAR(36),
+account_sid CHAR(36),
+PRIMARY KEY (lcr_sid)
+) COMMENT='An LCR (least cost routing) table that is used by a service provider or account to make decisions about routing outbound calls when multiple carriers are available.';
+
+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
+);
+
+CREATE TABLE permissions
+(
+permission_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(32) NOT NULL UNIQUE ,
+description VARCHAR(255),
+PRIMARY KEY (permission_sid)
+);
 
 CREATE TABLE predefined_carriers
 (
@@ -214,7 +275,10 @@ CREATE TABLE sbc_addresses
 sbc_address_sid CHAR(36) NOT NULL UNIQUE ,
 ipv4 VARCHAR(255) NOT NULL,
 port INTEGER NOT NULL DEFAULT 5060,
+tls_port INTEGER,
+wss_port INTEGER,
 service_provider_sid CHAR(36),
+last_updated DATETIME,
 PRIMARY KEY (sbc_address_sid)
 );
 
@@ -228,6 +292,15 @@ tenant_fqdn VARCHAR(255) NOT NULL UNIQUE ,
 PRIMARY KEY (ms_teams_tenant_sid)
 ) COMMENT='A Microsoft Teams customer tenant';
 
+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)
+);
+
 CREATE TABLE signup_history
 (
 email VARCHAR(255) NOT NULL,
@@ -261,9 +334,17 @@ last_tested DATETIME,
 tts_tested_ok BOOLEAN,
 stt_tested_ok BOOLEAN,
 created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+label VARCHAR(64),
 PRIMARY KEY (speech_credential_sid)
 );
 
+CREATE TABLE system_information
+(
+domain_name VARCHAR(255),
+sip_domain_name VARCHAR(255),
+monitoring_domain_name VARCHAR(255)
+);
+
 CREATE TABLE users
 (
 user_sid CHAR(36) NOT NULL UNIQUE ,
@@ -283,6 +364,7 @@ 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)
 );
 
@@ -310,9 +392,21 @@ 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,
+register_status VARCHAR(4096),
 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 ,
@@ -330,7 +424,7 @@ PRIMARY KEY (smpp_gateway_sid)
 CREATE TABLE phone_numbers
 (
 phone_number_sid CHAR(36) UNIQUE ,
-number VARCHAR(32) NOT NULL UNIQUE ,
+number VARCHAR(132) NOT NULL,
 voip_carrier_sid CHAR(36),
 account_sid CHAR(36),
 application_sid CHAR(36),
@@ -348,6 +442,7 @@ inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound ca
 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,
+protocol ENUM('udp','tcp','tls', 'tls/srtp') DEFAULT 'udp' COMMENT 'Outbound call protocol',
 PRIMARY KEY (sip_gateway_sid)
 ) COMMENT='A whitelisted sip gateway used for origination/termination';
 
@@ -380,12 +475,16 @@ account_sid CHAR(36) COMMENT 'account that this application belongs to (if null,
 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 TEXT,
 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_synthesis_label VARCHAR(64),
 speech_recognizer_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
 speech_recognizer_language VARCHAR(64) NOT NULL DEFAULT 'en-US',
+speech_recognizer_label VARCHAR(64),
 created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+record_all_calls BOOLEAN NOT NULL DEFAULT false,
 PRIMARY KEY (application_sid)
 ) COMMENT='A defined set of behaviors to be applied to phone calls ';
 
@@ -418,6 +517,14 @@ 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),
+record_all_calls BOOLEAN NOT NULL DEFAULT false,
+record_format VARCHAR(16) NOT NULL DEFAULT 'mp3',
+bucket_credential VARCHAR(8192) COMMENT 'credential used to authenticate with storage service',
 PRIMARY KEY (account_sid)
 ) COMMENT='An enterprise that uses the platform for comm services';
 
@@ -425,19 +532,34 @@ CREATE INDEX account_static_ip_sid_idx ON account_static_ips (account_static_ip_
 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_1 (account_sid) REFERENCES accounts (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_2 (account_sid) REFERENCES accounts (account_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_3 (account_sid) REFERENCES accounts (account_sid);
+CREATE INDEX client_sid_idx ON clients (client_sid);
+ALTER TABLE clients ADD CONSTRAINT account_sid_idxfk_13 FOREIGN KEY account_sid_idxfk_13 (account_sid) REFERENCES accounts (account_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 lcr_sid_idx ON lcr_routes (lcr_sid);
+ALTER TABLE lcr_routes ADD FOREIGN KEY lcr_sid_idxfk (lcr_sid) REFERENCES lcr (lcr_sid);
+
+CREATE INDEX lcr_sid_idx ON lcr (lcr_sid);
+ALTER TABLE lcr ADD FOREIGN KEY default_carrier_set_entry_sid_idxfk (default_carrier_set_entry_sid) REFERENCES lcr_carrier_set_entry (lcr_carrier_set_entry_sid);
+
+CREATE INDEX service_provider_sid_idx ON lcr (service_provider_sid);
+CREATE INDEX account_sid_idx ON lcr (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);
@@ -456,14 +578,14 @@ ALTER TABLE account_products ADD FOREIGN KEY product_sid_idxfk (product_sid) REF
 
 CREATE INDEX account_offer_sid_idx ON account_offers (account_offer_sid);
 CREATE INDEX account_sid_idx ON account_offers (account_sid);
-ALTER TABLE account_offers ADD FOREIGN KEY account_sid_idxfk_4 (account_sid) REFERENCES accounts (account_sid);
+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_5 (account_sid) REFERENCES accounts (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);
@@ -477,59 +599,68 @@ ALTER TABLE sbc_addresses ADD FOREIGN KEY service_provider_sid_idxfk_1 (service_
 CREATE INDEX ms_teams_tenant_sid_idx ON ms_teams_tenants (ms_teams_tenant_sid);
 ALTER TABLE ms_teams_tenants ADD FOREIGN KEY service_provider_sid_idxfk_2 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
-ALTER TABLE ms_teams_tenants ADD FOREIGN KEY account_sid_idxfk_6 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY 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_3 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
-
-CREATE UNIQUE INDEX speech_credentials_idx_1 ON speech_credentials (vendor,account_sid);
+ALTER TABLE smpp_addresses ADD FOREIGN KEY service_provider_sid_idxfk_4 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
 CREATE INDEX speech_credential_sid_idx ON speech_credentials (speech_credential_sid);
 CREATE INDEX service_provider_sid_idx ON speech_credentials (service_provider_sid);
-ALTER TABLE speech_credentials ADD FOREIGN KEY service_provider_sid_idxfk_4 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+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_7 (account_sid) REFERENCES accounts (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_8 (account_sid) REFERENCES accounts (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_5 (service_provider_sid) REFERENCES service_providers (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_9 (account_sid) REFERENCES accounts (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_6 (service_provider_sid) REFERENCES service_providers (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 UNIQUE INDEX phone_numbers_unique_idx_voip_carrier_number ON phone_numbers (number,voip_carrier_sid);
+
 CREATE INDEX phone_number_sid_idx ON phone_numbers (phone_number_sid);
 CREATE INDEX number_idx ON phone_numbers (number);
 CREATE INDEX voip_carrier_sid_idx ON phone_numbers (voip_carrier_sid);
 ALTER TABLE phone_numbers ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
 
-ALTER TABLE phone_numbers ADD FOREIGN KEY account_sid_idxfk_10 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE phone_numbers ADD FOREIGN KEY 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_7 (service_provider_sid) REFERENCES service_providers (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);
 
@@ -545,10 +676,10 @@ CREATE UNIQUE INDEX applications_idx_name ON applications (account_sid,name);
 
 CREATE INDEX application_sid_idx ON applications (application_sid);
 CREATE INDEX service_provider_sid_idx ON applications (service_provider_sid);
-ALTER TABLE applications ADD FOREIGN KEY service_provider_sid_idxfk_8 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+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_11 (account_sid) REFERENCES accounts (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);
 
@@ -564,7 +695,7 @@ ALTER TABLE service_providers ADD FOREIGN KEY registration_hook_sid_idxfk (regis
 CREATE INDEX account_sid_idx ON accounts (account_sid);
 CREATE INDEX sip_realm_idx ON accounts (sip_realm);
 CREATE INDEX service_provider_sid_idx ON accounts (service_provider_sid);
-ALTER TABLE accounts ADD FOREIGN KEY service_provider_sid_idxfk_9 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+ALTER TABLE accounts ADD FOREIGN KEY 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);
 
@@ -572,4 +703,5 @@ ALTER TABLE accounts ADD FOREIGN KEY queue_event_hook_sid_idxfk (queue_event_hoo
 
 ALTER TABLE accounts ADD FOREIGN KEY device_calling_application_sid_idxfk (device_calling_application_sid) REFERENCES applications (application_sid);
 
-SET FOREIGN_KEY_CHECKS=0;
+ALTER TABLE accounts ADD FOREIGN KEY siprec_hook_sid_idxfk (siprec_hook_sid) REFERENCES applications (application_sid);
+SET FOREIGN_KEY_CHECKS=1;

test/dial-tests.js

@@ -0,0 +1,217 @@
+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')
+
+const sleepFor = (ms) => new Promise((r) => setTimeout(r, 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('\'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,
+        "callerName": "test_callerName",
+        "actionHook": "/actionHook",
+        "timeLimit": 5,
+        "target": [
+            {
+                "type": "phone",
+                "number": "15083084809"
+            }
+        ]
+      }
+    ];
+
+    await provisionCallHook(from, verbs);
+
+    // THEN
+    const p = sippUac('uas-dial.xml', '172.38.0.10', undefined, undefined, 2);
+    await sleepFor(1000);
+
+    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,
+      "callerName": "Tom",
+      "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 sleepFor(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"
+              }
+          ]
+        }
+      ];
+  
+      await 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"
+              }
+          ]
+        }
+      ];
+  
+      await 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

@@ -42,9 +42,9 @@ services:
         ipv4_address: 172.38.0.7
 
   drachtio:
-    image: drachtio/drachtio-server:latest
+    image: drachtio/drachtio-server:0.8.24
     restart: always
-    command: drachtio --contact "sip:*;transport=udp,tcp" --address 0.0.0.0 --port 9022
+    command: drachtio --contact "sip:*;transport=udp" --mtu 4096 --address 0.0.0.0 --port 9022
     ports:
       - "9060:9022/tcp"
     networks:
@@ -57,7 +57,7 @@ services:
         condition: service_healthy
 
   freeswitch:
-    image: drachtio/drachtio-freeswitch-mrf:v1.10.1-full
+    image: drachtio/drachtio-freeswitch-mrf:0.6.1
     restart: always
     command: freeswitch --rtp-range-start 20000 --rtp-range-end 20100
     environment:
@@ -68,7 +68,7 @@ services:
       - /tmp:/tmp
       - ./credentials:/opt/credentials
     healthcheck:
-      test: ['CMD', 'fs_cli' ,'-x', '"sofia status"']
+      test: ['CMD', 'fs_cli' ,'-p', 'JambonzR0ck$$', '-x', '"sofia status"']
       timeout: 5s
       retries: 15
     networks:
@@ -92,3 +92,13 @@ services:
     networks:
       fs:
         ipv4_address: 172.38.0.90
+
+  squid:
+    image: ubuntu/squid:edge
+    ports:
+      - "3128:3128"
+    volumes:
+      - ./configuration/squid.conf:/etc/squid/squid.conf
+    networks:
+      fs:
+        ipv4_address: 172.38.0.91

test/gather-tests.js

@@ -4,6 +4,15 @@ const bent = require('bent');
 const getJSON = bent('json')
 const clearModule = require('clear-module');
 const {provisionCallHook} = require('./utils')
+const {
+  GCP_JSON_KEY,
+  AWS_ACCESS_KEY_ID,
+  AWS_SECRET_ACCESS_KEY,
+  SONIOX_API_KEY,
+  DEEPGRAM_API_KEY,
+  MICROSOFT_REGION,
+  MICROSOFT_API_KEY,
+} = require('../lib/config');
 
 process.on('unhandledRejection', (reason, p) => {
   console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
@@ -17,7 +26,11 @@ function connect(connectable) {
   });
 }
 
-test('\'gather\' and \'transcribe\' tests', async(t) => {
+test('\'gather\' test - google', async(t) => {
+  if (!GCP_JSON_KEY) {
+    t.pass('skipping google tests');
+    return t.end();
+  }
   clearModule.all();
   const {srf, disconnect} = require('../app');
 
@@ -37,12 +50,261 @@ test('\'gather\' and \'transcribe\' tests', async(t) => {
       }
     ];
     let from = "gather_success";
-    provisionCallHook(from, verbs);
+    await 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`);
-    t.ok(obj.body.speech.alternatives[0].transcript = 'I\'d like to speak to customer support',
-      'gather: succeeds when using account credentials');
+    //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 (!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";
+    await 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('\'config\' test - reset to app defaults', async(t) => {
+  if (!GCP_JSON_KEY) {
+    t.pass('skipping config tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "config",
+        "recognizer": {
+          "vendor": "google",
+          "language": "fr-FR"
+        },
+      },
+      {
+        "verb": "config",
+        "reset": ['recognizer'],
+      },
+      {
+        "verb": "gather",
+        "input": ["speech"],
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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',
+      'config: resets recognizer to app defaults');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'gather\' test - microsoft', async(t) => {
+  if (!MICROSOFT_REGION || !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";
+    await 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 (!AWS_ACCESS_KEY_ID || !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";
+    await 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 (!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": DEEPGRAM_API_KEY
+          }
+        },
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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().includes('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 (!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": SONIOX_API_KEY
+          }
+        },
+        "timeout": 10,
+        "actionHook": "/actionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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) {

test/hangup-test.js

@@ -0,0 +1,53 @@
+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('\'hangup\' custom headers', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'play',
+        url: 'https://example.com/example.mp3'
+      },
+      {
+        "verb": "hangup",
+        "headers": {
+          "X-Reason" : "maximum call duration exceeded"
+        }
+      }
+    ];
+
+    const from = 'hangup_custom_headers';
+    await 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/http-proxy-test.js

@@ -0,0 +1,72 @@
+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('\'HTTP proxy\' test Info', async(t) => {
+  clearModule.all();
+  process.env.JAMBONES_HTTP_PROXY_IP = "127.0.0.1";
+  process.env.JAMBONES_HTTP_PROXY_PROTOCOL = "http";
+  process.env.JAMBONES_HTTP_PROXY_PORT = 3128;
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'config',
+        sipRequestWithinDialogHook: '/customHook'
+      },
+      {
+        verb: 'play',
+        url: 'silence_stream://5000',
+      }
+    ];
+
+    const waitHookVerbs = [
+      {
+        verb: 'hangup'
+      }
+    ];
+
+    const from = 'http_proxy_info';
+    await provisionCustomHook(from, waitHookVerbs)
+    await provisionCallHook(from, verbs);
+    
+
+    // THEN
+    await sippUac('uac-success-info-received-bye.xml', '172.38.0.10', from, "16174000015");
+    t.pass('sip Info: success send Info');
+
+    // Make sure that sipRequestWithinDialogHook is called and success
+    const json = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_customHook`)
+    t.pass(json.body.sip_method === 'INFO', 'sipRequestWithinDialogHook contains sip_method')
+    t.pass(json.body.sip_body === 'hello jambonz\r\n', 'sipRequestWithinDialogHook contains sip_method')
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  } finally {
+    process.env.JAMBONES_HTTP_PROXY_IP = null;
+    process.env.JAMBONES_HTTP_PROXY_PROTOCOL = null;
+    process.env.JAMBONES_HTTP_PROXY_PORT = null;
+  }
+});

test/in-dialog-test.js

@@ -0,0 +1,65 @@
+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('\'sip Indialog\' test Info', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'config',
+        sipRequestWithinDialogHook: '/customHook'
+      },
+      {
+        verb: 'play',
+        url: 'silence_stream://5000',
+      }
+    ];
+
+    const waitHookVerbs = [
+      {
+        verb: 'hangup'
+      }
+    ];
+
+    const from = 'sip_indialog_info';
+    await provisionCustomHook(from, waitHookVerbs)
+    await provisionCallHook(from, verbs);
+    
+
+    // THEN
+    await sippUac('uac-success-info-received-bye.xml', '172.38.0.10', from);
+    t.pass('sip Info: success send Info');
+
+    // Make sure that sipRequestWithinDialogHook is called and success
+    const json = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_customHook`)
+    t.pass(json.body.sip_method === 'INFO', 'sipRequestWithinDialogHook contains sip_method')
+    t.pass(json.body.sip_body === 'hello jambonz\r\n', 'sipRequestWithinDialogHook contains sip_method')
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/index.js

@@ -1,12 +1,23 @@
+require('./ws-requestor-unit-test');
 require('./unit-tests');
 require('./docker_start');
 require('./create-test-db');
 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('./queue-test');
+require('./in-dialog-test');
+require('./hangup-test');
+require('./sdp-utils-test');
+require('./http-proxy-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,
+      }
+    ];
+
+    await 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.skip('\'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" : "stereo",
+        "timeout": 2,
+        "maxLength": 2
+      }
+    ];
+
+    await 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"
+      }
+    ];
+
+    await 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

@@ -33,7 +33,7 @@ test('\'play\' tests single link in plain text', async(t) => {
     ];
 
     const from = 'play_single_link';
-    provisionCallHook(from, verbs)
+    await provisionCallHook(from, verbs)
 
     // THEN
     await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
@@ -62,7 +62,7 @@ test('\'play\' tests multi links in array', async(t) => {
     ];
 
     const from = 'play_multi_links_in_array';
-    provisionCallHook(from, verbs)
+    await provisionCallHook(from, verbs)
 
     // THEN
     await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
@@ -100,8 +100,8 @@ test('\'play\' tests single link in conference', async(t) => {
         waitHook: `/customHook`
       }
     ];
-    provisionCustomHook(from, waitHookVerbs)
-    provisionCallHook(from, verbs)
+    await provisionCustomHook(from, waitHookVerbs)
+    await provisionCallHook(from, verbs)
 
     // THEN
     await sippUac('uac-success-send-bye.xml', '172.38.0.10', from);
@@ -141,8 +141,8 @@ test('\'play\' tests multi links in array in conference', async(t) => {
         waitHook: `/customHook`
       }
     ];
-    provisionCustomHook(from, waitHookVerbs)
-    provisionCallHook(from, verbs)
+    await provisionCustomHook(from, waitHookVerbs)
+    await provisionCallHook(from, verbs)
 
     // THEN
     await sippUac('uac-success-send-bye.xml', '172.38.0.10', from);
@@ -178,17 +178,73 @@ test('\'play\' tests with seekOffset and actionHook', async(t) => {
     const waitHookVerbs = [];
 
     const from = 'play_action_hook';
-    provisionCallHook(from, verbs)
-    provisionCustomHook(from, waitHookVerbs)
+    await provisionCallHook(from, verbs)
+    await 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`)
-    t.ok(obj.body.reason === "playCompleted", "play: actionHook success received")
-    t.ok(obj.body.playback_seconds === "2", "playback_seconds: actionHook success received")
-    t.ok(obj.body.playback_milliseconds === "2048", "playback_milliseconds: actionHook success received")
-    t.ok(obj.body.playback_last_offset_pos === "16000", "playback_last_offset_pos: actionHook success received")
+    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';
+    await 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}`);

test/queue-test.js

@@ -0,0 +1,127 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const clearModule = require('clear-module');
+const {provisionCallHook, provisionActionHook, provisionAnyHook} = 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();
+    });
+  });
+}
+
+const sleepFor = (ms) => new Promise((resolve) => setTimeout(() => resolve(), ms));
+
+test('\'enqueue-dequeue\' tests', async(t) => {
+
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'enqueue',
+        name: 'support',
+        actionHook: '/actionHook'
+      }
+    ];
+
+    const verbs2 = [
+      {
+        verb: 'dequeue',
+        name: 'support'
+      }
+    ];
+
+    const actionVerbs = [
+      {
+        verb: 'play',
+        url: 'silence_stream://1000',
+        earlyMedia: true
+      }
+    ];
+
+    const from = 'enqueue_success';
+    await provisionCallHook(from, verbs);
+    await provisionActionHook(from, actionVerbs)
+
+    const from2 = 'dequeue_success';
+    await provisionCallHook(from2, verbs2);
+    
+
+    // THEN
+    const p1 = sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+
+    await sleepFor(1000);
+
+    const p2 = sippUac('uac-success-send-bye.xml', '172.38.0.11', from2);
+    await Promise.all([p1, p2]);
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    t.ok(obj.body.queue_result === 'bridged');
+    t.pass('enqueue-dequeue: succeeds connect');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\leave\' tests', async(t) => {
+
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+  try {
+    await connect(srf);
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'enqueue',
+        name: 'support1',
+        waitHook: '/anyHook/enqueue_success_leave',
+        actionHook: '/actionHook'
+      }
+    ];
+
+    const anyHookVerbs = [
+      {
+        verb: 'leave'
+      }
+    ];
+
+        const actionVerbs = [
+      {
+        verb: 'play',
+        url: 'silence_stream://1000',
+        earlyMedia: true
+      }
+    ];
+
+    const from = 'enqueue_success_leave';
+    await provisionCallHook(from, verbs);
+    await provisionAnyHook(from, anyHookVerbs);
+    await provisionActionHook(from, actionVerbs)
+    
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/enqueue_success_leave`);
+    t.ok(obj.body.queue_position === 0);
+    const obj1  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    t.ok(obj1.body.queue_result === 'leave');
+    t.pass('enqueue-dequeue: succeeds connect');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/remove-test-db.js

@@ -5,7 +5,6 @@ test('dropping jambones_test database', (t) => {
   exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360 < ${__dirname}/db/remove_test_db.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('database successfully dropped');
-    fs.unlinkSync(`${__dirname}/credentials/gcp.json`);
     t.end();
   });
 });

test/say-tests.js

@@ -31,7 +31,7 @@ test('\'say\' tests', async(t) => {
     ];
 
     const from = 'say_test_success';
-    provisionCallHook(from, verbs)
+    await provisionCallHook(from, verbs)
 
     // THEN
     await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
@@ -43,3 +43,124 @@ test('\'say\' tests', async(t) => {
     t.error(err);
   }
 });
+
+test('\'config\' reset synthesizer tests', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        "verb": "config",
+        "synthesizer": {
+          "vendor": "microsft",
+          "voice": "foobar"
+        },
+      },
+      {
+        "verb": "config",
+        "reset": 'synthesizer',
+      },
+      {
+        verb: 'say',
+        text: 'hello'
+      }
+    ];
+
+    const from = 'say_test_success';
+    await provisionCallHook(from, verbs)
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+    t.pass('say: succeeds when using using account credentials');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('Say verb array test', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        "verb": "config",
+        "synthesizer": {
+          "vendor": "microsft",
+          "voice": "foobar"
+        },
+      },
+      {
+        "verb": "config",
+        "reset": 'synthesizer',
+      },
+      {
+        verb: 'say',
+        text: ['hello', 'https://samplelib.com/lib/preview/mp3/sample-3s.mp3']
+      }
+    ];
+
+    const from = 'say_test_success';
+    await provisionCallHook(from, verbs)
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+    t.pass('say: succeeds when using using account credentials');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+const {MICROSOFT_CUSTOM_API_KEY, MICROSOFT_DEPLOYMENT_ID, MICROSOFT_CUSTOM_REGION, MICROSOFT_CUSTOM_VOICE} = process.env;
+if (MICROSOFT_CUSTOM_API_KEY && MICROSOFT_DEPLOYMENT_ID && MICROSOFT_CUSTOM_REGION && MICROSOFT_CUSTOM_VOICE) {
+  test('\'say\' tests - microsoft custom voice', async(t) => {
+    clearModule.all();
+    const {srf, disconnect} = require('../app');
+
+    try {
+      await connect(srf);
+
+      // GIVEN
+      const verbs = [
+        {
+          verb: 'say',
+          text: 'hello',
+          synthesizer: {
+            vendor: 'microsoft',
+            voice: MICROSOFT_CUSTOM_VOICE,
+            options: {
+              deploymentId: MICROSOFT_DEPLOYMENT_ID,
+              apiKey: MICROSOFT_CUSTOM_API_KEY,
+              region: MICROSOFT_CUSTOM_REGION,
+            }
+          }
+        }
+      ];
+
+      const from = 'say_test_success';
+      await provisionCallHook(from, verbs)
+
+      // THEN
+      await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+      t.pass('say: succeeds when using microsoft custom voice');
+      disconnect();
+    } catch (err) {
+      console.log(`error received: ${err}`);
+      disconnect();
+      t.error(err);
+    }
+  });
+}

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

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

test/scenarios/uac-invite-expect-183-cancel.xml

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+
+<scenario name="Basic Sipstone UAC">
+    <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+    <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+    <send retrans="500">
+        <![CDATA[
+
+      INVITE sip:[to]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: [from] <sip:[from]@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:[to]@[remote_ip]:[remote_port]>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:[from]@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: bb845d4b-83a9-4cde-a6e9-50f3743bab3f
+      Subject: uac-say
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+    </send>
+
+    <recv response="100"
+          optional="true">
+    </recv>
+
+    <recv response="180" optional="true">
+    </recv>
+
+    <recv response="183" rtd="true">
+    <action>
+      <ereg regexp=";branch=[^;]*" search_in="hdr" header="Via" check_it="false" assign_to="1"/>
+    </action>
+    </recv>
+
+    <send>
+      <![CDATA[
+        CANCEL sip:[to]@[remote_ip]:[remote_port] SIP/2.0
+        Via: SIP/2.0/[transport] [local_ip]:[local_port][$1]
+        From: [from] <sip:[from]@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+        To: [to] <sip:[to]@[remote_ip]:[remote_port]>
+        Call-ID: [call_id]
+        CSeq: [cseq] CANCEL
+        Contact: sip:[from]@[local_ip]:[local_port]
+        Max-Forwards: 70
+      ]]>
+    </send>
+
+    <recv response="200" rtd="true">
+    </recv>
+
+    <recv response="487" rtd="true">
+    </recv>
+
+    <!-- Packet lost can be simulated in any send/recv message by         -->
+    <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+    <send>
+        <![CDATA[
+
+      ACK sip:[to]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port][$1]
+      From: [from] <sip:[from]@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: [to] <sip:[to]@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Contact: sip:[from]@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-say
+      Content-Length: 0
+
+    ]]>
+    </send>
+
+</scenario>

test/scenarios/uac-refer-no-notify.xml

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

test/scenarios/uac-refer-with-notify.xml

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

test/scenarios/uac-success-info-received-bye.xml

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

test/scenarios/uas-dial.xml

@@ -0,0 +1,164 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp default 'uas' scenario.                       -->
+<!--                                                                    -->
+
+<scenario name="Basic UAS responder">
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv request="INVITE" crlf="true">
+    <action>
+      <ereg regexp=".*" search_in="hdr" header="Subject:" assign_to="1" />
+    </action>
+  </recv>
+
+  <!-- The '[last_*]' keyword is replaced automatically by the          -->
+  <!-- specified header if it was present in the last message received  -->
+  <!-- (except if it was a retransmission). If the header was not       -->
+  <!-- present or if no message has been received, the '[last_*]'       -->
+  <!-- keyword is discarded, and all bytes until the end of the line    -->
+  <!-- are also discarded.                                              -->
+  <!--                                                                  -->
+  <!-- If the specified header was present several times in the         -->
+  <!-- message, all occurrences are concatenated (CRLF separated)       -->
+  <!-- to be used in place of the '[last_*]' keyword.                   -->
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 180 Ringing
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      [last_Record-Route:]
+      Subject:[$1]
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      [last_Record-Route:]
+      Subject:[$1]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv request="ACK"
+        rtd="true"
+        crlf="true">
+  </recv>
+
+  <recv request="INFO" optional="true" next="1">
+  </recv>
+
+  <recv request="INVITE" crlf="true">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      [last_Record-Route:]
+      Subject:[$1]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv request="ACK"
+        rtd="true"
+        crlf="true">
+  </recv>
+
+  <recv request="BYE">
+  </recv>
+
+  <send next="2">
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <label id="1"/>
+  <send>
+  <![CDATA[
+
+    SIP/2.0 200 OK
+    [last_Via:]
+    [last_From:]
+    [last_To:]
+    [last_Call-ID:]
+    [last_CSeq:]
+    Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+    Content-Length: 0
+
+  ]]>
+</send>
+
+<label id="2"/>
+
+</scenario>
+

test/sdp-utils-test.js

@@ -0,0 +1,26 @@
+const test = require('tape');
+const {makeOpusFirst, isOpusFirst} = require('../lib/utils/sdp-utils');
+const sdpTransform = require('sdp-transform');
+
+test('test opus first', (t) => {
+    const sdp = 'v=0\r\no=- 3348584794228993675 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\na=group:BUNDLE 0\r\na=extmap-allow-mixed\r\na=msid-semantic: WMS caca8b77-5ae5-4e73-a4d5-de1fce930335\r\nm=audio 57088 UDP/TLS/RTP/SAVPF 111 63 9 0 8 13 110 126\r\nc=IN IP4 14.238.89.50\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=candidate:1401281302 1 udp 2122260223 10.231.36.146 57088 typ host generation 0 network-id 1 network-cost 10\r\na=candidate:2173263513 1 udp 1686052607 14.238.89.50 57088 typ srflx raddr 10.231.36.146 rport 57088 generation 0 network-id 1 network-cost 10\r\na=ice-ufrag:k5nc\r\na=ice-pwd:J0qwMs6HrIcFNZbDG5m8Kqpk\r\na=ice-options:trickle\r\na=fingerprint:sha-256 66:DE:9A:76:CE:11:2D:65:C4:08:C7:87:B4:90:7E:F1:8D:07:B9:F4:FF:E3:81:D7:E7:7D:C6:56:47:01:6E:55\r\na=setup:actpass\r\na=mid:0\r\na=extmap:1 urn:ietf:params:rtp-hdrext:ssrc-audio-level\r\na=extmap:2 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time\r\na=extmap:3 http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01\r\na=extmap:4 urn:ietf:params:rtp-hdrext:sdes:mid\r\na=sendrecv\r\na=msid:caca8b77-5ae5-4e73-a4d5-de1fce930335 52ad01f1-b1df-4b8e-a208-9201e98b6f7b\r\na=rtcp-mux\r\na=rtcp-fb:111 transport-cc\r\na=fmtp:111 minptime=10;useinbandfec=1\r\na=rtpmap:63 red/48000/2\r\na=fmtp:63 111/111\r\na=rtpmap:9 G722/8000\r\na=rtpmap:0 PCMU/8000\r\na=rtpmap:8 PCMA/8000\r\na=rtpmap:13 CN/8000\r\na=rtpmap:111 opus/48000/2\r\na=rtpmap:110 telephone-event/48000\r\na=rtpmap:126 telephone-event/8000\r\na=ssrc:3207459321 cname:4nyPJ6KXvseBUIhu\r\na=ssrc:3207459321 msid:caca8b77-5ae5-4e73-a4d5-de1fce930335 52ad01f1-b1df-4b8e-a208-9201e98b6f7b\r\n';
+    const opusSdp = makeOpusFirst(sdp);
+    const parsedSdp = sdpTransform.parse(opusSdp);
+    const opusIndex = parsedSdp.media[0].rtp.findIndex((entry) => entry.codec === 'opus');
+    t.ok(opusIndex === 0, 'succesffuly move opus to be first offer')
+    t.end();
+});
+
+
+test('test is opus first', (t) => {
+
+    const sdp = 'v=0\r\no=- 3348584794228993675 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\na=group:BUNDLE 0\r\na=extmap-allow-mixed\r\na=msid-semantic: WMS caca8b77-5ae5-4e73-a4d5-de1fce930335\r\nm=audio 57088 UDP/TLS/RTP/SAVPF 111 63 9 0 8 13 110 126\r\nc=IN IP4 14.238.89.50\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=candidate:1401281302 1 udp 2122260223 10.231.36.146 57088 typ host generation 0 network-id 1 network-cost 10\r\na=candidate:2173263513 1 udp 1686052607 14.238.89.50 57088 typ srflx raddr 10.231.36.146 rport 57088 generation 0 network-id 1 network-cost 10\r\na=ice-ufrag:k5nc\r\na=ice-pwd:J0qwMs6HrIcFNZbDG5m8Kqpk\r\na=ice-options:trickle\r\na=fingerprint:sha-256 66:DE:9A:76:CE:11:2D:65:C4:08:C7:87:B4:90:7E:F1:8D:07:B9:F4:FF:E3:81:D7:E7:7D:C6:56:47:01:6E:55\r\na=setup:actpass\r\na=mid:0\r\na=extmap:1 urn:ietf:params:rtp-hdrext:ssrc-audio-level\r\na=extmap:2 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time\r\na=extmap:3 http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01\r\na=extmap:4 urn:ietf:params:rtp-hdrext:sdes:mid\r\na=sendrecv\r\na=msid:caca8b77-5ae5-4e73-a4d5-de1fce930335 52ad01f1-b1df-4b8e-a208-9201e98b6f7b\r\na=rtcp-mux\r\na=rtpmap:111 opus/48000/2\r\na=rtcp-fb:111 transport-cc\r\na=fmtp:111 minptime=10;useinbandfec=1\r\na=rtpmap:63 red/48000/2\r\na=fmtp:63 111/111\r\na=rtpmap:9 G722/8000\r\na=rtpmap:0 PCMU/8000\r\na=rtpmap:8 PCMA/8000\r\na=rtpmap:13 CN/8000\r\na=rtpmap:110 telephone-event/48000\r\na=rtpmap:126 telephone-event/8000\r\na=ssrc:3207459321 cname:4nyPJ6KXvseBUIhu\r\na=ssrc:3207459321 msid:caca8b77-5ae5-4e73-a4d5-de1fce930335 52ad01f1-b1df-4b8e-a208-9201e98b6f7b\r\n';
+    t.ok(isOpusFirst(sdp), "opus is first offer");
+
+    const sdp2 = 'v=0\r\no=- 3348584794228993675 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\na=group:BUNDLE 0\r\na=extmap-allow-mixed\r\na=msid-semantic: WMS caca8b77-5ae5-4e73-a4d5-de1fce930335\r\nm=audio 57088 UDP/TLS/RTP/SAVPF 111 63 9 0 8 13 110 126\r\nc=IN IP4 14.238.89.50\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=candidate:1401281302 1 udp 2122260223 10.231.36.146 57088 typ host generation 0 network-id 1 network-cost 10\r\na=candidate:2173263513 1 udp 1686052607 14.238.89.50 57088 typ srflx raddr 10.231.36.146 rport 57088 generation 0 network-id 1 network-cost 10\r\na=ice-ufrag:k5nc\r\na=ice-pwd:J0qwMs6HrIcFNZbDG5m8Kqpk\r\na=ice-options:trickle\r\na=fingerprint:sha-256 66:DE:9A:76:CE:11:2D:65:C4:08:C7:87:B4:90:7E:F1:8D:07:B9:F4:FF:E3:81:D7:E7:7D:C6:56:47:01:6E:55\r\na=setup:actpass\r\na=mid:0\r\na=extmap:1 urn:ietf:params:rtp-hdrext:ssrc-audio-level\r\na=extmap:2 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time\r\na=extmap:3 http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01\r\na=extmap:4 urn:ietf:params:rtp-hdrext:sdes:mid\r\na=sendrecv\r\na=msid:caca8b77-5ae5-4e73-a4d5-de1fce930335 52ad01f1-b1df-4b8e-a208-9201e98b6f7b\r\na=rtcp-mux\r\na=rtcp-fb:111 transport-cc\r\na=fmtp:111 minptime=10;useinbandfec=1\r\na=rtpmap:63 red/48000/2\r\na=fmtp:63 111/111\r\na=rtpmap:9 G722/8000\r\na=rtpmap:0 PCMU/8000\r\na=rtpmap:8 PCMA/8000\r\na=rtpmap:13 CN/8000\r\na=rtpmap:111 opus/48000/2\r\na=rtpmap:110 telephone-event/48000\r\na=rtpmap:126 telephone-event/8000\r\na=ssrc:3207459321 cname:4nyPJ6KXvseBUIhu\r\na=ssrc:3207459321 msid:caca8b77-5ae5-4e73-a4d5-de1fce930335 52ad01f1-b1df-4b8e-a208-9201e98b6f7b\r\n';
+    t.ok(!isOpusFirst(sdp2), "opus is not first offer")
+
+    const sdp3 = 'v=0\r\no=xhoaluu2 1314 1504 IN IP4 192.168.1.4\r\ns=Talk\r\nc=IN IP4 192.168.1.4\r\nt=0 0\r\na=ice-pwd:397d063ea23fdc05164e3ee4\r\na=ice-ufrag:16c449a3\r\na=rtcp-xr:rcvr-rtt=all:10000 stat-summary=loss,dup,jitt,TTL voip-metrics\r\na=group:BUNDLE as\r\na=record:off\r\nm=audio 56542 RTP/AVPF 0 8\r\nc=IN IP4 14.226.233.151\r\na=rtcp-mux\r\na=mid:as\r\na=extmap:1 urn:ietf:params:rtp-hdrext:sdes:mid\r\na=rtcp:63076 IN IP4 192.168.1.4\r\na=candidate:1 1 UDP 2130706303 192.168.1.4 56542 typ host\r\na=candidate:1 2 UDP 2130706302 192.168.1.4 63076 typ host\r\na=candidate:2 1 UDP 2130706431 2001:ee0:d744:dcf0:c1d3:d73f:7a93:dc9f 56542 typ host\r\na=candidate:2 2 UDP 2130706430 2001:ee0:d744:dcf0:c1d3:d73f:7a93:dc9f 63076 typ host\r\na=candidate:3 1 UDP 2130706431 2001:ee0:d744:dcf0:15:6be3:8e6b:b736 56542 typ host\r\na=candidate:3 2 UDP 2130706430 2001:ee0:d744:dcf0:15:6be3:8e6b:b736 63076 typ host\r\na=candidate:4 1 UDP 1694498687 14.226.233.151 56542 typ srflx raddr 192.168.1.4 rport 56542\r\na=rtcp-fb:* trr-int 1000\r\na=rtcp-fb:* ccm tmmbr';
+    t.ok(!isOpusFirst(sdp2), "opus is not first offer")
+    t.end();
+});

test/sip-refer-tests.js

@@ -0,0 +1,100 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const clearModule = require('clear-module');
+const {provisionCallHook, provisionCustomHook, provisionActionHook} = require('./utils')
+const bent = require('bent');
+const getJSON = bent('json')
+
+const sleepFor = async(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('\'refer\' tests w/202 and NOTIFY', {timeout: 25000}, async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'say',
+        text: 'silence_stream://100'
+      },
+      {
+        verb: 'sip:refer',
+        referTo: '123456',
+        actionHook: '/actionHook'
+      }
+    ];
+    const noVerbs = [];
+
+    const from = 'refer_with_notify';
+    await provisionCallHook(from, verbs);
+    await provisionActionHook(from, noVerbs)
+
+    // THEN
+    await sippUac('uac-refer-with-notify.xml', '172.38.0.10', from);
+    t.pass('refer: successfully received 202 Accepted');
+    await sleepFor(1000);
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    t.ok(obj.body.final_referred_call_status === 200, 'refer: successfully received NOTIFY with 200 OK');
+    //console.log(`obj: ${JSON.stringify(obj)}`);
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'refer\' tests w/202 but no NOTIFY', {timeout: 25000}, async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'say',
+        text: 'silence_stream://100'
+      },
+      {
+        verb: 'sip:refer',
+        referTo: '123456',
+        actionHook: '/actionHook'
+      }
+    ];
+    const noVerbs = [];
+
+    const from = 'refer_no_notify';
+    await provisionCallHook(from, verbs);
+    await provisionActionHook(from, noVerbs)
+
+    // THEN
+    await sippUac('uac-refer-no-notify.xml', '172.38.0.10', from);
+    t.pass('refer: successfully received 202 Accepted w/o NOTIFY');
+    await sleepFor(17000);
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    console.log(`obj: ${JSON.stringify(obj)}`);
+    t.ok(obj.body.refer_status === 202, 'refer: successfully timed out and reported 202');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/sip-request-tests.js

@@ -40,7 +40,7 @@ test('sending SIP in-dialog requests tests', async(t) => {
       }
     ];
     let from = "sip_indialog_test";
-    provisionCallHook(from, verbs);
+    await provisionCallHook(from, verbs);
     // THEN
     await sippUac('uac-send-info-during-dialog.xml', '172.38.0.10', from);
     const obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);

test/sip-tests.js

@@ -53,6 +53,13 @@ test('incoming call tests', (t) => {
     .then(() => {
       return t.pass('handles in-dialog requests');
     })
+    .then(() => {
+      return sippUac('uac-refer-no-notify.xml', '172.38.0.30');
+    })
+    .then(() => {
+      return t.pass('handles sip:refer where we get 202 but no NOTIFY');
+    })
+
     .then(() => {
       srf.disconnect();
       t.end();

test/sipp.js

@@ -24,24 +24,24 @@ obj.output = () => {
   return output;
 };
 
-obj.sippUac = (file, bindAddress, from='sipp', to='16174000000') => {
+obj.sippUac = (file, bindAddress, from='sipp', to='16174000000', loop=1) => {
   const cmd = 'docker';
   const args = [
     'run', '-t', '--rm', '--net', `${network}`,
     '-v', `${__dirname}/scenarios:/tmp/scenarios`,
     'drachtio/sipp', 'sipp', '-sf', `/tmp/scenarios/${file}`,
-    '-m', '1',
+    '-m', loop,
     '-sleep', '250ms',
     '-nostdin',
     '-cid_str', `%u-%p@%s-${idx++}`,
     '172.38.0.50',
     '-key','from', from,
-    '-key','to', to, '-trace_msg'
+    '-key','to', to, '-trace_msg', '-trace_err'
   ];
 
   if (bindAddress) args.splice(5, 0, '--ip', bindAddress);
 
-  console.log(args.join(' '));
+  //console.log(args.join(' '));
   clearOutput();
 
   return new Promise((resolve, reject) => {

test/transcribe-tests.js

@@ -0,0 +1,450 @@
+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')
+const {
+  GCP_JSON_KEY,
+  AWS_ACCESS_KEY_ID,  
+  AWS_SECRET_ACCESS_KEY,
+  MICROSOFT_REGION,
+  MICROSOFT_API_KEY,
+  SONIOX_API_KEY,
+  DEEPGRAM_API_KEY,
+} = require('../lib/config');
+
+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('\'transcribe\' test - google', async(t) => {
+  if (!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": "transcribe",
+        "recognizer": {
+          "vendor": "google",
+          "hints": ["customer support", "sales", "human resources", "HR"]
+        },
+        "transcriptionHook": "/transcriptionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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'),
+      'transcribe: succeeds when using google credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - microsoft', async(t) => {
+  if (!MICROSOFT_REGION || !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": "transcribe",
+        "recognizer": {
+          "vendor": "microsoft",
+          "hints": ["customer support", "sales", "human resources", "HR"]
+        },
+        "transcriptionHook": "/transcriptionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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'),
+      'transcribe: succeeds when using  microsoft credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - aws', async(t) => {
+  if (!AWS_ACCESS_KEY_ID || !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": "transcribe",
+        "recognizer": {
+          "vendor": "aws",
+          "hints": ["customer support", "sales", "human resources", "HR"]
+        },
+        "transcriptionHook": "/transcriptionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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'),
+      'transcribe: succeeds when using aws credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+
+test('\'transcribe\' test - deepgram config options', async(t) => {
+  if (!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": "config",
+        "recognizer": {
+          "vendor": "deepgram",
+          "language": "en-US",
+          "altLanguages": [
+            "en-US"
+          ],
+          "deepgramOptions": {
+            "model": "2-ea",
+            "tier": "nova",
+            "numerals": true,
+            "ner": true,
+            "vadTurnoff": 10,
+            "keywords": [
+              "CPT"
+            ]
+          }
+        }
+      },
+      {
+        "verb": "transcribe",
+        "transcriptionHook": "/transcriptionHook",
+        "recognizer": {
+          "vendor": "deepgram",
+          "altLanguages": [
+            "en-AU"
+          ],
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "deepgramOptions": {
+            "apiKey": DEEPGRAM_API_KEY,
+          }
+        }
+      }
+    ];
+    let from = "gather_success";
+    await 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().includes('like to speak to customer support'),
+      'transcribe: succeeds when using deepgram credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - deepgram', async(t) => {
+  if (!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": "transcribe",
+        "recognizer": {
+          "vendor": "deepgram",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "deepgramOptions": {
+            "apiKey": DEEPGRAM_API_KEY
+          }
+        },
+        "transcriptionHook": "/transcriptionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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().includes('like to speak to customer support'),
+      'transcribe: succeeds when using deepgram credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - soniox', async(t) => {
+  if (!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": "transcribe",
+        "recognizer": {
+          "vendor": "soniox",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "deepgramOptions": {
+            "apiKey": SONIOX_API_KEY
+          }
+        },
+        "transcriptionHook": "/transcriptionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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'),
+      'transcribe: succeeds when using soniox credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - google with asrTimeout', async(t) => {
+  if (!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": "transcribe",
+        "recognizer": {
+          "vendor": "google",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "asrTimeout": 4
+        },
+        "transcriptionHook": "/transcriptionHook"
+      }
+    ];
+    let from = "gather_success";
+    await 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'),
+      'transcribe: succeeds when using google credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - deepgram config options altLanguages', async(t) => {
+  if (!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": "config",
+        "recognizer": {
+          "vendor": "deepgram",
+          "language": "en-US",
+          "altLanguages": [
+            "en-US"
+          ],
+          "deepgramOptions": {
+            "model": "2-ea",
+            "tier": "nova",
+            "numerals": true,
+            "ner": true,
+            "vadTurnoff": 10,
+            "keywords": [
+              "CPT"
+            ]
+          }
+        }
+      },
+      {
+        "verb": "transcribe",
+        "transcriptionHook": "/transcriptionHook",
+        "recognizer": {
+          "vendor": "deepgram",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "deepgramOptions": {
+            "apiKey": DEEPGRAM_API_KEY,
+          }
+        }
+      }
+    ];
+    let from = "gather_success_no_altLanguages";
+    await 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().includes('like to speak to customer support'),
+      'transcribe: succeeds when using deepgram credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - deepgram config options altLanguages', async(t) => {
+  if (!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": "config",
+        "recognizer": {
+          "vendor": "deepgram",
+          "language": "en-US",
+          "altLanguages": [
+            "en-US"
+          ],
+          "deepgramOptions": {
+            "model": "2-ea",
+            "tier": "nova",
+            "numerals": true,
+            "ner": true,
+            "vadTurnoff": 10,
+            "keywords": [
+              "CPT"
+            ]
+          }
+        }
+      },
+      {
+        "verb": "transcribe",
+        "transcriptionHook": "/transcriptionHook",
+        "recognizer": {
+          "vendor": "deepgram",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "altLanguages": [],
+          "deepgramOptions": {
+            "apiKey": DEEPGRAM_API_KEY,
+          }
+        }
+      }
+    ];
+    let from = "gather_success_has_altLanguages";
+    await 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().includes('like to speak to customer support'),
+      'transcribe: succeeds when using deepgram credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/unit-tests.js

@@ -44,10 +44,25 @@ test('unit tests', (t) => {
 
   task = makeTask(logger, require('./data/good/say-text-array'));
   t.ok(task.name === 'say', 'parsed say with multiple segments');
+  
+  task = makeTask(logger, require('./data/good/say-ssml'));
+  // the ssml is more than 1000 chars, 
+  // expecting first chunk is length > 100, stop at ? instead of first .
+  // 2nd chunk is long text < 1000 char, stop at .
+  // 3rd chunk is the rest.
+  t.ok(task.text.length === 3 &&
+    task.text[0].length === 187 &&
+    task.text[1].length === 882 &&
+    task.text[2].length === 123, 'parsed say');
 
+  task = makeTask(logger, require('./data/bad/bad-say-ssml'));
+  t.ok(task.text.length === 1 &&
+    task.text[0].length === 1162, 'parsed bad say');
+
+  
   const alt = require('./data/good/alternate-syntax');
-  const normalize = require('../lib/utils/normalize-jambones');
-  normalize(logger, alt).forEach((t) => {
+  const { normalizeJambones } = require('@jambonz/verb-specifications');
+  normalizeJambones(logger, alt).forEach((t) => {
     const task = makeTask(logger, t);
   });
   t.pass('alternate syntax works');
@@ -62,4 +77,4 @@ const errMissingProperty = () => makeTask(logger, require('./data/bad/missing-re
 const errInvalidType = () => makeTask(logger, require('./data/bad/invalid-type'));
 const errBadEnum = () => makeTask(logger, require('./data/bad/bad-enum'));
 const errBadPayload = () => makeTask(logger, require('./data/bad/bad-payload'));
-const errBadPayload2 = () => makeTask(logger, require('./data/bad/bad-payload2'));
+const errBadPayload2 = () => makeTask(logger, require('./data/bad/bad-payload2'));

test/utils.js

@@ -6,22 +6,40 @@ const bent = require('bent');
 * The function help testcase to register desired jambonz json response for an application call
 * When a call has From number match the registered hook event, the desired jambonz json will be responded.
 */
-const provisionCallHook = (from, verbs) => {
+const provisionCallHook = async (from, verbs) => {
   const mapping = {
     from,
     data: JSON.stringify(verbs)
   };
   const post = bent('http://127.0.0.1:3100', 'POST', 'string', 200);
-  post('/appMapping', mapping);
+  await post('/appMapping', mapping);
 }
 
-const provisionCustomHook = (from, verbs) => {
+const provisionCustomHook = async(from, verbs) => {
   const mapping = {
     from,
     data: JSON.stringify(verbs)
   };
   const post = bent('http://127.0.0.1:3100', 'POST', 'string', 200);
-  post(`/customHookMapping`, mapping);
+  await post(`/customHookMapping`, mapping);
 }
 
-module.exports = { provisionCallHook, provisionCustomHook}
+const provisionActionHook = async(from, verbs) => {
+  const mapping = {
+    from,
+    data: JSON.stringify(verbs)
+  };
+  const post = bent('http://127.0.0.1:3100', 'POST', 'string', 200);
+  await post(`/actionHook`, mapping);
+}
+
+const provisionAnyHook = async(key, verbs) => {
+  const mapping = {
+    key,
+    data: JSON.stringify(verbs)
+  };
+  const post = bent('http://127.0.0.1:3100', 'POST', 'string', 200);
+  await post(`/anyHookMapping`, mapping);
+}
+
+module.exports = { provisionCallHook, provisionCustomHook, provisionActionHook, provisionAnyHook}

test/webhook/app.js

@@ -1,14 +1,55 @@
-const assert = require('assert');
-const fs = require('fs');
 const express = require('express');
 const app = express();
+const Websocket = require('ws');
 const listenPort = process.env.HTTP_PORT || 3000;
+const any_hook_json_mapping = new Map();
 let json_mapping = new Map();
 let hook_mapping = new Map();
+let ws_packet_count = new Map();
+let ws_metadata = new Map();
 
-app.listen(listenPort, () => {
+/** websocket server for listen audio  */
+const recvAudio = (socket, req) => {
+  let packets = 0;
+  let path = req.url;
+  console.log('received websocket connection');
+  socket.on('message', (data, isBinary) => {
+    if (!isBinary) {
+      try {
+        const msg = JSON.parse(data);
+        console.log({msg}, 'received websocket message');
+        ws_metadata.set(path, msg);
+      }
+      catch (err) {
+        console.log({err}, 'error parsing websocket message');
+      }
+    }
+    else {
+      packets += data.length;
+    }
+  });
+  socket.on('error', (err) => {
+    console.log({err}, 'listen websocket: error');
+  });
+
+  socket.on('close', () => {
+    ws_packet_count.set(path, packets);
+  })
+};
+
+const wsServer = new Websocket.Server({ noServer: true });
+wsServer.setMaxListeners(0);
+wsServer.on('connection', recvAudio.bind(null));
+
+const server = app.listen(listenPort, () => {
   console.log(`sample jambones app server listening on ${listenPort}`);
 });
+server.on('upgrade', (request, socket, head) => {
+  console.log('received upgrade request');
+  wsServer.handleUpgrade(request, socket, head, (socket) => {
+    wsServer.emit('connection', socket, request);
+  });
+});
 
 app.use(express.urlencoded({ extended: true }));
 app.use(express.json());
@@ -20,7 +61,8 @@ app.use(express.json());
 app.all('/', (req, res) => {
   console.log(req.body, 'POST /');
   const key = req.body.from
-  return getJsonFromMap(key, req, res);
+  addRequestToMap(key, req, hook_mapping);
+  return getJsonFromMap(json_mapping, key, req, res);
 });
 
 app.post('/appMapping', (req, res) => {
@@ -39,7 +81,16 @@ app.post('/callStatus', (req, res) => {
   return res.sendStatus(200);
 });
 /*
- * action Hook
+ * transcriptionHook
+ */
+app.post('/transcriptionHook', (req, res) => {
+  console.log({payload: req.body}, 'POST /transcriptionHook');
+  let key = req.body.from + "_actionHook"
+  addRequestToMap(key, req, hook_mapping);
+  return res.json([{"verb": "hangup"}]);
+});
+/*
+ * actionHook
  */
 app.post('/actionHook', (req, res) => {
   console.log({payload: req.body}, 'POST /actionHook');
@@ -56,7 +107,7 @@ app.post('/actionHook', (req, res) => {
 app.all('/customHook', (req, res) => {
   let key = `${req.body.from}_customHook`;;
   console.log(req.body, `POST /customHook`);
-  return getJsonFromMap(key, req, res);
+  return getJsonFromMap(json_mapping, key, req, res);
 });
 
 app.post('/customHookMapping', (req, res) => {
@@ -66,6 +117,23 @@ app.post('/customHookMapping', (req, res) => {
   return res.sendStatus(200);
 });
 
+/**
+ * Any Hook
+ */
+
+app.all('/anyHook/:key', (req, res) => {
+  let key = req.params.key;
+  console.log(req.body, `POST /anyHook/${key}`);
+  return getJsonFromMap(any_hook_json_mapping, key, req, res);
+});
+
+app.post('/anyHookMapping', (req, res) => {
+  let key = req.body.key;
+  console.log(req.body, `POST /anyHookMapping/${key}`);
+  any_hook_json_mapping.set(key, req.body.data);
+  return res.sendStatus(200);
+});
+
 // Fetch Requests
 app.get('/requests/:key', (req, res) => {
   let key = req.params.key;
@@ -87,13 +155,34 @@ app.get('/lastRequest/:key', (req, res) => {
   }
 })
 
+// WS Fetch
+app.get('/ws_packet_count/:key', (req, res) => {
+  let key = `/${req.params.key}`;
+  console.log(key, ws_packet_count);
+  if (ws_packet_count.has(key)) {
+    return res.json({ count: ws_packet_count.get(key) });
+  } else {
+    return res.sendStatus(404);
+  }
+})
+
+app.get('/ws_metadata/:key', (req, res) => {
+  let key = `/${req.params.key}`;
+  console.log(key, ws_packet_count);
+  if (ws_metadata.has(key)) {
+    return res.json({ metadata: ws_metadata.get(key) });
+  } else {
+    return res.sendStatus(404);
+  }
+})
+
 /*
  * private function
  */
 
-function getJsonFromMap(key, req, res) {
-  if (!json_mapping.has(key)) return res.sendStatus(404);
-  const retData = JSON.parse(json_mapping.get(key));
+function getJsonFromMap(map, key, req, res) {
+  if (!map.has(key)) return res.sendStatus(404);
+  const retData = JSON.parse(map.get(key));
   console.log(retData, ` Response to ${req.method} ${req.url}`);
   addRequestToMap(key, req, hook_mapping);
   return res.json(retData);