@jambonz/node-red-contrib-jambonz 2.4.28 → 2.4.30

package/examples/Generic Verb Node.json

@@ -0,0 +1,124 @@
+[
+    {
+        "id": "5d9a3f1fa6551a9f",
+        "type": "webhook in",
+        "z": "1b97c147228e3829",
+        "name": "",
+        "url": "/call",
+        "method": "post",
+        "x": 100,
+        "y": 220,
+        "wires": [
+            [
+                "e627c4f20ede7606"
+            ]
+        ]
+    },
+    {
+        "id": "1d33431d324d0453",
+        "type": "webhook out",
+        "z": "1b97c147228e3829",
+        "name": "",
+        "x": 1270,
+        "y": 180,
+        "wires": []
+    },
+    {
+        "id": "9bf6ecad5a81a2bf",
+        "type": "debug",
+        "z": "1b97c147228e3829",
+        "name": "debug 18",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "jambonz",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 1260,
+        "y": 280,
+        "wires": []
+    },
+    {
+        "id": "73e79d1cc5ac62d0",
+        "type": "generic",
+        "z": "1b97c147228e3829",
+        "name": "generic - say",
+        "verb": "say",
+        "data": "{\"text\":\"goodbye\"}",
+        "dataType": "json",
+        "x": 1030,
+        "y": 220,
+        "wires": [
+            [
+                "9bf6ecad5a81a2bf",
+                "1d33431d324d0453"
+            ]
+        ]
+    },
+    {
+        "id": "e627c4f20ede7606",
+        "type": "generic",
+        "z": "1b97c147228e3829",
+        "name": "generic - answer",
+        "verb": "answer",
+        "data": "{}",
+        "dataType": "json",
+        "x": 290,
+        "y": 220,
+        "wires": [
+            [
+                "453b7fb4d62ef93e"
+            ]
+        ]
+    },
+    {
+        "id": "453b7fb4d62ef93e",
+        "type": "generic",
+        "z": "1b97c147228e3829",
+        "name": "generic - pause",
+        "verb": "pause",
+        "data": "{\"length\":1}",
+        "dataType": "json",
+        "x": 480,
+        "y": 220,
+        "wires": [
+            [
+                "da2ac5d1cd9ab0a5"
+            ]
+        ]
+    },
+    {
+        "id": "da2ac5d1cd9ab0a5",
+        "type": "generic",
+        "z": "1b97c147228e3829",
+        "name": "generic -say",
+        "verb": "say",
+        "data": "{\"text\":\"Please hold\",\"loop\":1,\"earlyMedia\":false}",
+        "dataType": "json",
+        "x": 670,
+        "y": 220,
+        "wires": [
+            [
+                "b7225263b1115bde"
+            ]
+        ]
+    },
+    {
+        "id": "b7225263b1115bde",
+        "type": "generic",
+        "z": "1b97c147228e3829",
+        "name": "generic - pause",
+        "verb": "pause",
+        "data": "{\"length\":5}",
+        "dataType": "json",
+        "x": 840,
+        "y": 220,
+        "wires": [
+            [
+                "73e79d1cc5ac62d0"
+            ]
+        ]
+    }
+]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/node-red-contrib-jambonz",
-  "version": "2.4.28",
+  "version": "2.4.30",
   "description": "Node-RED nodes for jambonz platform",
   "keywords": [
     "node-red"
@@ -50,14 +50,15 @@
       "get_calls": "src/nodes/get_calls.js",
       "get_recent_calls": "src/nodes/get_recent_calls.js",
       "answer": "src/nodes/answer.js",
-      "dub": "src/nodes/dub.js"
+      "dub": "src/nodes/dub.js",
+      "generic": "src/nodes/generic-verb.js"
     }
   },
   "author": "Dave Horton",
   "license": "MIT",
   "dependencies": {
     "aws-sdk": "^2.1665.0",
-    "body-parser": "^1.20.2",
+    "body-parser": "^1.20.3",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
     "hash-sum": "^2.0.0",
@@ -68,7 +69,7 @@
     "on-headers": "^1.0.2",
     "raw-body": "^2.5.2",
     "s3-upload-stream": "^1.0.7",
-    "undici": "^5.28.4",
+    "undici": "^5.28.5",
     "ws": "^8.18.0"
   }
 }

