@jambonz/sdk
    Preparing search index...

    Interface ListenVerb

    interface ListenVerb {
        verb: "listen";
        id?: string;
        url: string;
        actionHook?: ActionHook;
        wsAuth?: Auth;
        mixType?: "mono" | "stereo" | "mixed";
        metadata?: Record<string, unknown>;
        sampleRate?: number;
        finishOnKey?: string;
        maxLength?: number;
        passDtmf?: boolean;
        playBeep?: boolean;
        disableBidirectionalAudio?: boolean;
        bidirectionalAudio?: BidirectionalAudio;
        timeout?: number;
        transcribe?: Omit<TranscribeVerb, "verb">;
        earlyMedia?: boolean;
        channel?: number;
    }
    Index

    Properties

    verb id? url actionHook? wsAuth? mixType? metadata? sampleRate? finishOnKey? maxLength? passDtmf? playBeep? disableBidirectionalAudio? bidirectionalAudio? timeout? transcribe? earlyMedia? channel?

    Properties

    verb: "listen"
    id?: string
    url: string

    Websocket URL to stream audio to.

    actionHook?: ActionHook

    Webhook when listen ends.

    wsAuth?: Auth

    Websocket auth credentials.

    mixType?: "mono" | "stereo" | "mixed"

    Audio channel mixing mode.

    metadata?: Record<string, unknown>

    Metadata sent with initial connection.

    sampleRate?: number

    Audio sample rate in Hz.

    finishOnKey?: string

    DTMF key that ends the session.

    maxLength?: number

    Max duration in seconds.

    passDtmf?: boolean

    Forward DTMF events to websocket.

    playBeep?: boolean

    Play beep before streaming.

    disableBidirectionalAudio?: boolean

    Disable receiving audio from websocket.

    bidirectionalAudio?: BidirectionalAudio

    Bidirectional audio configuration.

    timeout?: number

    Inactivity timeout in seconds.

    transcribe?: Omit<TranscribeVerb, "verb">

    Simultaneous transcription config.

    earlyMedia?: boolean

    Stream before call is answered.

    channel?: number

    Specific audio channel to stream.

    Settings

    Member Visibility

    On This Page

    Properties