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

package/src/nodes/create_call.html

@@ -0,0 +1,287 @@
+<!-- Javascript -->
+<script type="text/javascript">
+ RED.nodes.registerType('create-call',{
+      category: 'jambonz',
+      color: '#aebfb9',
+      defaults: {
+        name: {value: ''},
+        server: {value: '', required: true, type: 'jambonz_auth'},
+        from: {value: '', required: true},
+        fromType: {value: ''},
+        to: {value: '', required: true},
+        toType: {value: ''},
+        dest: {value: 'phone', required: true},
+        timeout: {},
+        application: {value: ''},
+        appName: {},
+        mode: {value: 'app'},
+        call_hook_url : {},
+        call_hook_urlType : {value: 'str'},
+        call_hook_method : {value : 'GET'},
+        call_status_url : {},
+        call_status_urlType : {value: 'str'},
+        call_status_method :  {value : 'GET'},
+        vendor: {value: 'default', validate : function (v) {
+          console.log(v)
+          if ( v == null &&  $('#node-input-mode').val() == 'url'){
+            return(false)
+          } else {
+            return(true)
+          }
+        }},
+        lang: {value: 'default'},
+        xlang: {},
+        voice: {value: 'default'},
+        xvoice: {},
+        transcriptionvendor: {value: 'default', validate : function (v) {
+          console.log(v)
+          if ( v == null &&  $('#node-input-mode').val() == 'url'){
+            return(false)
+          } else {
+            return(true)
+          }
+        }},
+        recognizerlang: {value: 'default'}
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { 
+        return this.name || 'create call';
+      },
+      oneditprepare: function() {
+        var node = this;
+        var destElem = $('#node-input-dest');
+        var serverElem = $('#node-input-server');
+        var applicationElem = $('#node-input-application');
+        prepareTtsControls(node);
+        prepareSttControls(node);
+
+
+        $('#node-input-from').typedInput({
+          default: $('#node-input-fromType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-fromType')
+        });
+        $('#node-input-to').typedInput({
+          default: $('#node-input-toType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-toType')
+        });
+        $('#node-input-call_hook_url').typedInput({
+          default: $('#node-input-call_hook_urlType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-call_hook_urlType')
+        });
+        $('#node-input-call_status_url').typedInput({
+          default: $('#node-input-call_status_urlType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-call_status_urlType')
+        });
+
+        var populateApplications = function() {
+          var serverId = $('#node-input-server option:selected').val();
+            $.ajax({
+              url: `_jambonz/applications/${serverId}`,
+              dataType: 'json',
+              timeout: 500,
+              error: (err) => {
+                console.log(err);
+              },
+              success: (res) => {
+                applicationElem.find('option').remove();
+                var options = '';
+                res.forEach((app) => {
+                  if (node.application === app.application_sid) {
+                    options += `<option value="${app.application_sid}" selected>${app.name}</option>`;
+                    node.appName = app.name;
+                  }
+                  else {
+                    options += `<option value="${app.application_sid}">${app.name}</option>`;
+                  }
+                });
+                if (options.length) applicationElem.append(options);
+              }
+            });
+          }
+        serverElem.change(populateApplications);
+        applicationElem.change(() => {
+          node.appName = $('#node-input-application option:selected').text();
+        });
+        $('#url-options').hide();
+        $('#node-input-mode').change(function() {
+          const mode = $('#node-input-mode').val();
+          if (mode == 'app') {
+            $('#app-options').show();
+            $('#url-options').hide();
+          }
+          else {
+            $('#app-options').hide();
+            $('#url-options').show();
+
+          }
+        });
+      }
+  });
+</script>
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="create-call">
+    <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-from">From</label>
+    <input type="text" id="node-input-from" placeholder="calling party number">
+    <input type="hidden" id="node-input-fromType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-to">To</label>
+    <input type="text" id="node-input-to" placeholder="called party info">
+    <input type="hidden" id="node-input-toType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-dest">Call type</label>
+    <select id="node-input-dest">
+      <option value="phone">phone number</option>
+      <option value="user">registered sip device/user</option>
+      <option value="sip">sip endpoint</option>
+      <option value="ms-teams">Microsoft teams</option>
+    </select>
+  </div>
+  <div class="form-row">
+    <label for="node-input-timeout">Ring timeout</label>
+    <input type="text" id="node-input-timeout" placeholder="ring no answer timeout in secs (default: 60)">
+    <input type="hidden" id="node-input-timeoutType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-application">Connect to</label>
+    <select id="node-input-mode">
+      <option value="app">Application</option>
+      <option value="url">Webhooks</option>
+    </select>
+  </div>
+  <div id="app-options">
+    <div class="form-row">
+      <label for="node-input-application">Application</label>
+      <select id="node-input-application">
+      </select>
+    </div>
+  </div>
+  <div id="url-options">
+    <fieldset>
+      <legend>Webhook options</legend>
+    <div class="form-row">
+      <label for="node-input-call_hook_url">Call Hook URL</label>
+      <input type="text" id="node-input-call_hook_url" placeholder="https://example.com/answer">
+      <input type="hidden" id="node-input-call_hook_urlType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-call_hook_method">Method</label>
+      <select id="node-input-call_hook_method">
+        <option value="GET">GET</option>
+        <option value="POST">POST</option>
+      </select>
+    </div>
+    <div class="form-row">
+      <label for="node-input-call_status_url">Call Status URL</label>
+      <input type="text" id="node-input-call_status_url" placeholder="https://example.com/status">
+      <input type="hidden" id="node-input-call_status_urlType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-call_status_method">Method</label>
+      <select id="node-input-call_status_method">
+        <option value="GET">GET</option>
+        <option value="POST">POST</option>
+      </select>
+    </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 disabled>--Select Vendor--</option>
+          <option value="google">google</option>
+          <option value="aws">aws/polly</option>
+          <option value="microsoft">microsoft</option>
+          <option value="ibm">ibm</option>
+          <option value="nuance">nuance</option>
+        </select>
+      </div>
+      <div class="form-row" style="display: none;">
+        <label for="node-input-lang"> Lang</label>
+        <input type="text" id="node-input-lang">
+      </div>
+      <div class="form-row">
+        <label for="node-input-xlang">Language</label>
+        <select id="node-input-xlang">
+        </select>
+      </div>
+      <div class="form-row" style="display: none;">
+        <label for="node-input-voice"> Voice</label>
+        <input type="text" id="node-input-voice">
+      </div>
+      <div class="form-row">
+        <label for="node-input-xvoice">Voice</label>
+        <select id="node-input-xvoice">
+        </select>
+      </div>
+      <legend>Transcription options</legend>
+      <div id="speech-input-container">
+        <div class="form-row">
+          <label for="node-input-transcriptionvendor">Vendor</label>
+          <select id="node-input-transcriptionvendor">
+            <option value="default" selected disabled>--Select Vendor--</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-recognizerlang"><i class="icon-tag"></i> Language</label>
+          <select id="node-input-recognizerlang">
+          </select>
+        </div>
+    </fieldset>
+  </div>
+  
+  
+  </script>
+
+<!-- Help Text -->
+
+<script type="text/html" data-help-name="create-call">
+  <p>Create an outbound call</p>
+  <h3>Properties</h3>
+    <p><code>Server</code> -jambonz server to connect to</p>
+    <p><code>From</code> - Calling party phone number</p>
+    <p><code>To</code> - Called party phone number, or other identifier</p>
+    <p><code>Call type</code> - Type of destination: phone number, registered user, sip endpoint, or microsoft teams</p>
+    <p><code>Application</code> - Application to execute when call is answered</p>
+  
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+   <dt>statusCode<span class="property-type">int</span></dt>
+   <dd> <code>msg.statusCode</code> will contain the response code from Jambomnz to the createCall request</dd>
+   <dt>callSid<span class="property-type">string</span></dt>
+   <dd> <code>msg.callSid</code> will contain the SID of the call that was created</dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The create call command is used to generate a new outbound call.  
+  When the call is answered the specified application's call hook will be invoked.
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/rest/#create-a-call">Jambonz reference</a></li>
+    </ul>
+  </script>

package/src/nodes/create_call.js

@@ -0,0 +1,104 @@
+var {createHash} = require('crypto');
+var mustache = require('mustache');
+const { toNamespacedPath } = require('path');
+mustache.escape = function(text) {return text;};
+var {v_resolve, doCreateCall, } = require('./libs')
+
+module.exports = function(RED) {
+ /** Create call */
+ function create_call(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
+      if (!url || !accountSid || !apiToken) {
+        node.error(`invalid / missing credentials, skipping create-call node: ${JSON.stringify(server.credentials)}`);
+        send(msg);
+        if (done) done();
+        return;
+      }
+
+      var from = v_resolve(config.from, config.fromType, this.context(), msg);
+      var to = v_resolve(config.to, config.toType, this.context(), msg);
+
+      const opts = {
+        from,
+        to: {
+          type: config.dest
+        },
+      };
+
+      switch (config.mode) {
+        case 'app':
+          opts.application_sid =  config.application 
+          break
+        case 'url':
+          opts.call_hook = {
+            url: config.call_hook_url,
+            method: config.call_hook_method
+          }
+          opts.call_status_hook = {
+            url: config.call_status_url,
+            method: config.call_status_method
+          }
+          opts.speech_synthesis_vendor = config.vendor
+          opts.speech_synthesis_language = config.lang
+          opts.speech_synthesis_voice = config.voice
+          opts.speech_recognizer_vendor = config.transcriptionvendor
+          opts.speech_recognizer_language = config.recognizerlang
+          break
+      }
+
+      if (config.timeout) {
+        const timeout = parseInt(config.timeout);
+        if (timeout > 0) opts.timeout = timeout;
+      }
+      switch (config.dest) {
+        case 'phone':
+          opts.to.number = to;
+          break;
+        case 'user':
+          opts.to.name = to;
+          break;
+        case 'sip':
+          opts.to.sipUri = to;
+          break;
+        case 'ms-teams':
+          opts.to.user = to;
+          break;
+        default:
+          if (done) done(`unknown dest type ${config.dest}`);
+          else node.error(`unknown dest type ${config.dest}`, msg);
+          send(msg);
+          return;
+      }
+      node.log(JSON.stringify(opts))
+      try {
+        const res = await doCreateCall(url, accountSid, apiToken, opts);
+        msg.statusCode = 202;
+        msg.callSid = res.sid;
+      } catch (err) {
+        if (err.statusCode) {
+          console.log(JSON.stringify(err))
+          node.error(`create-call failed with ${err.statusCode}`);
+          msg.statusCode = err.statusCode;
+        }
+        else {
+          node.error(`Error sending create all ${JSON.stringify(err)}`);
+          if (done) done(err);
+          else node.error(err, msg);
+          send(msg);
+          return;
+        }
+      }
+      send(msg);
+      if (done) done();
+    });
+  }
+  RED.nodes.registerType('create-call', create_call);
+}

