Package com.sinch.sdk.domains.voice.models.v1.svaml.action

Interface Menu

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Menu.Builder
    Dedicated Builder

  • Method Summary

    Modifier and Type
    Method
    Description
    static Menu.Builder
    builder()
    Getting builder
    String
    getId()
    The identifier of a menu.
    String
    getMainPrompt()
    The main voice prompt that the user hears when the menu starts the first time.
    Integer
    getMaxDigits()
    The maximum number of digits expected for a user to enter.
    Integer
    getMaxTimeoutMills()
    Sets a limit for the maximum amount of time allowed to collect voice input.
    List<MenuOption>
    getOptions()
    The set of options available in the menu.
    String
    getRepeatPrompt()
    The prompt that will be played if valid or expected DTMF digits are not entered.
    Integer
    getRepeats()
    The number of times that the repeatPrompt is played.
    Integer
    getTimeoutMills()
    Determines silence for the purposes of collecting a DTMF or voice response in milliseconds.

  • Method Details

    • getId

      String getId()
      The identifier of a menu. One menu must have the ID value of main.
      Returns:
      id

    • getMainPrompt

      String getMainPrompt()
      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.
      Returns:
      mainPrompt

    • getRepeatPrompt

      String getRepeatPrompt()
      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.
      Returns:
      repeatPrompt

    • getRepeats

      Integer getRepeats()
      The number of times that the repeatPrompt is played.
      Returns:
      repeats

    • getMaxDigits

      Integer getMaxDigits()
      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.
      Returns:
      maxDigits

    • getTimeoutMills

      Integer getTimeoutMills()
      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.
      Returns:
      timeoutMills

    • getMaxTimeoutMills

      Integer getMaxTimeoutMills()
      Sets a limit for the maximum amount of time allowed to collect voice input.
      Returns:
      maxTimeoutMills

    • getOptions

      List<MenuOption> getOptions()
      The set of options available in the menu.
      Returns:
      options

    • builder

      static Menu.Builder builder()
      Getting builder
      Returns:
      New Builder instance