0.0.57

* add config.ambientNoise

* add answer verb to force answer

README.md

@@ -1,4 +1,4 @@
-# verb-specificiations
+# verb-specifications
 Jambonz Verb Specification Utilities
 
 #### Running the test suite

jambonz-app-json-validation.js

@@ -58,7 +58,8 @@ function validateVerb(name, data, logger) {
       const dSpec = specData.properties[dKey];
       debug(`Task:validate validating property ${dKey} with value ${JSON.stringify(dVal)}`);
 
-      if (typeof dSpec === 'string' && dSpec === 'array') {
+      if (typeof dVal === 'undefined') continue;
+      else if (typeof dSpec === 'string' && dSpec === 'array') {
         if (!Array.isArray(dVal)) throw new Error(`${name}: property ${dKey} is not an array`);
       }
       else if (typeof dSpec === 'string' && dSpec.includes('|')) {

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@jambonz/verb-specifications",
-  "version": "0.0.19",
+  "version": "0.0.57",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@jambonz/verb-specifications",
-      "version": "0.0.19",
+      "version": "0.0.57",
       "license": "MIT",
       "dependencies": {
         "debug": "^4.3.4",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/verb-specifications",
-  "version": "0.0.19",
+  "version": "0.0.57",
   "description": "Jambonz Verb Specification Utilities",
   "main": "index.js",
   "scripts": {

specs.json

@@ -1,4 +1,11 @@
 {
+  "answer": {
+    "properties": {
+      "id": "string"
+    },
+    "required": [
+    ]
+  },
   "sip:decline": {
     "properties": {
       "id": "string",
@@ -43,8 +50,13 @@
       "bargeIn": "#bargeIn",
       "record": "#recordOptions",
       "listen": "#listenOptions",
+      "transcribe": "#transcribeOptions",
       "amd": "#amd",
-      "notifyEvents": "boolean"
+      "notifyEvents": "boolean",
+      "reset": "string|array",
+      "onHoldMusic": "string",
+      "actionHookDelayAction": "#actionHookDelayAction",
+      "sipRequestWithinDialogHook": "object|string"
     },
     "required": []
   },
@@ -58,7 +70,12 @@
         "type": "string",
         "enum": ["mono", "stereo", "mixed"]
       },
-      "metadata": "object"
+      "metadata": "object",
+      "maxLength": "number",
+      "passDtmf": "boolean",
+      "playBeep": "boolean",
+      "disableBidirectionalAudio": "boolean",
+      "timeout": "number"
     },
     "required": [
       "enable"
@@ -82,13 +99,42 @@
       "enable"
     ]
   },
+  "transcribeOptions": {
+    "properties": {
+      "enable": "boolean",
+      "transcriptionHook": "string",
+      "recognizer": "#recognizer"
+    },
+    "required": [
+      "enable"
+    ]
+  },
+  "dub": {
+    "properties": {
+      "id": "string",
+      "action": {
+        "type": "string",
+        "enum": ["addTrack", "removeTrack", "silenceTrack", "playOnTrack", "sayOnTrack"]
+      },
+      "track": "string",
+      "play": "string",
+      "say": "string",
+      "loop": "boolean",
+      "gain": "number|string"
+    },
+    "required": [
+      "action",
+      "track"
+    ]
+  },
   "dequeue": {
     "properties": {
       "id": "string",
       "name": "string",
       "actionHook": "object|string",
       "timeout": "number",
-      "beep": "boolean"
+      "beep": "boolean",
+      "callSid": "string"
     },
     "required": [
       "name"
@@ -100,6 +146,7 @@
       "name": "string",
       "actionHook": "object|string",
       "waitHook": "object|string",
+      "priority": "number",
       "_": "object"
     },
     "required": [
@@ -165,7 +212,8 @@
       "timeout": "number",
       "recognizer": "#recognizer",
       "play": "#play",
-      "say": "#say"
+      "say": "#say",
+      "actionHookDelayAction": "#actionHookDelayAction"
     },
     "required": [
     ]
@@ -175,8 +223,11 @@
       "id": "string",
       "name": "string",
       "beep": "boolean",
+      "memberTag": "string",
+      "speakOnlyTo": "string",
       "startConferenceOnEnter": "boolean",
       "endConferenceOnExit": "boolean",
+      "endConferenceDuration": "number",
       "maxParticipants": "number",
       "joinMuted": "boolean",
       "actionHook": "object|string",
@@ -194,6 +245,7 @@
     "properties": {
       "id": "string",
       "actionHook": "object|string",
+      "onHoldHook": "object|string",
       "answerOnBridge": "boolean",
       "callerId": "string",
       "callerName": "string",
@@ -210,7 +262,8 @@
       "timeout": "number",
       "proxy": "string",
       "transcribe": "#transcribe",
-      "amd": "#amd"
+      "amd": "#amd",
+      "tag": "object"
     },
     "required": [
       "target"
@@ -361,7 +414,8 @@
         "enum": ["startCallRecording", "stopCallRecording", "pauseCallRecording", "resumeCallRecording"]
       },
       "recordingID": "string",
-      "siprecServerURL": "string"
+      "siprecServerURL": "string|array",
+      "headers": "object"
     },
     "required": [
       "action"
@@ -394,7 +448,10 @@
       "tag": "object",
       "to": "#target",
       "headers": "object",
-      "timeout": "number"
+      "timeout": "number",
+      "amd": "#amd",
+      "dual_streams": "boolean",
+      "sipRequestWithinDialogHook": "string"
     },
     "required": [
       "call_hook",
@@ -419,7 +476,7 @@
       "earlyMedia": "boolean"
     },
     "required": [
-      "recognizer"
+      "transcriptionHook"
     ]
   },
   "target": {
@@ -442,7 +499,8 @@
       "vmail": "boolean",
       "tenant": "string",
       "trunk": "string",
-      "overrideTo": "string"
+      "overrideTo": "string",
+      "proxy": "string"
     },
     "required": [
       "type"
@@ -469,8 +527,13 @@
   "synthesizer": {
     "properties": {
       "vendor": "string",
+      "label": "string",
       "language": "string",
-      "voice": "string",
+      "voice": "string|object",
+      "fallbackVendor": "string",
+      "fallbackLabel": "string",
+      "fallbackLanguage": "string",
+      "fallbackVoice": "string|object",
       "engine": {
         "type": "string",
         "enum": ["standard", "neural"]
@@ -478,7 +541,8 @@
       "gender": {
         "type": "string",
         "enum": ["MALE", "FEMALE", "NEUTRAL"]
-      }
+      },
+      "options": "object"
     },
     "required": [
       "vendor"
@@ -487,7 +551,11 @@
   "recognizer": {
     "properties": {
       "vendor": "string",
+      "label": "string",
       "language": "string",
+      "fallbackVendor": "string",
+      "fallbackLabel": "string",
+      "fallbackLanguage": "string",
       "vad": "#vad",
       "hints": "array",
       "hintsBoost": "number",
@@ -550,11 +618,16 @@
       "azureSttEndpointId": "string",
       "asrDtmfTerminationDigit": "string",
       "asrTimeout": "number",
+      "fastRecognitionTimeout": "number",
       "nuanceOptions": "#nuanceOptions",
       "deepgramOptions": "#deepgramOptions",
       "ibmOptions": "#ibmOptions",
       "nvidiaOptions": "#nvidiaOptions",
       "sonioxOptions": "#sonioxOptions",
+      "cobaltOptions": "#cobaltOptions",
+      "awsOptions": "#awsOptions",
+      "azureOptions": "#azureOptions",
+      "assemblyAiOptions": "#assemblyAiOptions",
       "customOptions": "#customOptions"
     },
     "required": [
@@ -570,6 +643,48 @@
     "required": [
     ]
   },
+  "awsOptions": {
+    "properties": {
+      "accessKey": "string",
+      "secretKey": "string",
+      "securityToken": "string",
+      "region": "string",
+      "vocabularyName": "string",
+      "vocabularyFilterName": "string",
+      "vocabularyFilterMethod": {
+        "type": "string",
+        "enum": [
+          "remove",
+          "mask",
+          "tag"
+        ]
+      },
+      "languageModelName": "string",
+      "piiEntityTypes": "array",
+      "piiIdentifyEntities": "boolean"
+    },
+    "required": [
+    ]
+  },
+  "azureOptions": {
+    "properties": {
+      "speechSegmentationSilenceTimeoutMs": "number"
+    },
+    "required": [
+    ]
+  },
+  "cobaltOptions": {
+    "properties": {
+      "serverUri": "string",
+      "enableConfusionNetwork": "boolean",
+      "metadata": "string",
+      "compiledContextData": "string",
+      "wordTimeOffsets": "boolean",
+      "contextToken": "string"
+    },
+    "required": [
+    ]
+  },
   "nvidiaOptions": {
     "properties": {
       "rivaUri": "string",
@@ -602,12 +717,15 @@
   },
   "deepgramOptions": {
     "properties": {
+      "deepgramSttUri": "string",
+      "deepgramSttUseTls": "boolean",
       "apiKey": "string",
       "tier": "string",
       "model": "string",
       "customModel": "string",
       "version": "string",
       "punctuate": "boolean",
+      "smartFormatting": "boolean",
       "profanityFilter": "boolean",
       "redact": {
         "type": "string",
@@ -628,6 +746,8 @@
       "replace": "array",
       "keywords": "array",
       "endpointing": "boolean | number",
+      "utteranceEndMs": "number",
+      "shortUtterance": "boolean",
       "vadTurnoff": "number",
       "tag": "string"
     }
@@ -702,6 +822,11 @@
     "required": [
     ]
   },
+  "assemblyAiOptions": {
+    "properties": {
+      "apiKey": "string"
+    }
+  },
   "resource": {
     "properties": {
       "externalReference": "#resourceReference",
@@ -802,5 +927,14 @@
       "toneTimeoutMs": "number",
       "greetingCompletionTimeoutMs": "number"
     }
+  },
+  "actionHookDelayAction" : {
+    "properties": {
+      "enabled": "boolean",
+      "noResponseTimeout": "number",
+      "noResponseGiveUpTimeout": "number",
+      "retries": "number",
+      "actions": "array"
+    }
   }
 }

test/jambonz-verb-test.js

@@ -24,27 +24,96 @@ test("validate correct verbs", async (t) => {
       "verb": "config",
       "synthesizer": {
         "voice": "Jenny",
-        "vendor": "google"
+        "vendor": "google",
+        "label": "label1"
       },
       "recognizer": {
         "vendor": "google",
-        "language": "de-DE"
+        "language": "de-DE",
+        "label": "label1"
       },
       "bargeIn": {
         "enable": true,
         "input" : ["speech"],
         "actionHook": "/userInput"
+      },
+      "transcribe": {
+        "enable": true,
+        "transcriptionHook": "http://server.com/hook",
+        "recognizer": {
+          "vendor": "google",
+          "language": "de-DE",
+        }
+      },
+      "onHoldMusic": "http://server.com/hold",
+      "actionHookDelayAction": {
+        "enabled": true,
+        "noResponseTimeout": 5,
+        "noResponseGiveUpTimeout": 10,
+        "retries": 3,
+        "actions": [
+          {
+            "verb": "say",
+            "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
+            "synthesizer": {
+              "vendor": "google",
+              "language": "en-US"
+            }
+          },
+          {
+            "verb": "play",
+            "url": "https://example.com/example.mp3",
+            "timeoutSecs": 10,
+            "seekOffset": 8000,
+            "actionHook": "/play/action"
+          }
+        ]
+      }
+    },
+    {
+      "verb": "config",
+      "recognizer": {
+        "vendor": "google",
+        "language": "de-DE",
+        "label": "label1",
+        "assemblyAiOptions": {
+          "apiKey": "apikey"
+        }
+      }
+    },
+    {
+      "verb": "config",
+      "record": {
+      "action": "startCallRecording",
+      "siprecServerURL": ["sip:srs@recording.example.com","sip:srs@recording.example.com"],
+      "headers" : {
+        "X-Header1": "Value1",
+        "X-Header2": "Value2"
+      }
+      }
+    },
+    {
+      "verb": "config",
+      "sipRequestWithinDialogHook": "https://jambonz.or/sipIndialogActionHook"
+    },
+    {
+      "verb": "config",
+      "record": {
+      "action": "startCallRecording",
+      "siprecServerURL": "sip:srs@recording.example.com"
       }
     },
     {
       "verb": "dequeue",
       "name": "support",
       "beep": true,
-      "timeout": 60
+      "timeout": 60,
+      "callSid": "call_sid1234"
     },
     {
       "verb": "dial",
       "actionHook": "/outdial",
+      "onHoldHook": "/onHoldHook",
       "callerId": "+16173331212",
       "callerName": "Tom",
       "answerOnBridge": true,
@@ -95,7 +164,8 @@ test("validate correct verbs", async (t) => {
       "verb": "enqueue",
       "name": "support",
       "actionHook": "/queue-action",
-      "waitHook": "/queue-wait"
+      "waitHook": "/queue-wait",
+      "priority": 50
     },
     {
       "verb": "gather",
@@ -111,6 +181,7 @@ test("validate correct verbs", async (t) => {
         "language": "en-US",
         "hints": ["sales", "support"],
         "hintsBoost": 10,
+        "fastRecognitionTimeout": 2000,
         "deepgramOptions": {
           "endpointing": 500
         }
@@ -119,7 +190,30 @@ test("validate correct verbs", async (t) => {
         "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
         "synthesizer": {
           "vendor": "google",
-          "language": "en-US"
+          "language": "en-US",
+          "label": "label1",
+          "fallbackVendor": "google",
+          "fallbackLanguage": "en-US",
+          "fallbackLabel": "label1",
+          "fallbackVoice": "voice"
+        }
+      },
+      "say": {
+        "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
+        "synthesizer": {
+          "vendor": "google",
+          "language": "en-US",
+          "voice": {
+            "reportedUsage":"REALTIME",
+            "model":"path/to/model",
+           },
+          "fallbackVendor": "google",
+          "fallbackLanguage": "en-US",
+          "fallbackLabel": "label1",
+          "fallbackVoice": {
+            "reportedUsage":"REALTIME",
+            "model":"path/to/model",
+           }
         }
       }
     },
@@ -135,12 +229,37 @@ test("validate correct verbs", async (t) => {
       "recognizer": {
         "vendor": "google",
         "language": "en-US",
+        "fallbackVendor": "google",
+        "fallbackLanguage": "en-US",
+        "fallbackLabel": "label1",
         "hints": ["sales", "support"],
         "hintsBoost": 10,
         "deepgramOptions": {
           "endpointing": true
         }
       },
+      "actionHookDelayAction": {
+        "noResponseTimeout": 5,
+        "noResponseGiveUpTimeout": 10,
+        "retries": 3,
+        "actions": [
+          {
+            "verb": "say",
+            "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
+            "synthesizer": {
+              "vendor": "google",
+              "language": "en-US"
+            }
+          },
+          {
+            "verb": "play",
+            "url": "https://example.com/example.mp3",
+            "timeoutSecs": 10,
+            "seekOffset": 8000,
+            "actionHook": "/play/action"
+          }
+        ]
+      }
     },
     {
       "verb": "hangup",
@@ -261,22 +380,27 @@ test("validate correct verbs", async (t) => {
     },
     {
       "verb": "rest:dial",
-      account_sid: "1291964182631236912836123912",
-      call_hook: {
-        url: "http://127.0.0.1:3100/",
-        method: "POST",
-        username: "username",
-        password: "password",
+      "account_sid": "1291964182631236912836123912",
+      "call_hook": {
+        "url": "http://127.0.0.1:3100/",
+        "method": "POST",
+        "username": "username",
+        "password": "password",
       },
-      from: "15583084810",
-      to: {
-        type: "phone",
-        number: "15583084809",
+      "from": "15583084810",
+      "to": {
+        "type": "phone",
+        "number": "15583084809",
       },
-      tag: {
-        customer: "acme",
-        referenceId: "deadbeef",
-      }
+      "tag": {
+        "customer": "acme",
+        "referenceId": "deadbeef",
+      },
+      "amd": {
+        "actionHook": "/answeringMachineDetection",
+    
+      },
+      "dual_streams": true
     }
   ];
   try {