telnyx 3.0.0__py3-none-any.whl

telnyx/types/calls/__init__.py

@@ -0,0 +1,95 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .loopcount_param import LoopcountParam as LoopcountParam
+from .action_refer_params import ActionReferParams as ActionReferParams
+from .action_speak_params import ActionSpeakParams as ActionSpeakParams
+from .action_answer_params import ActionAnswerParams as ActionAnswerParams
+from .action_bridge_params import ActionBridgeParams as ActionBridgeParams
+from .action_gather_params import ActionGatherParams as ActionGatherParams
+from .action_hangup_params import ActionHangupParams as ActionHangupParams
+from .action_reject_params import ActionRejectParams as ActionRejectParams
+from .action_enqueue_params import ActionEnqueueParams as ActionEnqueueParams
+from .action_refer_response import ActionReferResponse as ActionReferResponse
+from .action_speak_response import ActionSpeakResponse as ActionSpeakResponse
+from .action_answer_response import ActionAnswerResponse as ActionAnswerResponse
+from .action_bridge_response import ActionBridgeResponse as ActionBridgeResponse
+from .action_gather_response import ActionGatherResponse as ActionGatherResponse
+from .action_hangup_response import ActionHangupResponse as ActionHangupResponse
+from .action_reject_response import ActionRejectResponse as ActionRejectResponse
+from .action_transfer_params import ActionTransferParams as ActionTransferParams
+from .action_enqueue_response import ActionEnqueueResponse as ActionEnqueueResponse
+from .action_send_dtmf_params import ActionSendDtmfParams as ActionSendDtmfParams
+from .action_transfer_response import ActionTransferResponse as ActionTransferResponse
+from .aws_voice_settings_param import AwsVoiceSettingsParam as AwsVoiceSettingsParam
+from .action_leave_queue_params import ActionLeaveQueueParams as ActionLeaveQueueParams
+from .action_send_dtmf_response import ActionSendDtmfResponse as ActionSendDtmfResponse
+from .action_stop_gather_params import ActionStopGatherParams as ActionStopGatherParams
+from .action_stop_siprec_params import ActionStopSiprecParams as ActionStopSiprecParams
+from .action_start_siprec_params import ActionStartSiprecParams as ActionStartSiprecParams
+from .action_stop_forking_params import ActionStopForkingParams as ActionStopForkingParams
+from .transcription_config_param import TranscriptionConfigParam as TranscriptionConfigParam
+from .action_leave_queue_response import ActionLeaveQueueResponse as ActionLeaveQueueResponse
+from .action_send_sip_info_params import ActionSendSipInfoParams as ActionSendSipInfoParams
+from .action_start_forking_params import ActionStartForkingParams as ActionStartForkingParams
+from .action_stop_gather_response import ActionStopGatherResponse as ActionStopGatherResponse
+from .action_stop_playback_params import ActionStopPlaybackParams as ActionStopPlaybackParams
+from .action_stop_siprec_response import ActionStopSiprecResponse as ActionStopSiprecResponse
+from .call_control_command_result import CallControlCommandResult as CallControlCommandResult
+from .interruption_settings_param import InterruptionSettingsParam as InterruptionSettingsParam
+from .telnyx_voice_settings_param import TelnyxVoiceSettingsParam as TelnyxVoiceSettingsParam
+from .action_start_playback_params import ActionStartPlaybackParams as ActionStartPlaybackParams
+from .action_start_siprec_response import ActionStartSiprecResponse as ActionStartSiprecResponse
+from .action_stop_forking_response import ActionStopForkingResponse as ActionStopForkingResponse
+from .action_stop_recording_params import ActionStopRecordingParams as ActionStopRecordingParams
+from .action_stop_streaming_params import ActionStopStreamingParams as ActionStopStreamingParams
+from .action_gather_using_ai_params import ActionGatherUsingAIParams as ActionGatherUsingAIParams
+from .action_pause_recording_params import ActionPauseRecordingParams as ActionPauseRecordingParams
+from .action_send_sip_info_response import ActionSendSipInfoResponse as ActionSendSipInfoResponse
+from .action_start_forking_response import ActionStartForkingResponse as ActionStartForkingResponse
+from .action_start_recording_params import ActionStartRecordingParams as ActionStartRecordingParams
+from .action_start_streaming_params import ActionStartStreamingParams as ActionStartStreamingParams
+from .action_stop_playback_response import ActionStopPlaybackResponse as ActionStopPlaybackResponse
+from .google_transcription_language import GoogleTranscriptionLanguage as GoogleTranscriptionLanguage
+from .action_resume_recording_params import ActionResumeRecordingParams as ActionResumeRecordingParams
+from .action_start_playback_response import ActionStartPlaybackResponse as ActionStartPlaybackResponse
+from .action_stop_recording_response import ActionStopRecordingResponse as ActionStopRecordingResponse
+from .action_stop_streaming_response import ActionStopStreamingResponse as ActionStopStreamingResponse
+from .action_gather_using_ai_response import ActionGatherUsingAIResponse as ActionGatherUsingAIResponse
+from .action_pause_recording_response import ActionPauseRecordingResponse as ActionPauseRecordingResponse
+from .action_start_recording_response import ActionStartRecordingResponse as ActionStartRecordingResponse
+from .action_start_streaming_response import ActionStartStreamingResponse as ActionStartStreamingResponse
+from .action_stop_ai_assistant_params import ActionStopAIAssistantParams as ActionStopAIAssistantParams
+from .action_gather_using_audio_params import ActionGatherUsingAudioParams as ActionGatherUsingAudioParams
+from .action_gather_using_speak_params import ActionGatherUsingSpeakParams as ActionGatherUsingSpeakParams
+from .action_resume_recording_response import ActionResumeRecordingResponse as ActionResumeRecordingResponse
+from .action_start_ai_assistant_params import ActionStartAIAssistantParams as ActionStartAIAssistantParams
+from .action_stop_transcription_params import ActionStopTranscriptionParams as ActionStopTranscriptionParams
+from .eleven_labs_voice_settings_param import ElevenLabsVoiceSettingsParam as ElevenLabsVoiceSettingsParam
+from .action_start_transcription_params import ActionStartTranscriptionParams as ActionStartTranscriptionParams
+from .action_stop_ai_assistant_response import ActionStopAIAssistantResponse as ActionStopAIAssistantResponse
+from .action_update_client_state_params import ActionUpdateClientStateParams as ActionUpdateClientStateParams
+from .transcription_start_request_param import TranscriptionStartRequestParam as TranscriptionStartRequestParam
+from .action_gather_using_audio_response import ActionGatherUsingAudioResponse as ActionGatherUsingAudioResponse
+from .action_gather_using_speak_response import ActionGatherUsingSpeakResponse as ActionGatherUsingSpeakResponse
+from .action_start_ai_assistant_response import ActionStartAIAssistantResponse as ActionStartAIAssistantResponse
+from .action_stop_transcription_response import ActionStopTranscriptionResponse as ActionStopTranscriptionResponse
+from .action_start_transcription_response import ActionStartTranscriptionResponse as ActionStartTranscriptionResponse
+from .action_update_client_state_response import ActionUpdateClientStateResponse as ActionUpdateClientStateResponse
+from .transcription_engine_a_config_param import TranscriptionEngineAConfigParam as TranscriptionEngineAConfigParam
+from .transcription_engine_b_config_param import TranscriptionEngineBConfigParam as TranscriptionEngineBConfigParam
+from .action_stop_noise_suppression_params import ActionStopNoiseSuppressionParams as ActionStopNoiseSuppressionParams
+from .action_switch_supervisor_role_params import ActionSwitchSupervisorRoleParams as ActionSwitchSupervisorRoleParams
+from .action_start_noise_suppression_params import (
+    ActionStartNoiseSuppressionParams as ActionStartNoiseSuppressionParams,
+)
+from .action_stop_noise_suppression_response import (
+    ActionStopNoiseSuppressionResponse as ActionStopNoiseSuppressionResponse,
+)
+from .action_switch_supervisor_role_response import (
+    ActionSwitchSupervisorRoleResponse as ActionSwitchSupervisorRoleResponse,
+)
+from .action_start_noise_suppression_response import (
+    ActionStartNoiseSuppressionResponse as ActionStartNoiseSuppressionResponse,
+)

