@jambonz/node-red-contrib-jambonz 2.2.72 → 2.3.0

package/src/nodes/lcc.html

@@ -0,0 +1,256 @@
+<!-- Javascript -->
+<script type="text/javascript">
+RED.nodes.registerType('lcc',{
+      category: 'jambonz',
+      color: '#aebfb9',
+      defaults: {
+        name: {value: ''},
+        server: {value: '', required: true, type: 'jambonz_auth'},
+        callSid: {required: true},
+        callSidType: {value: 'msg'},
+        action: {value: 'hangup', required: true},
+        text: {value: '', validate: function(v) {
+          const action = $('#node-input-action').val();
+          return action !== 'whisper' || v.length > 0;
+        }},
+        vendor: {value: 'default'},
+        lang: {value: 'default'},
+        voice: {value: 'default'},
+        callHook: {value: '', validate: function(v) {
+          const action = $('#node-input-action').val();
+          return action !== 'redirect' || v.length > 0;
+        }},
+        callHookType: {value: 'str'},
+        waitHook: {value: '', validate: function(v) {
+          const action = $('#node-input-action').val();
+          return action !== 'hold_conf' || v.length > 0;
+        }},
+        waitHookType: {value: 'str'},
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { 
+        return this.name || (this.action ? `LCC - ${this.action}` : 'LCC');
+      },
+      oneditprepare: function() {
+        var node = this;
+        var actionElem = $('#node-input-action');
+        var vendorElem = $('#node-input-vendor');
+        var langElem = $('#node-input-lang');
+        var voiceElem = $('#node-input-voice');
+        var sayDiv = $('#say-options');
+        var redirectDiv = $('#redirect-options');
+        var waitHookDiv = $('#wait-options');
+        sayDiv.hide();
+        waitHookDiv.hide();
+
+        $('#node-input-callSid').typedInput({
+          default: $('#node-input-callSidType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-callSidType')
+        });
+        $('#node-input-callHook').typedInput({
+          default: $('#node-input-callHookType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-callHookType')
+        });
+        $('#node-input-waitHook').typedInput({
+          default: $('#node-input-waitHookType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-waitHookType')
+        });
+
+        var onActionChanged = function () {
+          node.action = actionElem.find(':selected').val();
+          if ('whisper' === node.action) sayDiv.show();
+          else sayDiv.hide();
+          if ('redirect' === node.action) redirectDiv.show();
+          else redirectDiv.hide();
+          if ('hold_conf' === node.action) waitHookDiv.show();
+          else waitHookDiv.hide();
+        }
+
+        var onVendorChanged = function() {
+          node.vendor = vendorElem.find(':selected').val();
+          console.log(`say vendor changed to ${node.vendor}`);
+          setLanguage(node.vendor);
+        }
+
+        var onLangChanged = function() {
+          node.lang = langElem.find(':selected').val();
+          console.log(`language changed to ${node.lang}`);
+          setVoice(node.vendor, node.lang)
+        }
+      
+        var onVoiceChanged = function() {
+          node.voice = voiceElem.find(':selected').val();
+          console.log(`voice changed to ${node.voice}`);
+        }
+
+        var setLanguage = function(v) {
+          langElem.find('option').remove();
+          voiceElem.find('option').remove();
+
+          switch (v) {
+            case 'default': 
+              langElem.append('<option value="default" selected>--application default--</option>');
+              voiceElem.append('<option value="default" selected>--application default--</option>');
+              node.lang = 'default';
+              node.voice = 'default';
+              break;
+
+            case 'google':
+              langElem.append(googleLanguageOptions);
+              break;
+
+            case 'aws':
+              langElem.append(awsLanguageOptions);
+              break;
+          }
+          langElem.val(node.lang);
+        }
+
+        var setVoice = function(vendor, lang) {
+          console.log(`say set voice for language ${lang} vendor ${vendor}`);
+          voiceElem.find('option').remove();
+
+          switch (vendor) {
+            case 'default':
+              voiceElem.append('<option value="default" selected>--application default--</option>');
+              break;
+
+            case 'google':
+            case 'aws':
+              var obj = 'google' === vendor ? mapGoogle[lang] : mapAws[lang];
+              if (obj) {
+                var options = '';
+                for (var i = 0; i < obj.voices.length; i++) {
+                  if (i) options += `<option value="${obj.voices[i].value}">${obj.voices[i].name}</option>`;
+                  else options += `<option value="${obj.voices[i].value}">${obj.voices[i].name}</option>`;
+                }
+                voiceElem.append(options);
+              }
+              break;
+          }
+          voiceElem.val(node.voice);
+        }
+
+        actionElem.change(onActionChanged);
+        vendorElem.change(onVendorChanged);
+        langElem.change(onLangChanged);
+        voiceElem.change(onVoiceChanged);
+      }
+  });
+
+</script>
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="lcc">
+    <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-server">Server</label>
+    <input type="text" id="node-input-server">
+  </div>
+  <div class="form-row">
+    <label for="node-input-callSid">CallSid</label>
+    <input type="text" id="node-input-callSid">
+    <input type="hidden" id="node-input-callSidType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-action">Action</label>
+    <select id="node-input-action">
+      <option value="hangup">hangup call</option>
+      <option value="mute">mute caller</option>
+      <option value="unmute">unmute caller</option>
+      <option value="mute_conf">mute conference participants</option>
+      <option value="unmute_conf">unmute conference participants</option>
+      <option value="hold_conf">hold conference participant</option>
+      <option value="unhold_conf">unhold conference participant</option>
+      <option value="pause">pause listen audio feed</option>
+      <option value="resume">resume listen audio feed</option>
+      <option value="redirect">redirect call</option>
+      <option value="whisper">whisper</option>
+    </select>
+  </div>
+  <div id="say-options">
+    <div class="form-row">
+      <label for="node-input-text">Text</label>
+      <textarea id="node-input-text" rows="4" placeholder="Text or SSML to whisper" style="width:70%"></textarea>
+    </div>
+    <fieldset>
+      <legend>Speech synthesis options</legend>
+      <div class="form-row">
+        <label for="node-input-vendor">Vendor</label>
+        <select id="node-input-vendor">
+          <option value="default" selected>--application default--</option>
+          <option value="google">google</option>
+          <option value="aws">aws/polly</option>
+        </select>
+      </div>
+      <div class="form-row">
+        <label for="node-input-lang">Language</label>
+        <select id="node-input-lang">
+          <option value="default" selected>--application default--</option>
+        </select>
+      </div>
+      <div class="form-row">
+        <label for="node-input-voice">Voice</label>
+        <select id="node-input-voice">
+          <option value="default" selected>--application default--</option>
+        </select>
+      </div>
+    </fieldset>
+  </div>
+  <div id="redirect-options">
+    <div class="form-row">
+      <label for="node-input-callHook">Call webhook</label>
+      <input type="text" id="node-input-callHook" placeholder="/path">
+      <input type="hidden" id="node-input-callHookType">
+    </div>  
+  </div>
+  <div id="wait-options">
+    <div class="form-row">
+      <label for="node-input-waitHook">Wait webhook</label>
+      <input type="text" id="node-input-waitHook" placeholder="/path">
+      <input type="hidden" id="node-input-waitHookType">
+    </div>  
+  </div>
+  </script>
+
+<!-- Help Text -->
+
+<script type="text/html" data-help-name="lcc">
+    <p>Perform Live Call Control</p>
+    <h3>Properties</h3>
+      <p><code>Server</code> - 
+       jambonz server to connect to</p>
+      <p><code>CallSid</code> - 
+       Call identifier</p>
+      <p><code>Action</code> - 
+       Action to perform on the call</p>
+      <p><code>Text</code> - 
+       Text to speak, only if action is 'whisper'</p>
+      <p><code>Vendor</code> - 
+       TTS vendor to use for whisper</p>
+      <p><code>Language</code> - 
+       TTS language to use for whisper</p>
+      <p><code>Voice</code> - 
+       TTS voice to use for whisper</p>
+     
+  
+  <h3>Details</h3>
+  The lcc command is used to perform live call control on a call in progress.
+  The call can be terminated, the caller can be muted or unmuted, or the live 
+  audio feed that is being sent via a <a href="https://docs.jambonz.org/jambonz/#listen">listen</a> verb can be paused or resumed.
+  <br/><br/>
+  A common use case is to use dtmf captures in a <a href="https://docs.jambonz.org/jambonz/#dial">dial</a> verb to call a webhook 
+  that then uses lcc to modify the state of the call.
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/rest/#updating-a-call">Jambonz reference</a></li>
+  </script>

package/src/nodes/lcc.js

@@ -0,0 +1,102 @@
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {v_resolve, doLCC} = require('./libs')
+
+module.exports = function(RED) {
+/** LCC */
+function lcc(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    const server = RED.nodes.getNode(config.server);
+
+    node.on('input', async(msg, send, done) => {
+      send = send || function() { node.send.apply(node, arguments);};
+
+      const {accountSid, apiToken} = server.credentials;
+      const url = server.url;
+      const callSid = v_resolve(config.callSid, config.callSidType, this.context(), msg);
+      if (!url || !accountSid || !apiToken || !callSid) {
+        node.log(`invalid / missing credentials or callSid, skipping LCC node: ${JSON.stringify(server.credentials)}`);
+        send(msg);
+        if (done) done();
+        return;
+      }
+
+      const opts = {};
+      switch (config.action) {
+        case 'hangup':
+          opts.call_status = 'completed';
+          break;
+        case 'mute':
+          opts.mute_status = 'mute';
+          break;
+        case 'unmute':
+          opts.mute_status = 'unmute';
+          break;
+        case 'mute_conf':
+          opts.conf_mute_status = 'mute';
+          break;
+        case 'unmute_conf':
+          opts.conf_mute_status = 'unmute';
+          break;
+        case 'pause':
+          opts.listen_status = 'pause';
+          break;
+        case 'resume':
+          opts.listen_status = 'resume';
+          break;
+        case 'redirect':
+          node.log(`LCC redirect callHook ${config.callHook} callHookType: ${config.callHookType}`);
+          opts.call_hook = {url: v_resolve(config.callHook, config.callHookType, this.context(), msg)};
+          break;
+        case 'hold_conf':
+          opts.conf_hold_status = 'hold';
+          opts.wait_hook = {url: v_resolve(config.waitHook, config.waitHookType, this.context(), msg)};
+          break;
+        case 'unhold_conf':
+          opts.conf_hold_status = 'unhold';
+        case 'whisper':
+          Object.assign(opts, {
+            whisper: {
+              verb: 'say',
+              text: config.text
+            }
+          });
+          if (['aws', 'google'].includes(config.vendor)) {
+            Object.assign(opts.whisper, {
+              synthesizer: {
+                vendor: config.vendor,
+                language: config.lang,
+                voice: config.voice
+              }
+            });
+          }
+          break;
+        default:
+          node.log(`invalid action: ${config.action}`);
+          send(msg);
+          if (done) done();
+          return;
+      }
+
+      try {
+        msg.payload = await doLCC(node, url, accountSid, apiToken, callSid, opts);
+        msg.statusCode = 202;
+      } catch (err) {
+        if (err.statusCode) msg.statusCode = err.statusCode;
+        else {
+          node.error(`Error sending LCC ${JSON.stringify(err)}`);
+          if (done) done(err);
+          else node.error(err, msg);
+          send(msg);
+          return;
+        }
+      }
+      send(msg);
+      if (done) done();
+    });
+  }
+  RED.nodes.registerType('lcc', lcc);
+}

package/src/nodes/leave.html

@@ -0,0 +1,40 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('leave',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'leave';}
+  });
+</script>
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="leave">
+    <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>
+  </script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="leave">
+    <p>transfer call out of queue</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>leave</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The leave verb transfers a call out of a queue. The call then returns to the flow of execution following the enqueue verb that parked the call, or the document returned by that verbs actionHook property, if provided.<h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/jambonz/#leave">Jambonz leave reference</a></li>
+    </ul>
+  </script>

package/src/nodes/leave.js

@@ -0,0 +1,21 @@
+
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {appendVerb} = require('./libs')
+
+
+module.exports = function(RED) {
+  function leave(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.on('input', function(msg, send, done) {
+      appendVerb(msg, {
+        verb: 'leave'
+      });
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('leave', leave);
+}