sinch.domains.voice.models.v2.svaml.shared package

class sinch.domains.voice.models.v2.svaml.shared.AmdCommand(**extra_data: Any)[source]

Bases: BaseConfigModel

Parameters:

extra_data (Any)

command: Literal['amd']
events: AmdEvents | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.AmdEvents(*, onHuman: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onMachine: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onBeep: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onUnknown: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, **extra_data: ~typing.Any)[source]

Bases: BaseConfigModel

Parameters:
on_human: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_machine: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_beep: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_unknown: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.AnswerCommand(
*,
command: Literal['answer'] = 'answer',
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['answer'])

  • extra_data (Any)

command: Literal['answer']
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.BridgeCallCommand(
*,
command: Literal['bridgeCall'] = 'bridgeCall',
bridgeName: Annotated[str, Strict(strict=True)],
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['bridgeCall'])

  • bridgeName (Annotated[str, Strict(strict=True)])

  • extra_data (Any)

command: Literal['bridgeCall']
bridge_name: Annotated[str, Strict(strict=True)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.CallEvents(*, onAnswer: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onBusy: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onReject: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onTimeout: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onHangup: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onFailure: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, **extra_data: ~typing.Any)[source]

Bases: BaseConfigModel

Parameters:
on_answer: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_busy: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_reject: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_timeout: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_hangup: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_failure: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.CustomEventCommand(
*,
command: Literal['customEvent'] = 'customEvent',
webhookName: Annotated[str, Strict(strict=True)],
url: Annotated[str, Strict(strict=True)],
fallbackUrl: Annotated[str, Strict(strict=True)] | None = None,
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['customEvent'])

  • webhookName (Annotated[str, Strict(strict=True)])

  • url (Annotated[str, Strict(strict=True)])

  • fallbackUrl (Annotated[str, Strict(strict=True)] | None)

  • extra_data (Any)

command: Literal['customEvent']
custom_event_name: Annotated[str, Strict(strict=True)]
url: Annotated[str, Strict(strict=True)]
fallback_url: Annotated[str, Strict(strict=True)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.DialCommand(**extra_data: Any)[source]

Bases: BaseConfigModel

Parameters:

extra_data (Any)

command: Literal['dial']
call_name: Annotated[str, Strict(strict=True)] | None
from_: ResolveUnion object at 0x7fe3f455f550>] | None
to: ResolveUnion object at 0x7fe3f4531dd0>]
dial_timeout_duration_seconds: Annotated[int, Strict(strict=True)] | None
max_call_duration_seconds: Annotated[int, Strict(strict=True)] | None
events: CallEvents | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.GotoMenuCommand(
*,
command: Literal['gotoMenu'] = 'gotoMenu',
menuName: Annotated[str, Strict(strict=True)],
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['gotoMenu'])

  • menuName (Annotated[str, Strict(strict=True)])

  • extra_data (Any)

command: Literal['gotoMenu']
menu_name: Annotated[str, Strict(strict=True)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.HangupCommand(
*,
command: Literal['hangup'] = 'hangup',
callName: Annotated[str, Strict(strict=True)] | None = None,
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['hangup'])

  • callName (Annotated[str, Strict(strict=True)] | None)

  • extra_data (Any)

command: Literal['hangup']
call_name: Annotated[str, Strict(strict=True)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.MenuCommand(**extra_data: Any)[source]

Bases: BaseConfigModel

Parameters:

extra_data (Any)

command: Literal['menu']
start_menu: Annotated[str, Strict(strict=True)]
menus: Dict[Annotated[str, Strict(strict=True)], MenuItem]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.MenuItem(*, prompt: ~sinch.domains.voice.models.v2.svaml.shared.menu_prompt.MenuPrompt | None = None, repeatPrompt: ~sinch.domains.voice.models.v2.svaml.shared.menu_prompt.MenuPrompt | None = None, inputTimeoutDurationSeconds: ~typing.Annotated[int, ~pydantic.types.Strict(strict=True)] | None = None, repeatCount: ~typing.Annotated[int, ~pydantic.types.Strict(strict=True)] | None = None, minimumInputLength: ~typing.Annotated[int, ~pydantic.types.Strict(strict=True)] | None = None, maximumInputLength: ~typing.Annotated[int, ~pydantic.types.Strict(strict=True)] | None = None, terminatingSequence: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None = None, inputMethods: ~typing.Annotated[list[~typing.Literal['DTMF'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, matches: ~typing.Dict[~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)]] | None = None, onFailure: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, **extra_data: ~typing.Any)[source]

Bases: BaseConfigModel

Parameters:
prompt: MenuPrompt | None
repeat_prompt: MenuPrompt | None
input_timeout_duration_seconds: Annotated[int, Strict(strict=True)] | None
repeat_count: Annotated[int, Strict(strict=True)] | None
minimum_input_length: Annotated[int, Strict(strict=True)] | None
maximum_input_length: Annotated[int, Strict(strict=True)] | None
terminating_sequence: Annotated[str, Strict(strict=True)] | None
input_methods: Annotated[list[Literal['DTMF'] | Annotated[str, Strict(strict=True)]], Len(min_length=0, max_length=None)] | None
matches: Dict[Annotated[str, Strict(strict=True)], Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)]] | None
on_failure: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.MenuPrompt(*, allowBargeIn: ~typing.Annotated[bool, ~pydantic.types.Strict(strict=True)] | None = None, messages: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.message.SayMessage | ~sinch.domains.voice.models.v2.svaml.shared.message.PlayMessage, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45a2590>]], ~annotated_types.Len(min_length=0, max_length=None)], **extra_data: ~typing.Any)[source]

Bases: BaseConfigModel

Parameters:

  • allowBargeIn (Annotated[bool, Strict(strict=True)] | None)

  • messages (Annotated[list[Annotated[SayMessage | PlayMessage, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45a2590>]], Len(min_length=0, max_length=None)])

  • extra_data (Any)

allow_barge_in: Annotated[bool, Strict(strict=True)] | None
messages: Len(min_length=0, max_length=None)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.MessageEvents(*, onFinish: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, **extra_data: ~typing.Any)[source]

Bases: BaseConfigModel

Parameters:
on_finish: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.MessagesCommand(**extra_data: Any)[source]

Bases: BaseConfigModel

Parameters:

extra_data (Any)

command: Literal['messages']
messages_name: Annotated[str, Strict(strict=True)] | None
messages: Len(min_length=0, max_length=None)]
events: MessageEvents | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.PauseCommand(
*,
command: Literal['pause'] = 'pause',
durationMilliseconds: Annotated[int, Strict(strict=True)],
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['pause'])

  • durationMilliseconds (Annotated[int, Strict(strict=True)])

  • extra_data (Any)

