Class ConversationAction

Namespace

Vonage.Voice.Nccos

Assembly

Vonage.dll

Represents a NCCO Conversation.

public class ConversationAction : NccoAction

Inheritance

object

NccoAction

ConversationAction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Action

Returns the Conversation ActionType.

[JsonProperty("action", Order = 0)]
public override NccoAction.ActionType Action { get; }

Property Value

NccoAction.ActionType

CanHear

A list of leg UUIDs that this participant can hear. If not provided, the participant can hear everyone. If an empty list is provided, the participant will not hear any other participants

[JsonProperty("canHear", Order = 7)]
public string[] CanHear { get; set; }

Property Value

string[]

CanSpeak

A list of leg UUIDs that this participant can be heard by. If not provided, the participant can be heard by everyone. If an empty list is provided, the participant will not be heard by anyone

[JsonProperty("canSpeak", Order = 6)]
public string[] CanSpeak { get; set; }

Property Value

string[]

EndOnExit

Specifies whether a moderated conversation ends when the moderator hangs up. This is set to false by default, which means that the conversation only ends when the last remaining participant hangs up, regardless of whether the moderator is still on the call. Set endOnExit to true to terminate the conversation when the moderator hangs up.

[JsonProperty("endOnExit", Order = 4)]
public bool EndOnExit { get; set; }

Property Value

bool

EventMethod

Method to use on the webhooks for the conversation

[JsonProperty("eventMethod")]
public string EventMethod { get; set; }

Property Value

string

EventUrl

Url to receive webhooks at for the conversation

[JsonProperty("eventUrl")]
public string[] EventUrl { get; set; }

Property Value

string[]

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.

[JsonProperty("musicOnHoldUrl", Order = 2)]
public string[] MusicOnHoldUrl { get; set; }

Property Value

string[]

Name

The name of the Conversation room. Names are namespaced to the application level.

[JsonProperty("name", Order = 1)]
public string Name { get; set; }

Property Value

string

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

[JsonProperty("record", Order = 5)]
public bool Record { get; set; }

Property Value

bool

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.

[JsonProperty("startOnEnter", DefaultValueHandling = DefaultValueHandling.Include, Order = 3)]
public bool StartOnEnter { get; set; }

Property Value

bool