Class RecordAction

Namespace

Vonage.Voice.Nccos

Assembly

Vonage.dll

Represents an NCCO Record action that records the call audio. The recording is available for download via the recording webhook.

public class RecordAction : NccoAction

Inheritance

object

NccoAction

RecordAction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Action

The type of NCCO action to execute.

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

Property Value

NccoAction.ActionType

BeepStart

Set to true to play a beep when a recording starts

[JsonProperty("beepStart", Order = 8)]
public bool BeepStart { get; set; }

Property Value

bool

Channels

The number of channels to record (maximum 32). If the number of participants exceeds channels any additional participants will be added to the last channel in file. split conversation must also be enabled

[JsonProperty("channels", Order = 3)]
public uint? Channels { get; set; }

Property Value

uint?

EndOnKey

Stop recording when a digit is pressed on the handset. Possible values are: *, # or any single digit e.g. 9

[JsonProperty("endOnKey", Order = 5)]
public string EndOnKey { get; set; }

Property Value

string

EndOnSilence

Stop recording after n seconds of silence. Once the recording is stopped the recording data is sent to event_url. The range of possible values is 3<=endOnSilence<=10.

[JsonProperty("endOnSilence", Order = 4)]
public string EndOnSilence { get; set; }

Property Value

string

EventMethod

The HTTP method used to make the request to eventUrl. The default value is POST.

[JsonProperty("eventMethod", Order = 10)]
public string EventMethod { get; set; }

Property Value

string

EventUrl

The URL to the webhook endpoint that is called asynchronously when a recording is finished. If the message recording is hosted by Vonage, this webhook contains the URL you need to download the recording and other meta data.

[JsonProperty("eventUrl", Order = 9)]
public string[] EventUrl { get; set; }

Property Value

string[]

Format

Record the Call in a specific format. The default value is mp3, or wav when recording more than 2 channels.

[JsonProperty("format", Order = 1)]
public RecordAction.AudioFormat? Format { get; set; }

Property Value

RecordAction.AudioFormat?

Split

Record the sent and received audio in separate channels of a stereo recording—set to conversation to enable this.

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

Property Value

string

TimeOut

The maximum length of a recording in seconds. One the recording is stopped the recording data is sent to event_url. The range of possible values is between 3 seconds and 7200 seconds (2 hours)

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

Property Value

string

Transcription

Set to an empty object, {}, to use the default values or customize with Transcription Settings

[JsonProperty("transcription", Order = 11)]
public RecordAction.TranscriptionSettings Transcription { get; set; }

Property Value

RecordAction.TranscriptionSettings