telnyx/types/calls/action_answer_params.py

@@ -0,0 +1,148 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, TypedDict
+
+from ..stream_codec import StreamCodec
+from ..sip_header_param import SipHeaderParam
+from ..custom_sip_header_param import CustomSipHeaderParam
+from ..sound_modifications_param import SoundModificationsParam
+from ..stream_bidirectional_mode import StreamBidirectionalMode
+from ..stream_bidirectional_codec import StreamBidirectionalCodec
+from ..stream_bidirectional_target_legs import StreamBidirectionalTargetLegs
+from .transcription_start_request_param import TranscriptionStartRequestParam
+
+__all__ = ["ActionAnswerParams"]
+
+
+class ActionAnswerParams(TypedDict, total=False):
+    billing_group_id: str
+    """Use this field to set the Billing Group ID for the call.
+
+    Must be a valid and existing Billing Group ID.
+    """
+
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    custom_headers: Iterable[CustomSipHeaderParam]
+    """Custom headers to be added to the SIP INVITE response."""
+
+    preferred_codecs: Literal["G722,PCMU,PCMA,G729,OPUS,VP8,H264"]
+    """
+    The list of comma-separated codecs in a preferred order for the forked media to
+    be received.
+    """
+
+    record: Literal["record-from-answer"]
+    """Start recording automatically after an event. Disabled by default."""
+
+    record_channels: Literal["single", "dual"]
+    """
+    Defines which channel should be recorded ('single' or 'dual') when `record` is
+    specified.
+    """
+
+    record_custom_file_name: str
+    """The custom recording file name to be used instead of the default `call_leg_id`.
+
+    Telnyx will still add a Unix timestamp suffix.
+    """
+
+    record_format: Literal["wav", "mp3"]
+    """
+    Defines the format of the recording ('wav' or 'mp3') when `record` is specified.
+    """
+
+    record_max_length: int
+    """
+    Defines the maximum length for the recording in seconds when `record` is
+    specified. The minimum value is 0. The maximum value is 43200. The default value
+    is 0 (infinite).
+    """
+
+    record_timeout_secs: int
+    """
+    The number of seconds that Telnyx will wait for the recording to be stopped if
+    silence is detected when `record` is specified. The timer only starts when the
+    speech is detected. Please note that call transcription is used to detect
+    silence and the related charge will be applied. The minimum value is 0. The
+    default value is 0 (infinite).
+    """
+
+    record_track: Literal["both", "inbound", "outbound"]
+    """The audio track to be recorded.
+
+    Can be either `both`, `inbound` or `outbound`. If only single track is specified
+    (`inbound`, `outbound`), `channels` configuration is ignored and it will be
+    recorded as mono (single channel).
+    """
+
+    record_trim: Literal["trim-silence"]
+    """
+    When set to `trim-silence`, silence will be removed from the beginning and end
+    of the recording.
+    """
+
+    send_silence_when_idle: bool
+    """Generate silence RTP packets when no transmission available."""
+
+    sip_headers: Iterable[SipHeaderParam]
+    """SIP headers to be added to the SIP INVITE response.
+
+    Currently only User-to-User header is supported.
+    """
+
+    sound_modifications: SoundModificationsParam
+    """Use this field to modify sound effects, for example adjust the pitch."""
+
+    stream_bidirectional_codec: StreamBidirectionalCodec
+    """Indicates codec for bidirectional streaming RTP payloads.
+
+    Used only with stream_bidirectional_mode=rtp. Case sensitive.
+    """
+
+    stream_bidirectional_mode: StreamBidirectionalMode
+    """Configures method of bidirectional streaming (mp3, rtp)."""
+
+    stream_bidirectional_target_legs: StreamBidirectionalTargetLegs
+    """Specifies which call legs should receive the bidirectional stream audio."""
+
+    stream_codec: StreamCodec
+    """Specifies the codec to be used for the streamed audio.
+
+    When set to 'default' or when transcoding is not possible, the codec from the
+    call will be used.
+    """
+
+    stream_track: Literal["inbound_track", "outbound_track", "both_tracks"]
+    """Specifies which track should be streamed."""
+
+    stream_url: str
+    """The destination WebSocket address where the stream is going to be delivered."""
+
+    transcription: bool
+    """Enable transcription upon call answer. The default value is false."""
+
+    transcription_config: TranscriptionStartRequestParam
+
+    webhook_url: str
+    """
+    Use this field to override the URL for which Telnyx will send subsequent
+    webhooks to for this call.
+    """
+
+    webhook_url_method: Literal["POST", "GET"]
+    """HTTP request type used for `webhook_url`."""

