telnyx 5.119.0 → 5.121.0

data/lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb

@@ -0,0 +1,390 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class VoiceSDKCallReportRetrieveResponseItem < Telnyx::Internal::Type::BaseModel
+      # @!attribute call_id
+      #   Unique call identifier.
+      #
+      #   @return [String, nil]
+      optional :call_id, String
+
+      # @!attribute call_report_id
+      #   User-scoped storage grouping identifier derived from the authenticated user.
+      #   This is not a unique per-call report identifier and may be shared by multiple
+      #   calls for the same user.
+      #
+      #   @return [String, nil]
+      optional :call_report_id, String
+
+      # @!attribute created_at
+      #   Creation timestamp when present.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute flush_reason
+      #   Reason the SDK flushed this stats report segment, for example an intermediate
+      #   socket-close flush.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :flush_reason,
+               Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
+               api_name: :flushReason
+
+      # @!attribute logs
+      #   Raw logs payload emitted by the Voice SDK and stored without normalization. Live
+      #   responses commonly return an array of log entries, but object-shaped log
+      #   payloads are also allowed for compatibility.
+      #
+      #   @return [Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries, nil]
+      optional :logs, union: -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs }
+
+      # @!attribute organization_id
+      #   Organization associated with the stored call report when provided by the Voice
+      #   SDK reporting path.
+      #
+      #   @return [String, nil]
+      optional :organization_id, String
+
+      # @!attribute segment
+      #   Zero-based stats segment index when the SDK sends segmented or intermediate
+      #   reports.
+      #
+      #   @return [Integer, nil]
+      optional :segment, Integer
+
+      # @!attribute stats
+      #   Raw stats payload emitted by the Voice SDK and stored without normalization. The
+      #   exact shape can vary by SDK platform and version. Live responses commonly return
+      #   an array of interval snapshots, but object-shaped stats payloads are also
+      #   allowed for compatibility.
+      #
+      #   @return [Array<Hash{Symbol=>Object}>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats::UnionMember1, nil]
+      optional :stats, union: -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats }
+
+      # @!attribute stored_at
+      #   Time when the call report was stored.
+      #
+      #   @return [Time, nil]
+      optional :stored_at, Time
+
+      # @!attribute summary
+      #   High-level call metadata.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :summary, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute telnyx_leg_id
+      #   Telnyx call leg identifier for correlating the report with call-control, SIP,
+      #   and media troubleshooting data.
+      #
+      #   @return [String, nil]
+      optional :telnyx_leg_id, String
+
+      # @!attribute telnyx_session_id
+      #   Telnyx RTC session identifier for correlating the report with Voice SDK
+      #   signaling and media-session logs.
+      #
+      #   @return [String, nil]
+      optional :telnyx_session_id, String
+
+      # @!attribute user_agent
+      #   Voice SDK user agent string reported by the client. This is the preferred
+      #   SDK/platform/version dimension when present.
+      #
+      #   @return [String, nil]
+      optional :user_agent, String
+
+      # @!attribute user_id
+      #   Authenticated user that owns the call report.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!attribute version
+      #   Legacy SDK version value when the client reports one separately from the user
+      #   agent.
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!attribute voice_sdk_id
+      #   Voice SDK instance identifier.
+      #
+      #   @return [String, nil]
+      optional :voice_sdk_id, String
+
+      # @!attribute voice_sdk_id_decoded
+      #   Decoded Voice SDK identifier metadata emitted by voice-sdk-proxy when available.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :voice_sdk_id_decoded, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute voice_sdk_session_id
+      #   Voice SDK session correlation identifier used to group stats segments for the
+      #   same SDK session.
+      #
+      #   @return [String, nil]
+      optional :voice_sdk_session_id, String
+
+      # @!method initialize(call_id: nil, call_report_id: nil, created_at: nil, flush_reason: nil, logs: nil, organization_id: nil, segment: nil, stats: nil, stored_at: nil, summary: nil, telnyx_leg_id: nil, telnyx_session_id: nil, user_agent: nil, user_id: nil, version: nil, voice_sdk_id: nil, voice_sdk_id_decoded: nil, voice_sdk_session_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem} for more details.
+      #
+      #   A raw call report stats JSON payload. The schema is intentionally permissive
+      #   because Voice SDK clients can add fields over time.
+      #
+      #   @param call_id [String] Unique call identifier.
+      #
+      #   @param call_report_id [String] User-scoped storage grouping identifier derived from the authenticated user. Thi
+      #
+      #   @param created_at [Time] Creation timestamp when present.
+      #
+      #   @param flush_reason [Hash{Symbol=>Object}] Reason the SDK flushed this stats report segment, for example an intermediate so
+      #
+      #   @param logs [Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries] Raw logs payload emitted by the Voice SDK and stored without normalization. Live
+      #
+      #   @param organization_id [String] Organization associated with the stored call report when provided by the Voice S
+      #
+      #   @param segment [Integer] Zero-based stats segment index when the SDK sends segmented or intermediate repo
+      #
+      #   @param stats [Array<Hash{Symbol=>Object}>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats::UnionMember1] Raw stats payload emitted by the Voice SDK and stored without normalization. The
+      #
+      #   @param stored_at [Time] Time when the call report was stored.
+      #
+      #   @param summary [Hash{Symbol=>Object}] High-level call metadata.
+      #
+      #   @param telnyx_leg_id [String] Telnyx call leg identifier for correlating the report with call-control, SIP, an
+      #
+      #   @param telnyx_session_id [String] Telnyx RTC session identifier for correlating the report with Voice SDK signalin
+      #
+      #   @param user_agent [String] Voice SDK user agent string reported by the client. This is the preferred SDK/pl
+      #
+      #   @param user_id [String] Authenticated user that owns the call report.
+      #
+      #   @param version [String] Legacy SDK version value when the client reports one separately from the user ag
+      #
+      #   @param voice_sdk_id [String] Voice SDK instance identifier.
+      #
+      #   @param voice_sdk_id_decoded [Hash{Symbol=>Object}] Decoded Voice SDK identifier metadata emitted by voice-sdk-proxy when available.
+      #
+      #   @param voice_sdk_session_id [String] Voice SDK session correlation identifier used to group stats segments for the sa
+
+      # Raw logs payload emitted by the Voice SDK and stored without normalization. Live
+      # responses commonly return an array of log entries, but object-shaped log
+      # payloads are also allowed for compatibility.
+      #
+      # @see Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem#logs
+      module Logs
+        extend Telnyx::Internal::Type::Union
+
+        # Raw log entries emitted by the Voice SDK.
+        variant -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0Array }
+
+        # Raw logs object emitted by the Voice SDK when logs are grouped under an entries field.
+        variant -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries }
+
+        class UnionMember0 < Telnyx::Internal::Type::BaseModel
+          # @!attribute context
+          #   Raw structured context attached to the log entry.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :context, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute level
+          #   Log level emitted by the SDK.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0::Level, nil]
+          optional :level,
+                   enum: -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0::Level }
+
+          # @!attribute message
+          #   Log message.
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!attribute timestamp
+          #   Time when the log entry was emitted.
+          #
+          #   @return [Time, nil]
+          optional :timestamp, Time
+
+          # @!method initialize(context: nil, level: nil, message: nil, timestamp: nil)
+          #   A raw Voice SDK log entry. Additional SDK-specific fields may be present.
+          #
+          #   @param context [Hash{Symbol=>Object}] Raw structured context attached to the log entry.
+          #
+          #   @param level [Symbol, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0::Level] Log level emitted by the SDK.
+          #
+          #   @param message [String] Log message.
+          #
+          #   @param timestamp [Time] Time when the log entry was emitted.
+
+          # Log level emitted by the SDK.
+          #
+          # @see Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0#level
+          module Level
+            extend Telnyx::Internal::Type::Enum
+
+            DEBUG = :debug
+            INFO = :info
+            WARN = :warn
+            ERROR = :error
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Entries < Telnyx::Internal::Type::BaseModel
+          # @!attribute entries
+          #   Raw log entries when the SDK groups logs under an entries field.
+          #
+          #   @return [Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries::Entry>, nil]
+          optional :entries,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries::Entry] }
+
+          # @!method initialize(entries: nil)
+          #   Raw logs object emitted by the Voice SDK when logs are grouped under an entries
+          #   field.
+          #
+          #   @param entries [Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries::Entry>] Raw log entries when the SDK groups logs under an entries field.
+
+          class Entry < Telnyx::Internal::Type::BaseModel
+            # @!attribute context
+            #   Raw structured context attached to the log entry.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :context, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+            # @!attribute level
+            #   Log level emitted by the SDK.
+            #
+            #   @return [Symbol, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries::Entry::Level, nil]
+            optional :level,
+                     enum: -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries::Entry::Level }
+
+            # @!attribute message
+            #   Log message.
+            #
+            #   @return [String, nil]
+            optional :message, String
+
+            # @!attribute timestamp
+            #   Time when the log entry was emitted.
+            #
+            #   @return [Time, nil]
+            optional :timestamp, Time
+
+            # @!method initialize(context: nil, level: nil, message: nil, timestamp: nil)
+            #   A raw Voice SDK log entry. Additional SDK-specific fields may be present.
+            #
+            #   @param context [Hash{Symbol=>Object}] Raw structured context attached to the log entry.
+            #
+            #   @param level [Symbol, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries::Entry::Level] Log level emitted by the SDK.
+            #
+            #   @param message [String] Log message.
+            #
+            #   @param timestamp [Time] Time when the log entry was emitted.
+
+            # Log level emitted by the SDK.
+            #
+            # @see Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries::Entry#level
+            module Level
+              extend Telnyx::Internal::Type::Enum
+
+              DEBUG = :debug
+              INFO = :info
+              WARN = :warn
+              ERROR = :error
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries)]
+
+        # @type [Telnyx::Internal::Type::Converter]
+        UnionMember0Array =
+          Telnyx::Internal::Type::ArrayOf[-> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0 }]
+      end
+
+      # Raw stats payload emitted by the Voice SDK and stored without normalization. The
+      # exact shape can vary by SDK platform and version. Live responses commonly return
+      # an array of interval snapshots, but object-shaped stats payloads are also
+      # allowed for compatibility.
+      #
+      # @see Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem#stats
+      module Stats
+        extend Telnyx::Internal::Type::Union
+
+        # Raw interval stats snapshots emitted by the Voice SDK.
+        variant -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats::UnionMember0Array }
+
+        # Raw stats object emitted by the Voice SDK.
+        variant -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats::UnionMember1 }
+
+        class UnionMember1 < Telnyx::Internal::Type::BaseModel
+          # @!attribute audio
+          #   Raw audio stats such as inbound/outbound packet, byte, jitter, packet-loss,
+          #   bitrate, and audio-level metrics.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :audio, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute connection
+          #   Raw connection stats such as round-trip time, packets, and bytes sent or
+          #   received.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :connection, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute ice
+          #   Raw ICE candidate-pair information, including selected pair, local/remote
+          #   candidates, state, and nomination data when provided by the SDK.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :ice, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute transport
+          #   Raw transport stats such as ICE state, DTLS state, SRTP cipher, TLS version, and
+          #   selected-candidate-pair changes.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :transport, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!method initialize(audio: nil, connection: nil, ice: nil, transport: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats::UnionMember1}
+          #   for more details.
+          #
+          #   Raw stats object emitted by the Voice SDK.
+          #
+          #   @param audio [Hash{Symbol=>Object}] Raw audio stats such as inbound/outbound packet, byte, jitter, packet-loss, bitr
+          #
+          #   @param connection [Hash{Symbol=>Object}] Raw connection stats such as round-trip time, packets, and bytes sent or receive
+          #
+          #   @param ice [Hash{Symbol=>Object}] Raw ICE candidate-pair information, including selected pair, local/remote candid
+          #
+          #   @param transport [Hash{Symbol=>Object}] Raw transport stats such as ICE state, DTLS state, SRTP cipher, TLS version, and
+        end
+
+        # @!method self.variants
+        #   @return [Array(Array<Hash{Symbol=>Object}>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats::UnionMember1)]
+
+        # @type [Telnyx::Internal::Type::Converter]
+        UnionMember0Array =
+          Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+      end
+    end
+
+    # @type [Telnyx::Internal::Type::Converter]
+    VoiceSDKCallReportRetrieveResponse =
+      Telnyx::Internal::Type::ArrayOf[-> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem }]
+  end
+end

