telnyx 5.119.0 → 5.121.0

data/rbi/telnyx/models.rbi

@@ -1969,6 +1969,11 @@ module Telnyx
 
   VoiceDesignRetrieveParams = Telnyx::Models::VoiceDesignRetrieveParams
 
+  VoiceSDKCallReportListParams = Telnyx::Models::VoiceSDKCallReportListParams
+
+  VoiceSDKCallReportRetrieveParams =
+    Telnyx::Models::VoiceSDKCallReportRetrieveParams
+
   WebhookAPIVersion = Telnyx::Models::WebhookAPIVersion
 
   WebhookDeliveryListParams = Telnyx::Models::WebhookDeliveryListParams

data/rbi/telnyx/resources/calls/actions.rbi

@@ -61,6 +61,8 @@ module Telnyx
             billing_group_id: String,
             client_state: String,
             command_id: String,
+            conversation_relay_config:
+              Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::OrHash,
             custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
             deepfake_detection:
               Telnyx::Calls::ActionAnswerParams::DeepfakeDetection::OrHash,
@@ -124,6 +126,13 @@ module Telnyx
           # Use this field to avoid duplicate commands. Telnyx will ignore any command with
           # the same `command_id` for the same `call_control_id`.
           command_id: nil,
+          # Starts a Conversation Relay session automatically when the answered/dialed call
+          # is answered. This embedded shape is supported on `answer` and `dial`. It uses
+          # public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`,
+          # etc.) and maps them to the underlying Conversation Relay action. `client_state`,
+          # `tts_language`, and `transcription_language` inside this object are ignored; use
+          # the parent command's `client_state` and `command_id` fields instead.
+          conversation_relay_config: nil,
           # Custom headers to be added to the SIP INVITE response.
           custom_headers: nil,
           # Enables deepfake detection on the call. When enabled, audio from the remote
@@ -704,8 +713,8 @@ module Telnyx
           #   `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
           #   to configure speed, volume, pitch, and language_boost.
           # - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
-          #   Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
-          #   voice_speed.
+          #   Supported model_ids: `Arcana`, `Mist`, `ArcanaV3`, `Coda`. Use
+          #   `voice_settings` to configure voice_speed.
           # - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
           #   `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
           #   `voice_settings` to configure precision, sample_rate, and format.
@@ -1117,8 +1126,8 @@ module Telnyx
           #   `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
           #   to configure speed, volume, pitch, and language_boost.
           # - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
-          #   Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
-          #   voice_speed.
+          #   Supported model_ids: `Arcana`, `Mist`, `ArcanaV3`, `Coda`. Use
+          #   `voice_settings` to configure voice_speed.
           # - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
           #   `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
           #   `voice_settings` to configure precision, sample_rate, and format.
@@ -1292,7 +1301,13 @@ module Telnyx
             conversation_relay_settings:
               Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::OrHash,
             conversation_relay_url: String,
+            custom_parameters: T::Hash[Symbol, T.anything],
+            dtmf_detection: T::Boolean,
             greeting: String,
+            interruptible:
+              Telnyx::Calls::ActionStartConversationRelayParams::Interruptible::OrSymbol,
+            interruptible_greeting:
+              Telnyx::Calls::ActionStartConversationRelayParams::InterruptibleGreeting::OrSymbol,
             interruption_settings:
               Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings::OrHash,
             language: String,
@@ -1300,19 +1315,25 @@ module Telnyx
               T::Array[
                 Telnyx::Calls::ActionStartConversationRelayParams::Language::OrHash
               ],