telnyx/types/calls/action_answer_response.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ActionAnswerResponse", "Data"]
+
+
+class Data(BaseModel):
+    recording_id: Optional[str] = None
+    """The ID of the recording.
+
+    Only present when the record parameter is set to record-from-answer.
+    """
+
+    result: Optional[str] = None
+
+
+class ActionAnswerResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/calls/action_bridge_params.py

@@ -0,0 +1,170 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ActionBridgeParams"]
+
+
+class ActionBridgeParams(TypedDict, total=False):
+    body_call_control_id: Required[Annotated[str, PropertyInfo(alias="call_control_id")]]
+    """
+    The Call Control ID of the call you want to bridge with, can't be used together
+    with queue parameter or video_room_id parameter.
+    """
+
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    mute_dtmf: Literal["none", "both", "self", "opposite"]
+    """When enabled, DTMF tones are not passed to the call participant.
+
+    The webhooks containing the DTMF information will be sent.
+    """
+
+    park_after_unbridge: str
+    """Specifies behavior after the bridge ends (i.e.
+
+    the opposite leg either hangs up or is transferred). If supplied with the value
+    `self`, the current leg will be parked after unbridge. If not set, the default
+    behavior is to hang up the leg.
+    """
+
+    play_ringtone: bool
+    """
+    Specifies whether to play a ringtone if the call you want to bridge with has not
+    yet been answered.
+    """
+
+    queue: str
+    """
+    The name of the queue you want to bridge with, can't be used together with
+    call_control_id parameter or video_room_id parameter. Bridging with a queue
+    means bridging with the first call in the queue. The call will always be removed
+    from the queue regardless of whether bridging succeeds. Returns an error when
+    the queue is empty.
+    """
+
+    record: Literal["record-from-answer"]
+    """Start recording automatically after an event. Disabled by default."""
+
+    record_channels: Literal["single", "dual"]
+    """
+    Defines which channel should be recorded ('single' or 'dual') when `record` is
+    specified.
+    """
+
+    record_custom_file_name: str
+    """The custom recording file name to be used instead of the default `call_leg_id`.
+
+    Telnyx will still add a Unix timestamp suffix.
+    """
+
+    record_format: Literal["wav", "mp3"]
+    """
+    Defines the format of the recording ('wav' or 'mp3') when `record` is specified.
+    """
+
+    record_max_length: int
+    """
+    Defines the maximum length for the recording in seconds when `record` is
+    specified. The minimum value is 0. The maximum value is 43200. The default value
+    is 0 (infinite).
+    """
+
+    record_timeout_secs: int
+    """
+    The number of seconds that Telnyx will wait for the recording to be stopped if
+    silence is detected when `record` is specified. The timer only starts when the
+    speech is detected. Please note that call transcription is used to detect
+    silence and the related charge will be applied. The minimum value is 0. The
+    default value is 0 (infinite).
+    """
+
+    record_track: Literal["both", "inbound", "outbound"]
+    """The audio track to be recorded.
+
+    Can be either `both`, `inbound` or `outbound`. If only single track is specified
+    (`inbound`, `outbound`), `channels` configuration is ignored and it will be
+    recorded as mono (single channel).
+    """
+
+    record_trim: Literal["trim-silence"]
+    """
+    When set to `trim-silence`, silence will be removed from the beginning and end
+    of the recording.
+    """
+
+    ringtone: Literal[
+        "at",
+        "au",
+        "be",
+        "bg",
+        "br",
+        "ch",
+        "cl",
+        "cn",
+        "cz",
+        "de",
+        "dk",
+        "ee",
+        "es",
+        "fi",
+        "fr",
+        "gr",
+        "hu",
+        "il",
+        "in",
+        "it",
+        "jp",
+        "lt",
+        "mx",
+        "my",
+        "nl",
+        "no",
+        "nz",
+        "ph",
+        "pl",
+        "pt",
+        "ru",
+        "se",
+        "sg",
+        "th",
+        "tw",
+        "uk",
+        "us-old",
+        "us",
+        "ve",
+        "za",
+    ]
+    """Specifies which country ringtone to play when `play_ringtone` is set to `true`.
+
+    If not set, the US ringtone will be played.
+    """
+
+    video_room_context: str
+    """The additional parameter that will be passed to the video conference.
+
+    It is a text field and the user can decide how to use it. For example, you can
+    set the participant name or pass JSON text. It can be used only with
+    video_room_id parameter.
+    """
+
+    video_room_id: str
+    """
+    The ID of the video room you want to bridge with, can't be used together with
+    call_control_id parameter or queue parameter.
+    """