data/lib/telnyx/models.rb

@@ -1777,6 +1777,10 @@ module Telnyx
 
   VoiceDesignRetrieveParams = Telnyx::Models::VoiceDesignRetrieveParams
 
+  VoiceSDKCallReportListParams = Telnyx::Models::VoiceSDKCallReportListParams
+
+  VoiceSDKCallReportRetrieveParams = Telnyx::Models::VoiceSDKCallReportRetrieveParams
+
   WebhookAPIVersion = Telnyx::Models::WebhookAPIVersion
 
   WebhookDeliveryListParams = Telnyx::Models::WebhookDeliveryListParams

data/lib/telnyx/resources/calls/actions.rb

@@ -55,7 +55,7 @@ module Telnyx
         # When the `record` parameter is set to `record-from-answer`, the response will
         # include a `recording_id` field.
         #
-        # @overload answer(call_control_id, assistant: nil, billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: nil, deepfake_detection: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
+        # @overload answer(call_control_id, assistant: nil, billing_group_id: nil, client_state: nil, command_id: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -67,6 +67,8 @@ module Telnyx
         #
         # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
         #
+        # @param conversation_relay_config [Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig] Starts a Conversation Relay session automatically when the answered/dialed call
+        #
         # @param custom_headers [Array<Telnyx::Models::CustomSipHeader>] Custom headers to be added to the SIP INVITE response.
         #
         # @param deepfake_detection [Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection] Enables deepfake detection on the call. When enabled, audio from the remote part
