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

Interface SvamlActionRunMenu

All Superinterfaces:
SvamlAction
public interface SvamlActionRunMenu extends SvamlAction
Plays an interactive voice response (IVR) menu to the callee. This menu can play pre-recorded files or text-to-speech messages, collect DTMF tones, and trigger the Prompt Input Event (PIE) callback towards your backend, notifying you of the actions the callee took. Available to use in a response to an Incoming Call Event callback or an Answered Call Event callback. Also be used in combination with the Conferences endpoint of the Calling API.

  • Method Details

    • getBarge

      Boolean getBarge()
      'Barging' means that the user can press a DTMF digit before the prompt has finished playing. If a valid input is pressed, the message will stop playing and accept the input. If barge is disabled, the user must listen to the entire prompt before input is accepted. By default, barging is enabled.
      Returns:
      barge

    • getLocale

      String getLocale()
      The voice and language you want to use for the text-to-speech message. This can either be defined by the ISO 639 locale and language code or by specifying a particular voice. Supported languages and voices are detailed here. If using the enableVoice to enable voice detection, the locale property is required in order to select the input language.
      Returns:
      locale

    • getMainMenu

      String getMainMenu()
      Selects the menu item from the menus array to play first.
      Returns:
      mainMenu

    • getEnableVoice

      Boolean getEnableVoice()
      Enables voice detection. If enabled, users can say their answers to prompts in addition to entering them using the keypad.
      Returns:
      enableVoice

    • getMenus

      List<Menu> getMenus()
      The list of menus available. The menu with the id value of main will always play first. If no menu has an id value of main, an error is returned.
      Returns:
      menus

    • builder

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