@jambonz/node-red-contrib-jambonz 2.4.12 → 2.4.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/node-red-contrib-jambonz",
-  "version": "2.4.12",
+  "version": "2.4.14",
   "description": "Node-RED nodes for jambonz platform",
   "keywords": [
     "node-red"
@@ -46,6 +46,7 @@
       "create sms": "src/nodes/create_sms.js",
       "lcc": "src/nodes/lcc.js",
       "get_alerts": "src/nodes/get_alerts.js",
+      "get_call": "src/nodes/get_call.js",
       "get_calls": "src/nodes/get_calls.js",
       "get_recent_calls": "src/nodes/get_recent_calls.js"
     }
@@ -53,7 +54,7 @@
   "author": "Dave Horton",
   "license": "MIT",
   "dependencies": {
-    "aws-sdk": "^2.1354.0",
+    "aws-sdk": "^2.1405.0",
     "bent": "^7.3.12",
     "body-parser": "^1.20.2",
     "cookie-parser": "^1.4.6",

package/src/nodes/conference.html

@@ -1,6 +1,6 @@
 <!-- Javascript -->
 <script type="text/javascript">
-    var mustacheType = {
+  var mustacheType = {
     value: 'mustache',
     label: 'mustache',
     hasvalue: true,
@@ -16,13 +16,17 @@
       conferenceType: {value: 'str'},
       beep: {value: false},
       endConferenceOnExit: {value: false},
-      startConferenceOnEnter: {value: false},
+      startConferenceOnEnter: {value: true},
       maxParticipants: {},
       maxParticipantsType: {value: 'num'},
       enterHook: {},
       enterHookType: {value: 'str'},
       waitHook: {},
       waitHookType: {value: 'str'},
+      actionHook: {},
+      actionHookType: {value: 'str'},
+      statusHook: {},
+      statusHookType: {value: 'str'},
       joinMuted : {value: false}
     },
     inputs:1,
@@ -48,6 +52,14 @@
         types: ['num', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
         typeField: $('#node-input-maxParticipantsType')
       });
+      $('#node-input-actionHook').typedInput({
+        types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+        typeField: $('#node-input-actionHookType')
+      });
+      $('#node-input-statusHook').typedInput({
+        types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+        typeField: $('#node-input-statusHookType')
+      });
     }
   });
 </script>
@@ -73,6 +85,16 @@
       <input type="text" id="node-input-waitHook" placeholder="webhook url">
       <input type="hidden" id="node-input-waitHookType">
     </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-statusHook">Status hook</label>
+      <input type="text" id="node-input-statusHook" placeholder="webhook url">
+      <input type="hidden" id="node-input-statusHookType">
+    </div>
     <div class="form-row">
       <label for="node-input-beep">Beep on entry</label>
       <input type="checkbox" id="node-input-beep">
@@ -86,7 +108,7 @@
       <input type="checkbox" id="node-input-endConferenceOnExit">
     </div>
     <div class="form-row">
-      <label for="node-input-joinMuted">Join Muted</label>
+      <label for="node-input-joinMuted">Join muted</label>
       <input type="checkbox" id="node-input-joinMuted">
     </div>
     <div class="form-row">
@@ -94,30 +116,31 @@
       <input type="text" id="node-input-maxParticipants">
       <input type="hidden" id="node-input-maxParticipantsType">
     </div>
-  </script>
+</script>
 
 <!-- Help Text -->
 <script type="text/html" data-help-name="conference">