package/src/nodes/create_sms.html

@@ -0,0 +1,106 @@
+<!-- Javascript -->
+<script type="text/javascript">
+ RED.nodes.registerType('create-sms',{
+      category: 'jambonz',
+      color: '#aebfb9',
+      defaults: {
+        name: {value: ''},
+        server: {value: '', required: true, type: 'jambonz_auth'},
+        from: {value: '', required: true},
+        fromType: {value: ''},
+        to: {value: '', required: true},
+        toType: {value: ''},
+        text: {value: '', required: true},
+        textType: {value: ''},
+        provider: {value: ''},
+        providerType: {value: ''},
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { 
+        return this.name || 'create sms';
+      },
+      oneditprepare: function() {
+        var node = this;
+
+        $('#node-input-from').typedInput({
+          default: $('#node-input-fromType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-fromType')
+        });
+        $('#node-input-to').typedInput({
+          default: $('#node-input-toType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-toType')
+        });
+        $('#node-input-text').typedInput({
+          default: $('#node-input-textType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-textType')
+        });
+        $('#node-input-provider').typedInput({
+          default: $('#node-input-providerType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-providerType')
+        });
+      }
+  });
+
+</script>
+
+
+<!-- HTML -->
+
+<script type="text/html" data-template-name="create-sms">
+    <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-from">From</label>
+    <input type="text" id="node-input-from" placeholder="sending number">
+    <input type="hidden" id="node-input-fromType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-to">To</label>
+    <input type="text" id="node-input-to" placeholder="destination number">
+    <input type="hidden" id="node-input-toType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-text">Text</label>
+    <input type="text" id="node-input-text" placeholder="Text">
+    <input type="hidden" id="node-input-textType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-provider">SMS Provider</label>
+    <input type="text" id="node-input-provider">
+    <input type="hidden" id="node-input-providerType">
+  </div>
+  </script>
+  
+
+<!-- Help Text -->
+
+<script type="text/html" data-help-name="create-sms">
+    <p>Send an SMS</p>
+    <h3>Properties</h3>
+    <p><code>Server</code> -  jambonz server to connect to</p>
+    <p><code>From</code> -  Sending party phone number</p>
+    <p><code>To</code> -  Destination phone number</p>
+    <p><code>Text</code> - Text message</p>
+
+  
+  <h3>Details</h3>
+  The create message command is used to send an SMS message.  
+  <!--
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/rest/#create-a-call">Jambonz reference</a></li>
+    </ul>
+  -->
+  </script>

package/src/nodes/create_sms.js

@@ -0,0 +1,65 @@
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {v_resolve, doCreateMessage} = require('./libs')
+
+
+module.exports = function(RED) {
+/** Create sms */
+function create_sms(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
+      if (!url || !accountSid || !apiToken) {
+        node.log(`invalid / missing credentials, skipping create-message node: ${JSON.stringify(server.credentials)}`);
+        send(msg);
+        if (done) done();
+        return;
+      }
+
+      var from = v_resolve(config.from, config.fromType, this.context(), msg);
+      var to = v_resolve(config.to, config.toType, this.context(), msg);
+      var text = v_resolve(config.text, config.textType, this.context(), msg);
+      var provider = v_resolve(config.provider, config.providerType, this.context(), msg);
+
+      const opts = {
+        from,
+        to,
+        text,
+        provider
+      };
+
+      try {
+        node.log(`sending create message ${JSON.stringify(opts)}`);
+        const res = await doCreateMessage(url, accountSid, apiToken, opts);
+        msg.statusCode = 202;
+        msg.messageSid = res.sid;
+        msg.providerResponse = res.providerResponse;
+        node.log(`successfully launched call with messageSid ${msg.messageSid}`);
+      } catch (err) {
+        if (err.statusCode) {
+          node.log(`create_message failed with ${err.statusCode}`);
+          msg.statusCode = err.statusCode;
+        }
+        else {
+          node.log(`Error sending create message ${JSON.stringify(err)}`);
+          if (done) done(err);
+          else node.error(err, msg);
+          send(msg);
+          return;
+        }
+      }
+      send(msg);
+      if (done) done();
+    });
+  }
+  RED.nodes.registerType('create-sms', create_sms);
+
+}