package/resources/editor.js

@@ -156,10 +156,10 @@
     }
   }
 
-  function prepareSttControls(node) {
-    var vendorElem = $('#node-input-transcriptionvendor');
-    var languageElem = $('#node-input-recognizerlang');
-    var mixtypeElem = $('#node-input-mixtype');
+  function prepareSttControls(node, vendor='#node-input-transcriptionvendor', lang='#node-input-recognizerlang', mixType='#node-input-mixtype') {
+    var vendorElem = $(vendor);
+    var languageElem = $(lang);
+    var mixtypeElem = $(mixType);
 
     console.log('entering prepareSttControls');
     

package/src/nodes/dial.html

@@ -65,7 +65,16 @@
         vocabularynameType: {value: 'str'},
         vocabularyfiltername: {},
         vocabularyfilternameType: {value: 'str'},
-        vocabularyfiltermethod: {}
+        vocabularyfiltermethod: {},
+        amd_actionHook : {},
+        amd_actionHookType: {value: 'str'},
+        amd_recognizer_vendor: {value: 'default'},
+        amd_recognizer_lang: {value: 'default'},
+        amd_thresholdWordCount: {},
+        amd_timers_decisionTimeoutMs: {},
+        amd_timers_greetingCompletionTimeoutMs:{},
+        amd_timers_noSpeechTimeoutMs: {},
+        amd_timers_toneTimeoutMs: {}
       },
       inputs:1,
       outputs:1,
@@ -147,6 +156,7 @@
         });
 
         prepareSttControls(node);
