telnyx 5.110.1 → 5.111.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1825e7ada5f2ab99a685efc8a8f9c901d4934ee60bb91d429f9236c5c6843909
-  data.tar.gz: 557b223a38699efd837d3e11de09dca2b4ec9c09a5c3f94522df3cc5dd83fa27
+  metadata.gz: be2cf4e9be3cdaa6185fcb76deeb5d0d85ea5168492480b35878e8809c24eca8
+  data.tar.gz: a26e5c1c405399b8766093b9281a0597adb29ef0121001267e59c8d66f16798b
 SHA512:
-  metadata.gz: 63632fda4043ee4b1ceb675c0c1b042d1aaea29b73c0e47f3a502047b64a25dd8f2bd00ee2ad314baee3c396e76739aad9d352e410d0620909b1db13b376bcc6
-  data.tar.gz: 00f670b252eb199c01e0eda25e877589f12fc7f293ff148065db3b1c8cf97495c0d9f19e423945c624d4f27668b0ff9539ca5bbe4b39a1f89dfa2dd2c78b4f9c
+  metadata.gz: 6503aaffe64f1962021b6b1f91327752f6dc60c014e606422e165ce40acb77fd09dc0e9eb83e8c9317670f98d60c6b5bd422793256be9d09a09c829c50ead42b
+  data.tar.gz: 62dc3c4a7e0d4aed8851c548328640b9a2357c75cf408150306a4e651f817fd909b43477e7047ac2dc82bdaedf818d35208c1ad35b6d34b1d9163e0d76d8e2e6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.111.0 (2026-05-13)
+
+Full Changelog: [v5.110.1...v5.111.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.110.1...v5.111.0)
+
+### Features
+
+* Document AI call status callback overrides ([2458580](https://github.com/team-telnyx/telnyx-ruby/commit/2458580b9c24eb6dcaae8753720cf00f1891abc8))
+
 ## 5.110.1 (2026-05-13)
 
 Full Changelog: [v5.110.0...v5.110.1](https://github.com/team-telnyx/telnyx-ruby/compare/v5.110.0...v5.110.1)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.110.1"
+gem "telnyx", "~> 5.111.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/models/texml_initiate_ai_call_params.rb

@@ -77,13 +77,14 @@ module Telnyx
       optional :caller_id, String, api_name: :CallerId
 
       # @!attribute conversation_callback
-      #   URL destination for Telnyx to send conversation callback events to.
+      #   URL destination for Telnyx to send AI conversation callback events for this
+      #   call. Events include `conversation_created` and `conversation_ended`.
       #
       #   @return [String, nil]
       optional :conversation_callback, String, api_name: :ConversationCallback
 
       # @!attribute conversation_callback_method
-      #   HTTP request type used for `ConversationCallback`.
+      #   HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
       #
       #   @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::ConversationCallbackMethod, nil]
       optional :conversation_callback_method,
@@ -91,7 +92,8 @@ module Telnyx
                api_name: :ConversationCallbackMethod
 
       # @!attribute conversation_callbacks
-      #   An array of URL destinations for conversation callback events.
+      #   Array of URL destinations for AI conversation callback events for this call.
+      #   Events include `conversation_created` and `conversation_ended`.
       #
       #   @return [Array<String>, nil]
       optional :conversation_callbacks,
@@ -239,21 +241,27 @@ module Telnyx
       optional :sip_region, enum: -> { Telnyx::TexmlInitiateAICallParams::SipRegion }, api_name: :SipRegion
 
       # @!attribute status_callback
-      #   URL destination for Telnyx to send status callback events to for the call.
+      #   URL destination for Telnyx to send status callback events for this AI call. When
+      #   provided, this per-call value overrides the status callback URL configured on
+      #   the TeXML application/connection.
       #
       #   @return [String, nil]
       optional :status_callback, String, api_name: :StatusCallback
 
       # @!attribute status_callback_event
-      #   The call events for which Telnyx should send a webhook. Multiple events can be
-      #   defined when separated by a space. Valid values: initiated, ringing, answered,
-      #   completed.
+      #   The status callback events for which Telnyx should send a webhook for this AI
+      #   call. Multiple events can be defined when separated by a space. Valid values:
+      #   initiated, ringing, answered, completed, no-answer, busy, canceled, failed,
+      #   analyzed. When provided, this per-call value overrides the status callback
+      #   events configured on the TeXML application/connection.
       #
       #   @return [String, nil]
       optional :status_callback_event, String, api_name: :StatusCallbackEvent
 
       # @!attribute status_callback_method
-      #   HTTP request type used for `StatusCallback`.
+      #   HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
+      #   call. When provided, this per-call value overrides the status callback method
+      #   configured on the TeXML application/connection.
       #
       #   @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::StatusCallbackMethod, nil]
       optional :status_callback_method,
@@ -261,8 +269,9 @@ module Telnyx
                api_name: :StatusCallbackMethod
 
       # @!attribute status_callbacks
-      #   An array of URL destinations for Telnyx to send status callback events to for
-      #   the call.
+      #   Array of URL destinations for Telnyx to send status callback events for this AI
+      #   call. When provided, these per-call values override the status callback URL
+      #   configured on the TeXML application/connection.
       #
       #   @return [Array<String>, nil]
       optional :status_callbacks, Telnyx::Internal::Type::ArrayOf[String], api_name: :StatusCallbacks
@@ -313,11 +322,11 @@ module Telnyx
       #
       #   @param caller_id [String] To be used as the caller id name (SIP From Display Name) presented to the destin
       #
-      #   @param conversation_callback [String] URL destination for Telnyx to send conversation callback events to.
+      #   @param conversation_callback [String] URL destination for Telnyx to send AI conversation callback events for this call
       #
-      #   @param conversation_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::ConversationCallbackMethod] HTTP request type used for `ConversationCallback`.
+      #   @param conversation_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::ConversationCallbackMethod] HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
       #
-      #   @param conversation_callbacks [Array<String>] An array of URL destinations for conversation callback events.
+      #   @param conversation_callbacks [Array<String>] Array of URL destinations for AI conversation callback events for this call. Eve
       #
       #   @param custom_headers [Array<Telnyx::Models::TexmlInitiateAICallParams::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
       #
@@ -359,13 +368,13 @@ module Telnyx
       #
       #   @param sip_region [Symbol, Telnyx::Models::TexmlInitiateAICallParams::SipRegion] Defines the SIP region to be used for the call.
       #
-      #   @param status_callback [String] URL destination for Telnyx to send status callback events to for the call.
+      #   @param status_callback [String] URL destination for Telnyx to send status callback events for this AI call. When
       #
-      #   @param status_callback_event [String] The call events for which Telnyx should send a webhook. Multiple events can be d
+      #   @param status_callback_event [String] The status callback events for which Telnyx should send a webhook for this AI ca
       #
-      #   @param status_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::StatusCallbackMethod] HTTP request type used for `StatusCallback`.
+      #   @param status_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::StatusCallbackMethod] HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI ca
       #
-      #   @param status_callbacks [Array<String>] An array of URL destinations for Telnyx to send status callback events to for th
+      #   @param status_callbacks [Array<String>] Array of URL destinations for Telnyx to send status callback events for this AI
       #
       #   @param time_limit [Integer] The maximum duration of the call in seconds. The minimum value is 30 and the max
       #
@@ -386,7 +395,7 @@ module Telnyx
         #   @return [Array<Symbol>]
       end
 
-      # HTTP request type used for `ConversationCallback`.
+      # HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
       module ConversationCallbackMethod
         extend Telnyx::Internal::Type::Enum
 
@@ -487,7 +496,9 @@ module Telnyx
         #   @return [Array<Symbol>]
       end
 
-      # HTTP request type used for `StatusCallback`.
+      # HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
+      # call. When provided, this per-call value overrides the status callback method
+      # configured on the TeXML application/connection.
       module StatusCallbackMethod
         extend Telnyx::Internal::Type::Enum
 

data/lib/telnyx/resources/texml.rb

@@ -16,6 +16,17 @@ module Telnyx
       # client state, and calls the dial API. The Twiml, Texml, and Url parameters are
       # not allowed and will result in a 422 error.
       #
+      # **Expected callback events:**
+      #
+      # Status callbacks: `initiated`, `ringing`, `answered`, one terminal status
+      # (`completed`, `no-answer`, `busy`, `canceled`, or `failed`), then `analyzed`
+      # after post-call processing completes.
+      #
+      # Conversation callbacks: `conversation_created` and `conversation_ended`.
+      #
+      # 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: {})
       #
       # @param connection_id [String] The ID of the TeXML connection to use for the call.
@@ -38,11 +49,11 @@ module Telnyx
       #
       # @param caller_id [String] To be used as the caller id name (SIP From Display Name) presented to the destin
       #
-      # @param conversation_callback [String] URL destination for Telnyx to send conversation callback events to.
+      # @param conversation_callback [String] URL destination for Telnyx to send AI conversation callback events for this call
       #
-      # @param conversation_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::ConversationCallbackMethod] HTTP request type used for `ConversationCallback`.
+      # @param conversation_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::ConversationCallbackMethod] HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
       #
-      # @param conversation_callbacks [Array<String>] An array of URL destinations for conversation callback events.
+      # @param conversation_callbacks [Array<String>] Array of URL destinations for AI conversation callback events for this call. Eve
       #
       # @param custom_headers [Array<Telnyx::Models::TexmlInitiateAICallParams::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
       #
@@ -84,13 +95,13 @@ module Telnyx
       #
       # @param sip_region [Symbol, Telnyx::Models::TexmlInitiateAICallParams::SipRegion] Defines the SIP region to be used for the call.
       #
-      # @param status_callback [String] URL destination for Telnyx to send status callback events to for the call.
+      # @param status_callback [String] URL destination for Telnyx to send status callback events for this AI call. When
       #
-      # @param status_callback_event [String] The call events for which Telnyx should send a webhook. Multiple events can be d
+      # @param status_callback_event [String] The status callback events for which Telnyx should send a webhook for this AI ca
       #
-      # @param status_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::StatusCallbackMethod] HTTP request type used for `StatusCallback`.
+      # @param status_callback_method [Symbol, Telnyx::Models::TexmlInitiateAICallParams::StatusCallbackMethod] HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI ca
       #
-      # @param status_callbacks [Array<String>] An array of URL destinations for Telnyx to send status callback events to for th
+      # @param status_callbacks [Array<String>] Array of URL destinations for Telnyx to send status callback events for this AI
       #
       # @param time_limit [Integer] The maximum duration of the call in seconds. The minimum value is 30 and the max
       #

data/lib/telnyx/version.rb

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

data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi

@@ -87,14 +87,15 @@ module Telnyx
       sig { params(caller_id: String).void }
       attr_writer :caller_id
 
-      # URL destination for Telnyx to send conversation callback events to.
+      # URL destination for Telnyx to send AI conversation callback events for this
+      # call. Events include `conversation_created` and `conversation_ended`.
       sig { returns(T.nilable(String)) }
       attr_reader :conversation_callback
 
       sig { params(conversation_callback: String).void }
       attr_writer :conversation_callback
 
-      # HTTP request type used for `ConversationCallback`.
+      # HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
       sig do
         returns(
           T.nilable(
@@ -112,7 +113,8 @@ module Telnyx
       end
       attr_writer :conversation_callback_method
 
-      # An array of URL destinations for conversation callback events.
+      # Array of URL destinations for AI conversation callback events for this call.
+      # Events include `conversation_created` and `conversation_ended`.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :conversation_callbacks
 
@@ -335,23 +337,29 @@ module Telnyx
       end
       attr_writer :sip_region
 
-      # URL destination for Telnyx to send status callback events to for the call.
+      # URL destination for Telnyx to send status callback events for this AI call. When
+      # provided, this per-call value overrides the status callback URL configured on
+      # the TeXML application/connection.
       sig { returns(T.nilable(String)) }
       attr_reader :status_callback
 
       sig { params(status_callback: String).void }
       attr_writer :status_callback
 
-      # The call events for which Telnyx should send a webhook. Multiple events can be
-      # defined when separated by a space. Valid values: initiated, ringing, answered,
-      # completed.
+      # The status callback events for which Telnyx should send a webhook for this AI
+      # call. Multiple events can be defined when separated by a space. Valid values:
+      # initiated, ringing, answered, completed, no-answer, busy, canceled, failed,
+      # analyzed. When provided, this per-call value overrides the status callback
+      # events configured on the TeXML application/connection.
       sig { returns(T.nilable(String)) }
       attr_reader :status_callback_event
 
       sig { params(status_callback_event: String).void }
       attr_writer :status_callback_event
 
-      # HTTP request type used for `StatusCallback`.
+      # HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
+      # call. When provided, this per-call value overrides the status callback method
+      # configured on the TeXML application/connection.
       sig do
         returns(
           T.nilable(
@@ -369,8 +377,9 @@ module Telnyx
       end
       attr_writer :status_callback_method
 
-      # An array of URL destinations for Telnyx to send status callback events to for
-      # the call.
+      # Array of URL destinations for Telnyx to send status callback events for this AI
+      # call. When provided, these per-call values override the status callback URL
+      # configured on the TeXML application/connection.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :status_callbacks
 
@@ -486,11 +495,13 @@ module Telnyx
         # containing only letters, numbers, spaces, and `-_~!.+` special characters. If
         # omitted, the display name will be the same as the number in the `From` field.
         caller_id: nil,
-        # URL destination for Telnyx to send conversation callback events to.
+        # URL destination for Telnyx to send AI conversation callback events for this
+        # call. Events include `conversation_created` and `conversation_ended`.
         conversation_callback: nil,
-        # HTTP request type used for `ConversationCallback`.
+        # HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
         conversation_callback_method: nil,
-        # An array of URL destinations for conversation callback events.
+        # Array of URL destinations for AI conversation callback events for this call.
+        # Events include `conversation_created` and `conversation_ended`.
         conversation_callbacks: nil,
         # Custom HTTP headers to be sent with the call. Each header should be an object
         # with 'name' and 'value' properties.
@@ -540,16 +551,23 @@ module Telnyx
         sip_auth_username: nil,
         # Defines the SIP region to be used for the call.
         sip_region: nil,
-        # URL destination for Telnyx to send status callback events to for the call.
+        # URL destination for Telnyx to send status callback events for this AI call. When
+        # provided, this per-call value overrides the status callback URL configured on
+        # the TeXML application/connection.
         status_callback: nil,
-        # The call events for which Telnyx should send a webhook. Multiple events can be
-        # defined when separated by a space. Valid values: initiated, ringing, answered,
-        # completed.
+        # The status callback events for which Telnyx should send a webhook for this AI
+        # call. Multiple events can be defined when separated by a space. Valid values:
+        # initiated, ringing, answered, completed, no-answer, busy, canceled, failed,
+        # analyzed. When provided, this per-call value overrides the status callback
+        # events configured on the TeXML application/connection.
         status_callback_event: nil,
-        # HTTP request type used for `StatusCallback`.
+        # HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
+        # call. When provided, this per-call value overrides the status callback method
+        # configured on the TeXML application/connection.
         status_callback_method: nil,
-        # An array of URL destinations for Telnyx to send status callback events to for
-        # the call.
+        # Array of URL destinations for Telnyx to send status callback events for this AI
+        # call. When provided, these per-call values override the status callback URL
+        # configured on the TeXML application/connection.
         status_callbacks: nil,
         # The maximum duration of the call in seconds. The minimum value is 30 and the
         # maximum value is 14400 (4 hours). Default is 14400 seconds.
@@ -659,7 +677,7 @@ module Telnyx
         end
       end
 
-      # HTTP request type used for `ConversationCallback`.
+      # HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
       module ConversationCallbackMethod
         extend Telnyx::Internal::Type::Enum
 
@@ -940,7 +958,9 @@ module Telnyx
         end
       end
 
-      # HTTP request type used for `StatusCallback`.
+      # HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
+      # call. When provided, this per-call value overrides the status callback method
+      # configured on the TeXML application/connection.
       module StatusCallbackMethod
         extend Telnyx::Internal::Type::Enum
 

data/rbi/telnyx/resources/texml.rbi

@@ -12,6 +12,17 @@ module Telnyx
       # an internal TeXML with an AI Assistant configuration, encodes instructions into
       # client state, and calls the dial API. The Twiml, Texml, and Url parameters are
       # not allowed and will result in a 422 error.
+      #
+      # **Expected callback events:**
+      #
+      # Status callbacks: `initiated`, `ringing`, `answered`, one terminal status
+      # (`completed`, `no-answer`, `busy`, `canceled`, or `failed`), then `analyzed`
+      # after post-call processing completes.
+      #
+      # Conversation callbacks: `conversation_created` and `conversation_ended`.
+      #
+      # Recording, AMD, transcription, and deepfake detection callbacks are only sent
+      # when those features are enabled.
       sig do
         params(
           connection_id: String,
@@ -93,11 +104,13 @@ module Telnyx
         # containing only letters, numbers, spaces, and `-_~!.+` special characters. If
         # omitted, the display name will be the same as the number in the `From` field.
         caller_id: nil,
-        # URL destination for Telnyx to send conversation callback events to.
+        # URL destination for Telnyx to send AI conversation callback events for this
+        # call. Events include `conversation_created` and `conversation_ended`.
         conversation_callback: nil,
-        # HTTP request type used for `ConversationCallback`.
+        # HTTP request type used for `ConversationCallback` and `ConversationCallbacks`.
         conversation_callback_method: nil,
-        # An array of URL destinations for conversation callback events.
+        # Array of URL destinations for AI conversation callback events for this call.
+        # Events include `conversation_created` and `conversation_ended`.
         conversation_callbacks: nil,
         # Custom HTTP headers to be sent with the call. Each header should be an object
         # with 'name' and 'value' properties.
@@ -147,16 +160,23 @@ module Telnyx
         sip_auth_username: nil,
         # Defines the SIP region to be used for the call.
         sip_region: nil,
-        # URL destination for Telnyx to send status callback events to for the call.
+        # URL destination for Telnyx to send status callback events for this AI call. When
+        # provided, this per-call value overrides the status callback URL configured on
+        # the TeXML application/connection.
         status_callback: nil,
-        # The call events for which Telnyx should send a webhook. Multiple events can be
-        # defined when separated by a space. Valid values: initiated, ringing, answered,
-        # completed.
+        # The status callback events for which Telnyx should send a webhook for this AI
+        # call. Multiple events can be defined when separated by a space. Valid values:
+        # initiated, ringing, answered, completed, no-answer, busy, canceled, failed,
+        # analyzed. When provided, this per-call value overrides the status callback
+        # events configured on the TeXML application/connection.
         status_callback_event: nil,
-        # HTTP request type used for `StatusCallback`.
+        # HTTP request type used for `StatusCallback` and `StatusCallbacks` for this AI
+        # call. When provided, this per-call value overrides the status callback method
+        # configured on the TeXML application/connection.
         status_callback_method: nil,
-        # An array of URL destinations for Telnyx to send status callback events to for
-        # the call.
+        # Array of URL destinations for Telnyx to send status callback events for this AI
+        # call. When provided, these per-call values override the status callback URL
+        # configured on the TeXML application/connection.
         status_callbacks: nil,
         # The maximum duration of the call in seconds. The minimum value is 30 and the
         # maximum value is 14400 (4 hours). Default is 14400 seconds.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telnyx
 version: !ruby/object:Gem::Version
-  version: 5.110.1
+  version: 5.111.0
 platform: ruby
 authors:
 - Telnyx