rest dial dtmf

lib/tasks/rest_dial.js

@@ -2,10 +2,44 @@ const Task = require('./task');
 const {TaskName} = require('../utils/constants');
 const makeTask = require('./make_task');
 const { normalizeJambones } = require('@jambonz/verb-specifications');
+const DtmfCollector = require('../utils/dtmf-collector');
 
 /**
  * Manages an outdial made via REST API
  */
+
+function parseDtmfOptions(logger, dtmfCapture) {
+  console.log('DTMF Capture Settings:', dtmfCapture); // Log the initial DTMF capture settings
+
+  let parentDtmfCollector, childDtmfCollector;
+  const parentKeys = [], childKeys = [];
+
+  if (Array.isArray(dtmfCapture)) {
+    Array.prototype.push.apply(parentKeys, dtmfCapture);
+    Array.prototype.push.apply(childKeys, dtmfCapture);
+  } else if (dtmfCapture.childCall || dtmfCapture.parentCall) {
+    if (dtmfCapture.childCall && Array.isArray(dtmfCapture.childCall)) {
+      Array.prototype.push.apply(childKeys, dtmfCapture.childCall);
+    }
+    if (dtmfCapture.parentCall && Array.isArray(dtmfCapture.parentCall)) {
+      Array.prototype.push.apply(parentKeys, dtmfCapture.parentCall);
+    }
+  }
+  console.log('Parent DTMF Keys:', parentKeys); // Log the keys for the parent call
+  console.log('Child DTMF Keys:', childKeys); // Log the keys for the child call
+
+  if (childKeys.length) {
+    childDtmfCollector = new DtmfCollector({logger, patterns: childKeys});
+    console.log('Child DtmfCollector created:', childDtmfCollector); // Log when child DTMF collector is created
+  }
+  if (parentKeys.length) {
+    parentDtmfCollector = new DtmfCollector({logger, patterns: parentKeys});
+    console.log('Parent DtmfCollector created:', parentDtmfCollector); // Log when parent DTMF collector is created
+  }
+
+  return {childDtmfCollector, parentDtmfCollector};
+}
+
 class TaskRestDial extends Task {
   constructor(logger, opts) {
     super(logger, opts);
@@ -15,10 +49,21 @@ class TaskRestDial extends Task {
     this.fromHost = this.data.fromHost;
     this.to = this.data.to;
     this.call_hook = this.data.call_hook;
+    this.dtmfHook = this.data.dtmfHook;
     this.timeout = this.data.timeout || 60;
     this.sipRequestWithinDialogHook = this.data.sipRequestWithinDialogHook;
     this.referHook = this.data.referHook;
 
+    if (this.dtmfHook) {
+      const {parentDtmfCollector, childDtmfCollector} = parseDtmfOptions(logger, this.data.dtmfCapture || {});
+      if (parentDtmfCollector) {
+        this.parentDtmfCollector = parentDtmfCollector;
+      }
+      if (childDtmfCollector) {
+        this.childDtmfCollector = childDtmfCollector;
+      }
+    }
+
     this.on('connect', this._onConnect.bind(this));
     this.on('callStatus', this._onCallStatus.bind(this));
   }
@@ -31,8 +76,9 @@ class TaskRestDial extends Task {
 
   /**
    * INVITE has just been sent at this point
-  */
+   */
   async exec(cs) {
+    console.log('Executing TaskRestDial'); // Log when exec is called
     await super.exec(cs);
     this.cs = cs;
     this.canCancel = true;
@@ -45,8 +91,10 @@ class TaskRestDial extends Task {
 
     this._setCallTimer();
     await this.awaitTaskDone();
+    console.log('TaskRestDial execution completed'); // Log when exec is finished
   }
 
+
   turnOffAmd() {
     if (this.callSession.ep && this.callSession.ep.amd) this.stopAmd(this.callSession.ep, this);
   }
@@ -58,15 +106,27 @@ class TaskRestDial extends Task {
       this.canCancel = false;
       cs?.req?.cancel();
     }
+
+    // Remove DTMF detection
+    this._removeDtmfDetection(cs.dlg);
+
     this.notifyTaskDone();
   }
 
   async _onConnect(dlg) {
+    console.log('Call connected, setting up dialog and DTMF detection');
     this.canCancel = false;
     const cs = this.callSession;
     cs.setDialog(dlg);
     cs.referHook = this.referHook;
     this.logger.debug('TaskRestDial:_onConnect - call connected');
+
+    // Attach DTMF detection
+    if (this.parentDtmfCollector || this.childDtmfCollector) {
+      console.log('Setting up DTMF detection'); // Log when DTMF detection is being set up
+      this._installDtmfDetection(cs, dlg);
+    }
+
     if (this.sipRequestWithinDialogHook) this._initSipRequestWithinDialogHandler(cs, dlg);
     try {
       const b3 = this.getTracingPropagation();
@@ -141,9 +201,57 @@ class TaskRestDial extends Task {
     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');
-      });
+        .catch((err) => {
+          this.logger.error({err}, 'Rest:dial:_onAmdEvent - error calling actionHook');
+        });
+  }
+
+  _installDtmfDetection(cs, dlg) {
+    console.log('Installing DTMF detection'); // Log when installing DTMF detection
+    dlg.on('info', this._onInfo.bind(this, cs, dlg));
+  }
+
+  _onInfo(cs, dlg, req, res) {
+    console.log('INFO message received:', req.body); // Log the incoming INFO message
+    res.send(200);
+    if (req.get('Content-Type') !== 'application/dtmf-relay') {
+      console.log('INFO message is not DTMF relay'); // Log if the INFO message is not a DTMF relay
+      return;
+    }
+
+    const dtmfDetector = dlg === cs.dlg ? this.parentDtmfCollector : this.childDtmfCollector;
+    if (!dtmfDetector) {
+      console.log('No DTMF detector available'); // Log if no DTMF detector is available
+      return;
+    }
+
+    const arr = /Signal=([0-9#*])/.exec(req.body);
+    if (!arr) {
+      console.log('No DTMF signal found in INFO message'); // Log if no DTMF signal is found
+      return;
+    }
+
+    const key = arr[1];
+    console.log('DTMF Signal received:', key); // Log the detected DTMF signal
+    const match = dtmfDetector.keyPress(key);
+
+    if (match) {
+      console.log('DTMF match found:', match); // Log if a DTMF match is found
+      const b3 = this.getTracingPropagation();
+      const httpHeaders = b3 && {b3};
+      this.logger.info({callSid: cs.callSid}, `RestDial:_onInfo triggered dtmf match: ${match}`);
+
+      cs.requestor.request('verb:hook', this.dtmfHook, {dtmf: match, ...cs.callInfo.toJSON()}, httpHeaders)
+          .catch((err) => this.logger.info(err, 'RestDial:_onDtmf - error'));
+    } else {
+      console.log('No DTMF match found for key:', key); // Log if no match is found for the DTMF signal
+    }
+  }
+
+
+  _removeDtmfDetection(dlg) {
+    console.log('Removing DTMF detection'); // Log when removing DTMF detection
+    dlg && dlg.removeAllListeners('info');
   }
 
   _initSipRequestWithinDialogHandler(cs, dlg) {