Package com.sinch.sdk.domains.voice.models.v2.svaml.playback

Interface SayMessage

All Superinterfaces:

Message

public interface SayMessage
extends Message

A text-to-speech (TTS) message item. The platform synthesizes the provided text into speech and plays it on the call.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SayMessage.Builder	Dedicated Builder
static class	SayMessage.FormatEnum	Gets or Sets format

Method Summary

Modifier and Type	Method	Description
static SayMessage.Builder	builder()	Getting builder
SayMessage.FormatEnum	getFormat()	Format of the message
String	getText()	The text to be synthesized into speech.
String	getVoiceName()	The name of the voice to use for text-to-speech synthesis.

Method Details

getText

String getText()

The text to be synthesized into speech.

If format is TEXT (default), provide plain text. If format is SSML, provide a valid SSML document (for example, <speak>...</speak>).

Field is required

Returns:

text

getFormat

SayMessage.FormatEnum getFormat()

Format of the message

Returns:

format

getVoiceName

String getVoiceName()

The name of the voice to use for text-to-speech synthesis.

Supported voices include: Emma, Brian, and others. For a complete list of available voices and their characteristics, see the Text-to-Speech Voices documentation.

Field is required

Returns:

voiceName

builder

static SayMessage.Builder builder()

Getting builder

Returns:

New Builder instance