+        prepareSttControls(node, '#node-input-amd_recognizer_vendor', '#node-input-amd_recognizer_lang');
 
         $('#node-input-target-container').css('min-height','180px').css('min-width','450px').editableList({
           addItem: function(container, i, opt) {
@@ -482,7 +492,7 @@
     <div class="form-row">
       <label for="node-input-dialmusic">Dial music</label>
       <input type="text" id="node-input-dialmusic" placeholder="url to .wav or .mp3 file to play during dial">
-      <input type="hidden" id="node-input-dialMusicType">
+      <input type="hidden" id="node-input-dialmusicType">
     </div>
     <div class="form-row">
       <label for="node-input-dtmfcapture">Dtmf capture</label>
@@ -652,6 +662,51 @@
           <ol id="node-input-headers-container"></ol>
       </div>
     </fieldset>
+    <fieldset>
+      <legend>Answering Machine Detection</legend>
+      <div class="form-row">
+        <label for="node-input-amd_actionHook">actionHook</label>
+        <input type="text" id="node-input-amd_actionHook">
+        <input type="hidden" id="node-input-amd_actionHookType">
+      </div>
+      <div class="form-row">
+        <label for="node-input-amd_recognizer_vendor">Vendor</label>
+        <select id="node-input-amd_recognizer_vendor">
+          <option value="default" selected>--application default--</option>
+          <option value="google">Google</option>
+          <option value="aws">AWS</option>
+          <option value="deepgram">deepgram</option>
+          <option value="microsoft">microsoft</option>
+          <option value="ibm">ibm</option>
+          <option value="nuance">nuance</option>
+        </select>
+      </div>
+      <div class="form-row">
+        <label for="node-input-amd_recognizer_lang">Language</label>
+        <select id="node-input-amd_recognizer_lang">
+        </select>
+      </div>
+      <div class="form-row">
+        <label for="node-input-amd_thresholdWordCount">Threshold Word Count</label>
+        <input type="text" id="node-input-amd_thresholdWordCount">
+      </div>
+      <div class="form-row">
+        <label for="node-input-amd_timers_decisionTimeoutMs">Decision Timeout</label>
+        <input type="text" id="node-input-amd_timers_decisionTimeoutMs">
+      </div>
+      <div class="form-row">
+        <label for="node-input-amd_timers_greetingCompletionTimeoutMs">Greeting Completion Timeout</label>
+        <input type="text" id="node-input-amd_timers_greetingCompletionTimeoutMs">
+      </div>
+      <div class="form-row">
+        <label for="node-input-amd_timers_noSpeechTimeoutMs">No-Speech Timeout</label>
+        <input type="text" id="node-input-amd_timers_noSpeechTimeoutMs">
+      </div>
+      <div class="form-row">
+        <label for="node-input-amd_timers_toneTimeoutMs">Tone Timeout</label>
+        <input type="text" id="node-input-amd_timers_toneTimeoutMs">
+      </div>
+    </fieldset>
   </div>
 </script>
 

package/src/nodes/dial.js

@@ -49,7 +49,7 @@ module.exports = function(RED) {
         confirmHook: await new_resolve(RED, config.confirmhook, config.confirmhookType, node, msg), 
         dialMusic: await new_resolve(RED, config.dialmusic, config.dialmusicType, node, msg),
         referHook: await new_resolve(RED, config.referhook, config.referhookType, node, msg),
-        dtmfHook: await new_resolve(RED, config.dtmfhook, config.dtmfhookType, node, msg),
+        dtmfHook: await new_resolve(RED, config.dtmfhook, config.dtmfhookType, node, msg)
       };
 
       if (config.hasOwnProperty('anchormedia')) {
@@ -132,6 +132,31 @@ module.exports = function(RED) {
         delete data.dtmfHook;
       }
 
+      // AMD
+      const _amd_actionHook =  await new_resolve(RED, config.amd_actionHook, config.amd_actionHookType, node, msg)
+      if (_amd_actionHook){
+        data.amd = {}
+        data.amd.actionHook = _amd_actionHook;
+        config.amd_thresholdWordCount && (data.amd.thresholdWordCount = Number(config.amd_thresholdWordCount))
+        data.amd.timers = {
+          ...(config.amd_timers_decisionTimeoutMs && {decisionTimeoutMs: Number(config.amd_timers_decisionTimeoutMs)}),
+          ...(config.amd_timers_greetingCompletionTimeoutMs && {greetingCompletionTimeoutMs: Number(config.amd_timers_greetingCompletionTimeoutMs)}),
+          ...(config.amd_timers_noSpeechTimeoutMs && {noSpeechTimeoutMs: Number(config.amd_timers_noSpeechTimeoutMs)}),
+          ...(config.amd_timers_toneTimeoutMs && {toneTimeoutMs: Number(config.amd_timers_toneTimeoutMs)}),
+        }
+        //If none of the timer values are set remove the object
+        if (Object.keys(data.amd.timers).length == 0){
+          delete(data.amd.timers)
+        }
+        //If custom recogniser is used
+        if (config.amd_recognizer_vendor != 'default'){
+          data.amd.recognizer = {
+            ...(config.amd_recognizer_vendor && {vendor : config.amd_recognizer_vendor}),
+            ...(config.amd_recognizer_lang && {language : config.amd_recognizer_lang})
+          }
+        }
+      }
+
       node.log(`dial verb: ${JSON.stringify(data)}`);
 
       appendVerb(msg, data);

package/src/nodes/generic-verb.html

@@ -0,0 +1,60 @@
+<!-- Javascript -->
+<script type="text/javascript">
+ 
+
+  RED.nodes.registerType('generic',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        verb: {required: true},
+        data: {value: '{}'},
+        dataType: {value: 'json'},
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'generic';},
+      oneditprepare: function() {
+        $('#node-input-data').typedInput({
+          default: $('#node-input-dataType').val(),
+          types: ['json','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-dataType')
+        });
+      }
+  });
+</script>
+
+<!-- HTML -->
+<script type="text/html" data-template-name="generic">
+    <div class="form-row">
+      <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+      <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+      <label for="node-input-verb">Verb</label>
+      <input type="text" id="node-input-verb" placeholder="verb">
+    </div>
+    <div class="form-row">
+      <label for="node-input-data">Attributes</label>
+      <input type="text" id="node-input-data">
+      <input type="hidden" id="node-input-dataType">
+    </div>
+</script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="generic">
+  <p>A generic node to set any verb</p>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>jambonz<span class="property-type">object</span></dt>
+    <dd> <code>msg.jambonz</code> will contain any previous actions provided to the input with the new <code>pause</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  Allows use of complex or new verbs in Jambonz that may not have nodes, set the verb name and then pass any additional attributes as a JSON object in the data field.
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://www.jambonz.org/docs/webhooks/">Jambonz Verb reference</a></li>
+    </ul>
+</script>

package/src/nodes/generic-verb.js

@@ -0,0 +1,18 @@
+var {appendVerb, new_resolve} = require('./libs')
+
+module.exports = function(RED) {
+  function generic(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.verb = config.verb
+    node.on('input', async function(msg) {
+      let data = await new_resolve(RED, config.data, config.dataType, node, msg);
+      appendVerb(msg, {
+        ...{verb: node.verb}, 
+        ...data
+      });
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('generic', generic);
+}

package/src/nodes/lcc.html

@@ -70,6 +70,16 @@
           return action !== 'tag' || v.length > 0;
         }},
         tagType: {value: 'json'},
+        dubTrack: {value: ''},
+        dubTrackType: {value: 'str'},
+        dubPlay: {},
+        dubPlayType: {value: 'str'},
+        dubSay: {},
+        dubSayType: {value: 'str'},
+        dubLoop: {value: false},
+        dubLoopType: {value: 'bool'},
+        dubGain: {value: 0},
+        dubGainType: {value: 'num'},
       },
       inputs:1,
       outputs:1,
@@ -91,6 +101,7 @@
         var sipRequestDiv = $('#sip-request-options');
         var dtmfDiv = $('#dtmf-options');
         var tagDiv = $('#tag-options');
+        var dubDiv = $('#dub-options');
 
         $('#node-input-callSid').typedInput({
           default: $('#node-input-callSidType').val(),
@@ -152,6 +163,31 @@
           types: ['msg', 'flow', 'global', 'json', 'jsonata', 'env', mustacheType],
           typeField: $('#node-input-tagType')
         });
+        $('#node-input-dubTrack').typedInput({
+          default: $('#node-input-dubTrackType').val(),
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-dubTrackType')
+        });
+        $('#node-input-dubPlay').typedInput({
+          default: $('#node-input-dubPlayType').val(),
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-dubPlayType')
+        });
+        $('#node-input-dubSay').typedInput({
+          default: $('#node-input-dubSayType').val(),
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-dubSayType')
+        });
+        $('#node-input-dubLoop').typedInput({
+          default: $('#node-input-dubLoopType').val(),
+          types: ['bool', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-dubLoopType')
+        });
+        $('#node-input-dubGain').typedInput({
+          default: $('#node-input-dubFainType').val(),
+          types: ['num', 'flow', 'global', 'json', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-dubGainType')
+        });
 
         var onActionChanged = function () {
           var selectedAction = actionElem.find(':selected').val();
@@ -169,6 +205,8 @@
           else dtmfDiv.hide();
           if ('tag' === selectedAction) tagDiv.show();
           else tagDiv.hide();
+          if ('dub' === selectedAction.substring(0,3)) dubDiv.show();
+          else dubDiv.hide();
         }
 
         var onVendorChanged = function() {
@@ -337,6 +375,11 @@
       <option value="resume_call_recording">resume call recording</option>
       <option value="send_dtmf">send RFC 2833 DTMF</option>
       <option value="tag">tag call</option>
+      <option value="dubAdd">Dub - addTrack</option>
+      <option value="dubRemove">Dub - removeTrack</option>
+      <option value="dubPlay">Dub - playOnTrack</option>
+      <option value="dubSay">Dub - sayOnTrack</option>
+      <option value="dubSilence">Dub - SilenceTrack</option>
     </select>
   </div>
   <div id="say-options">
@@ -451,6 +494,33 @@
       <input type="hidden" id="node-input-tagType">
     </div>
   </div>
+  <div id="dub-options">
+    <div class="form-row">
+      <label for="node-input-dubTrack">Track</label>
+      <input type="text" id="node-input-dubTrack">
+      <input type="hidden" id="node-input-dubTrackType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-dubPlay">Play URL</label>
+      <input type="text" id="node-input-dubPlay" placeholder="https://example.com/file.mp3">
+      <input type="hidden" id="node-input-dubPlayType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-dubSay">Say Text</label>
+      <input type="text" id="node-input-dubSay" placeholder="Text">
+      <input type="hidden" id="node-input-tagType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-dubLoop">Loop</label>
+      <input type="text" id="node-input-dubLoop">
+      <input type="hidden" id="node-input-dubLoopType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-dubGain">Gain</label>
+      <input type="text" id="node-input-dubGain">
+      <input type="hidden" id="node-input-dubGainType">
+    </div>
+  </div>
 </script>
 
 <!-- Help Text -->

package/src/nodes/lcc.js

@@ -121,8 +121,39 @@ function lcc(config) {
           };
           break;
         case 'tag':
-            opts.tag = await new_resolve(RED, config.tag, config.tagType, node, msg);
-            break;
+          opts.tag = await new_resolve(RED, config.tag, config.tagType, node, msg);
+          break;
+        case 'dubAdd':
+          opts.dub = { action: 'addTrack' };
+          opts.dub.track = await new_resolve(RED, config.dubTrack, config.dubTrackType, node, msg);
+          opts.dub.say = await new_resolve(RED, config.dubSay, config.dubSayType, node, msg) || undefined
+          opts.dub.play = await new_resolve(RED, config.dubPlay, config.dubPlayType, node, msg) || undefined
+          opts.dub.loop = await new_resolve(RED, config.dubLoop, config.dubLoopType, node, msg) 
+          opts.dub.gain = await new_resolve(RED, config.dubGain, config.dubGainType, node, msg);
+          break
+        case 'dubRemove':
+          opts.dub = { action: 'removeTrack' };
+          opts.dub.track = await new_resolve(RED, config.dubTrack, config.dubTrackType, node, msg);
+          break
+        case 'dubPlay':
+          console.log(config)
+          opts.dub = { action: 'playOnTrack' };
+          opts.dub.track = await new_resolve(RED, config.dubTrack, config.dubTrackType, node, msg);
+          opts.dub.play = await new_resolve(RED, config.dubPlay, config.dubPlayType, node, msg);
+          opts.dub.loop = await new_resolve(RED, config.dubLoop, config.dubLoopType, node, msg);
+          opts.dub.gain = await new_resolve(RED, config.dubGain, config.dubGainType, node, msg);
+          break
+        case 'dubSay':
+          opts.dub = { action : 'sayOnTrack' };
+          opts.dub.track = await new_resolve(RED, config.dubTrack, config.dubTrackType, node, msg);
+          opts.dub.say = await new_resolve(RED, config.dubSay, config.dubSayType, node, msg);
+          opts.dub.loop = await new_resolve(RED, config.dubLoop, config.dubLoopType, node, msg);
+          opts.dub.gain = await new_resolve(RED, config.dubGain, config.dubGainType, node, msg);
+          break
+        case 'dubSilence':
+          opts.dub = { action: 'silenceTrack' };
+          opts.dub.track = await new_resolve(RED, config.dubTrack, config.dubTrackType, node, msg);
+          break          
         default:
           node.log(`invalid action: ${config.action}`);
           send(msg);

package/src/nodes/libs.js

@@ -133,7 +133,7 @@ exports.appendVerb = (msg, obj) => {
     const url = `${baseUrl}/v1/Accounts/${accountSid}/Calls/${callSid}`;
     node.log(`invoking LCC with payload ${JSON.stringify(opts)} at ${url}`);
     const response = await fetch(url, {
-      method: 'POST',
+      method: 'POST', // TODO Should move this to PUT in next major update but will need regression testing
       headers: {
         'Content-Type': 'application/json',
         'Authorization': `Bearer ${apiToken}`

package/src/nodes/tag.js

@@ -6,8 +6,15 @@ module.exports = function(RED) {
     var node = this;
     node.on('input', async function(msg) {
       var data = await new_resolve(RED, config.data, config.dataType, node, msg);
-      if (typeof(data) != 'object'){
-        data = JSON.parse(data)
+      if (typeof(data) != 'object') {
+        try {
+          data = JSON.parse(data)
+        } catch (e) {
+          console.log('Failed to parse data as JSON: ', data)
+          return node.send(msg);
+        }
+      } else {
+        data = Object.assign({}, data);
       }
       appendVerb(msg, {
         verb: 'tag',