package/src/nodes/dequeue.html

@@ -0,0 +1,102 @@
+<!-- Javascript -->
+<script type="text/javascript">
+RED.nodes.registerType('dequeue',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        queue: {required: true, value: ''},
+        queueType: {value: 'str'},
+        actionHook: {},
+        actionHookType: {value: 'str'},
+        confirmHook: {},
+        confirmHookType: {value: 'str'},
+        beep: {value: false},
+        timeout: {},
+        timeoutType: {value: 'num'}
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { 
+        return this.name || 'dequeue';
+      },
+      oneditprepare: function() {
+        $('#node-input-queue').typedInput({
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-queueType')
+        });
+        $('#node-input-actionHook').typedInput({
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-actionHookType')
+        });
+        $('#node-input-confirmHook').typedInput({
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-confirmHookType')
+        });
+        $('#node-input-timeout').typedInput({
+          types: ['num', 'msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-timeoutType')
+        });
+      }
+  });
+</script>
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="dequeue">
+    <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-queue">Queue name</label>
+      <input type="text" id="node-input-queue" placeholder="name of queue to remove caller from">
+      <input type="hidden" id="node-input-queueType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-beep">Play beep on connecting</label>
+      <input type="checkbox" id="node-input-beep">
+    </div>
+    <div class="form-row">
+      <label for="node-input-actionHook">Action hook</label>
+      <input type="text" id="node-input-actionHook" placeholder="webhook url">
+      <input type="hidden" id="node-input-actionHookType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-confirmHook">Confirm hook</label>
+      <input type="text" id="node-input-confirmHook" placeholder="webhook url">
+      <input type="hidden" id="node-input-confirmHookType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-timeout">Timeout</label>
+      <input type="text" id="node-input-timeout" placeholder="seconds to wait if queue is empty">
+      <input type="hidden" id="node-input-timeoutType">
+    </div>
+  </script>
+  
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="dequeue">
+    <p>removes the a call from the front of a queue and bridges that call to the current caller.</p>
+    <h3>Properties</h3>
+    <p><code>Queue name</code> -  Name of the queue.</p>
+    <p><code>Play beep on connecting</code> -  Play a beep tone to this caller only just prior to connecting the queued call.</p>
+    <p><code>Action hook</code> - A webhook invoke when call ends.</p>
+    <p><code>Confirm hook</code> - A webhook for an application to run on the callee's end before the call is bridged.</p>
+    <p><code>Timeout</code> - number of seconds to wait on an empty queue before returning.</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>dequeue</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The dequeue verb removes the a call from the front of a specified queue and bridges that call to the current caller.
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/jambonz/#dequeue">Jambonz dequeue reference</a></li>
+    </ul>
+  </script>