0.0.22

rest:dial amd

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 jambonz
+Copyright (c) 2023 Drachtio Communications Services, LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package-lock.json

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

package.json

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

specs.json

@@ -44,7 +44,8 @@
       "record": "#recordOptions",
       "listen": "#listenOptions",
       "amd": "#amd",
-      "notifyEvents": "boolean"
+      "notifyEvents": "boolean",
+      "reset": "string|array"
     },
     "required": []
   },
@@ -196,12 +197,14 @@
       "actionHook": "object|string",
       "answerOnBridge": "boolean",
       "callerId": "string",
+      "callerName": "string",
       "confirmHook": "object|string",
       "referHook": "object|string",
       "dialMusic": "string",
       "dtmfCapture": "object",
       "dtmfHook": "object|string",
       "headers": "object",
+      "anchorMedia": "boolean",
       "listen": "#listen",
       "target": ["#target"],
       "timeLimit": "number",
@@ -382,6 +385,7 @@
       "call_hook": "object|string",
       "call_status_hook": "object|string",
       "from": "string",
+      "callerName": "string",
       "fromHost": "string",
       "speech_synthesis_vendor": "string",
       "speech_synthesis_voice": "string",
@@ -391,7 +395,8 @@
       "tag": "object",
       "to": "#target",
       "headers": "object",
-      "timeout": "number"
+      "timeout": "number",
+      "amd": "#amd"
     },
     "required": [
       "call_hook",
@@ -465,10 +470,7 @@
   },
   "synthesizer": {
     "properties": {
-      "vendor": {
-        "type": "string",
-        "enum": ["google", "aws", "polly", "microsoft", "nuance", "ibm", "nvidia", "default"]
-      },
+      "vendor": "string",
       "language": "string",
       "voice": "string",
       "engine": {
@@ -478,7 +480,8 @@
       "gender": {
         "type": "string",
         "enum": ["MALE", "FEMALE", "NEUTRAL"]
-      }
+      },
+      "options": "object"
     },
     "required": [
       "vendor"
@@ -486,10 +489,7 @@
   },
   "recognizer": {
     "properties": {
-      "vendor": {
-        "type": "string",
-        "enum": ["google", "aws", "microsoft", "nuance", "deepgram", "ibm", "nvidia", "default"]
-      },
+      "vendor": "string",
       "language": "string",
       "vad": "#vad",
       "hints": "array",
@@ -556,12 +556,23 @@
       "nuanceOptions": "#nuanceOptions",
       "deepgramOptions": "#deepgramOptions",
       "ibmOptions": "#ibmOptions",
-      "nvidiaOptions": "#nvidiaOptions"
+      "nvidiaOptions": "#nvidiaOptions",
+      "sonioxOptions": "#sonioxOptions",
+      "customOptions": "#customOptions"
     },
     "required": [
       "vendor"
     ]
   },
+  "customOptions": {
+    "properties": {
+      "authToken": "string",
+      "uri": "string",
+      "options": "object"
+    },
+    "required": [
+    ]
+  },
   "nvidiaOptions": {
     "properties": {
       "rivaUri": "string",
@@ -595,26 +606,8 @@
   "deepgramOptions": {
     "properties": {
       "apiKey": "string",
-      "tier": {
-        "type": "string",
-        "enum": [
-          "enhanced",
-          "base"
-        ]
-      },
-      "model": {
-        "type": "string",
-        "enum": [
-          "general",
-          "meeting",
-          "phonecall",
-          "voicemail",
-          "finance",
-          "conversationalai",
-          "video",
-          "custom"
-        ]
-      },
+      "tier": "string",
+      "model": "string",
       "customModel": "string",
       "version": "string",
       "punctuate": "boolean",
@@ -637,11 +630,36 @@
       "search": "array",
       "replace": "array",
       "keywords": "array",
-      "endpointing": "boolean",
+      "endpointing": "boolean | number",
       "vadTurnoff": "number",
       "tag": "string"
     }
   },
+  "sonioxOptions": {
+    "properties": {
+      "apiKey": "string",
+      "model": "string",
+      "endpointDetection": "boolean",
+      "profanityFilter": "boolean",
+      "speechContext": "string",
+      "clientRequestReference": "string",
+      "storage": "#sonioxStorage"
+    },
+    "required": [
+    ]
+  },
+  "sonioxStorage": {
+    "properties": {
+      "id": "string",
+      "title": "string",
+      "disableStoreAudio": "boolean",
+      "disableStoreTranscript": "boolean",
+      "disableSearch": "boolean",
+      "metadata": "object"
+    },
+    "required": [
+    ]
+  },
   "nuanceOptions": {
     "properties": {
       "clientId": "string",
@@ -693,7 +711,7 @@
       "inlineWordset": "string",
       "builtin": "string",
       "inlineGrammar": "string",
-      "wakeupWord": "[string]",
+      "wakeupWord": "array",
       "weightName": {
         "type": "string",
         "enum": [

test/jambonz-verb-test.js

@@ -46,6 +46,7 @@ test("validate correct verbs", async (t) => {
       "verb": "dial",
       "actionHook": "/outdial",
       "callerId": "+16173331212",
+      "callerName": "Tom",
       "answerOnBridge": true,
       "dtmfCapture": ["*2", "*3"],
       "dtmfHook": {
@@ -109,7 +110,10 @@ test("validate correct verbs", async (t) => {
         "vendor": "google",
         "language": "en-US",
         "hints": ["sales", "support"],
-        "hintsBoost": 10
+        "hintsBoost": 10,
+        "deepgramOptions": {
+          "endpointing": 500
+        }
       },
       "say": {
         "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
@@ -119,6 +123,25 @@ test("validate correct verbs", async (t) => {
         }
       }
     },
+    {
+      "verb": "gather",
+      "actionHook": "http://example.com/collect",
+      "input": ["digits", "speech"],
+      "bargein": true,
+      "dtmfBargein": true,
+      "finishOnKey": "#",
+      "numDigits": 5,
+      "timeout": 8,
+      "recognizer": {
+        "vendor": "google",
+        "language": "en-US",
+        "hints": ["sales", "support"],
+        "hintsBoost": 10,
+        "deepgramOptions": {
+          "endpointing": true
+        }
+      },
+    },
     {
       "verb": "hangup",
       "headers": {
@@ -235,6 +258,29 @@ test("validate correct verbs", async (t) => {
         "language" : "en-US",
         "interim": true
       }
+    },
+    {
+      "verb": "rest:dial",
+      "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",
+      },
+      "tag": {
+        "customer": "acme",
+        "referenceId": "deadbeef",
+      },
+      "amd": {
+        "actionHook": "/answeringMachineDetection",
+    
+      }
     }
   ];
   try {