@@ -945,7 +947,7 @@ module Telnyx
         #   the customer WebSocket disconnects, the webhook payload `reason` is
         #   `customer_disconnect`.
         #
-        # @overload start_conversation_relay(call_control_id, assistant: nil, client_state: nil, command_id: nil, conversation_relay_dtmf_detection: nil, conversation_relay_settings: nil, conversation_relay_url: nil, greeting: nil, interruption_settings: nil, language: nil, languages: nil, transcription: nil, transcription_language: nil, tts_language: nil, voice: nil, voice_settings: nil, request_options: {})
+        # @overload start_conversation_relay(call_control_id, assistant: nil, client_state: nil, command_id: nil, conversation_relay_dtmf_detection: nil, conversation_relay_settings: nil, conversation_relay_url: nil, custom_parameters: nil, dtmf_detection: nil, greeting: nil, interruptible: nil, interruptible_greeting: nil, interruption_settings: nil, language: nil, languages: nil, provider: nil, structured_provider: nil, transcription: nil, transcription_engine: nil, transcription_engine_config: nil, tts_provider: nil, url: nil, voice: nil, voice_settings: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -957,27 +959,43 @@ module Telnyx
         #
         # @param conversation_relay_dtmf_detection [Boolean] Enable DTMF detection for the relay session.
         #