-    <p>places a caller in a conference.</p>
-    <h3>Properties</h3>
-      <p><code>Conference Name </code> - The name of the conference to join the caller to.</p>
-      <p><code>Enter hook </code> - A webhook to retrieve something to play or say to the caller just before they are put into a conference after waiting for it to start</p>
-      <p><code>Wait hook </code> - A webhook to retrieve commands to play or say while the caller is waiting for the conference to start</p>
-      <p><code>Beep on entry</code> - if checked, play a beep tone to the conference when caller enters </p>
-      <p><code>Start on entry</code> - if checked, start the conference only when this caller enters</p>
-      <p><code>End on exit</code> - if checked, end the conference when this caller hangs up</p>
-      <p><code>Max participants</code> - maximum number of participants that will be allowed in the conference</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>conference</code> action appended  </dd>
-</dl>
-
-<h3>Details</h3>
-The conference verb places a call into a conference.
-<h3>References</h3>
+  <p>Places a caller in a conference.</p>
+  <h3>Properties</h3>
+  <p><code>Conference Name</code> - The name of the conference to join the caller to.</p>
+  <p><code>Enter hook</code> - A webhook to retrieve something to play or say to the caller just before they are put into a conference after waiting for it to start</p>
+  <p><code>Wait hook</code> - A webhook to retrieve commands to play or say while the caller is waiting for the conference to start</p>
+  <p><code>Action hook</code> - A webhook to call when the conference ends</p>
+  <p><code>Status hook</code> - A webhook to call with conference status events</p>
+  <p><code>Beep on entry</code> - If checked, play a beep tone to the conference when caller enters </p>
+  <p><code>Start on entry</code> - If checked, start the conference only when this caller enters</p>
+  <p><code>End on exit</code> - If checked, end the conference when this caller hangs up</p>
+  <p><code>Max participants</code> - Maximum number of participants that will be allowed in the conference</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>conference</code> action appended  </dd>
+  </dl>
+  <h3>Details</h3>
+  The conference verb places a call into a conference.
+  <h3>References</h3>
   <ul>
-      <li><a href="https://www.jambonz.org/docs/webhooks/conference/">Jambonz conference reference</a></li>
+    <li><a href="https://www.jambonz.org/docs/webhooks/conference/">Jambonz conference reference</a></li>
   </ul>
 </script>
 

package/src/nodes/conference.js

@@ -6,17 +6,20 @@ module.exports = function(RED) {
     RED.nodes.createNode(this, config);
     var node = this;
     node.on('input', function(msg) {
-      var maxParticipants = new_resolve(RED, config.maxParticipants, config.maxParticipantsType, node, msg)
+      var statusHook = new_resolve(RED, config.statusHook, config.statusHookType, node, msg);
       appendVerb(msg, {
         verb: 'conference',
         name: new_resolve(RED, config.conference, config.conferenceType, node, msg),
         enterHook: new_resolve(RED, config.enterHook, config.enterHookType, node, msg),
         waitHook: new_resolve(RED, config.waitHook, config.waitHookType, node, msg),
-        maxParticipants,
+        actionHook: new_resolve(RED, config.actionHook, config.actionHookType, node, msg),
+        statusHook,
+        ...(statusHook && { statusEvents: ['start', 'end', 'join', 'leave'] }),
+        maxParticipants: new_resolve(RED, config.maxParticipants, config.maxParticipantsType, node, msg),
         beep: config.beep,
         startConferenceOnEnter: config.startConferenceOnEnter,
-        endOnExit: config.endOnExit,
-        joinMuted : config.joinMuted
+        endConferenceOnExit: config.endConferenceOnExit,
+        joinMuted: config.joinMuted
       });
       node.send(msg);
     });

package/src/nodes/create_call.html

@@ -18,10 +18,15 @@
         to: {value: '', required: true},
         toType: {value: ''},
         dest: {value: 'phone', required: true},
-        timeout: {},
+        timeout: {validate: RED.validators.regex(/^\d*$/) },
+        tag: {required: true},
+        tagType: {value: 'json'},
         application: {value: ''},
         appName: {},
         mode: {value: 'app'},
+        callername: {value: ''},
+        callernameType: {value: ''},
+        headers: {value: []},
         call_hook_url : {},
         call_hook_urlType : {value: 'str'},
         call_hook_method : {value : 'GET'},
@@ -84,6 +89,15 @@
           types: ['str','msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
           typeField: $('#node-input-call_status_urlType')
         });
