SpeakRequest

Properties

Name	Type	Description	Notes
payload	String	The text or SSML to be converted into speech. There is a 3,000 character limit.
payloadType	PayloadTypeEnum	The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).	[optional]
serviceLevel	ServiceLevelEnum	This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed.	[optional]
stop	String	When specified, it stops the current audio being played. Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue.	[optional]
voice	VoiceEnum	The gender of the voice used to speak back the text or the specific Amazon Polly voice to be used in the form of `Polly.<voice>`, e.g. `Polly.Brian`. All standard Amazon Polly voices are supported.
language	LanguageEnum	The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified.	[optional]
clientState	String	Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.	[optional]
commandId	String	Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.	[optional]

Name	Value
TEXT	"text"
SSML	"ssml"

Name	Value
BASIC	"basic"
PREMIUM	"premium"

Name	Value
MALE	"male"
FEMALE	"female"