0.0.20

Merge pull request #11 from jambonz/feat/rest_dial_amd
rest:dial amd
2026-03-26 05:47:53 +00:00 · 2023-05-07 08:41:52 -04:00 · 2023-05-07 08:41:37 -04:00 · 2023-05-07 19:40:28 +07:00 · 2023-05-07 08:31:16 -04:00 · 2023-05-07 08:31:02 -04:00
5 changed files with 99 additions and 37 deletions
--- a/2
+++ b/2
@@ -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
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
  "name": "@jambonz/verb-specifications",
-  "version": "0.0.4",
+  "version": "0.0.20",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "@jambonz/verb-specifications",
-      "version": "0.0.4",
+      "version": "0.0.20",
      "license": "MIT",
      "dependencies": {
        "debug": "^4.3.4",
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@jambonz/verb-specifications",
-  "version": "0.0.4",
+  "version": "0.0.20",
  "description": "Jambonz Verb Specification Utilities",
  "main": "index.js",
  "scripts": {
--- a/specs.json
+++ b/specs.json
@@ -196,12 +196,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 +384,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 +394,8 @@
      "tag": "object",
      "to": "#target",
      "headers": "object",
-      "timeout": "number"
+      "timeout": "number",
+      "amd": "#amd"
    },
    "required": [
      "call_hook",
@@ -465,10 +469,7 @@
  },
  "synthesizer": {
    "properties": {
-      "vendor": {
-        "type": "string",
-        "enum": ["google", "aws", "polly", "microsoft", "nuance", "ibm", "nvidia", "default"]
-      },
+      "vendor": "string",
      "language": "string",
      "voice": "string",
      "engine": {
@@ -486,10 +487,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 +554,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 +604,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 +628,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 +709,7 @@
      "inlineWordset": "string",
      "builtin": "string",
      "inlineGrammar": "string",
-      "wakeupWord": "[string]",
+      "wakeupWord": "array",
      "weightName": {
        "type": "string",
        "enum": [
--- a/test/jambonz-verb-test.js
+++ b/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 {
Author	SHA1	Message	Date
Dave Horton	72225385ae	0.0.20	2023-05-07 08:41:52 -04:00
Dave Horton	6ad9d2bce0	Merge pull request #11 from jambonz/feat/rest_dial_amd rest:dial amd	2023-05-07 08:41:37 -04:00
Quan HL	045df8a9fe	rest:dial amd	2023-05-07 19:40:28 +07:00
Dave Horton	f3ede17b80	0.0.19	2023-05-07 08:31:16 -04:00
Dave Horton	2551dbe18e	Merge pull request #10 from jambonz/feat/remove_metadata fix: remove metadata in rest:dial	2023-05-07 08:31:02 -04:00
Quan HL	f4a887a67a	fix: remove metadata in rest:dial	2023-05-07 19:30:17 +07:00
Dave Horton	874abac5e3	0.0.18	2023-05-06 21:12:49 -04:00
Dave Horton	827ddcebf0	Merge pull request #9 from jambonz/feat/metadata feat: add rest:dial metadata	2023-05-06 21:11:56 -04:00
Quan HL	98043693be	feat: add rest:dial metadata	2023-05-07 06:39:35 +07:00
Dave Horton	436c8e1861	0.0.17	2023-04-28 07:39:08 -04:00
Dave Horton	21214eb2ce	Merge pull request #8 from jambonz/feat/deepgram_endpointing deepgram: endpointing support number	2023-04-28 07:38:15 -04:00
Quan HL	017b8cd0c3	deepgram: endpointing support number	2023-04-28 11:32:15 +07:00
Dave Horton	8ae7419b7a	0.0.16	2023-04-13 13:13:53 -04:00
Dave Horton	11c34aa6fc	dont restrict deepgram tier	2023-04-13 13:13:43 -04:00
Dave Horton	5548a67412	0.0.15	2023-04-13 13:05:09 -04:00
Dave Horton	8f89bac676	dont restrict deepgram models	2023-04-13 13:05:05 -04:00
Dave Horton	146f691890	bump version	2023-04-11 20:18:12 -04:00
Dave Horton	283512e765	Merge pull request #6 from jambonz/feat/dial_caller_name feat: update callerName to dial	2023-04-11 20:17:27 -04:00
Quan HL	d7219b990b	feat: update callerName to rest	2023-04-12 06:38:16 +07:00
Quan HL	68b3c7de01	feat: update callerName to dial	2023-04-12 06:30:29 +07:00
Dave Horton	dff94d3ac5	add anchorMedia option to dial verb	2023-04-07 14:05:37 -04:00
Dave Horton	70f7c5ab96	another fix for wakeupWord	2023-03-03 09:16:51 -05:00
Dave Horton	403766cd4d	fix wakeupWord syntax	2023-03-03 09:08:50 -05:00
Dave Horton	10c7f60bad	fix json error	2023-03-02 14:52:10 -05:00
Dave Horton	32f63759db	add options for custom speech	2023-03-02 14:45:12 -05:00
Dave Horton	825130348b	remove enum on speech vendor since we want to allow custom	2023-03-02 13:21:00 -05:00
Dave Horton	f99b94a405	add soniox storage options	2023-02-24 14:35:18 -05:00
Dave Horton	6c40dda566	add options for soniox	2023-02-23 14:19:34 -05:00