Package com.vonage.client.voice.ncco

Class ConversationAction.Builder

java.lang.Object
com.vonage.client.voice.ncco.ConversationAction.Builder
Enclosing class:
ConversationAction
public static class ConversationAction.Builder extends Object

  • Method Details

    • name

      public ConversationAction.Builder name(String name)
      Parameters:
      name - The name of the Conversation room.
      Returns:
      This builder.

    • musicOnHoldUrl

      public ConversationAction.Builder musicOnHoldUrl(Collection<String> musicOnHoldUrl)
      Parameters:
      musicOnHoldUrl - A URL to the mp3 file to stream to participants until the conversation starts. By default the conversation starts when the first person calls the virtual number associated with your Voice app. To stream this mp3 before the moderator joins the conversation, set startOnEnter to false for all users other than the moderator.
      Returns:
      This builder.

    • musicOnHoldUrl

      public ConversationAction.Builder musicOnHoldUrl(String... musicOnHoldUrl)
      Parameters:
      musicOnHoldUrl - A URL to the mp3 file to stream to participants until the conversation starts. By default the conversation starts when the first person calls the virtual number associated with your Voice app. To stream this mp3 before the moderator joins the conversation, set startOnEnter to false for all users other than the moderator.
      Returns:
      This builder.

    • startOnEnter

      public ConversationAction.Builder startOnEnter(Boolean startOnEnter)
      Parameters:
      startOnEnter - The default value of true ensures that the conversation starts when this caller joins conversation name. Set to false for attendees in a moderated conversation.
      Returns:
      This builder.

    • endOnExit

      public ConversationAction.Builder endOnExit(Boolean endOnExit)
      Parameters:
      endOnExit - For moderated conversations, set to true in the moderator NCCO so the conversation is ended when the moderator hangs up. The default value of false means the conversation is not terminated when a caller hangs up; the conversation ends when the last caller hangs up.
      Returns:
      This builder.

    • record

      public ConversationAction.Builder record(Boolean record)
      Parameters:
      record - Set to true to record this conversation. For standard conversations, recordings start when one or more attendees connects to the conversation. For moderated conversations, recordings start when the moderator joins. That is, when an NCCO is executed for the named conversation where startOnEnter is set to true. When the recording is terminated, the URL you download the recording from is sent to the event URL.

      By default audio is recorded in MP3 format. See the recording guide for more details

      Returns:
      This builder.

    • eventUrl

      public ConversationAction.Builder eventUrl(Collection<String> eventUrl)
      Parameters:
      eventUrl - Set the URL to the webhook endpoint Vonage calls asynchronously on each of the Call States.
      Returns:
      This builder.

    • eventUrl

      public ConversationAction.Builder eventUrl(String... eventUrl)
      Parameters:
      eventUrl - Set the URL to the webhook endpoint Vonage calls asynchronously on each of the Call States.
      Returns:
      This builder.

    • eventMethod

      public ConversationAction.Builder eventMethod(EventMethod eventMethod)
      Parameters:
      eventMethod - Set the HTTP method used to make the request to eventUrl. The default value is POST.
      Returns:
      This builder.

    • build

      public ConversationAction build()
      Returns:
      A new ConversationAction object from the stored builder options.