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

package/src/nodes/dtmf.html

@@ -13,7 +13,6 @@
           icon: "font-awesome/fa-cubes",
           label: function() { return this.name || 'dtmf';},
           oneditprepare: function() {
-            
             $('#node-input-dtmf').typedInput({
               default: $('#node-input-dtmfType').val(),
               types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
@@ -26,10 +25,8 @@
             })
           }
     });
-
 </script>
 
-
 <!-- HTML -->
 <script type="text/html" data-template-name="dtmf">
     <div class="form-row">
@@ -49,26 +46,23 @@
   </script>
 
 <!-- Help Text -->
-<script type="text/html" data-help-name="play">
+<script type="text/html" data-help-name="dtmf">
     <p>generates a string of dtmf digit signals</p>
     <h3>Properties</h3>
     <p><code>DTMF</code> - a string containing a sequence of dtmf digits (0-9,*,#)</p>
     <p><code>Duration</code> - 	the length of each digit, in milliseconds, Defaults to 500</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>play</code> action appended  </dd>
+    <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>play</code> action appended  </dd>
   </dl>
   
   <h3>Details</h3>
   The dtmf action generates a string of dtmf digit signals. These are sent as RTP payloads using RFC 2833.
 
-
-  
   <h3>References</h3>
     <ul>
-        <li><a href="https://www.jambonz.org/docs/webhooks/dtmf/">Jambonz play reference</a></li>
+        <li><a href="https://www.jambonz.org/docs/webhooks/dtmf/">Jambonz dtmf reference</a></li>
     </ul>
-  </script>
+</script>

package/src/nodes/dtmf.js

@@ -1,10 +1,5 @@
-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 dtmf(config) {
     RED.nodes.createNode(this, config);

package/src/nodes/enqueue.html

@@ -1,6 +1,4 @@
 <!-- Javascript -->
-
-
 <script type="text/javascript">
     RED.nodes.registerType('enqueue',{
       category: 'jambonz',
@@ -35,12 +33,9 @@
         });
       }
   });
-
 </script>
 
-
 <!-- HTML -->
-
 <script type="text/html" data-template-name="enqueue">
     <div class="form-row">
       <label for="node-input-name"><i class="icon-tag"></i> Name</label>
@@ -64,27 +59,25 @@
   </script>
 
 <!-- Help Text -->
-
 <script type="text/html" data-help-name="enqueue">
     <p>places a caller in a queue.</p>
     <h3>Properties</h3>
       <p><code>Queue name</code> - 
-       The name of the queue</p>
+        The name of the queue</p>
       <p><code>Action hook</code> - 
-       A webhook invoke when operation completes.</p>
+        A webhook invoke when operation completes.</p>
       <p><code>Wait hook</code> - 
-       A webhook to invoke while the caller is in queue. The only allowed verbs in the application returned from this webhook are say, play, pause, and leave,.</p>
-   
+        A webhook to invoke while the caller is in queue. The only allowed verbs in the application returned from this webhook are say, play, pause, and leave,.</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>enqueue</code> action appended  </dd>
+    <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>enqueue</code> action appended  </dd>
   </dl>
   
   <h3>Details</h3>
   The enqueue command is used to place a caller in a queue.
   <h3>References</h3>
     <ul>
-        <li><a href="https://docs.jambonz.org/jambonz/#enqueue">Jambonz enqueue reference</a></li>
+        <li><a href="https://www.jambonz.org/docs/webhooks/enqueue/">Jambonz enqueue reference</a></li>
     </ul>
-  </script>
+</script>

package/src/nodes/enqueue.js

@@ -1,10 +1,5 @@
-var {createHash} = require('crypto');
-const bent = require('bent');
-var mustache = require('mustache');
-mustache.escape = function(text) {return text;};
 var {appendVerb, v_resolve} = require('./libs')
 
-
 module.exports = function(RED) {
   /** enqueue */
   function enqueue(config) {
@@ -21,5 +16,4 @@ module.exports = function(RED) {
     });
   }
   RED.nodes.registerType('enqueue', enqueue);
-
 }

package/src/nodes/gather.html

@@ -1,6 +1,4 @@
 <!-- Javascript -->
-
-
 <script type="text/javascript">
   RED.nodes.registerType('gather',{
       category: 'jambonz',
@@ -113,12 +111,9 @@
         $('#node-input-prompttype').change(onSayPlayChanged);
       }
   });
