telnyx 5.111.0 → 5.113.0

data/lib/telnyx/models/texml_initiate_ai_call_params.rb

@@ -110,7 +110,9 @@ module Telnyx
                api_name: :CustomHeaders
 
       # @!attribute detection_mode
-      #   Allows you to choose between Premium and Standard detections.
+      #   Allows you to choose between Regular, Premium, and PremiumCallScreening
+      #   detections. See
+      #   https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
       #
       #   @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode, nil]
       optional :detection_mode,
@@ -125,6 +127,13 @@ module Telnyx
                enum: -> { Telnyx::TexmlInitiateAICallParams::MachineDetection },
                api_name: :MachineDetection
 
+      # @!attribute machine_detection_prompt_end_timeout
+      #   Silence duration threshold after a call screening prompt before ending prompt
+      #   detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
+      #
+      #   @return [Integer, nil]
+      optional :machine_detection_prompt_end_timeout, Integer, api_name: :MachineDetectionPromptEndTimeout
+
       # @!attribute machine_detection_silence_timeout
       #   If initial silence duration is greater than this value, consider it a machine.
       #   Ignored when `premium` detection is used.
@@ -298,7 +307,7 @@ module Telnyx
       #   @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::Trim, nil]
       optional :trim, enum: -> { Telnyx::TexmlInitiateAICallParams::Trim }, api_name: :Trim
 
-      # @!method initialize(connection_id:, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
+      # @!method initialize(connection_id:, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::TexmlInitiateAICallParams} for more details.
       #
@@ -330,10 +339,12 @@ module Telnyx
       #
       #   @param custom_headers [Array<Telnyx::Models::TexmlInitiateAICallParams::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
       #
-      #   @param detection_mode [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode] Allows you to choose between Premium and Standard detections.
+      #   @param detection_mode [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
       #
       #   @param machine_detection [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetection] Enables Answering Machine Detection.
       #
+      #   @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
+      #
       #   @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
       #
       #   @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
@@ -425,12 +436,15 @@ module Telnyx
         #   @param value [String] The value of the custom header
       end
 
-      # Allows you to choose between Premium and Standard detections.
+      # Allows you to choose between Regular, Premium, and PremiumCallScreening
+      # detections. See
+      # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
       module DetectionMode
         extend Telnyx::Internal::Type::Enum
 
         PREMIUM = :Premium
         REGULAR = :Regular
+        PREMIUM_CALL_SCREENING = :PremiumCallScreening
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/telnyx/resources/ai/openai.rb

@@ -47,7 +47,7 @@ module Telnyx
         #
         # @param conversation [String] Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided, Te
         #
-        # @param input [Object] The input items for this turn, using the OpenAI Responses API input format.
+        # @param input [Hash{Symbol=>Object}] The input items for this turn, using the OpenAI Responses API input format.
         #
         # @param instructions [String] Optional system/developer instructions for the model. When used with a persisted
         #

data/lib/telnyx/resources/ai.rb

@@ -55,9 +55,9 @@ module Telnyx
       # supported at the moment. Use the `conversation` parameter with a Telnyx
       # Conversation ID to leverage persistent conversations.
       #
-      # @overload create_response(body:, request_options: {})
+      # @overload create_response(params:, request_options: {})
       #
-      # @param body [Hash{Symbol=>Object}]
+      # @param params [Hash{Symbol=>Object}]
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Hash{Symbol=>Object}]
@@ -68,7 +68,7 @@ module Telnyx
         @client.request(
           method: :post,
           path: "ai/responses",
-          body: parsed[:body],
+          body: parsed[:params],
           model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
           options: options
         )

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

@@ -930,6 +930,71 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Calls::ActionStartConversationRelayParams} for more details.
+        #
+        # Start a Conversation Relay session on an active call. Conversation Relay
+        # connects the call audio to your WebSocket so your application can exchange
+        # realtime messages with the caller while Telnyx handles speech recognition and
+        # text-to-speech. Only one AI Assistant or Conversation Relay session can be
+        # active on a call at a time.
+        #
+        # **Expected Webhooks:**
+        #
+        # - `call.conversation.ended` - Sent when the Conversation Relay session ends. If
+        #   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: {})
+        #
+        # @param call_control_id [String] Unique identifier and token for controlling the call
+        #
+        # @param assistant [Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant] Custom parameters for the Conversation Relay session. Pass key-value data as `as
+        #
+        # @param client_state [String] Use this field to add state to subsequent webhooks. It must be a valid Base-64 e
+        #
+        # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
+        #
+        # @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_url [String] WebSocket URL for your Conversation Relay server. Must start with `ws://` or `ws
+        #
+        # @param greeting [String] Text played when the relay session starts.
+        #
+        # @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 transcription [Telnyx::Models::Calls::ActionStartConversationRelayParams::Transcription] Speech-to-text settings for Conversation Relay.
+        #
+        # @param transcription_language [String] Language to use for speech recognition. Overrides `language` for transcription w
+        #
+        # @param tts_language [String] Language to use for text-to-speech. Overrides `language` for TTS when provided.
+        #
+        # @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 request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Calls::ActionStartConversationRelayResponse]
+        #
+        # @see Telnyx::Models::Calls::ActionStartConversationRelayParams
+        def start_conversation_relay(call_control_id, params = {})
+          parsed, options = Telnyx::Calls::ActionStartConversationRelayParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["calls/%1$s/actions/conversation_relay_start", call_control_id],
+            body: parsed,
+            model: Telnyx::Models::Calls::ActionStartConversationRelayResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStartForkingParams} for more details.
         #
