Interface SvamlActionConnectSip

All Superinterfaces:
SvamlAction

public interface SvamlActionConnectSip extends SvamlAction
Determines how to route a call to a SIP server. Available to use in a response to an Incoming Call Event callback.
  • Method Details

    • getDestination

      DestinationSip getDestination()
      Get destination
      Returns:
      destination
    • 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
    • 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
    • getTransport

      An optional parameter to specify the SIP transport protocol. If unspecified, UDP is used.
      Returns:
      transport
    • getSuppressCallbacks

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

      List<CallHeader> getCallHeaders()
      Private SIP headers to send with the call.
      Returns:
      callHeaders
    • getMusicOnHold

      MusicOnHold getMusicOnHold()
      Means "music on hold". If this optional parameter is included, plays music to the connected participant if the SIP call is placed on hold. If moh isn't specified and the SIP call is placed on hold, the user will only hear silence while during the holding period .
      Returns:
      MusicOnHold
    • builder

      Getting builder
      Returns:
      New Builder instance