Package com.vonage.client.voice

Class SpeechResults

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.voice.SpeechResults

All Implemented Interfaces:

Jsonable

public class SpeechResults
extends JsonableBaseObject

Represents the speech recognition results in EventWebhook.getSpeech().

Since:

8.2.0

Constructor Summary

Constructors

Constructor	Description
SpeechResults()

Method Summary

Modifier and Type	Method	Description
String	getError()	Error message.
URI	getRecordingUrl()	Speech recording URL.
List<SpeechTranscript>	getResults()	The recognised text objects.
SpeechTimeoutReason	getTimeoutReason()	Indicates if the input ended when user stopped speaking, by max duration timeout or if the user didn't say anything.

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

Constructor Details

SpeechResults

public SpeechResults()

Method Details

getRecordingUrl

public URI getRecordingUrl()

Speech recording URL. Included if the saveAudio flag is set to true in the input action. Requires JWT authorization for downloading see Download a Recording documentation for details.

Returns:

The recording URL, or null if absent.

Since:

8.2.0

getError

public String getError()

Error message.

Returns:

The error message, or null if absent / not applicable.

getTimeoutReason

public SpeechTimeoutReason getTimeoutReason()

Indicates if the input ended when user stopped speaking, by max duration timeout or if the user didn't say anything.

Returns:

Reason for the timeout as an enum.

getResults

public List<SpeechTranscript> getResults()

The recognised text objects.

Returns:

The list of transcript texts, or null if there are none.