Skip to main content

VoiceOverrideDto

Per-request overrides for the Voice channel.

Supplying this at all opts the event into voice; voice calls cost roughly three times an SMS and ring a phone, so the channel is never inferred from the recipient merely having a number.

languagestring | nullnullable

BCP-47 language tag for the voice profile.

Example: en-US
scriptstring | nullnullable

Spoken script for the call. Falls back to the workspace voice template when omitted.

Example: Your verification code is 48291
voice_idstring | nullnullable

TTS voice profile to speak the script in. Serialised snake_case (voice_id) to match the canonical VoiceOverride contract and the worker key; voiceId is accepted as an input alias.

Example: Ada
VoiceOverrideDto
{
  "language": "en-US",
  "script": "Your verification code is 48291",
  "voice_id": "Ada"
}