@jambonz/sdk
    Preparing search index...

    Interface GatherVerb

    interface GatherVerb {
        verb: "gather";
        id?: string;
        actionHook?: ActionHook;
        input?: ("speech" | "digits")[];
        finishOnKey?: string;
        numDigits?: number;
        minDigits?: number;
        maxDigits?: number;
        interDigitTimeout?: number;
        speechTimeout?: number;
        timeout?: number;
        partialResultHook?: ActionHook;
        listenDuringPrompt?: boolean;
        dtmfBargein?: boolean;
        bargein?: boolean;
        minBargeinWordCount?: number;
        recognizer?: Recognizer;
        say?: Omit<SayVerb, "verb">;
        play?: Omit<PlayVerb, "verb">;
        fillerNoise?: FillerNoise;
        actionHookDelayAction?: ActionHookDelayAction;
    }
    Index

    Properties

    verb id? actionHook? input? finishOnKey? numDigits? minDigits? maxDigits? interDigitTimeout? speechTimeout? timeout? partialResultHook? listenDuringPrompt? dtmfBargein? bargein? minBargeinWordCount? recognizer? say? play? fillerNoise? actionHookDelayAction?

    Properties

    verb: "gather"
    id?: string
    actionHook?: ActionHook

    Webhook to invoke with collected input.

    input?: ("speech" | "digits")[]

    Input types to accept.

    finishOnKey?: string

    DTMF key that signals end of input.

    numDigits?: number

    Exact number of digits to collect.

    minDigits?: number

    Minimum digits required.

    maxDigits?: number

    Maximum digits to collect.

    interDigitTimeout?: number

    Seconds between digits before input complete.

    speechTimeout?: number

    Seconds of silence after speech.

    timeout?: number

    Overall timeout in seconds.

    partialResultHook?: ActionHook

    Webhook for interim speech results.

    listenDuringPrompt?: boolean

    Listen for input while prompt plays.

    dtmfBargein?: boolean

    DTMF interrupts playing prompt.

    bargein?: boolean

    Speech interrupts playing prompt.

    minBargeinWordCount?: number

    Minimum words before barge-in triggers.

    recognizer?: Recognizer

    Override session-level STT config.

    say?: Omit<SayVerb, "verb">

    Nested say prompt (without 'verb' property).

    play?: Omit<PlayVerb, "verb">

    Nested play prompt (without 'verb' property).

    fillerNoise?: FillerNoise

    Filler noise while waiting for actionHook.

    actionHookDelayAction?: ActionHookDelayAction

    Handle slow actionHook responses.

    Settings

    Member Visibility

    On This Page

    Properties