-
 </script>
 
-
 <!-- HTML -->
-
 <script type="text/html" data-template-name="gather">
     <div class="form-row">
       <label for="node-input-name"><i class="icon-tag"></i> Name</label>
@@ -276,7 +271,7 @@
       </div>
     </div>
   </fieldset>
-  </script>
+</script>
 
 <!-- Help Text -->
 <script type="text/html" data-help-name="gather">
@@ -315,8 +310,12 @@
   
     <h3>Details</h3>
     The gather command is used to collect dtmf or speech input.
+
+    Within the text field you can use mustache syntax to insert properties of the msg, flow or global objects.
+    For example if you wanted to insert the value of msg.payload into the text you could put
+    <code>The payload is {{msg.payload}}</code>
     <h3>References</h3>
       <ul>
-          <li><a href="https://docs.jambonz.org/jambonz/#gather">Jambonz gather reference</a></li>
+          <li><a href="https://www.jambonz.org/docs/webhooks/gather/">Jambonz gather reference</a></li>
       </ul>
-  </script>
+</script>

package/src/nodes/gather.js

@@ -1,10 +1,5 @@
-var {createHash} = require('crypto');
-const bent = require('bent');
-var mustache = require('mustache');
-mustache.escape = function(text) {return text;};
 var {appendVerb, v_resolve, v_text_resolve} = require('./libs')
 
