-
Notifications
You must be signed in to change notification settings - Fork 180
/
CommonOutboundCall.ts
45 lines (38 loc) · 1.22 KB
/
CommonOutboundCall.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
import { HttpMethod, MachineDetectionBehavior } from '../enums';
import { CallEndpoint } from './Endpoint';
import { AdvancedMachineDetection } from './AdvancedMachineDetection';
import { CommonCallFields } from './CommonCallFields';
/**
* Represents common fields for defining an outbound call, including the caller (from) and recipient (to) endpoints,
* along with additional call parameters.
*/
export type CommonOutboundCall = Omit<CommonCallFields, 'to'> & {
/**
* An array of recipient endpoints for the call.
*/
to: Array<CallEndpoint>;
/**
* Specifies the behavior for machine detection during the call.
*/
machineDetection?: MachineDetectionBehavior;
/**
* Advanced machine detection settings for the call.
*/
advancedMachineDetection?: AdvancedMachineDetection;
/**
* The length of time to wait for call answer, in seconds.
*/
lengthTimer?: number;
/**
* The length of time to wait for the call to ring before considering it unanswered, in seconds.
*/
ringingTimer?: number;
/**
* An array of URLs to notify with call events.
*/
eventUrl?: string[];
/**
* The HTTP method to use when sending events to the specified event URLs.
*/
eventMethod?: HttpMethod;
};