-            transcription:
-              Telnyx::Calls::ActionStartConversationRelayParams::Transcription::OrHash,
-            transcription_language: String,
-            tts_language: String,
+            provider: String,
+            structured_provider: T::Hash[Symbol, T.anything],
+            transcription: T::Hash[Symbol, T.anything],
+            transcription_engine:
+              Telnyx::Calls::ActionStartConversationRelayParams::TranscriptionEngine::OrSymbol,
+            transcription_engine_config: T::Hash[Symbol, T.anything],
+            tts_provider: String,
+            url: String,
             voice: String,
             voice_settings:
               T.any(
                 Telnyx::Calls::ElevenLabsVoiceSettings::OrHash,
                 Telnyx::Calls::TelnyxVoiceSettings::OrHash,
                 Telnyx::Calls::AwsVoiceSettings::OrHash,
+                Telnyx::MinimaxVoiceSettings::OrHash,
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::RimeVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
+                Telnyx::Calls::ActionStartConversationRelayParams::VoiceSettings::Inworld::OrHash,
                 Telnyx::XaiVoiceSettings::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
@@ -1332,34 +1353,62 @@ module Telnyx
           command_id: nil,
           # Enable DTMF detection for the relay session.
           conversation_relay_dtmf_detection: nil,
-          # Conversation Relay connection settings. This object is used by TeXML Call
-          # Scripting's `<ConversationRelay>` verb. The `interruptible` and
-          # `interruptible_greeting` fields are shorthand for
-          # `interruption_settings.interruptible` and
-          # `interruption_settings.interruptible_greeting`; use top-level
-          # `interruption_settings` for the full interruption settings shape.
+          # Conversation Relay connection settings. This object can provide `url`,
+          # `dtmf_detection`, `interruptible`, `interruptible_greeting`, and `languages`.
+          # Top-level aliases override nested values when both are present.
           conversation_relay_settings: nil,
           # WebSocket URL for your Conversation Relay server. Must start with `ws://` or
           # `wss://`.
           conversation_relay_url: nil,
+          # Custom key-value parameters forwarded to the relay session as
+          # `assistant.dynamic_variables`. If `assistant.dynamic_variables` is also present,
+          # these values are merged in.
+          custom_parameters: nil,
+          # Public alias for `conversation_relay_dtmf_detection`. If both are present, this
+          # value wins.
+          dtmf_detection: nil,
           # Text played when the relay session starts.
           greeting: nil,
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          interruptible: nil,
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          interruptible_greeting: nil,
           # Settings for handling caller interruptions during Conversation Relay speech.
           interruption_settings: nil,
           # Default language for the relay session. This value is used for both
-          # text-to-speech and speech recognition unless `tts_language` or
-          # `transcription_language` are provided.
+          # text-to-speech and speech recognition.
           language: nil,
-          # Language-specific TTS and transcription settings. Use this when the relay
-          # session needs per-language provider, voice, or speech model configuration.
+          # Per-language TTS and transcription settings.
           languages: nil,
-          # Speech-to-text settings for Conversation Relay.
+          # Structured voice provider. Must be supplied together with `structured_provider`.
+          provider: nil,
+          # Provider-specific structured voice settings. Must be supplied together with
+          # `provider`; Telnyx sends the value as the nested provider configuration for
+          # Conversation Relay.
+          structured_provider: nil,
+          # Not supported for Conversation Relay start requests. Use `transcription_engine`
+          # and `transcription_engine_config` instead.
           transcription: nil,
-          # Language to use for speech recognition. Overrides `language` for transcription
-          # when provided.
-          transcription_language: nil,
-          # Language to use for text-to-speech. Overrides `language` for TTS when provided.
-          tts_language: nil,
+          # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+          # `Telnyx` are supported for backward compatibility. For Conversation Relay, use
+          # this field with `transcription_engine_config`; the `transcription` object is not
+          # supported.
+          transcription_engine: nil,
+          # Engine-specific transcription settings for Conversation Relay. This accepts the
+          # same provider-specific options used by the Call Transcription Start command,
+          # such as `transcription_model`, without requiring the engine discriminator to be
+          # repeated inside this object.
+          transcription_engine_config: nil,
+          # Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
+          # `provider`.
+          tts_provider: nil,
+          # Public alias for `conversation_relay_url`. Must start with `ws://` or `wss://`.
+          # If both are present, this value wins.
+          url: nil,
           # The voice to be used by the voice assistant. Currently we support ElevenLabs,
           # Telnyx and AWS voices.
           #

data/rbi/telnyx/resources/calls.rbi

@@ -48,6 +48,8 @@ module Telnyx
           client_state: String,
           command_id: String,
           conference_config: Telnyx::CallDialParams::ConferenceConfig::OrHash,
+          conversation_relay_config:
+            Telnyx::CallDialParams::ConversationRelayConfig::OrHash,
           custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
           deepfake_detection: Telnyx::CallDialParams::DeepfakeDetection::OrHash,
           dialogflow_config: Telnyx::DialogflowConfig::OrHash,
@@ -178,6 +180,13 @@ module Telnyx
         command_id: nil,
         # Optional configuration parameters to dial new participant into a conference.
         conference_config: nil,
+        # Starts a Conversation Relay session automatically when the answered/dialed call
+        # is answered. This embedded shape is supported on `answer` and `dial`. It uses
+        # public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`,
+        # etc.) and maps them to the underlying Conversation Relay action. `client_state`,
+        # `tts_language`, and `transcription_language` inside this object are ignored; use
+        # the parent command's `client_state` and `command_id` fields instead.
+        conversation_relay_config: nil,
         # Custom headers to be added to the SIP INVITE.
         custom_headers: nil,
         # Enables deepfake detection on the call. When enabled, audio from the remote

data/rbi/telnyx/resources/conferences/actions.rbi

@@ -577,8 +577,8 @@ module Telnyx
           #   `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
           #   to configure speed, volume, pitch, and language_boost.
           # - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
-          #   Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
-          #   voice_speed.
+          #   Supported model_ids: `Arcana`, `Mist`, `ArcanaV3`, `Coda`. Use
+          #   `voice_settings` to configure voice_speed.
           # - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
           #   `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
           #   `voice_settings` to configure precision, sample_rate, and format.

data/rbi/telnyx/resources/voice_sdk_call_reports.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+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.
+      sig do
+        params(
+          call_id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(
+          T::Array[Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem]
+        )
+      end
+      def retrieve(
+        # Call identifier used to retrieve reports owned by the authenticated user.
+        call_id,
+        request_options: {}
+      )
+      end
+
+      # Returns paginated raw call report stats JSON payloads stored for the
+      # authenticated user. The user is derived from Telnyx authentication, not from
+      # request parameters.
+      sig do
+        params(
+          page_number: Integer,
+          page_size: Integer,
+          sort: Telnyx::VoiceSDKCallReportListParams::Sort::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::Models::VoiceSDKCallReportListResponse
+          ]
+        )
+      end
+      def list(
+        page_number: nil,
+        page_size: nil,
+        # Set the order of the results by creation date. `asc` and `created_at` sort
+        # oldest reports first; `desc` and `-created_at` sort newest reports first. If not
+        # given, results are sorted by creation date in descending order.
+        sort: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/telnyx/client.rbs

@@ -344,6 +344,8 @@ module Telnyx
 
     attr_reader uac_connections: Telnyx::Resources::UacConnections
 
+    attr_reader voice_sdk_call_reports: Telnyx::Resources::VoiceSDKCallReports
+
     private def auth_headers: -> ::Hash[String, String]
 
     private def bearer_auth: -> ::Hash[String, String]