-
 module.exports = function(RED) {
   /** gather */
   function gather(config) {

package/src/nodes/get_alerts.html

@@ -1,8 +1,6 @@
 <!-- Javascript -->
-
-
 <script type="text/javascript">
- RED.nodes.registerType('get_alerts',{
+RED.nodes.registerType('get_alerts',{
       category: 'jambonz',
       color: '#aebfb9',
       defaults: {
@@ -13,7 +11,7 @@
         count:{value: 25},
         countType:{value: 'num'},
         days:{value: 7},
-        countType:{value: 'num'}
+        daysType:{value: 'num'}
       },
       inputs:1,
       outputs:1,
@@ -36,13 +34,9 @@
         });
       }
   });
-
-
 </script>
 
-
 <!-- HTML -->
-
 <script type="text/html" data-template-name="get_alerts">
         <div class="form-row">
           <label for="node-input-name"><i class="icon-tag"></i> Name</label>
@@ -67,28 +61,12 @@
           <input type="text" id="node-input-days" >
           <input type="hidden" id="node-input-daysType">
         </div>
-
-  
 </script>
 
 <!-- Help Text -->
-
 <script type="text/html" data-help-name="get_alerts">
-        <p>DESCRIPTION</p>
-      <h3>Properties</h3>
-          <p><code>XXXX</code> - TEXT</p>
-        
-      <h3>Outputs</h3>
-       <dl class="message-properties">
-         <dt>payload<span class="property-type">object</span></dt>
-         <dd> <code>msg.payload</code> will contain ...  </dd>
-       </dl>
-      
-      <h3>Details</h3>
-      The listen verb establishes a connection to a websocket server and sends live audio for the current call.<h3>References</h3>
-        <ul>
-            <li><a href="https://docs.jambonz.org/jambonz/#listen">Jambonz listen reference</a></li>
-        </ul>
-      </script>
+      <p>Get alerts</p>
 
+      <h3>Details</h3>
+      Retrieve alerts for a specified account
 </script>

package/src/nodes/get_alerts.js

@@ -1,8 +1,5 @@
-var {createHash} = require('crypto');
 const bent = require('bent');
-var mustache = require('mustache');
-mustache.escape = function(text) {return text;};
-var {appendVerb, v_resolve, v_text_resolve, doLCC, doCreateCall, doCreateMessage} = require('./libs')
+var {v_resolve} = require('./libs');
 
 module.exports = function(RED) {
     function get_alerts(config) {
@@ -12,10 +9,11 @@ module.exports = function(RED) {
         const {accountSid, apiToken} = server.credentials;
         node.on('input', async(msg, send, done) => {
             const data = {
-                page: config.page,
-                count : config.count,
-                days : config.days
+                page: v_resolve(config.page, config.pageType, this.context(), msg),
+                count: v_resolve(config.count, config.countType, this.context(), msg),
+                days: v_resolve(config.days, config.daysType, this.context(), msg),
             }
+            Object.keys(data).forEach((k) => data[k] == null || data[k] == '' && delete data[k]);
             const params = new URLSearchParams(data).toString()
             const req = bent(`${server.url}/v1/Accounts/${accountSid}/Alerts?${params}`, 'GET', 'json', {
                 'Authorization': `Bearer ${apiToken}`
@@ -28,20 +26,20 @@ module.exports = function(RED) {
                 msg.page = res.page
             } catch (err) {
                 if (err.statusCode) {
-                  node.error(`create-call failed with ${err.statusCode}`);
-                  msg.statusCode = err.statusCode;
+                    node.error(`GetAlerts failed with ${err.statusCode}`);
+                    msg.statusCode = err.statusCode;
                 }
                 else {
-                  node.error(`Error getting alerts ${JSON.stringify(err)}`);
-                  if (done) done(err);
-                  else node.error(err, msg);
-                  send(msg);
-                  return;
+                    node.error(`Error getting alerts ${JSON.stringify(err)}`);
+                    if (done) done(err);
+                    else node.error(err, msg);
+                    send(msg);
+                    return;
                 }
             }
             send(msg);
             if (done) done();
         });
-      }
-      RED.nodes.registerType('get_alerts', get_alerts);
+    }
+    RED.nodes.registerType('get_alerts', get_alerts);
 }

package/src/nodes/get_calls.html

@@ -1,8 +1,6 @@
 <!-- Javascript -->
-
-
 <script type="text/javascript">
- RED.nodes.registerType('get_calls',{
+  RED.nodes.registerType('get_calls',{
       category: 'jambonz',
       color: '#aebfb9',
       defaults: {
@@ -13,18 +11,11 @@
       outputs:1,
       icon: "font-awesome/fa-cubes",
       paletteLabel: "Get - Calls",
-      label: function() { return this.name || 'Get Calls';},
-      oneditprepare: () => {
-        var node = this;
-      }
+      label: function() { return this.name || 'Get Calls';}
   });
-
-
 </script>
 
-
 <!-- HTML -->
-
 <script type="text/html" data-template-name="get_calls">
         <div class="form-row">
           <label for="node-input-name"><i class="icon-tag"></i> Name</label>
@@ -37,23 +28,10 @@
 </script>
 
 <!-- Help Text -->
-
 <script type="text/html" data-help-name="get_calls">
-        <p>DESCRIPTION</p>
-      <h3>Properties</h3>
-          <p><code>XXXX</code> - TEXT</p>
-        
-      <h3>Outputs</h3>
-       <dl class="message-properties">
-         <dt>payload<span class="property-type">object</span></dt>
-         <dd> <code>msg.payload</code> will contain ...  </dd>
-       </dl>
-      
-      <h3>Details</h3>
-      The listen verb establishes a connection to a websocket server and sends live audio for the current call.<h3>References</h3>
-        <ul>
-            <li><a href="https://docs.jambonz.org/jambonz/#listen">Jambonz listen reference</a></li>
-        </ul>
-      </script>
+      <p>Get calls</p>
 
+      <h3>Details</h3>
+      Retrieve info for a group of calls under an account.
+      Call detail are only kept in the system for 10 minutes by default.
 </script>

package/src/nodes/get_calls.js

@@ -1,38 +1,38 @@
-var {createHash} = require('crypto');
-const bent = require('bent');
-var mustache = require('mustache');
-mustache.escape = function(text) {return text;};
-var {appendVerb, v_resolve, v_text_resolve, doLCC, doCreateCall, doCreateMessage} = require('./libs')
+const bent = require("bent");
 
-module.exports = function(RED) {
-    function get_calls(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 req = bent(`${server.url}/v1/Accounts/${accountSid}/Calls`, 'GET', 'json', {
-                'Authorization': `Bearer ${apiToken}`
-            });           
-            try {
-                const res = await req();
-                msg.payload = res
-            } catch (err) {
-                if (err.statusCode) {
-                  node.error(`create-call failed with ${err.statusCode}`);
-                  msg.statusCode = err.statusCode;
-                }
-                else {
-                  node.error(`Error getting calls ${JSON.stringify(err)}`);
-                  if (done) done(err);
-                  else node.error(err, msg);
-                  send(msg);
-                  return;
-                }
-            }
-            send(msg);
-            if (done) done();
-        });
+module.exports = function (RED) {
+  function get_calls(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 req = bent(
+        `${server.url}/v1/Accounts/${accountSid}/Calls`,
+        "GET",
+        "json",
+        {
+          Authorization: `Bearer ${apiToken}`,
+        }
+      );
+      try {
+        const res = await req();
+        msg.payload = res;
+      } catch (err) {
+        if (err.statusCode) {
+          node.error(`GetCalls failed with ${err.statusCode}`);
+          msg.statusCode = err.statusCode;
+        } else {
+          node.error(`Error getting calls ${JSON.stringify(err)}`);
+          if (done) done(err);
+          else node.error(err, msg);
+          send(msg);
+          return;
+        }
       }
-      RED.nodes.registerType('get_calls', get_calls);
-}
+      send(msg);
+      if (done) done();
+    });
+  }
+  RED.nodes.registerType("get_calls", get_calls);
+};

package/src/nodes/get_recent_calls.html

@@ -1,19 +1,21 @@
 <!-- Javascript -->
-
-
 <script type="text/javascript">
- RED.nodes.registerType('get_recent_calls',{
+  RED.nodes.registerType('get_recent_calls',{
       category: 'jambonz',
       color: '#aebfb9',
       defaults: {
         name: {value: ''},
         server: {value: '', required: true, type: 'jambonz_auth'},
+        direction: {value: ''},
+        directionType:{value: 'str'},
+        trunk: {value: ''},
+        trunkType:{value: 'str'},
         page:{value: 1},
         pageType:{value: 'num'},
         count:{value: 25},
         countType:{value: 'num'},
         days:{value: 7},
-        countType:{value: 'num'}
+        daysType:{value: 'num'}
       },
       inputs:1,
       outputs:1,
@@ -21,7 +23,6 @@
       paletteLabel: "Get - Recent Calls",
       label: function() { return this.name || 'Get Recent Calls';},
       oneditprepare: () => {
-        var node = this;
         $('#node-input-page').typedInput({
             types: ['num', 'msg', 'flow', 'global', 'jsonata', 'env'],
             typeField: $('#node-input-pageType')
@@ -34,15 +35,19 @@
             types: ['num', 'msg', 'flow', 'global', 'jsonata', 'env'],
             typeField: $('#node-input-daysType')
         });
+        $('#node-input-direction').typedInput({
+          types: ['str', 'msg', 'flow', 'global'],
+          typeField: $('#node-input-directionType')
+        });
+        $('#node-input-trunk').typedInput({
+          types: ['str', 'msg', 'flow', 'global'],
+          typeField: $('#node-input-trunkType')
+        });
       }
   });
-
-
 </script>
 
-
 <!-- HTML -->
-
 <script type="text/html" data-template-name="get_recent_calls">
         <div class="form-row">
           <label for="node-input-name"><i class="icon-tag"></i> Name</label>
@@ -52,6 +57,16 @@
           <label for="node-input-server">Server</label>
           <input type="text" id="node-input-server">
         </div>
+        <div class="form-row">
+          <label for="node-input-direction">Direction</label>
+          <input type="text" id="node-input-direction" placeholder="inbound">
+          <input type="hidden" id="node-input-directionType">
+        </div>
+        <div class="form-row">
+          <label for="node-input-trunk">Trunk</label>
+          <input type="text" id="node-input-trunk" placeholder="trunk name">
+          <input type="hidden" id="node-input-trunkType">
+        </div>
         <div class="form-row">
           <label for="node-input-page">Page</label>
           <input type="text" id="node-input-page" >
@@ -67,29 +82,12 @@
           <input type="text" id="node-input-days" >
           <input type="hidden" id="node-input-daysType">
         </div>
-
-  
 </script>
 
 <!-- Help Text -->
-
 <script type="text/html" data-help-name="get_recent_calls">
-        <p>Get previous call records</p>
-      <h3>Properties</h3>
-          <p><code>XXXX</code> - TEXT</p>
-        
-      <h3>Outputs</h3>
-       <dl class="message-properties">
-         <dt>payload<span class="property-type">object</span></dt>
-         <dd> <code>msg.payload</code> will contain ...  </dd>
-       </dl>
+      <p>Get recent call records</p>
       
       <h3>Details</h3>
       Call detail records are only kept in the system for 30 days. As there could be a large number of CDRs, this node allows you to query pages of data at a time.
-
-      <ul>
-            <li><a href="https://api.jambonz.org/#4e82bdc2-327b-40a5-9b52-f86357647b45">Jambonz Get Recent Calls reference</a></li>
-        </ul>
-      </script>
-
 </script>

package/src/nodes/get_recent_calls.js

@@ -1,8 +1,5 @@
-var {createHash} = require('crypto');
 const bent = require('bent');
-var mustache = require('mustache');
-mustache.escape = function(text) {return text;};
-var {appendVerb, v_resolve, v_text_resolve, doLCC, doCreateCall, doCreateMessage} = require('./libs')
+var {v_resolve} = require('./libs');
 
 module.exports = function(RED) {
     function get_recent_calls(config) {
@@ -12,36 +9,39 @@ module.exports = function(RED) {
         const {accountSid, apiToken} = server.credentials;
         node.on('input', async(msg, send, done) => {
             const data = {
-                page: config.page,
-                count : config.count,
-                days : config.days
+                direction: v_resolve(config.direction, config.directionType, this.context(), msg),
+                trunk: v_resolve(config.trunk, config.trunkType, this.context(), msg),
+                page: v_resolve(config.page, config.pageType, this.context(), msg),
+                count: v_resolve(config.count, config.countType, this.context(), msg),
+                days: v_resolve(config.days, config.daysType, this.context(), msg),
             }
-            const params = new URLSearchParams(data).toString()
+            Object.keys(data).forEach((k) => data[k] == null || data[k] == '' && delete data[k]);
+            const params = new URLSearchParams(data).toString();
             const req = bent(`${server.url}/v1/Accounts/${accountSid}/RecentCalls?${params}`, 'GET', 'json', {
                 'Authorization': `Bearer ${apiToken}`
             });           
             try {
                 const res = await req();
-                msg.payload = res.data
-                msg.total = res.total
-                msg.page_size = res.page_size
-                msg.page = res.page
+                msg.payload = res.data;
+                msg.total = res.total;
+                msg.page_size = res.page_size;
+                msg.page = res.page;
             } catch (err) {
                 if (err.statusCode) {
-                  node.error(`create-call failed with ${err.statusCode}`);
-                  msg.statusCode = err.statusCode;
+                    node.error(`GetRecentCalls failed with ${err.statusCode}`);
+                    msg.statusCode = err.statusCode;
                 }
                 else {
-                  node.error(`Error getting alerts ${JSON.stringify(err)}`);
-                  if (done) done(err);
-                  else node.error(err, msg);
-                  send(msg);
-                  return;
+                    node.error(`Error getting recent calls ${JSON.stringify(err)}`);
+                    if (done) done(err);
+                    else node.error(err, msg);
+                    send(msg);
+                    return;
                 }
             }
             send(msg);
             if (done) done();
         });
-      }
-      RED.nodes.registerType('get_recent_calls', get_recent_calls);
+    }
+    RED.nodes.registerType('get_recent_calls', get_recent_calls);
 }

package/src/nodes/hangup.html

@@ -1,9 +1,6 @@
 <!-- Javascript -->
-
-
 <script type="text/javascript">
-
-RED.nodes.registerType('hangup',{
+  RED.nodes.registerType('hangup',{
       category: 'jambonz',
       color: '#bbabaa',
       defaults: {
@@ -14,18 +11,15 @@ RED.nodes.registerType('hangup',{
       icon: "font-awesome/fa-cubes",
       label: function() { return this.name || 'hangup';},
   });
-
-
 </script>
 
-
 <!-- HTML -->
 <script type="text/html" data-template-name="hangup">
     <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>
+</script>
 
 <!-- Help Text -->
 <script type="text/html" data-help-name="hangup">
@@ -33,14 +27,14 @@ RED.nodes.registerType('hangup',{
   
   <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>hangup</code> action appended  </dd>
+    <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>hangup</code> action appended  </dd>
   </dl>
   
   <h3>Details</h3>
   The hangup verb hangs up the current call.
   <h3>References</h3>
     <ul>
-        <li><a href="https://docs.jambonz.org/jambonz/#hangup">Jambonz hangup reference</a></li>
+        <li><a href="https://www.jambonz.org/docs/webhooks/hangup/">Jambonz hangup reference</a></li>
     </ul>
 </script>