-        # @param conversation_relay_settings [Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings] Conversation Relay connection settings. This object is used by TeXML Call Script
+        # @param conversation_relay_settings [Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings] Conversation Relay connection settings. This object can provide `url`, `dtmf_det
         #
         # @param conversation_relay_url [String] WebSocket URL for your Conversation Relay server. Must start with `ws://` or `ws
         #
+        # @param custom_parameters [Hash{Symbol=>Object}] Custom key-value parameters forwarded to the relay session as `assistant.dynamic
+        #
+        # @param dtmf_detection [Boolean] Public alias for `conversation_relay_dtmf_detection`. If both are present, this
+        #
         # @param greeting [String] Text played when the relay session starts.
         #
+        # @param interruptible [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::Interruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
+        #
+        # @param interruptible_greeting [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptibleGreeting] Controls when caller input can interrupt assistant speech. `any` allows speech o
+        #
         # @param interruption_settings [Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings] Settings for handling caller interruptions during Conversation Relay speech.
         #
         # @param language [String] Default language for the relay session. This value is used for both text-to-spee
         #
-        # @param languages [Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Language>] Language-specific TTS and transcription settings. Use this when the relay sessio
+        # @param languages [Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Language>] Per-language TTS and transcription settings.
         #
-        # @param transcription [Telnyx::Models::Calls::ActionStartConversationRelayParams::Transcription] Speech-to-text settings for Conversation Relay.
+        # @param provider [String] Structured voice provider. Must be supplied together with `structured_provider`.
         #
-        # @param transcription_language [String] Language to use for speech recognition. Overrides `language` for transcription w
+        # @param structured_provider [Hash{Symbol=>Object}] Provider-specific structured voice settings. Must be supplied together with `pro
         #
-        # @param tts_language [String] Language to use for text-to-speech. Overrides `language` for TTS when provided.
+        # @param transcription [Hash{Symbol=>Object}] Not supported for Conversation Relay start requests. Use `transcription_engine`
+        #
+        # @param transcription_engine [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
+        #
+        # @param transcription_engine_config [Hash{Symbol=>Object}] Engine-specific transcription settings for Conversation Relay. This accepts the
+        #
+        # @param tts_provider [String] Text-to-speech provider. If omitted, Telnyx derives it from `voice` or `provider
+        #
+        # @param url [String] Public alias for `conversation_relay_url`. Must start with `ws://` or `wss://`.
         #
         # @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
         #
-        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionStartConversationRelayParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/telnyx/resources/calls.rb

