Package com.sinch.sdk.domains.voice.models.v1.svaml.instruction

Interface SvamlInstructionPlayFiles

All Superinterfaces:

SvamlInstruction

public interface SvamlInstructionPlayFiles
extends SvamlInstruction

Plays Interactive Voice Response (IVR) files for the supported locale or SSML commands at the Sinch backend. An IVR message is played only on the caller's side.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SvamlInstructionPlayFiles.Builder	Dedicated Builder
static class	SvamlInstructionPlayFiles.NameEnum	The name property.

Method Summary

Modifier and Type	Method	Description
static SvamlInstructionPlayFiles.Builder	builder()	Getting builder
List<String>	getIds()	The IDs of the files which will be played.
String	getLocale()	If using SSML or TTS, this is a required field.

Method Details

getIds

List<String> getIds()

The IDs of the files which will be played. These can be a URL to a file, SSML commands using the #ssml[] element, or text using the #tts[] element.

Returns:

ids

getLocale

String getLocale()

If using SSML or TTS, this is a required field. The voice and language you want to use for the text-to-speech message. This can either be defined by the ISO 639 locale and language code or by specifying a particular voice. Supported languages and voices are detailed here.

Returns:

locale

builder

static SvamlInstructionPlayFiles.Builder builder()

Getting builder

Returns:

New Builder instance