@@ -1256,7 +1321,7 @@ module Telnyx
         #
         # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
         #
-        # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
+        # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
         #
         # @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
         #
@@ -1305,6 +1370,35 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Calls::ActionStopConversationRelayParams} for more details.
+        #
+        # Stop the active Conversation Relay session on a call.
+        #
+        # @overload stop_conversation_relay(call_control_id, client_state: nil, command_id: nil, request_options: {})
+        #
+        # @param call_control_id [String] Unique identifier and token for controlling the call
+        #
+        # @param client_state [String] Use this field to add state to subsequent webhooks. It must be a valid Base-64 e
+        #
+        # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Calls::ActionStopConversationRelayResponse]
+        #
+        # @see Telnyx::Models::Calls::ActionStopConversationRelayParams
+        def stop_conversation_relay(call_control_id, params = {})
+          parsed, options = Telnyx::Calls::ActionStopConversationRelayParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["calls/%1$s/actions/conversation_relay_stop", call_control_id],
+            body: parsed,
+            model: Telnyx::Models::Calls::ActionStopConversationRelayResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStopForkingParams} for more details.
         #

data/lib/telnyx/resources/faxes.rb

@@ -15,6 +15,18 @@ module Telnyx
       # is bigger than 50MB or has more than 350 pages it will fail with
       # `file_size_limit_exceeded` and `page_count_limit_exceeded` respectively.
       #
+      # **Supported file formats:**
+      #
+      # - PDF (`application/pdf`)
+      # - TIFF (`application/tiff`, `image/tiff`)
+      # - JPEG (`image/jpeg`)
+      # - PNG (`image/png`)
+      # - Microsoft Word `.doc` (`application/msword`)
+      # - Microsoft Word `.docx`
+      #   (`application/vnd.openxmlformats-officedocument.wordprocessingml.document`)
+      # - Rich Text Format `.rtf` (`application/rtf`)
+      # - Plain text `.txt` (`text/plain`)
+      #
       # **Expected Webhooks:**
       #
       # - `fax.queued`
@@ -39,7 +51,7 @@ module Telnyx
       #
       # @param media_name [String] The media_name used for the fax's media. Must point to a file previously uploade
       #
-      # @param media_url [String] The URL (or list of URLs) to the PDF used for the fax's media. media_url and med
+      # @param media_url [String] The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF, JPE
       #
       # @param monochrome [Boolean] The flag to enable monochrome, true black and white fax results.
       #

data/lib/telnyx/resources/texml.rb

@@ -27,7 +27,7 @@ module Telnyx
       # Recording, AMD, transcription, and deepfake detection callbacks are only sent
       # when those features are enabled.
       #
-      # @overload initiate_ai_call(connection_id, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
+      # @overload initiate_ai_call(connection_id, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
       #
       # @param connection_id [String] The ID of the TeXML connection to use for the call.
       #
@@ -57,10 +57,12 @@ module Telnyx
       #
       # @param custom_headers [Array<Telnyx::Models::TexmlInitiateAICallParams::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
       #
-      # @param detection_mode [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode] Allows you to choose between Premium and Standard detections.
+      # @param detection_mode [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
       #
       # @param machine_detection [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetection] Enables Answering Machine Detection.
       #
+      # @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
+      #
       # @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
       #
       # @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere

data/lib/telnyx/version.rb

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

data/lib/telnyx.rb

@@ -605,6 +605,8 @@ require_relative "telnyx/models/calls/action_speak_params"
 require_relative "telnyx/models/calls/action_speak_response"
 require_relative "telnyx/models/calls/action_start_ai_assistant_params"
 require_relative "telnyx/models/calls/action_start_ai_assistant_response"