@@ -35,7 +35,7 @@ module Telnyx
       # When the `record` parameter is set to `record-from-answer`, the response will
       # include a `recording_id` field.
       #
-      # @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
+      # @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
       #
       # @param connection_id [String] The ID of the Call Control App (formerly ID of the connection) to be used when d
       #
@@ -63,6 +63,8 @@ module Telnyx
       #
       # @param conference_config [Telnyx::Models::CallDialParams::ConferenceConfig] Optional configuration parameters to dial new participant into a conference.
       #
+      # @param conversation_relay_config [Telnyx::Models::CallDialParams::ConversationRelayConfig] Starts a Conversation Relay session automatically when the answered/dialed call
+      #
       # @param custom_headers [Array<Telnyx::Models::CustomSipHeader>] Custom headers to be added to the SIP INVITE.
       #
       # @param deepfake_detection [Telnyx::Models::CallDialParams::DeepfakeDetection] Enables deepfake detection on the call. When enabled, audio from the remote part

data/lib/telnyx/resources/voice_sdk_call_reports.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Retrieve raw Voice SDK call report stats payloads for WebRTC call
+    # troubleshooting.
+    class VoiceSDKCallReports
+      # Returns raw call report stats JSON payloads stored for the authenticated user
+      # and `call_id`. The user is derived from Telnyx authentication, not from request
+      # parameters.
+      #
+      # @overload retrieve(call_id, request_options: {})
+      #
+      # @param call_id [String] Call identifier used to retrieve reports owned by the authenticated user.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem>]
+      #
+      # @see Telnyx::Models::VoiceSDKCallReportRetrieveParams
+      def retrieve(call_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["voice_sdk_call_reports/%1$s", call_id],
+          model: Telnyx::Internal::Type::ArrayOf[Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem],
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::VoiceSDKCallReportListParams} for more details.
+      #
+      # Returns paginated raw call report stats JSON payloads stored for the
+      # authenticated user. The user is derived from Telnyx authentication, not from
+      # request parameters.
+      #
+      # @overload list(page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #
+      # @param page_number [Integer]
+      #
+      # @param page_size [Integer]
+      #
+      # @param sort [Symbol, Telnyx::Models::VoiceSDKCallReportListParams::Sort] Set the order of the results by creation date. `asc` and `created_at` sort oldes
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::VoiceSDKCallReportListResponse>]
+      #
+      # @see Telnyx::Models::VoiceSDKCallReportListParams
+      def list(params = {})
+        parsed, options = Telnyx::VoiceSDKCallReportListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "voice_sdk_call_reports",
+          query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+          page: Telnyx::Internal::DefaultFlatPagination,
+          model: Telnyx::Models::VoiceSDKCallReportListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.119.0"
+  VERSION = "5.121.0"
 end

data/lib/telnyx.rb

@@ -2327,6 +2327,10 @@ require_relative "telnyx/models/voice_design_rename_params"
 require_relative "telnyx/models/voice_design_rename_response"
 require_relative "telnyx/models/voice_design_retrieve_params"
 require_relative "telnyx/models/voice_design_retrieve_response"
+require_relative "telnyx/models/voice_sdk_call_report_list_params"
+require_relative "telnyx/models/voice_sdk_call_report_list_response"
+require_relative "telnyx/models/voice_sdk_call_report_retrieve_params"
+require_relative "telnyx/models/voice_sdk_call_report_retrieve_response"
 require_relative "telnyx/models/webhook_api_version"
 require_relative "telnyx/models/webhook_delivery_list_params"
 require_relative "telnyx/models/webhook_delivery_list_response"
@@ -2741,6 +2745,7 @@ require_relative "telnyx/resources/virtual_cross_connects"
 require_relative "telnyx/resources/virtual_cross_connects_coverage"
 require_relative "telnyx/resources/voice_clones"
 require_relative "telnyx/resources/voice_designs"
+require_relative "telnyx/resources/voice_sdk_call_reports"
 require_relative "telnyx/resources/webhook_deliveries"
 require_relative "telnyx/resources/webhooks"
 require_relative "telnyx/resources/well_known"

data/rbi/telnyx/client.rbi

@@ -658,6 +658,11 @@ module Telnyx
     sig { returns(Telnyx::Resources::UacConnections) }
     attr_reader :uac_connections
 
+    # Retrieve raw Voice SDK call report stats payloads for WebRTC call
+    # troubleshooting.
+    sig { returns(Telnyx::Resources::VoiceSDKCallReports) }
+    attr_reader :voice_sdk_call_reports
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers