Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface Menu

    An IVR menu that contains an audio prompt as well as configured options.

    interface Menu {
        id: string;
        mainPrompt?: string;
        maxDigits?: number;
        maxTimeoutMills?: number;
        options?: Option[];
        repeatPrompt?: string;
        repeats?: number;
        timeoutMills?: number;
    }
    Index

    Properties

    id mainPrompt? maxDigits? maxTimeoutMills? options? repeatPrompt? repeats? timeoutMills?

    Properties

    id: string

    The identifier of a menu. One menu must have the ID value of main.

    mainPrompt?: string

    The main voice prompt that the user hears when the menu starts the first time. You can use text-to-speech using the #tts[] element, SSML commands using the #ssml[] element, pre-recorded messages, or URL references to external media resources. You can use multiple prompts by separating each prompt with a semi-colon (;). If multiple prompts are used, they will be played in the order they are specified, without any pauses between playback. For external media resources, you can use an #href[...] or directly specify the full URL. Check the Supported audio formats section for more information.

    maxDigits?: number

    The maximum number of digits expected for a user to enter. Once these digits are collected, a Prompt Input Event (PIE) is triggered containing these digits.

    maxTimeoutMills?: number

    Sets a limit for the maximum amount of time allowed to collect voice input.

    options?: Option[]

    The set of options available in the menu.

    repeatPrompt?: string

    The prompt that will be played if valid or expected DTMF digits are not entered. You can use text-to-speech using the #tts[] element, SSML commands using the #ssml[] element, pre-recorded messages, or URL references to external media resources. You can use multiple prompts by separating each prompt with a semi-colon (;). If multiple prompts are used, they will be played in the order they are specified, without any pauses between playback. For external media resources, you can use an #href[...] or directly specify the full URL. Check the Supported audio formats section for more information.

    repeats?: number

    The number of times that the repeatPrompt is played.

    timeoutMills?: number

    Determines silence for the purposes of collecting a DTMF or voice response in milliseconds. If the timeout is reached, the response is considered completed and will be submitted.

    Settings

    Member Visibility

    On This Page

    Properties