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

Interface SvamlActionPark

All Superinterfaces:
SvamlAction
public interface SvamlActionPark extends SvamlAction
Parks the call and places the caller on hold. The caller is placed into a loop, listening to an IVR prompt (either a pre-recorded audio file or generated by text to speech). If the call is unparked, prompts will stop playing immediately. If the max duration is reached, the last prompt will be fully played until the call ends.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    SvamlActionPark.Builder
    Dedicated Builder
    static class 
    SvamlActionPark.NameEnum
    The name property.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SvamlActionPark.Builder
    builder()
    Getting builder
    String
    getHoldPrompt()
    The prompt that is played on repeat until the call is unparked or the until the maxDuration value is reached.
    String
    getIntroPrompt()
    That prompt that is played when the call is first answered.
    String
    getLocale()
    The voice and language you want to use for the text-to-speech message.
    Integer
    getMaxDuration()
    The maximum amount of time in seconds that the holdPrompt will be played.

  • Method Details

    • 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.
      Returns:
      locale

    • getIntroPrompt

      String getIntroPrompt()
      That prompt that is played when the call is first answered. You can use text-to-speech using the #tts[] element, SSML commands using the #ssml[] element.
      Returns:
      introPrompt

    • getHoldPrompt

      String getHoldPrompt()
      The prompt that is played on repeat until the call is unparked or the until the maxDuration value is reached. You can use text-to-speech using the #tts[] element, SSML commands using the #ssml[] element.
      Returns:
      holdPrompt

    • getMaxDuration

      Integer getMaxDuration()
      The maximum amount of time in seconds that the holdPrompt will be played.
      Returns:
      maxDuration

    • builder

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