+        $('#node-input-callername').typedInput({
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-callernameType')
+        });
+        $('#node-input-tag').typedInput({
+          default: $('#node-input-tagType').val(),
+          types: ['json', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-tagType')
+        });
 
         var populateApplications = function() {
           var serverId = $('#node-input-server option:selected').val();
@@ -127,6 +141,60 @@
 
           }
         });
+        $('#node-input-headers-container').css('min-height','120px').css('min-width','450px').editableList({
+          addItem: function(container, i, opt) {
+            var header = opt;
+            if (!header.hasOwnProperty('h')) {
+                header = {h: '', v: ''};
+            }
+            container.css({
+              overflow: 'hidden',
+              whiteSpace: 'nowrap'
+            });
+            let fragment = document.createDocumentFragment();
+            var row1 = $('<div/>',{style:"display:flex;"}).appendTo(fragment);
+            $('<input/>', {
+              class:"node-input-header-property-name", 
+              type:"text", 
+              placeholder: 'SIP Header'
+            })
+              .appendTo(row1);
+            $('<input/>', {
+              class:"node-input-value-property-name", 
+              type:"text", 
+              placeholder: 'value'
+            })
+              .appendTo(row1);
+            row1.find('.node-input-header-property-name').val(header.h);
+            row1.find('.node-input-value-property-name').val(header.v);
+            container[0].appendChild(fragment);
+          },
+          removable: true
+        });
+        if (!this.headers) {
+          var header = {
+            h: '',
+            v: '',
+          };
+          this.headers = [header];
+        }
+        for (var i=0; i < this.headers.length; i++) {
+            var header = this.headers[i];
+            $("#node-input-headers-container").editableList('addItem', header);
+        }
+      },
+      oneditsave: function () {
+        var node = this;
+        var headers = [];
+        $("#node-input-headers-container").editableList('items').each(function(i) {
+          var header = $(this);
+          var h = header.find(".node-input-header-property-name").val();
+          var v = header.find(".node-input-value-property-name").val();
+          var obj = {};
+          obj[h] = v;
+          headers.push({h, v});
+        });
+        node.headers = headers;
       }
   });
 </script>
@@ -146,6 +214,11 @@
     <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-callername">From name</label>
+    <input type="text" id="node-input-callername" placeholder="calling party name">
+    <input type="hidden" id="node-input-callernameType">
+  </div>
   <div class="form-row">
     <label for="node-input-to">To</label>
     <input type="text" id="node-input-to" placeholder="called party info">
@@ -163,7 +236,11 @@
   <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-tag">Tag data</label>
+    <input type="text" id="node-input-tag" placeholder="tag object">
+    <input type="hidden" id="node-input-tagType">
   </div>
   <div class="form-row">
     <label for="node-input-application">Connect to</label>
@@ -179,6 +256,15 @@
       </select>
     </div>
   </div>
+  <fieldset>
+    <legend>SIP Headers</legend>
+    <div class="form-row" style="margin-bottom:0;">
+      <label style="width:100%"><i class="fa fa-list"></i> <span>Add custom headers</span></label>
+    </div>
+    <div class="form-row node-input-headers-container-row">
+        <ol id="node-input-headers-container"></ol>
+    </div>
+  </fieldset>
   <div id="url-options">
     <fieldset>
       <legend>Webhook options</legend>
@@ -267,8 +353,10 @@
   <h3>Properties</h3>
     <p><code>Server</code> - Jambonz server to connect to</p>
     <p><code>From</code> - Calling party phone number</p>
+    <p><code>From name</code> - Calling party name</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>Tag data</code> - Initial set of customer-supplied metadata to associate with the call</p>
     <p><code>Application</code> - Application to execute when call is answered</p>
     <p><code>Webhooks</code> - Webhooks to execute when call is answered</p>
 

package/src/nodes/create_call.js

@@ -19,16 +19,30 @@ module.exports = function(RED) {
         return;
       }
 