command: Literal['pause']
duration_milliseconds: Annotated[int, Strict(strict=True)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.Play(
*,
url: Annotated[str, Strict(strict=True)],
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • url (Annotated[str, Strict(strict=True)])

  • extra_data (Any)

url: Annotated[str, Strict(strict=True)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.PlayMessage(
*,
type: Literal['PLAY'] = 'PLAY',
play: Play,
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • type (Literal['PLAY'])

  • play (Play)

  • extra_data (Any)

type: Literal['PLAY']
play: Play
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.RecordingEvents(*, onFinish: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, onFailure: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)] | None = None, **extra_data: ~typing.Any)[source]

Bases: BaseConfigModel

Parameters:
on_finish: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
on_failure: Annotated[list[SvamlCommand], Len(min_length=0, max_length=None)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.RecordingOptions(
*,
format: Literal['MP3', 'WAV'] | Annotated[str, Strict(strict=True)] | None = None,
recordingType: Literal['COMBINED', 'INBOUND', 'OUTBOUND'] | Annotated[str, Strict(strict=True)] | None = None,
destination: Literal['AWS', 'GCP', 'AZURE'] | Annotated[str, Strict(strict=True)],
destinationUrl: Annotated[str, Strict(strict=True)],
credentials: Annotated[str, Strict(strict=True)],
transcriptionOptions: TranscriptionOptions | None = None,
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • format (Literal['MP3', 'WAV'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

  • recordingType (Literal['COMBINED', 'INBOUND', 'OUTBOUND'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

  • destination (Literal['AWS', 'GCP', 'AZURE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)])

  • destinationUrl (Annotated[str, Strict(strict=True)])

  • credentials (Annotated[str, Strict(strict=True)])

  • transcriptionOptions (TranscriptionOptions | None)

  • extra_data (Any)

format: Literal['MP3', 'WAV'] | Annotated[str, Strict(strict=True)] | None
recording_type: Literal['COMBINED', 'INBOUND', 'OUTBOUND'] | Annotated[str, Strict(strict=True)] | None
destination: Literal['AWS', 'GCP', 'AZURE'] | Annotated[str, Strict(strict=True)]
destination_url: Annotated[str, Strict(strict=True)]
credentials: Annotated[str, Strict(strict=True)]
transcription_options: TranscriptionOptions | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.Say(
*,
text: Annotated[str, Strict(strict=True)],
format: Literal['TEXT', 'SSML'] | Annotated[str, Strict(strict=True)] | None = None,
voiceName: Literal['Aarav', 'Aarav_2', 'Aarohi', 'Aarti', 'Aarti_2', 'Aarti_3', 'Aashi', 'Abbi', 'Abdullah', 'Abeo', 'Abril', 'Achara', 'Ada', 'Ada_2', 'Adam', 'Adam_2', 'Aditi', 'Adri', 'Adriano', 'Agnieszka', 'Ahmet', 'Aigul', 'Ainhoa', 'Alain', 'Alba', 'Aled', 'Aleksandar', 'Alessio', 'Alessio_2', 'Alex', 'Alfie', 'Ali', 'Alina', 'Alloy', 'Alloy_2', 'Alonso', 'Alvaro', 'Amal', 'Amala', 'Amanda', 'Amany', 'Amber', 'Ambre', 'Ameha', 'Amina', 'Amy', 'Amy_2', 'Amy_3', 'Ana', 'Anahit', 'Ananya', 'Ananya_2', 'Anbu', 'Ander', 'Andre', 'Andre_2', 'Andrea', 'Andres', 'Andrew', 'Andrew_2', 'Andrew_3', 'Andrew_4', 'Angelo', 'Anila', 'Annette', 'Antoine', 'Antonin', 'Antonio', 'Anu', 'Aoi', 'Arabella', 'Ardi', 'Aria', 'Aria_2', 'Ariane', 'Arjun', 'Arjun_2', 'Arjun_3', 'Arlet', 'Arnau', 'Arnaud', 'Arthur', 'Arya', 'Arya_2', 'Asad', 'Ashley', 'Asilia', 'Astrid', 'Athina', 'Ava', 'Ava_2', 'Ava_3', 'Avri', 'Ayanda', 'Ayanda_2', 'Aysha', 'Babek', 'Banu', 'Bashkar', 'Bassel', 'Bataa', 'Beatrice', 'Beatriz', 'Belkys', 'Bella', 'Benigno', 'Bernd', 'Bianca', 'Bianca_2', 'Bianca_3', 'Blessica', 'BongJin', 'Borislav', 'Brandon', 'Brandon_2', 'Bree', 'Brenda', 'Brian', 'Brian_2', 'Brian_3', 'Brigitte', 'Bryan', 'Bryan_2', 'Bryan_3', 'Burcu', 'Calimero', 'Camila', 'Camilla', 'Camilla_2', 'Camilla_3', 'Candela', 'Carla', 'Carlos', 'Carlota', 'Carly', 'Carmen', 'Cataldo', 'Catalina', 'Cecilio', 'Celeste', 'Celine', 'Celine_2', 'Chantal', 'Chanthavong', 'Charline', 'Chilemba', 'Christel', 'Christoph', 'Christopher', 'Christopher_2', 'Clara', 'Claude', 'Colette', 'Colm', 'Conchita', 'Connor', 'Conrad', 'Cora', 'Cora_2', 'Coralie', 'Cristiano', 'Daichi', 'Dalia', 'Dalia_2', 'Daniel', 'Daniel_2', 'Danielle', 'Danielle_2', 'Dario', 'Dariya', 'Darren', 'Daudi', 'Daulet', 'Davis', 'Davis_2', 'Davis_3', 'Dena', 'Denise', 'Derek', 'Dhwani', 'Diego', 'Dilara', 'Dimas', 'Dmitry', 'Donato', 'Dora', 'Duarte', 'Duncan', 'Dustin', 'Echo', 'Eka', 'Elena', 'Elias', 'Elimu', 'Elin', 'Elizabeth', 'Elke', 'Elliot', 'Eloise', 'Elsa', 'Elsie', 'Elvira', 'Elza', 'Emel', 'Emil', 'Emilio', 'Emily', 'Emma', 'Emma_2', 'Emma_3', 'Emma_4', 'Enric', 'Enrique', 'Eric', 'Estrella', 'Ethan', 'Evelyn', 'Everita', 'Ewa', 'Ewa_2', 'Ezinne', 'Fabio', 'Fabiola', 'Fable', 'Fabrice', 'Fahed', 'Farid', 'Fatima', 'Federico', 'Fenna', 'Fernanda', 'Fiamma', 'Filiz', 'Finn', 'Florian', 'Florian_2', 'Florin', 'Francisca', 'Freya', 'Gabrielle', 'Gabrielle_2', 'Gabrijela', 'Gadis', 'Gagan', 'Gemma', 'Gemma_2', 'Geraint', 'Gerard', 'Gerardo', 'Gianni', 'Giorgi', 'Giorgio', 'Giovanna', 'Gisela', 'Giuseppe', 'Giuseppe_2', 'Gonzalo', 'GookMin', 'Goran', 'Grace', 'Gregory', 'Gudrun', 'Gul', 'GulNawaz', 'Gunnar', 'Guy', 'Gwyneth', 'Hala', 'Hamdan', 'Hamed', 'Hannah', 'Hannah_2', 'Hans', 'Harri', 'Hayk', 'Hedi', 'Hemkala', 'Henri', 'Hila', 'Hillevi', 'HiuGaai', 'Hiujin', 'HiuMaan', 'HoaiMy', 'Hollie', 'HsiaoChen', 'HsiaoYu', 'Humberto', 'Hyunsu', 'Hyunsu_2', 'Hyunsu_3', 'Ida', 'Ilir', 'Iman', 'Imani', 'Imelda', 'Ines', 'Ines_2', 'Ingrid', 'InJoon', 'Irene', 'Irma', 'Isabella', 'Isabella_2', 'Isabella_3', 'Isabelle', 'Isabelle_2', 'Iselin', 'Isidora', 'Ismael', 'Ivy', 'Ivy_2', 'Jacek', 'Jacob', 'Jacqueline', 'Jajang', 'Jamal', 'James', 'Jan', 'Jane', 'Jane_2', 'Jann', 'Jasmine', 'Jasmine_2', 'Jason', 'Javier', 'Jean', 'Jenny', 'Jenny_2', 'Jenny_3', 'Jeppe', 'Jerome', 'Jihye', 'JiMin', 'Jimmie', 'Jitka', 'Joana', 'Joanna', 'Joanna_2', 'Joanna_3', 'Joanne', 'Joey', 'Joey_2', 'Jonas', 'Jorge', 'Jorge_2', 'Joseph', 'Josephine', 'Juan', 'Julio', 'Justin', 'Justin_2', 'Kai', 'Kajal', 'Kajal_2', 'Kalina', 'Kani', 'Karina', 'Karl', 'Karla', 'Kasper', 'Katja', 'Kavya', 'Kavya_2', 'Kazuha', 'Keita', 'Ken', 'Kendra', 'Kendra_2', 'Keomany', 'Kert', 'Kevin', 'Killian', 'Kim', 'Kimberly', 'Kimberly_2', 'Klarissa', 'Klaus', 'Kumar', 'Kunal', 'Kunal_2', 'Laia', 'Laila', 'Laith', 'Larissa', 'Latifa', 'Laura', 'Laura_2', 'Layla', 'Lea', 'Lea_2', 'Lea_3', 'Leah', 'Leila', 'Leni', 'Lennart', 'Leonas', 'Leticia', 'Lewis', 'Lia', 'Liam', 'Lian', 'Lian_2', 'Libby', 'Liberto', 'Lisa', 'Lisa_2', 'Lisandro', 'Liv', 'Livia', 'Livia_2', 'Lola', 'Lorena', 'Lorenzio', 'Lorenzo', 'Lotte', 'Louisa', 'Lucia', 'Lucia_2', 'Lucia_3', 'Luciano', 'Lucien', 'Luis', 'Lukas', 'Luke', 'Luna', 'Luna_2', 'Lupe', 'Lupe_2', 'Lupe_3', 'Maarten', 'Macerio', 'Macerio_2', 'Madhur', 'Madina', 'Mads', 'Maisie', 'Maja', 'Manohar', 'Manuel', 'Manuela', 'Marcello', 'Marcelo', 'Marek', 'Margarita', 'Maria', 'Marija', 'Marina', 'Mario', 'Marlene', 'Marta', 'Maryam', 'Masaru', 'Mateo', 'Mathieu', 'Matthew', 'Matthew_2', 'Matthew_3', 'Mattias', 'Maurice', 'Maxim', 'Maya', 'Mayu', 'Mekdes', 'Mia', 'Mia_2', 'Mia_3', 'Michelle', 'Midhun', 'Miguel', 'Mitchell', 'Mizuki', 'Moaz', 'Mohan', 'Molly', 'Monica', 'Mouna', 'Muuse', 'Nabanita', 'Naja', 'NamMinh', 'Nanami', 'Nanami_2', 'Nancy', 'Nancy_2', 'Naoki', 'Natasha', 'Neerja', 'Neerja_2', 'Neil', 'Nestoras', 'Nia', 'Niamh', 'Niamh_2', 'Nicholas', 'Nicholas_2', 'Nicolau', 'Nicole', 'Nil', 'Nilar', 'Nils', 'Niranjan', 'Niwat', 'Noah', 'Noemi', 'Noora', 'Noura', 'Nova', 'Nova_2', 'Nuria', 'Ojas', 'Ola', 'Ola_2', 'Oliver', 'Olivia', 'Ollie', 'Ollie_2', 'Omar', 'Ona', 'Onyx', 'Orla', 'Osman', 'Ostap', 'Pallavi', 'Palmira', 'Paloma', 'Paola', 'Pedro', 'Pedro_2', 'Pelayo', 'Penelope', 'Pernille', 'Petra', 'Phoebe', 'Phoebe_2', 'Pierina', 'Piseth', 'Polina', 'Prabhat', 'Prabhat_2', 'Pradeep', 'Premwadee', 'Priyom', 'Rafiki', 'Ralf', 'Rami', 'Ramona', 'Rana', 'Raquel', 'Raveena', 'Reem', 'Rehaan', 'Rehaan_2', 'Rehema', 'Remi', 'Remi_2', 'Remy', 'Remy_2', 'Renata', 'Ricardo', 'Rinaldo', 'Roberto', 'Rodrigo', 'Roger', 'Roi', 'Rok', 'Rosa', 'Ruben', 'Russell', 'Ruth', 'Ruth_2', 'Ryan', 'Ryan_2', 'Sabela', 'Sabrina', 'Sabrina_2', 'Sagar', 'Saleh', 'Salli', 'Salli_2', 'Salli_3', 'Salma', 'Salman', 'Salome', 'Sam', 'Sameera', 'Samuel', 'Sana', 'Sapna', 'Sara', 'Saranya', 'Sardor', 'Saul', 'Sebastian', 'Selma', 'SeoHyeon', 'Seoyeon', 'Seoyeon_2', 'Seoyeon_3', 'Seraphina', 'Seraphina_2', 'Serena', 'Serena_2', 'Sergio', 'Sergio_2', 'Shakir', 'Shimmer', 'Shiori', 'Shruti', 'Siqiniq', 'Siqiniq_2', 'Siti', 'Sobhana', 'Soffie', 'Sofia', 'Sofie', 'Sonia', 'SoonBok', 'Sophie', 'Sophie_2', 'Srecko', 'Sreymom', 'Steffan', 'Steffan_2', 'Steffan_3', 'Stephen', 'Stephen_2', 'Subhasini', 'Sukant', 'SunHi', 'SunHi_2', 'Surya', 'Suvi', 'Svetlana', 'Swara', 'Sylvie', 'Sylvie_2', 'Taim', 'Takumi', 'Takumi_2', 'Tamas', 'Tania', 'Tanishaa', 'Tanja', 'Taqqiq', 'Taqqiq_2', 'Tatyana', 'Teo', 'Teresa', 'Thalita', 'Thalita_2', 'Thalita_3', 'Thando', 'Themba', 'Thiago', 'Thierry', 'Thierry_2', 'Thiha', 'Thilini', 'Thomas', 'Tiana', 'Tiffany', 'Tim', 'Tina', 'Tomas', 'Tomoko', 'Tony', 'Triana', 'Tristan', 'Tristan_ES', 'Tristan_ES_2', 'Tuti', 'Tyler', 'Ubax', 'Uzma', 'Vaani', 'Valentina', 'Valerio', 'Valluvar', 'Venba', 'Vera', 'Vesna', 'Vicki', 'Vicki_2', 'Vicki_3', 'Victor', 'Viktoria', 'Vitoria', 'Vitoria_2', 'Vivienne', 'Vivienne_2', 'Vlasta', 'WanLung', 'Wayne', 'Willem', 'William', 'William_2', 'Xiaochen', 'Xiaochen_2', 'Xiaochen_3', 'Xiaochen_4', 'Xiaohan', 'Xiaohan_2', 'Xiaomeng', 'XiaoMin', 'Xiaomo', 'Xiaoqiu', 'Xiaorou', 'Xiaorui', 'Xiaoshuang', 'Xiaoshuang_2', 'Xiaoshuang_3', 'Xiaotong', 'Xiaoxiao', 'Xiaoxiao_2', 'Xiaoxiao_3', 'Xiaoxiao_4', 'Xiaoxiao_5', 'Xiaoyan', 'Xiaoyi', 'Xiaoyi_2', 'Xiaoyou', 'Xiaoyou_2', 'Xiaoyou_3', 'Xiaoyu', 'Xiaoyu_2', 'Xiaozhen', 'Ximena', 'Ximena_ES', 'Ximena_ES_2', 'Ximena_ES_3', 'Yago', 'Yan', 'Yara', 'Yashica', 'Yasmin', 'Yesui', 'Yolanda', 'YuJin', 'Yundeng', 'Yunfan', 'Yunfan_2', 'Yunfeng', 'Yunhan', 'Yunhao', 'YunJhe', 'Yunjian', 'Yunjie', 'YunSong', 'Yunxi', 'Yunxi_2', 'Yunxia', 'Yunxia_2', 'Yunxiang', 'Yunxiao', 'Yunxiao_2', 'Yunyang', 'Yunye', 'Yunye_2', 'Yunyi', 'Yunyi_2', 'Yunze', 'Yunzhe', 'Yves', 'Yvette', 'Zariyah', 'Zayd', 'Zeina', 'Zhiyu', 'Zhiyu_2', 'Zofia', 'Zuri'] | Annotated[str, Strict(strict=True)],
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • text (Annotated[str, Strict(strict=True)])

  • format (Literal['TEXT', 'SSML'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

  • voiceName (Literal['Aarav', 'Aarav_2', 'Aarohi', 'Aarti', 'Aarti_2', 'Aarti_3', 'Aashi', 'Abbi', 'Abdullah', 'Abeo', 'Abril', 'Achara', 'Ada', 'Ada_2', 'Adam', 'Adam_2', 'Aditi', 'Adri', 'Adriano', 'Agnieszka', 'Ahmet', 'Aigul', 'Ainhoa', 'Alain', 'Alba', 'Aled', 'Aleksandar', 'Alessio', 'Alessio_2', 'Alex', 'Alfie', 'Ali', 'Alina', 'Alloy', 'Alloy_2', 'Alonso', 'Alvaro', 'Amal', 'Amala', 'Amanda', 'Amany', 'Amber', 'Ambre', 'Ameha', 'Amina', 'Amy', 'Amy_2', 'Amy_3', 'Ana', 'Anahit', 'Ananya', 'Ananya_2', 'Anbu', 'Ander', 'Andre', 'Andre_2', 'Andrea', 'Andres', 'Andrew', 'Andrew_2', 'Andrew_3', 'Andrew_4', 'Angelo', 'Anila', 'Annette', 'Antoine', 'Antonin', 'Antonio', 'Anu', 'Aoi', 'Arabella', 'Ardi', 'Aria', 'Aria_2', 'Ariane', 'Arjun', 'Arjun_2', 'Arjun_3', 'Arlet', 'Arnau', 'Arnaud', 'Arthur', 'Arya', 'Arya_2', 'Asad', 'Ashley', 'Asilia', 'Astrid', 'Athina', 'Ava', 'Ava_2', 'Ava_3', 'Avri', 'Ayanda', 'Ayanda_2', 'Aysha', 'Babek', 'Banu', 'Bashkar', 'Bassel', 'Bataa', 'Beatrice', 'Beatriz', 'Belkys', 'Bella', 'Benigno', 'Bernd', 'Bianca', 'Bianca_2', 'Bianca_3', 'Blessica', 'BongJin', 'Borislav', 'Brandon', 'Brandon_2', 'Bree', 'Brenda', 'Brian', 'Brian_2', 'Brian_3', 'Brigitte', 'Bryan', 'Bryan_2', 'Bryan_3', 'Burcu', 'Calimero', 'Camila', 'Camilla', 'Camilla_2', 'Camilla_3', 'Candela', 'Carla', 'Carlos', 'Carlota', 'Carly', 'Carmen', 'Cataldo', 'Catalina', 'Cecilio', 'Celeste', 'Celine', 'Celine_2', 'Chantal', 'Chanthavong', 'Charline', 'Chilemba', 'Christel', 'Christoph', 'Christopher', 'Christopher_2', 'Clara', 'Claude', 'Colette', 'Colm', 'Conchita', 'Connor', 'Conrad', 'Cora', 'Cora_2', 'Coralie', 'Cristiano', 'Daichi', 'Dalia', 'Dalia_2', 'Daniel', 'Daniel_2', 'Danielle', 'Danielle_2', 'Dario', 'Dariya', 'Darren', 'Daudi', 'Daulet', 'Davis', 'Davis_2', 'Davis_3', 'Dena', 'Denise', 'Derek', 'Dhwani', 'Diego', 'Dilara', 'Dimas', 'Dmitry', 'Donato', 'Dora', 'Duarte', 'Duncan', 'Dustin', 'Echo', 'Eka', 'Elena', 'Elias', 'Elimu', 'Elin', 'Elizabeth', 'Elke', 'Elliot', 'Eloise', 'Elsa', 'Elsie', 'Elvira', 'Elza', 'Emel', 'Emil', 'Emilio', 'Emily', 'Emma', 'Emma_2', 'Emma_3', 'Emma_4', 'Enric', 'Enrique', 'Eric', 'Estrella', 'Ethan', 'Evelyn', 'Everita', 'Ewa', 'Ewa_2', 'Ezinne', 'Fabio', 'Fabiola', 'Fable', 'Fabrice', 'Fahed', 'Farid', 'Fatima', 'Federico', 'Fenna', 'Fernanda', 'Fiamma', 'Filiz', 'Finn', 'Florian', 'Florian_2', 'Florin', 'Francisca', 'Freya', 'Gabrielle', 'Gabrielle_2', 'Gabrijela', 'Gadis', 'Gagan', 'Gemma', 'Gemma_2', 'Geraint', 'Gerard', 'Gerardo', 'Gianni', 'Giorgi', 'Giorgio', 'Giovanna', 'Gisela', 'Giuseppe', 'Giuseppe_2', 'Gonzalo', 'GookMin', 'Goran', 'Grace', 'Gregory', 'Gudrun', 'Gul', 'GulNawaz', 'Gunnar', 'Guy', 'Gwyneth', 'Hala', 'Hamdan', 'Hamed', 'Hannah', 'Hannah_2', 'Hans', 'Harri', 'Hayk', 'Hedi', 'Hemkala', 'Henri', 'Hila', 'Hillevi', 'HiuGaai', 'Hiujin', 'HiuMaan', 'HoaiMy', 'Hollie', 'HsiaoChen', 'HsiaoYu', 'Humberto', 'Hyunsu', 'Hyunsu_2', 'Hyunsu_3', 'Ida', 'Ilir', 'Iman', 'Imani', 'Imelda', 'Ines', 'Ines_2', 'Ingrid', 'InJoon', 'Irene', 'Irma', 'Isabella', 'Isabella_2', 'Isabella_3', 'Isabelle', 'Isabelle_2', 'Iselin', 'Isidora', 'Ismael', 'Ivy', 'Ivy_2', 'Jacek', 'Jacob', 'Jacqueline', 'Jajang', 'Jamal', 'James', 'Jan', 'Jane', 'Jane_2', 'Jann', 'Jasmine', 'Jasmine_2', 'Jason', 'Javier', 'Jean', 'Jenny', 'Jenny_2', 'Jenny_3', 'Jeppe', 'Jerome', 'Jihye', 'JiMin', 'Jimmie', 'Jitka', 'Joana', 'Joanna', 'Joanna_2', 'Joanna_3', 'Joanne', 'Joey', 'Joey_2', 'Jonas', 'Jorge', 'Jorge_2', 'Joseph', 'Josephine', 'Juan', 'Julio', 'Justin', 'Justin_2', 'Kai', 'Kajal', 'Kajal_2', 'Kalina', 'Kani', 'Karina', 'Karl', 'Karla', 'Kasper', 'Katja', 'Kavya', 'Kavya_2', 'Kazuha', 'Keita', 'Ken', 'Kendra', 'Kendra_2', 'Keomany', 'Kert', 'Kevin', 'Killian', 'Kim', 'Kimberly', 'Kimberly_2', 'Klarissa', 'Klaus', 'Kumar', 'Kunal', 'Kunal_2', 'Laia', 'Laila', 'Laith', 'Larissa', 'Latifa', 'Laura', 'Laura_2', 'Layla', 'Lea', 'Lea_2', 'Lea_3', 'Leah', 'Leila', 'Leni', 'Lennart', 'Leonas', 'Leticia', 'Lewis', 'Lia', 'Liam', 'Lian', 'Lian_2', 'Libby', 'Liberto', 'Lisa', 'Lisa_2', 'Lisandro', 'Liv', 'Livia', 'Livia_2', 'Lola', 'Lorena', 'Lorenzio', 'Lorenzo', 'Lotte', 'Louisa', 'Lucia', 'Lucia_2', 'Lucia_3', 'Luciano', 'Lucien', 'Luis', 'Lukas', 'Luke', 'Luna', 'Luna_2', 'Lupe', 'Lupe_2', 'Lupe_3', 'Maarten', 'Macerio', 'Macerio_2', 'Madhur', 'Madina', 'Mads', 'Maisie', 'Maja', 'Manohar', 'Manuel', 'Manuela', 'Marcello', 'Marcelo', 'Marek', 'Margarita', 'Maria', 'Marija', 'Marina', 'Mario', 'Marlene', 'Marta', 'Maryam', 'Masaru', 'Mateo', 'Mathieu', 'Matthew', 'Matthew_2', 'Matthew_3', 'Mattias', 'Maurice', 'Maxim', 'Maya', 'Mayu', 'Mekdes', 'Mia', 'Mia_2', 'Mia_3', 'Michelle', 'Midhun', 'Miguel', 'Mitchell', 'Mizuki', 'Moaz', 'Mohan', 'Molly', 'Monica', 'Mouna', 'Muuse', 'Nabanita', 'Naja', 'NamMinh', 'Nanami', 'Nanami_2', 'Nancy', 'Nancy_2', 'Naoki', 'Natasha', 'Neerja', 'Neerja_2', 'Neil', 'Nestoras', 'Nia', 'Niamh', 'Niamh_2', 'Nicholas', 'Nicholas_2', 'Nicolau', 'Nicole', 'Nil', 'Nilar', 'Nils', 'Niranjan', 'Niwat', 'Noah', 'Noemi', 'Noora', 'Noura', 'Nova', 'Nova_2', 'Nuria', 'Ojas', 'Ola', 'Ola_2', 'Oliver', 'Olivia', 'Ollie', 'Ollie_2', 'Omar', 'Ona', 'Onyx', 'Orla', 'Osman', 'Ostap', 'Pallavi', 'Palmira', 'Paloma', 'Paola', 'Pedro', 'Pedro_2', 'Pelayo', 'Penelope', 'Pernille', 'Petra', 'Phoebe', 'Phoebe_2', 'Pierina', 'Piseth', 'Polina', 'Prabhat', 'Prabhat_2', 'Pradeep', 'Premwadee', 'Priyom', 'Rafiki', 'Ralf', 'Rami', 'Ramona', 'Rana', 'Raquel', 'Raveena', 'Reem', 'Rehaan', 'Rehaan_2', 'Rehema', 'Remi', 'Remi_2', 'Remy', 'Remy_2', 'Renata', 'Ricardo', 'Rinaldo', 'Roberto', 'Rodrigo', 'Roger', 'Roi', 'Rok', 'Rosa', 'Ruben', 'Russell', 'Ruth', 'Ruth_2', 'Ryan', 'Ryan_2', 'Sabela', 'Sabrina', 'Sabrina_2', 'Sagar', 'Saleh', 'Salli', 'Salli_2', 'Salli_3', 'Salma', 'Salman', 'Salome', 'Sam', 'Sameera', 'Samuel', 'Sana', 'Sapna', 'Sara', 'Saranya', 'Sardor', 'Saul', 'Sebastian', 'Selma', 'SeoHyeon', 'Seoyeon', 'Seoyeon_2', 'Seoyeon_3', 'Seraphina', 'Seraphina_2', 'Serena', 'Serena_2', 'Sergio', 'Sergio_2', 'Shakir', 'Shimmer', 'Shiori', 'Shruti', 'Siqiniq', 'Siqiniq_2', 'Siti', 'Sobhana', 'Soffie', 'Sofia', 'Sofie', 'Sonia', 'SoonBok', 'Sophie', 'Sophie_2', 'Srecko', 'Sreymom', 'Steffan', 'Steffan_2', 'Steffan_3', 'Stephen', 'Stephen_2', 'Subhasini', 'Sukant', 'SunHi', 'SunHi_2', 'Surya', 'Suvi', 'Svetlana', 'Swara', 'Sylvie', 'Sylvie_2', 'Taim', 'Takumi', 'Takumi_2', 'Tamas', 'Tania', 'Tanishaa', 'Tanja', 'Taqqiq', 'Taqqiq_2', 'Tatyana', 'Teo', 'Teresa', 'Thalita', 'Thalita_2', 'Thalita_3', 'Thando', 'Themba', 'Thiago', 'Thierry', 'Thierry_2', 'Thiha', 'Thilini', 'Thomas', 'Tiana', 'Tiffany', 'Tim', 'Tina', 'Tomas', 'Tomoko', 'Tony', 'Triana', 'Tristan', 'Tristan_ES', 'Tristan_ES_2', 'Tuti', 'Tyler', 'Ubax', 'Uzma', 'Vaani', 'Valentina', 'Valerio', 'Valluvar', 'Venba', 'Vera', 'Vesna', 'Vicki', 'Vicki_2', 'Vicki_3', 'Victor', 'Viktoria', 'Vitoria', 'Vitoria_2', 'Vivienne', 'Vivienne_2', 'Vlasta', 'WanLung', 'Wayne', 'Willem', 'William', 'William_2', 'Xiaochen', 'Xiaochen_2', 'Xiaochen_3', 'Xiaochen_4', 'Xiaohan', 'Xiaohan_2', 'Xiaomeng', 'XiaoMin', 'Xiaomo', 'Xiaoqiu', 'Xiaorou', 'Xiaorui', 'Xiaoshuang', 'Xiaoshuang_2', 'Xiaoshuang_3', 'Xiaotong', 'Xiaoxiao', 'Xiaoxiao_2', 'Xiaoxiao_3', 'Xiaoxiao_4', 'Xiaoxiao_5', 'Xiaoyan', 'Xiaoyi', 'Xiaoyi_2', 'Xiaoyou', 'Xiaoyou_2', 'Xiaoyou_3', 'Xiaoyu', 'Xiaoyu_2', 'Xiaozhen', 'Ximena', 'Ximena_ES', 'Ximena_ES_2', 'Ximena_ES_3', 'Yago', 'Yan', 'Yara', 'Yashica', 'Yasmin', 'Yesui', 'Yolanda', 'YuJin', 'Yundeng', 'Yunfan', 'Yunfan_2', 'Yunfeng', 'Yunhan', 'Yunhao', 'YunJhe', 'Yunjian', 'Yunjie', 'YunSong', 'Yunxi', 'Yunxi_2', 'Yunxia', 'Yunxia_2', 'Yunxiang', 'Yunxiao', 'Yunxiao_2', 'Yunyang', 'Yunye', 'Yunye_2', 'Yunyi', 'Yunyi_2', 'Yunze', 'Yunzhe', 'Yves', 'Yvette', 'Zariyah', 'Zayd', 'Zeina', 'Zhiyu', 'Zhiyu_2', 'Zofia', 'Zuri'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)])

  • extra_data (Any)

text: Annotated[str, Strict(strict=True)]
format: Literal['TEXT', 'SSML'] | Annotated[str, Strict(strict=True)] | None
voice_name: Literal['Aarav', 'Aarav_2', 'Aarohi', 'Aarti', 'Aarti_2', 'Aarti_3', 'Aashi', 'Abbi', 'Abdullah', 'Abeo', 'Abril', 'Achara', 'Ada', 'Ada_2', 'Adam', 'Adam_2', 'Aditi', 'Adri', 'Adriano', 'Agnieszka', 'Ahmet', 'Aigul', 'Ainhoa', 'Alain', 'Alba', 'Aled', 'Aleksandar', 'Alessio', 'Alessio_2', 'Alex', 'Alfie', 'Ali', 'Alina', 'Alloy', 'Alloy_2', 'Alonso', 'Alvaro', 'Amal', 'Amala', 'Amanda', 'Amany', 'Amber', 'Ambre', 'Ameha', 'Amina', 'Amy', 'Amy_2', 'Amy_3', 'Ana', 'Anahit', 'Ananya', 'Ananya_2', 'Anbu', 'Ander', 'Andre', 'Andre_2', 'Andrea', 'Andres', 'Andrew', 'Andrew_2', 'Andrew_3', 'Andrew_4', 'Angelo', 'Anila', 'Annette', 'Antoine', 'Antonin', 'Antonio', 'Anu', 'Aoi', 'Arabella', 'Ardi', 'Aria', 'Aria_2', 'Ariane', 'Arjun', 'Arjun_2', 'Arjun_3', 'Arlet', 'Arnau', 'Arnaud', 'Arthur', 'Arya', 'Arya_2', 'Asad', 'Ashley', 'Asilia', 'Astrid', 'Athina', 'Ava', 'Ava_2', 'Ava_3', 'Avri', 'Ayanda', 'Ayanda_2', 'Aysha', 'Babek', 'Banu', 'Bashkar', 'Bassel', 'Bataa', 'Beatrice', 'Beatriz', 'Belkys', 'Bella', 'Benigno', 'Bernd', 'Bianca', 'Bianca_2', 'Bianca_3', 'Blessica', 'BongJin', 'Borislav', 'Brandon', 'Brandon_2', 'Bree', 'Brenda', 'Brian', 'Brian_2', 'Brian_3', 'Brigitte', 'Bryan', 'Bryan_2', 'Bryan_3', 'Burcu', 'Calimero', 'Camila', 'Camilla', 'Camilla_2', 'Camilla_3', 'Candela', 'Carla', 'Carlos', 'Carlota', 'Carly', 'Carmen', 'Cataldo', 'Catalina', 'Cecilio', 'Celeste', 'Celine', 'Celine_2', 'Chantal', 'Chanthavong', 'Charline', 'Chilemba', 'Christel', 'Christoph', 'Christopher', 'Christopher_2', 'Clara', 'Claude', 'Colette', 'Colm', 'Conchita', 'Connor', 'Conrad', 'Cora', 'Cora_2', 'Coralie', 'Cristiano', 'Daichi', 'Dalia', 'Dalia_2', 'Daniel', 'Daniel_2', 'Danielle', 'Danielle_2', 'Dario', 'Dariya', 'Darren', 'Daudi', 'Daulet', 'Davis', 'Davis_2', 'Davis_3', 'Dena', 'Denise', 'Derek', 'Dhwani', 'Diego', 'Dilara', 'Dimas', 'Dmitry', 'Donato', 'Dora', 'Duarte', 'Duncan', 'Dustin', 'Echo', 'Eka', 'Elena', 'Elias', 'Elimu', 'Elin', 'Elizabeth', 'Elke', 'Elliot', 'Eloise', 'Elsa', 'Elsie', 'Elvira', 'Elza', 'Emel', 'Emil', 'Emilio', 'Emily', 'Emma', 'Emma_2', 'Emma_3', 'Emma_4', 'Enric', 'Enrique', 'Eric', 'Estrella', 'Ethan', 'Evelyn', 'Everita', 'Ewa', 'Ewa_2', 'Ezinne', 'Fabio', 'Fabiola', 'Fable', 'Fabrice', 'Fahed', 'Farid', 'Fatima', 'Federico', 'Fenna', 'Fernanda', 'Fiamma', 'Filiz', 'Finn', 'Florian', 'Florian_2', 'Florin', 'Francisca', 'Freya', 'Gabrielle', 'Gabrielle_2', 'Gabrijela', 'Gadis', 'Gagan', 'Gemma', 'Gemma_2', 'Geraint', 'Gerard', 'Gerardo', 'Gianni', 'Giorgi', 'Giorgio', 'Giovanna', 'Gisela', 'Giuseppe', 'Giuseppe_2', 'Gonzalo', 'GookMin', 'Goran', 'Grace', 'Gregory', 'Gudrun', 'Gul', 'GulNawaz', 'Gunnar', 'Guy', 'Gwyneth', 'Hala', 'Hamdan', 'Hamed', 'Hannah', 'Hannah_2', 'Hans', 'Harri', 'Hayk', 'Hedi', 'Hemkala', 'Henri', 'Hila', 'Hillevi', 'HiuGaai', 'Hiujin', 'HiuMaan', 'HoaiMy', 'Hollie', 'HsiaoChen', 'HsiaoYu', 'Humberto', 'Hyunsu', 'Hyunsu_2', 'Hyunsu_3', 'Ida', 'Ilir', 'Iman', 'Imani', 'Imelda', 'Ines', 'Ines_2', 'Ingrid', 'InJoon', 'Irene', 'Irma', 'Isabella', 'Isabella_2', 'Isabella_3', 'Isabelle', 'Isabelle_2', 'Iselin', 'Isidora', 'Ismael', 'Ivy', 'Ivy_2', 'Jacek', 'Jacob', 'Jacqueline', 'Jajang', 'Jamal', 'James', 'Jan', 'Jane', 'Jane_2', 'Jann', 'Jasmine', 'Jasmine_2', 'Jason', 'Javier', 'Jean', 'Jenny', 'Jenny_2', 'Jenny_3', 'Jeppe', 'Jerome', 'Jihye', 'JiMin', 'Jimmie', 'Jitka', 'Joana', 'Joanna', 'Joanna_2', 'Joanna_3', 'Joanne', 'Joey', 'Joey_2', 'Jonas', 'Jorge', 'Jorge_2', 'Joseph', 'Josephine', 'Juan', 'Julio', 'Justin', 'Justin_2', 'Kai', 'Kajal', 'Kajal_2', 'Kalina', 'Kani', 'Karina', 'Karl', 'Karla', 'Kasper', 'Katja', 'Kavya', 'Kavya_2', 'Kazuha', 'Keita', 'Ken', 'Kendra', 'Kendra_2', 'Keomany', 'Kert', 'Kevin', 'Killian', 'Kim', 'Kimberly', 'Kimberly_2', 'Klarissa', 'Klaus', 'Kumar', 'Kunal', 'Kunal_2', 'Laia', 'Laila', 'Laith', 'Larissa', 'Latifa', 'Laura', 'Laura_2', 'Layla', 'Lea', 'Lea_2', 'Lea_3', 'Leah', 'Leila', 'Leni', 'Lennart', 'Leonas', 'Leticia', 'Lewis', 'Lia', 'Liam', 'Lian', 'Lian_2', 'Libby', 'Liberto', 'Lisa', 'Lisa_2', 'Lisandro', 'Liv', 'Livia', 'Livia_2', 'Lola', 'Lorena', 'Lorenzio', 'Lorenzo', 'Lotte', 'Louisa', 'Lucia', 'Lucia_2', 'Lucia_3', 'Luciano', 'Lucien', 'Luis', 'Lukas', 'Luke', 'Luna', 'Luna_2', 'Lupe', 'Lupe_2', 'Lupe_3', 'Maarten', 'Macerio', 'Macerio_2', 'Madhur', 'Madina', 'Mads', 'Maisie', 'Maja', 'Manohar', 'Manuel', 'Manuela', 'Marcello', 'Marcelo', 'Marek', 'Margarita', 'Maria', 'Marija', 'Marina', 'Mario', 'Marlene', 'Marta', 'Maryam', 'Masaru', 'Mateo', 'Mathieu', 'Matthew', 'Matthew_2', 'Matthew_3', 'Mattias', 'Maurice', 'Maxim', 'Maya', 'Mayu', 'Mekdes', 'Mia', 'Mia_2', 'Mia_3', 'Michelle', 'Midhun', 'Miguel', 'Mitchell', 'Mizuki', 'Moaz', 'Mohan', 'Molly', 'Monica', 'Mouna', 'Muuse', 'Nabanita', 'Naja', 'NamMinh', 'Nanami', 'Nanami_2', 'Nancy', 'Nancy_2', 'Naoki', 'Natasha', 'Neerja', 'Neerja_2', 'Neil', 'Nestoras', 'Nia', 'Niamh', 'Niamh_2', 'Nicholas', 'Nicholas_2', 'Nicolau', 'Nicole', 'Nil', 'Nilar', 'Nils', 'Niranjan', 'Niwat', 'Noah', 'Noemi', 'Noora', 'Noura', 'Nova', 'Nova_2', 'Nuria', 'Ojas', 'Ola', 'Ola_2', 'Oliver', 'Olivia', 'Ollie', 'Ollie_2', 'Omar', 'Ona', 'Onyx', 'Orla', 'Osman', 'Ostap', 'Pallavi', 'Palmira', 'Paloma', 'Paola', 'Pedro', 'Pedro_2', 'Pelayo', 'Penelope', 'Pernille', 'Petra', 'Phoebe', 'Phoebe_2', 'Pierina', 'Piseth', 'Polina', 'Prabhat', 'Prabhat_2', 'Pradeep', 'Premwadee', 'Priyom', 'Rafiki', 'Ralf', 'Rami', 'Ramona', 'Rana', 'Raquel', 'Raveena', 'Reem', 'Rehaan', 'Rehaan_2', 'Rehema', 'Remi', 'Remi_2', 'Remy', 'Remy_2', 'Renata', 'Ricardo', 'Rinaldo', 'Roberto', 'Rodrigo', 'Roger', 'Roi', 'Rok', 'Rosa', 'Ruben', 'Russell', 'Ruth', 'Ruth_2', 'Ryan', 'Ryan_2', 'Sabela', 'Sabrina', 'Sabrina_2', 'Sagar', 'Saleh', 'Salli', 'Salli_2', 'Salli_3', 'Salma', 'Salman', 'Salome', 'Sam', 'Sameera', 'Samuel', 'Sana', 'Sapna', 'Sara', 'Saranya', 'Sardor', 'Saul', 'Sebastian', 'Selma', 'SeoHyeon', 'Seoyeon', 'Seoyeon_2', 'Seoyeon_3', 'Seraphina', 'Seraphina_2', 'Serena', 'Serena_2', 'Sergio', 'Sergio_2', 'Shakir', 'Shimmer', 'Shiori', 'Shruti', 'Siqiniq', 'Siqiniq_2', 'Siti', 'Sobhana', 'Soffie', 'Sofia', 'Sofie', 'Sonia', 'SoonBok', 'Sophie', 'Sophie_2', 'Srecko', 'Sreymom', 'Steffan', 'Steffan_2', 'Steffan_3', 'Stephen', 'Stephen_2', 'Subhasini', 'Sukant', 'SunHi', 'SunHi_2', 'Surya', 'Suvi', 'Svetlana', 'Swara', 'Sylvie', 'Sylvie_2', 'Taim', 'Takumi', 'Takumi_2', 'Tamas', 'Tania', 'Tanishaa', 'Tanja', 'Taqqiq', 'Taqqiq_2', 'Tatyana', 'Teo', 'Teresa', 'Thalita', 'Thalita_2', 'Thalita_3', 'Thando', 'Themba', 'Thiago', 'Thierry', 'Thierry_2', 'Thiha', 'Thilini', 'Thomas', 'Tiana', 'Tiffany', 'Tim', 'Tina', 'Tomas', 'Tomoko', 'Tony', 'Triana', 'Tristan', 'Tristan_ES', 'Tristan_ES_2', 'Tuti', 'Tyler', 'Ubax', 'Uzma', 'Vaani', 'Valentina', 'Valerio', 'Valluvar', 'Venba', 'Vera', 'Vesna', 'Vicki', 'Vicki_2', 'Vicki_3', 'Victor', 'Viktoria', 'Vitoria', 'Vitoria_2', 'Vivienne', 'Vivienne_2', 'Vlasta', 'WanLung', 'Wayne', 'Willem', 'William', 'William_2', 'Xiaochen', 'Xiaochen_2', 'Xiaochen_3', 'Xiaochen_4', 'Xiaohan', 'Xiaohan_2', 'Xiaomeng', 'XiaoMin', 'Xiaomo', 'Xiaoqiu', 'Xiaorou', 'Xiaorui', 'Xiaoshuang', 'Xiaoshuang_2', 'Xiaoshuang_3', 'Xiaotong', 'Xiaoxiao', 'Xiaoxiao_2', 'Xiaoxiao_3', 'Xiaoxiao_4', 'Xiaoxiao_5', 'Xiaoyan', 'Xiaoyi', 'Xiaoyi_2', 'Xiaoyou', 'Xiaoyou_2', 'Xiaoyou_3', 'Xiaoyu', 'Xiaoyu_2', 'Xiaozhen', 'Ximena', 'Ximena_ES', 'Ximena_ES_2', 'Ximena_ES_3', 'Yago', 'Yan', 'Yara', 'Yashica', 'Yasmin', 'Yesui', 'Yolanda', 'YuJin', 'Yundeng', 'Yunfan', 'Yunfan_2', 'Yunfeng', 'Yunhan', 'Yunhao', 'YunJhe', 'Yunjian', 'Yunjie', 'YunSong', 'Yunxi', 'Yunxi_2', 'Yunxia', 'Yunxia_2', 'Yunxiang', 'Yunxiao', 'Yunxiao_2', 'Yunyang', 'Yunye', 'Yunye_2', 'Yunyi', 'Yunyi_2', 'Yunze', 'Yunzhe', 'Yves', 'Yvette', 'Zariyah', 'Zayd', 'Zeina', 'Zhiyu', 'Zhiyu_2', 'Zofia', 'Zuri'] | Annotated[str, Strict(strict=True)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.SayMessage(
*,
type: Literal['SAY'] = 'SAY',
say: Say,
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • type (Literal['SAY'])

  • say (Say)

  • extra_data (Any)

type: Literal['SAY']
say: Say
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.StartRecordingCommand(**extra_data: Any)[source]

Bases: BaseConfigModel

Parameters:

extra_data (Any)

command: Literal['startRecording']
recording_name: Annotated[str, Strict(strict=True)] | None
recording_options: RecordingOptions
events: RecordingEvents | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.StopMessagesCommand(
*,
command: Literal['stopMessages'] = 'stopMessages',
messagesName: Annotated[str, Strict(strict=True)],
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['stopMessages'])

  • messagesName (Annotated[str, Strict(strict=True)])

  • extra_data (Any)

command: Literal['stopMessages']
messages_name: Annotated[str, Strict(strict=True)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.StopRecordingCommand(
*,
command: Literal['stopRecording'] = 'stopRecording',
recordingName: Annotated[str, Strict(strict=True)],
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • command (Literal['stopRecording'])

  • recordingName (Annotated[str, Strict(strict=True)])

  • extra_data (Any)

command: Literal['stopRecording']
recording_name: Annotated[str, Strict(strict=True)]
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.SvamlInput(*, commands: ~typing.Annotated[list[~typing.Annotated[~sinch.domains.voice.models.v2.svaml.shared.amd_command.AmdCommand | ~sinch.domains.voice.models.v2.svaml.shared.dial_command.DialCommand | ~sinch.domains.voice.models.v2.svaml.shared.messages_command.MessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_messages_command.StopMessagesCommand | ~sinch.domains.voice.models.v2.svaml.shared.custom_event_command.CustomEventCommand | ~sinch.domains.voice.models.v2.svaml.shared.hangup_command.HangupCommand | ~sinch.domains.voice.models.v2.svaml.shared.answer_command.AnswerCommand | ~sinch.domains.voice.models.v2.svaml.shared.pause_command.PauseCommand | ~sinch.domains.voice.models.v2.svaml.shared.start_recording_command.StartRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.stop_recording_command.StopRecordingCommand | ~sinch.domains.voice.models.v2.svaml.shared.bridge_call_command.BridgeCallCommand | ~sinch.domains.voice.models.v2.svaml.shared.menu_command.MenuCommand | ~sinch.domains.voice.models.v2.svaml.shared.goto_menu_command.GotoMenuCommand, <sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]], ~annotated_types.Len(min_length=0, max_length=None)], callName: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None = None, events: ~sinch.domains.voice.models.v2.svaml.shared.incoming_call_response_events.IncomingCallResponseEvents | None = None, **extra_data: ~typing.Any)[source]

Bases: BaseConfigModel

Parameters:
commands: Len(min_length=0, max_length=None)]
call_name: Annotated[str, Strict(strict=True)] | None
events: IncomingCallResponseEvents | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.TranscriptionOptions(
*,
isEnabled: Annotated[bool, Strict(strict=True)],
locale: Annotated[str, Strict(strict=True)] | None = None,
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:

  • isEnabled (Annotated[bool, Strict(strict=True)])

  • locale (Annotated[str, Strict(strict=True)] | None)

  • extra_data (Any)

is_enabled: Annotated[bool, Strict(strict=True)]
locale: Annotated[str, Strict(strict=True)] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.voice.models.v2.svaml.shared.IncomingCallResponseEvents(
*,
onHangup: GotoMenuCommand,
<sinch.core.models.internal.unions.ResolveUnion object at 0x7fe3f45ae950>]] | None=None,
**extra_data: Any,
)[source]

Bases: BaseConfigModel

Parameters:
on_hangup: ResolveUnion object at 0x7fe3f45ae950>]] | None
model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(
_BaseConfigModel__context: Any,
) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None