Package com.vonage.client.voice.ncco

Class TranscriptionSettings

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.voice.ncco.TranscriptionSettings

All Implemented Interfaces:

Jsonable

public final class TranscriptionSettings
extends JsonableBaseObject

Customisable settings for call recording transcription.

Since:

8.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TranscriptionSettings.Builder	Builder for setting the TranscriptionSettings parameters.

Method Summary

Modifier and Type	Method	Description
static TranscriptionSettings.Builder	builder()	Entrypoint for constructing an instance of this class.
EventMethod	getEventMethod()	The HTTP method Vonage uses to make the request to getEventUrl().
List<URI>	getEventUrl()	The URL to the webhook endpoint that is called asynchronously when a transcription is finished.
SpeechSettings.Language	getLanguage()	Language for the recording transcription.
Boolean	getSentimentAnalysis()	Perform sentiment analysis on the call recording transcription segments.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Method Details

getLanguage

public SpeechSettings.Language getLanguage()

Language for the recording transcription.

Returns:

The language as an enum, or null if unspecified.

getEventUrl

public List<URI> getEventUrl()

The URL to the webhook endpoint that is called asynchronously when a transcription is finished.

Returns:

The event URL wrapped in a list, or null if unspecified.

getEventMethod

public EventMethod getEventMethod()

The HTTP method Vonage uses to make the request to getEventUrl().

Returns:

The event method, or null if unspecified.

getSentimentAnalysis

public Boolean getSentimentAnalysis()

Perform sentiment analysis on the call recording transcription segments.

Returns:

Whether sentiment analysis is enabled, or null if unspecified.

builder

public static TranscriptionSettings.Builder builder()

Entrypoint for constructing an instance of this class.

Returns:

A new builder.