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

Interface SvamlActionConnectPstn

All Superinterfaces:
SvamlAction
public interface SvamlActionConnectPstn extends SvamlAction
Determines how a PSTN call is connected. Available to use in a response to an Incoming Call Event callback.

  • Method Details

    • getNumber

      String getNumber()
      Used to override where PSTN call is connected. If not specified, the extension the client called is used.
      Returns:
      number

    • getLocale

      String getLocale()
      Specifies the locale. Uses the language code according to ISO 639, a dash (- ), and a country code according to ISO 3166-1 alpha-2. If not specified, the default locale of en-US is used.
      Returns:
      locale

    • getMaxDuration

      Integer getMaxDuration()
      The max duration of the call in seconds (max 14400 seconds). If the call is still connected at that time, it will be automatically disconnected.
      Returns:
      maxDuration

    • getDialTimeout

      Integer getDialTimeout()
      The max duration the call will wait in ringing unanswered state before terminating with TIMEOUT/NO ANSWER on PSTN leg and NA/BUSYon MXP leg.
      Returns:
      dialTimeout

    • getCli

      String getCli()
      Used to override the CLI (or caller ID) of the client. The phone number of the person who initiated the call is shown as the CLI. To set your own CLI, you may use your verified number or your Dashboard virtual number.
      Returns:
      cli

    • getSuppressCallbacks

      Boolean getSuppressCallbacks()
      If enabled, suppresses ACE and DICE callbacks for the call.
      Returns:
      suppressCallbacks

    • getDtmf

      DualToneMultiFrequency getDtmf()
      A string that determines the DTMF tones to play to the callee when the call is picked up. Valid characters are: 0-9, #, and w. w renders a 500ms pause. For example, the string ww1234#w#, plays a 1 second pause, the DTMF tones for 1, 2, 3, 4, and #, followed by a 500ms pause and finally the # tone. This is useful if the callout destination requires a conference PIN code or an extension. If there is a calling party, it will hear progress while the DTMF is sent.
      Returns:
      dtmf

    • getIndications

      SvamlActionConnectPstn.IndicationsEnum getIndications()
      The locale's tone to play while ringing.
      Returns:
      indications

    • getAmd

      ConnectPstnAnsweringMachineDetection getAmd()
      Get amd
      Returns:
      amd

    • builder

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