Package com.sinch.sdk.domains.voice.models.v1.callouts.request

Interface CalloutRequestConference

All Superinterfaces:
CalloutRequest
public interface CalloutRequestConference extends CalloutRequest
CalloutRequestConference

  • Method Details

    • getCli

      String getCli()
      The number that will be displayed as the incoming caller. To set your own CLI, you may use your verified number or your Dashboard number. The number must be in E.164 format.
      Returns:
      cli

    • getDtmf

      DualToneMultiFrequency getDtmf()
      When the destination picks up, this DTMF tones will be played to the callee. Valid characters in the string are "0"-"9", "#" and "w". A "w" will render a 500 ms pause. Example: "ww1234#w#" will render a 1s pause, the DTMF tones "1", "2", "3", "4" and "#" followed by a 0.5s pause and finally the DTMF tone for "#". This can be used if the callout destination for instance require a conference PIN code or an extension to be entered.
      Returns:
      dtmf

    • getCustom

      String getCustom()
      Used to input custom data.
      Returns:
      custom

    • getDestination

      DestinationConference getDestination()
      Get destination
      Returns:
      destination

    • getConferenceId

      String getConferenceId()
      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.
      Returns:
      conferenceId

    • getConferenceDtmfOptions

      ConferenceDtmfOptions getConferenceDtmfOptions()
      Get conferenceDtmfOptions
      Returns:
      conferenceDtmfOptions

    • getMaxDuration

      Integer getMaxDuration()
      Get maxDuration
      Returns:
      maxDuration

    • getEnableAce

      Boolean getEnableAce()
      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.
      Returns:
      enableAce

    • getEnableDice

      Boolean getEnableDice()
      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.
      Returns:
      enableDice

    • getEnablePie

      Boolean getEnablePie()
      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.
      Returns:
      enablePie

    • getLocale

      String getLocale()
      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. Supported languages and voices are detailed here
      Returns:
      locale

    • getGreeting

      String getGreeting()
      The text that will be spoken as a greeting.
      Returns:
      greeting

    • getMusicOnHold

      MusicOnHold getMusicOnHold()
      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. It can take one of these pre-defined values:
      • ring (progress tone)
      • music1 (music file)
      • music2 (music file)
      • music3 (music file)

      If no “music-on-hold” is specified, the user will only hear silence.
      Returns:
      MusicOnHold

    • getDomain

      Domain getDomain()
      can be either “pstn” for PSTN endpoint or “mxp” for data (app or web) clients.
      Returns:
      domain

    • builder

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