+require_relative "telnyx/models/calls/action_start_conversation_relay_params"
+require_relative "telnyx/models/calls/action_start_conversation_relay_response"
 require_relative "telnyx/models/calls/action_start_forking_params"
 require_relative "telnyx/models/calls/action_start_forking_response"
 require_relative "telnyx/models/calls/action_start_noise_suppression_params"
@@ -621,6 +623,8 @@ require_relative "telnyx/models/calls/action_start_transcription_params"
 require_relative "telnyx/models/calls/action_start_transcription_response"
 require_relative "telnyx/models/calls/action_stop_ai_assistant_params"
 require_relative "telnyx/models/calls/action_stop_ai_assistant_response"
+require_relative "telnyx/models/calls/action_stop_conversation_relay_params"
+require_relative "telnyx/models/calls/action_stop_conversation_relay_response"
 require_relative "telnyx/models/calls/action_stop_forking_params"
 require_relative "telnyx/models/calls/action_stop_forking_response"
 require_relative "telnyx/models/calls/action_stop_gather_params"
@@ -661,6 +665,7 @@ require_relative "telnyx/models/calls/transcription_engine_azure_config"
 require_relative "telnyx/models/calls/transcription_engine_b_config"
 require_relative "telnyx/models/calls/transcription_engine_deepgram_config"
 require_relative "telnyx/models/calls/transcription_engine_google_config"
+require_relative "telnyx/models/calls/transcription_engine_speechmatics_config"
 require_relative "telnyx/models/calls/transcription_engine_telnyx_config"
 require_relative "telnyx/models/calls/transcription_engine_xai_config"
 require_relative "telnyx/models/call_siprec_failed"

data/rbi/telnyx/models/ai/openai_create_response_params.rbi

@@ -26,10 +26,10 @@ module Telnyx
         attr_writer :conversation
 
         # The input items for this turn, using the OpenAI Responses API input format.
-        sig { returns(T.nilable(T.anything)) }
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :input
 
-        sig { params(input: T.anything).void }
+        sig { params(input: T::Hash[Symbol, T.anything]).void }
         attr_writer :input
 
         # Optional system/developer instructions for the model. When used with a persisted
@@ -60,7 +60,7 @@ module Telnyx
         sig do
           params(
             conversation: String,
-            input: T.anything,
+            input: T::Hash[Symbol, T.anything],
             instructions: String,
             model: String,
             stream: T::Boolean,
@@ -93,7 +93,7 @@ module Telnyx
           override.returns(
             {
               conversation: String,
-              input: T.anything,
+              input: T::Hash[Symbol, T.anything],
               instructions: String,
               model: String,
               stream: T::Boolean,

data/rbi/telnyx/models/ai_create_response_params.rbi

@@ -12,21 +12,21 @@ module Telnyx
         end
 
       sig { returns(T::Hash[Symbol, T.anything]) }
-      attr_accessor :body
+      attr_accessor :params
 
       sig do
         params(
-          body: T::Hash[Symbol, T.anything],
+          params: T::Hash[Symbol, T.anything],
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(body:, request_options: {})
+      def self.new(params:, request_options: {})
       end
 
       sig do
         override.returns(
           {
-            body: T::Hash[Symbol, T.anything],
+            params: T::Hash[Symbol, T.anything],
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/call_conversation_ended.rbi

@@ -229,6 +229,11 @@ module Telnyx
         sig { params(llm_model: String).void }
         attr_writer :llm_model
 
+        # Reason the conversation ended. For Conversation Relay, `customer_disconnect`
+        # indicates that the customer WebSocket disconnected.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
         # The speech-to-text model used in the conversation.
         sig { returns(T.nilable(String)) }
         attr_reader :stt_model
@@ -278,6 +283,7 @@ module Telnyx
             duration_sec: Integer,
             from: String,
             llm_model: String,
+            reason: T.nilable(String),
             stt_model: String,
             to: String,
             tts_model_id: String,
@@ -308,6 +314,9 @@ module Telnyx
           from: nil,
           # The large language model used during the conversation.
           llm_model: nil,
+          # Reason the conversation ended. For Conversation Relay, `customer_disconnect`
+          # indicates that the customer WebSocket disconnected.
+          reason: nil,
           # The speech-to-text model used in the conversation.
           stt_model: nil,
           # The callee's number or SIP address.
@@ -336,6 +345,7 @@ module Telnyx
               duration_sec: Integer,
               from: String,
               llm_model: String,
+              reason: T.nilable(String),
               stt_model: String,
               to: String,
               tts_model_id: String,