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

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

import { HttpMethod } from '../enums/HttpMethod.js';
import { MachineDetectionBehavior } from '../enums/MachineDetctionBehavior.js';
import { CallEndpoint } from '../types/Endpoint/CallEndpoint.js';
import { PhoneEndpoint } from '../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.
 *
 * @deprecated This class is deprecated. Please update to use the CommonOutboundCall type
 */
declare abstract class OutboundCall {
    /**
     * The list of call endpoints to which the outbound call will be made.
     */
    to: Array<CallEndpoint>;
    /**
     * The phone endpoint object representing the caller's information.
     */
    from?: PhoneEndpoint;
    /**
     * Indicates whether to use a random from number (optional).
     */
    randomFromNumber?: boolean;
    /**
     * The list of event URLs (optional).
     */
    eventUrl?: string[];
    /**
     * The HTTP method to use for event notifications (optional).
     */
    eventMethod?: HttpMethod;
    /**
     * The machine detection behavior (optional).
     */
    machineDetection?: MachineDetectionBehavior;
    /**
     * The length timer for the call (optional).
     */
    lengthTimer?: number;
    /**
     * The ringing timer for the call (optional).
     */
    ringingTimer?: number;
    /**
     * Creates a new outbound call.
     *
     * @param {CallEndpoint} to - The call endpoint to which the outbound call will be made.
     * @param {PhoneEndpointObject} [from] - The phone endpoint object representing the caller's information.
     */
    constructor(to: CallEndpoint, from?: PhoneEndpoint);
}

export { OutboundCall };