feat(voice): adding advanced machine detection (#835)

Vonage · Jun 26, 2023 · 1739320 · 1739320
1 parent 858b41e
commit 1739320
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 11 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/voice/__tests__/__dataSets__/create.ts b/packages/voice/__tests__/__dataSets__/create.ts
@@ -1,4 +1,5 @@
 import {
+  AdvancedMachineDetectionMode,
   CallDirection,
   CallStatus,
   HttpMethod,
@@ -41,6 +42,11 @@ export default [
           event_url: ['example.com'],
           event_method: HttpMethod.GET,
           machine_detection: MachineDetectionBehavior.CONTINUE,
+          advanced_machine_detection: {
+            behavior: MachineDetectionBehavior.HANGUP,
+            mode: AdvancedMachineDetectionMode.DETECT,
+            beep_timeout: 42,
+          },
           length_timer: 84,
           ringing_timer: 126,
         },
@@ -80,6 +86,11 @@ export default [
         eventUrl: ['example.com'],
         eventMethod: HttpMethod.GET,
         machineDetection: MachineDetectionBehavior.CONTINUE,
+        advancedMachineDetection: {
+          behavior: MachineDetectionBehavior.HANGUP,
+          mode: AdvancedMachineDetectionMode.DETECT,
+          beepTimeout: 42,
+        },
         lengthTimer: 84,
         ringingTimer: 126,
       } as CallWithNCCO,
@@ -117,6 +128,11 @@ export default [
           event_url: ['example.com'],
           event_method: HttpMethod.GET,
           machine_detection: MachineDetectionBehavior.CONTINUE,
+          advanced_machine_detection: {
+            behavior: MachineDetectionBehavior.HANGUP,
+            mode: AdvancedMachineDetectionMode.DETECT,
+            beep_timeout: 42,
+          },
           length_timer: 84,
           ringing_timer: 126,
         },
@@ -152,6 +168,11 @@ export default [
         eventUrl: ['example.com'],
         eventMethod: HttpMethod.GET,
         machineDetection: MachineDetectionBehavior.CONTINUE,
+        advancedMachineDetection: {
+          behavior: MachineDetectionBehavior.HANGUP,
+          mode: AdvancedMachineDetectionMode.DETECT,
+          beepTimeout: 42,
+        },
         lengthTimer: 84,
         ringingTimer: 126,
       } as CallWithAnswerURL,

diff --git a/packages/voice/__tests__/ncco.lagecy.test.ts → packages/voice/__tests__/ncco.test.ts b/packages/voice/__tests__/ncco.lagecy.test.ts → packages/voice/__tests__/ncco.test.ts
diff --git a/packages/voice/lib/enums/AdvancedMachineDetectionMode.ts b/packages/voice/lib/enums/AdvancedMachineDetectionMode.ts
@@ -0,0 +1,4 @@
+export enum AdvancedMachineDetectionMode {
+  DETECT = 'detect',
+  DETECTBEEP = 'detect_beep',
+}
diff --git a/packages/voice/lib/enums/index.ts b/packages/voice/lib/enums/index.ts
@@ -1,3 +1,4 @@
+export * from './AdvancedMachineDetectionMode';
 export * from './CallDirection';
 export * from './CallStatus';
 export * from './HttpMethod';

diff --git a/packages/voice/lib/interfaces/OutboundCall.ts b/packages/voice/lib/interfaces/OutboundCall.ts
@@ -1,6 +1,5 @@
 import { CallEndpoint } from '../types/Endpoint/CallEndpoint';
 import { PhoneEndpointObject } from './Endpoint/PhoneEndpointObject';
-
 import debug from 'debug';
 
 debug('@vonage/voice')(

diff --git a/packages/voice/lib/types/AdvancedMachineDetection.ts b/packages/voice/lib/types/AdvancedMachineDetection.ts
@@ -0,0 +1,10 @@
+import {
+  MachineDetectionBehavior,
+  AdvancedMachineDetectionMode,
+} from '../enums/index';
+
+export type AdvancedMachineDetection = {
+  behavior: MachineDetectionBehavior;
+  mode: AdvancedMachineDetectionMode;
+  beepTimeout?: number;
+};
diff --git a/packages/voice/lib/types/CommonOutboundCall.ts b/packages/voice/lib/types/CommonOutboundCall.ts
@@ -1,10 +1,12 @@
 import { HttpMethod, MachineDetectionBehavior } from '../enums/index';
 import { CallEndpoint } from './Endpoint/index';
+import { AdvancedMachineDetection } from './AdvancedMachineDetection';
 import { CommonCallFields } from './CommonCallFields';
 
 export type CommonOutboundCall = Omit<CommonCallFields, 'to'> & {
   to: Array<CallEndpoint>;
   machineDetection?: MachineDetectionBehavior;
+  advancedMachineDetection?: AdvancedMachineDetection;
   lengthTimer?: number;
   ringingTimer?: number;
   eventUrl?: string[];

diff --git a/packages/voice/lib/types/Requests/CreateCallRequest.ts b/packages/voice/lib/types/Requests/CreateCallRequest.ts
@@ -1,17 +1,22 @@
 import { OutboundCall } from '../OutboundCall';
+import { AdvancedMachineDetection } from '../AdvancedMachineDetection';
 import { MachineDetection } from '../../enums';
 
 export type CreateCallRequest = {
   random_from_number?: boolean;
   event_url?: Array<string>;
   machine_detection?: MachineDetection;
+  advanced_machine_detection: {
+    beep_timeout?: number;
+  } & Omit<AdvancedMachineDetection, 'beepTimeout'>;
   length_timer?: number;
   ringing_timer?: number;
 } & Omit<
   OutboundCall,
   | 'randomFromNumber'
   | 'eventUrl'
   | 'machineDetection'
+  | 'advancedMachineDetection'
   | 'lengthTimer'
   | 'ringingTimer'
 >;
diff --git a/packages/voice/lib/types/index.ts b/packages/voice/lib/types/index.ts
@@ -1,3 +1,4 @@
+export * from './AdvancedMachineDetection';
 export * from './BasicCallDetail';
 export * from './CallDetail';
 export * from './CallResult';

diff --git a/packages/voice/package.json b/packages/voice/package.json
@@ -31,10 +31,12 @@
         "compile": "npx tsc --build --verbose"
     },
     "dependencies": {
+        "@types/debug": "^4.1.8",
         "@vonage/auth": "^1.3.0",
         "@vonage/server-client": "^1.4.0",
         "@vonage/vetch": "^1.3.0",
-        "debug": "^4.3.4"
+        "debug": "^4.3.4",
+        "ts-xor": "^1.1.0"
     },
     "devDependencies": {
         "@types/debug": "^4.1.8",