@vonage/voice/dist/cjs/interfaces/OutboundCall.d.ts

The Voice API lets you create outbound calls, control in-progress calls and get information about historical calls.

import { CallEndpoint } from '../types/Endpoint/CallEndpoint.js';
import { PhoneEndpointObject } from './Endpoint/PhoneEndpointObject.js';
import '../types/Endpoint/PhoneEndpoint.js';
import '../types/Endpoint/SIPEndpoint.js';
import '../types/Endpoint/VBCEndpoint.js';
import '../types/Endpoint/WebsocketEndpoint.js';
import '../types/Endpoint/AppEndpoint.js';

/**
 * Represents an outbound call configuration.
 * @deprecated This interface is deprecated. Please update to use the OutboundCall type.
 */
interface OutboundCall {
    /**
     * The call's destination(s).
     */
    to: CallEndpoint[];
    /**
     * The caller's phone number or endpoint.
     */
    from?: PhoneEndpointObject;
    /**
     * Indicates whether to use a random caller's phone number.
     */
    randomFromNumber?: boolean;
    /**
     * URLs to receive call events.
     */
    eventUrl?: string[];
    /**
     * The HTTP method used to send events to the event URLs.
     */
    eventMethod?: string;
    /**
     * Whether machine detection should be enabled for the call.
     * @deprecated Machine detection behavior should be set separately using `machineDetection` property.
     */
    machineDetection?: boolean;
    /**
     * The length of time to wait for a call answer, in seconds.
     */
    lengthTimer?: number;
    /**
     * The length of time to ring before assuming a no-answer, in seconds.
     */
    ringingTimer?: number;
}

export type { OutboundCall };