Package com.sinch.sdk.domains.voice.models.requests

Class CalloutRequestParametersConference.Builder

java.lang.Object
com.sinch.sdk.domains.voice.models.requests.CalloutRequestParameters.Builder<CalloutRequestParametersConference.Builder>
com.sinch.sdk.domains.voice.models.requests.CalloutRequestParametersConference.Builder
Enclosing class:
CalloutRequestParametersConference
public static class CalloutRequestParametersConference.Builder extends CalloutRequestParameters.Builder<CalloutRequestParametersConference.Builder>

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • setConferenceId

      public CalloutRequestParametersConference.Builder setConferenceId(String conferenceId)
      The conferenceId of the conference to which you want the callee to join. * If the * conferenceId doesn't exist a conference room will be created.
      Parameters:
      conferenceId - The conference value
      Returns:
      current builder

    • setDtfmOptions

      public CalloutRequestParametersConference.Builder setDtfmOptions(ConferenceDtfmOptions dtfmOptions)
      Define Dual Tone Multi Frequency options to control how DTMF signals are used by the participant in the conference
      Parameters:
      dtfmOptions - DTFM definition
      Returns:
      current builder

    • setMaxDuration

      public CalloutRequestParametersConference.Builder setMaxDuration(Integer maxDuration)
      The maximum amount of time in seconds that the call will last.
      Parameters:
      maxDuration - Max duration value
      Returns:
      current builder

    • setEnableAce

      public CalloutRequestParametersConference.Builder setEnableAce(Boolean enableAce)
      If enableAce is set to true and the application has a callback URL specified, you will receive an ACE callback when the call is answered. When the callback is received, your platform must respond with a svamlet containing the connectConf action in order to add the call to a conference or create the conference if it's the first call. If it's set to false, no ACE event will be sent to your backend. Note if the call is towards an InApp destination type: username, then no ACE will be issued when the call is connected, even if enableAce is present in the callout request.
      Parameters:
      enableAce - is enabled or not
      Returns:
      current builder

    • setEnableDice

      public CalloutRequestParametersConference.Builder setEnableDice(Boolean enableDice)
      If enableDice is set to true and the application has a callback URL specified, you will receive a DiCE callback when the call is disconnected. If it's set to false, no DiCE event will be sent to your backend. Note if the call is towards an InApp destination type: username, then no DICE will be issued at the end of the call, even if enableDice is present in the callout request.
      Parameters:
      enableDice - is enabled or not
      Returns:
      current builder

    • setEnablePie

      public CalloutRequestParametersConference.Builder setEnablePie(Boolean enablePie)
      If enablePie is set to true and the application has a callback URL specified, you will receive a PIE callback after a runMenu action, with the information of the action that the user took. If it's set to false, no PIE event will be sent to your backend.
      Parameters:
      enablePie - is enabled or not
      Returns:
      current builder

    • setLocale

      public CalloutRequestParametersConference.Builder setLocale(String locale)
      The voice and language you want to use for the prompts. This can either be defined by the ISO 639 locale and language code or by specifying a particular voice.
      Parameters:
      locale - The locale to be used
      Returns:
      current builder
      See Also:

    • setGreeting

      public CalloutRequestParametersConference.Builder setGreeting(String greeting)
      Set the text that will be spoken as a greeting.
      Parameters:
      greeting - the text value
      Returns:
      current builder

    • setMusicOnHold

      public CalloutRequestParametersConference.Builder setMusicOnHold(MusicOnHoldType musicOnHold)
      Means "music-on-hold." It's an optional parameter that specifies what the first participant should listen to while they're alone in the conference, waiting for other participants to join.
      Parameters:
      musicOnHold - The music-on-hold to be used
      Returns:
      current builder

    • setDomain

      public CalloutRequestParametersConference.Builder setDomain(DomainType domain)
      Domain related call
      Parameters:
      domain - Domain to be used
      Returns:
      current builder

    • build

      public CalloutRequestParametersConference build()