Package com.vonage.client.video

Class SipDialRequest.Builder

java.lang.Object
com.vonage.client.video.SipDialRequest.Builder
Enclosing class:
SipDialRequest
public static class SipDialRequest.Builder extends Object
Used to create an SipDialRequest object.
See Also:

  • Constructor Details

  • Method Details

    • uri

      public SipDialRequest.Builder uri(URI uri, boolean secure)
      (REQUIRED) The SIP URI to be used as destination of the SIP call initiated from Vonage to your SIP platform.
      Parameters:
      uri - The URI as an object.
      secure - Whether the negotiation between Vonage and the SIP endpoint will be done securely. Note that this will only apply to the negotiation itself, and not to the transmission of audio. Setting this to true will append transport=tls to the URI. If you also want the audio transmission to be encrypted, set the secure(boolean) property of this builder to true.
      Returns:
      This builder.

    • from

      public SipDialRequest.Builder from(String from)
      (OPTIONAL) The number or string that will be sent to the final SIP number as the caller. It must be a string in the form of from@example.com, where from can be a string or a number. If from is set to a number (for example, "14155550101@example.com"), it will show up as the incoming number on PSTN phones. If from is undefined or set to a string (for example, "joe@example.com"), +00000000 will show up as the incoming number on PSTN phones.
      Parameters:
      from - The caller number or email as a string.
      Returns:
      This builder.

    • username

      public SipDialRequest.Builder username(String username)
      (OPTIONAL, but REQUIRED if password(String) is provided) The username to be used in the SIP INVITE request for HTTP digest authentication, if it is required by your SIP platform.
      Parameters:
      username - The username as a string.
      Returns:
      This builder.
      See Also:

    • password

      public SipDialRequest.Builder password(String password)
      (OPTIONAL) The password corresponding to the username for to be used in the SIP INVITE request.
      Parameters:
      password - The password as a string.
      Returns:
      This builder.
      See Also:

    • addHeader

      public SipDialRequest.Builder addHeader(String key, String value)
      (OPTIONAL) Define a custom header to be added to the SIP INVITE request initiated from Vonage to your SIP platform.
      Parameters:
      key - The header key.
      value - The header value.
      Returns:
      This builder.
      See Also:

    • addHeaders

      public SipDialRequest.Builder addHeaders(Map<String,String> headers)
      (OPTIONAL) Define custom headers (i.e. those starting with "X-") to be added to the SIP INVITE request initiated from Vonage to your SIP platform.
      Parameters:
      headers - Custom header key-value pairs as strings.
      Returns:
      This builder.
      See Also:

    • secure

      public SipDialRequest.Builder secure(boolean secure)
      (OPTIONAL) Flag that indicates whether the media must be transmitted encrypted (true) or not (false, the default).
      Parameters:
      secure - Whether media should be transmitted securely.
      Returns:
      This builder.

    • video

      public SipDialRequest.Builder video(boolean video)
      (OPTIONAL) Flag that indicates whether the SIP call will include video (true) or not (false, the default). With video included, the SIP client's video is included in the video stream that is sent to the Vonage video session. The SIP client will receive a single composed video of the published streams in the Vonage video session.
      Parameters:
      video - Whether to include video in the SIP call.
      Returns:
      This builder.

    • observeForceMute

      public SipDialRequest.Builder observeForceMute(boolean observeForceMute)
      (OPTIONAL) flag that indicates whether the SIP end point observes force mute moderation (true) or not (false, the default). Also, with observeForceMute set to true, the caller can press "*6" to unmute and mute the published audio. For the "*6" mute toggle to work, the SIP caller must negotiate RFC2833 DTMFs (RFC2833/RFC4733 digits). The mute toggle is not supported with SIP INFO or in-band DTMFs. A message (in English) is played to the caller when the caller mutes and unmutes, or when the SIP client is muted through a force mute action.
      Parameters:
      observeForceMute - Whether to observe forceMute moderation.
      Returns:
      This builder.

    • build

      public SipDialRequest build()
      Builds the SipDialRequest object with this builder's settings.
      Returns:
      A new SipDialRequest instance.