@vonage/voice/dist/cjs/types/Endpoint/WebsocketEndpoint.d.ts

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

import { WebsocketAuthorization } from './WebsocketAuthorization.js';
import { WebsocketBitrate } from '../../enums/Endpoint/WebsocketBitrate.js';

/**
 * Represents a WebSocket endpoint, which can be used as a call destination.
 */
type WebsocketEndpoint = {
    /**
     * Specifies the type of endpoint, which is 'websocket' for WebSocket.
     */
    type: 'websocket';
    /**
     * The URI (Uniform Resource Identifier) of the WebSocket endpoint.
     */
    uri: string;
    /**
     * An optional content type to specify the audio format sent to the WebSocket
     * endpoint.
     */
    contentType?: WebsocketBitrate | string;
    /**
     * Optional headers to include when connecting to the WebSocket endpoint.
     */
    headers?: Record<string, unknown>;
    /**
     * Optional configuration defining how the Authorization HTTP header is set
     * in the WebSocket opening handshake.
     */
    authorization?: WebsocketAuthorization;
};

export type { WebsocketEndpoint };