-      var from = new_resolve(RED, config.from, config.fromType, node, msg)
-      var to =   new_resolve(RED, config.to, config.toType, node, msg)
+      var from = new_resolve(RED, config.from, config.fromType, node, msg);
+      var to = new_resolve(RED, config.to, config.toType, node, msg);
+      var tag = new_resolve(RED, config.tag, config.tagType, node, msg);
 
       const opts = {
         from,
         to: {
           type: config.dest
         },
+        tag
       };
 
+      if (config.headers) {
+        var headers = {};
+        config.headers.forEach(function(h) {
+          if (h.h.length && h.v.length) headers[h.h] = h.v;
+        });
+        Object.assign(opts, {headers});
+      }
+
+      if (config.callername) {
+        opts.callerName = new_resolve(RED, config.callername, config.callernameType, node, msg);
+      }
+
       switch (config.mode) {
         case 'app':
           opts.application_sid = config.application;
@@ -54,6 +68,7 @@ module.exports = function(RED) {
         const timeout = parseInt(config.timeout);
         if (timeout > 0) opts.timeout = timeout;
       }
+
       switch (config.dest) {
         case 'phone':
           opts.to.number = to;

package/src/nodes/get_call.html

@@ -0,0 +1,57 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  var mustacheType = {
+    value: 'mustache',
+    label: 'mustache',
+    hasvalue: true,
+    icon: 'resources/@jambonz/node-red-contrib-jambonz/icons/mustache.svg'
+  }
+  RED.nodes.registerType('get_call', {
+      category: 'jambonz',
+      color: '#aebfb9',
+      defaults: {
+        name: {value: ''},
+        server: {value: '', required: true, type: 'jambonz_auth'},
+        callSid: {value: '', validate: function(v) {
+          return v.length > 0;
+        }},
+        callSidType:{value: 'str'},
+      },
+      inputs: 1,
+      outputs: 1,
+      icon: "font-awesome/fa-cubes",
+      paletteLabel: "Get - Call",
+      label: function() { return this.name || 'Get Call';},
+      oneditprepare: () => {
+        $('#node-input-callSid').typedInput({
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
+          typeField: $('#node-input-callSidType')
+        });
+      }
+  });
+</script>
+
+<!-- HTML -->
+<script type="text/html" data-template-name="get_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-callSid">CallSid</label>
+          <input type="text" id="node-input-callSid">
+          <input type="hidden" id="node-input-callSidType">
+        </div>
+</script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="get_call">
+      <p>Get call</p>
+
+      <h3>Details</h3>
+      Retrieve info for a single call under an account.
+</script>

package/src/nodes/get_call.js

@@ -0,0 +1,45 @@
+const bent = require("bent");
+var { new_resolve} = require("./libs");
+
+module.exports = function (RED) {
+  function get_call(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    const server = RED.nodes.getNode(config.server);
+    const { accountSid, apiToken } = server.credentials;
+    node.on("input", async (msg, send, done) => {
+      const callSid = new_resolve(RED, config.callSid, config.callSidType, node, msg);
+      if (!callSid) {
+        if (done) done(new Error('CallSid empty'));
+          else node.error(new Error('CallSid empty'), msg);
+        return;
+      }
+      const req = bent(
+        `${server.url}/v1/Accounts/${accountSid}/Calls/${callSid}`,
+        'GET',
+        'json',
+        {
+          Authorization: `Bearer ${apiToken}`,
+        }
+      );
+      try {
+        const res = await req();
+        msg.payload = res;
+      } catch (err) {
+        if (err.statusCode) {
+          node.error(`GetCall failed with ${err.statusCode}`);
+          msg.statusCode = err.statusCode;
+        } else {
+          node.error(`Error getting call info ${JSON.stringify(err)}`);
+          if (done) done(err);
+          else node.error(err, msg);
+          send(msg);
+          return;
+        }
+      }
+      send(msg);
+      if (done) done();
+    });
+  }
+  RED.nodes.registerType("get_call", get_call);
+};