telnyx/types/calls/action_bridge_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from .call_control_command_result import CallControlCommandResult
+
+__all__ = ["ActionBridgeResponse"]
+
+
+class ActionBridgeResponse(BaseModel):
+    data: Optional[CallControlCommandResult] = None

telnyx/types/calls/action_enqueue_params.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ActionEnqueueParams"]
+
+
+class ActionEnqueueParams(TypedDict, total=False):
+    queue_name: Required[str]
+    """The name of the queue the call should be put in.
+
+    If a queue with a given name doesn't exist yet it will be created.
+    """
+
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    max_size: int
+    """The maximum number of calls allowed in the queue at a given time.
+
+    Can't be modified for an existing queue.
+    """
+
+    max_wait_time_secs: int
+    """The number of seconds after which the call will be removed from the queue."""

telnyx/types/calls/action_enqueue_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from .call_control_command_result import CallControlCommandResult
+
+__all__ = ["ActionEnqueueResponse"]
+
+
+class ActionEnqueueResponse(BaseModel):
+    data: Optional[CallControlCommandResult] = None

telnyx/types/calls/action_gather_params.py

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["ActionGatherParams"]
+
+
+class ActionGatherParams(TypedDict, total=False):
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    gather_id: str
+    """An id that will be sent back in the corresponding `call.gather.ended` webhook.
+
+    Will be randomly generated if not specified.
+    """
+
+    initial_timeout_millis: int
+    """The number of milliseconds to wait for the first DTMF."""
+
+    inter_digit_timeout_millis: int
+    """The number of milliseconds to wait for input between digits."""
+
+    maximum_digits: int
+    """The maximum number of digits to fetch.
+
+    This parameter has a maximum value of 128.
+    """
+
+    minimum_digits: int
+    """The minimum number of digits to fetch. This parameter has a minimum value of 1."""
+
+    terminating_digit: str
+    """
+    The digit used to terminate input if fewer than `maximum_digits` digits have
+    been gathered.
+    """
+
+    timeout_millis: int
+    """The number of milliseconds to wait to complete the request."""
+
+    valid_digits: str
+    """A list of all digits accepted as valid."""

telnyx/types/calls/action_gather_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from .call_control_command_result import CallControlCommandResult
+
+__all__ = ["ActionGatherResponse"]
+
+
+class ActionGatherResponse(BaseModel):
+    data: Optional[CallControlCommandResult] = None