sinch.domains.voice.models.v2.svaml.types package

class sinch.domains.voice.models.v2.svaml.types.AmdCommandDict[source]

Bases: TypedDict

command: Literal['amd']

events: NotRequired[AmdEventsDict]

class sinch.domains.voice.models.v2.svaml.types.AmdEventsDict[source]

Bases: TypedDict

on_human: NotRequired[List[SvamlCommandDict]]

on_machine: NotRequired[List[SvamlCommandDict]]

on_beep: NotRequired[List[SvamlCommandDict]]

on_unknown: NotRequired[List[SvamlCommandDict]]

class sinch.domains.voice.models.v2.svaml.types.AnswerCommandDict[source]

Bases: TypedDict

command: Literal['answer']

class sinch.domains.voice.models.v2.svaml.types.BridgeCallCommandDict[source]

Bases: TypedDict

command: Literal['bridgeCall']

bridge_name: str

class sinch.domains.voice.models.v2.svaml.types.CallEventsDict[source]

Bases: TypedDict

on_answer: NotRequired[List[SvamlCommandDict]]

on_busy: NotRequired[List[SvamlCommandDict]]

on_reject: NotRequired[List[SvamlCommandDict]]

on_timeout: NotRequired[List[SvamlCommandDict]]

on_hangup: NotRequired[List[SvamlCommandDict]]

on_failure: NotRequired[List[SvamlCommandDict]]

class sinch.domains.voice.models.v2.svaml.types.CustomEventCommandDict[source]

Bases: TypedDict

command: Literal['customEvent']

custom_event_name: str

url: str

fallback_url: NotRequired[str]

class sinch.domains.voice.models.v2.svaml.types.DialCommandDict[source]

Bases: TypedDict

command: Literal['dial']

call_name: NotRequired[str]

from_: NotRequired[PhoneDict | SipFromDict]

to: PhoneDict | SipDict | StreamDict | VoiceRelayDict

dial_timeout_duration_seconds: NotRequired[int]

max_call_duration_seconds: NotRequired[int]

events: NotRequired[CallEventsDict]

class sinch.domains.voice.models.v2.svaml.types.GotoMenuCommandDict[source]

Bases: TypedDict

command: Literal['gotoMenu']

menu_name: str

class sinch.domains.voice.models.v2.svaml.types.HangupCommandDict[source]

Bases: TypedDict

command: Literal['hangup']

call_name: NotRequired[str]

class sinch.domains.voice.models.v2.svaml.types.IncomingCallResponseEventsDict[source]

Bases: TypedDict

on_hangup: NotRequired[List[SvamlCommandDict]]

class sinch.domains.voice.models.v2.svaml.types.MenuCommandDict[source]

Bases: TypedDict

command: Literal['menu']

start_menu: str

menus: Dict[str, MenuItemDict]

class sinch.domains.voice.models.v2.svaml.types.MenuItemDict[source]

Bases: TypedDict

prompt: NotRequired[MenuPromptDict]

repeat_prompt: NotRequired[MenuPromptDict]

input_timeout_duration_seconds: NotRequired[int]

repeat_count: NotRequired[int]

minimum_input_length: NotRequired[int]

maximum_input_length: NotRequired[int]

terminating_sequence: NotRequired[str]

input_methods: NotRequired[List[Literal['DTMF'] | str]]

matches: NotRequired[Dict[str, List[SvamlCommandDict]]]

on_fail: NotRequired[List[SvamlCommandDict]]

class sinch.domains.voice.models.v2.svaml.types.MenuPromptDict[source]

Bases: TypedDict

messages: List[SayMessageDict | PlayMessageDict]

allow_barge_in: NotRequired[bool]

class sinch.domains.voice.models.v2.svaml.types.MessageEventsDict[source]

Bases: TypedDict

on_finish: NotRequired[List[SvamlCommandDict]]

class sinch.domains.voice.models.v2.svaml.types.MessagesCommandDict[source]

Bases: TypedDict

command: Literal['messages']

messages_name: NotRequired[str]

messages: List[SayMessageDict | PlayMessageDict]

events: NotRequired[MessageEventsDict]

class sinch.domains.voice.models.v2.svaml.types.PauseCommandDict[source]

Bases: TypedDict

command: Literal['pause']

duration_milliseconds: int

class sinch.domains.voice.models.v2.svaml.types.PlayDict[source]

Bases: TypedDict

url: str

class sinch.domains.voice.models.v2.svaml.types.PlayMessageDict[source]

Bases: TypedDict

type: Literal['PLAY']

play: PlayDict

class sinch.domains.voice.models.v2.svaml.types.RecordingEventsDict[source]

Bases: TypedDict

on_finish: NotRequired[List[SvamlCommandDict]]

on_failure: NotRequired[List[SvamlCommandDict]]

class sinch.domains.voice.models.v2.svaml.types.RecordingOptionsDict[source]

Bases: TypedDict

destination: Literal['AWS', 'GCP', 'AZURE'] | Annotated[str, Strict(strict=True)]

destination_url: str

credentials: str

format: NotRequired[Literal['MP3', 'WAV'] | Annotated[str, Strict(strict=True)]]

recording_type: NotRequired[Literal['COMBINED', 'INBOUND', 'OUTBOUND'] | Annotated[str, Strict(strict=True)]]

transcription_options: NotRequired[TranscriptionOptionsDict]

class sinch.domains.voice.models.v2.svaml.types.SayDict[source]

Bases: TypedDict

text: str

voice_name: str

format: NotRequired[Literal['TEXT', 'SSML'] | str]

class sinch.domains.voice.models.v2.svaml.types.SayMessageDict[source]

Bases: TypedDict

type: Literal['SAY']

say: SayDict

class sinch.domains.voice.models.v2.svaml.types.StartRecordingCommandDict[source]

Bases: TypedDict

command: Literal['startRecording']

recording_name: NotRequired[str]

recording_options: RecordingOptionsDict

events: NotRequired[RecordingEventsDict]

class sinch.domains.voice.models.v2.svaml.types.StopMessagesCommandDict[source]

Bases: TypedDict

command: Literal['stopMessages']

messages_name: str

class sinch.domains.voice.models.v2.svaml.types.StopRecordingCommandDict[source]

Bases: TypedDict

command: Literal['stopRecording']

recording_name: str

class sinch.domains.voice.models.v2.svaml.types.SvamlInputDict[source]

Bases: TypedDict

commands: List[AmdCommandDict | DialCommandDict | MessagesCommandDict | StopMessagesCommandDict | CustomEventCommandDict | HangupCommandDict | AnswerCommandDict | PauseCommandDict | StartRecordingCommandDict | StopRecordingCommandDict | BridgeCallCommandDict | MenuCommandDict | GotoMenuCommandDict]

call_name: NotRequired[str]

events: NotRequired[IncomingCallResponseEventsDict]

class sinch.domains.voice.models.v2.svaml.types.TranscriptionOptionsDict[source]

Bases: TypedDict

is_enabled: bool

locale: NotRequired[str]