Class: Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection

Defined in:

lib/telnyx/models/calls/action_answer_params.rb

Instance Attribute Summary

• #enabled ⇒ Boolean

  Whether deepfake detection is enabled.

• #rtp_timeout ⇒ Integer^?

  Maximum time in seconds to wait for RTP audio before timing out.

• #timeout ⇒ Integer^?

  Maximum time in seconds to wait for a detection result before timing out.

Instance Method Summary

• #initialize(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: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see Telnyx::Models::Calls::ActionAnswerParams for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(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: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Calls::ActionAnswerParams for more details.

stream_

Parameters:

• call_control_id (String)
• assistant (Telnyx::Models::CallAssistantRequest) (defaults to: nil) —

  AI Assistant configuration. All fields except ‘id` are optional — the assistant’

• billing_group_id (String) (defaults to: nil) —

  Use this field to set the Billing Group ID for the call. Must be a valid and exi

• client_state (String) (defaults to: nil) —

  Use this field to add state to every subsequent webhook. It must be a valid Base

• command_id (String) (defaults to: nil) —

  Use this field to avoid duplicate commands. Telnyx will ignore any command with

• conversation_relay_config (Telnyx::Models::ConversationRelayEmbeddedConfig) (defaults to: nil) —

  Starts a Conversation Relay session automatically when the answered/dialed call

• custom_headers (Array<Telnyx::Models::CustomSipHeader>) (defaults to: nil) —

  Custom headers to be added to the SIP INVITE response.

• deepfake_detection (Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection) (defaults to: nil) —

  Enables deepfake detection on the call. When enabled, audio from the remote part

• preferred_codecs (Symbol, Telnyx::Models::Calls::ActionAnswerParams::PreferredCodecs) (defaults to: nil) —

  The list of comma-separated codecs in a preferred order for the forked media to

• record (Symbol, Telnyx::Models::Calls::ActionAnswerParams::Record) (defaults to: nil) —

  Start recording automatically after an event. Disabled by default.

• record_channels (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordChannels) (defaults to: nil) —

  Defines which channel should be recorded (‘single’ or ‘dual’) when ‘record` is s

• record_custom_file_name (String) (defaults to: nil) —

  The custom recording file name to be used instead of the default ‘call_leg_id`.

• record_format (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordFormat) (defaults to: nil) —

  Defines the format of the recording (‘wav’ or ‘mp3’) when ‘record` is specified.

• record_max_length (Integer) (defaults to: nil) —

  Defines the maximum length for the recording in seconds when ‘record` is specifi

• record_timeout_secs (Integer) (defaults to: nil) —

  The number of seconds that Telnyx will wait for the recording to be stopped if s

• record_track (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordTrack) (defaults to: nil) —

  The audio track to be recorded. Can be either ‘both`, `inbound` or `outbound`. I

• record_trim (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordTrim) (defaults to: nil) —

  When set to ‘trim-silence`, silence will be removed from the beginning and end o

• send_silence_when_idle (Boolean) (defaults to: nil) —

  Generate silence RTP packets when no transmission available.

• sip_headers (Array<Telnyx::Models::SipHeader>) (defaults to: nil) —

  SIP headers to be added to the SIP INVITE response. Currently only User-to-User

• sound_modifications (Telnyx::Models::SoundModifications) (defaults to: nil) —

  Use this field to modify sound effects, for example adjust the pitch.

• stream_bidirectional_codec (Symbol, Telnyx::Models::StreamBidirectionalCodec) (defaults to: nil) —

  Indicates codec for bidirectional streaming RTP payloads. Used only with

• stream_bidirectional_mode (Symbol, Telnyx::Models::StreamBidirectionalMode) (defaults to: nil) —

  Configures method of bidirectional streaming (mp3, rtp).

• stream_bidirectional_target_legs (Symbol, Telnyx::Models::StreamBidirectionalTargetLegs) (defaults to: nil) —

  Specifies which call legs should receive the bidirectional stream audio.

• stream_codec (Symbol, Telnyx::Models::StreamCodec) (defaults to: nil) —

  Specifies the codec to be used for the streamed audio. When set to ‘default’ or

• stream_track (Symbol, Telnyx::Models::Calls::ActionAnswerParams::StreamTrack) (defaults to: nil) —

  Specifies which track should be streamed.

• stream_url (String) (defaults to: nil) —

  The destination WebSocket address where the stream is going to be delivered.

• transcription (Boolean) (defaults to: nil) —

  Enable transcription upon call answer. The default value is false.

• transcription_config (Telnyx::Models::Calls::TranscriptionStartRequest) (defaults to: nil)
• webhook_retries_policies (Hash{Symbol=>Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy}) (defaults to: nil) —

  A map of event types to retry policies. Each retry policy contains an array of ‘

• webhook_url (String) (defaults to: nil) —

  Use this field to override the URL for which Telnyx will send subsequent webhook

• webhook_url_method (Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLMethod) (defaults to: nil) —

  HTTP request type used for ‘webhook_url`.

• webhook_urls (Hash{Symbol=>String}) (defaults to: nil) —

  A map of event types to webhook URLs. When an event of the specified type occurs

• webhook_urls_method (Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLsMethod) (defaults to: nil) —

  HTTP request method to invoke ‘webhook_urls`.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/calls/action_answer_params.rb', line 314

class DeepfakeDetection < Telnyx::Internal::Type::BaseModel
  # @!attribute enabled
  #   Whether deepfake detection is enabled.
  #
  #   @return [Boolean]
  required :enabled, Telnyx::Internal::Type::Boolean

  # @!attribute rtp_timeout
  #   Maximum time in seconds to wait for RTP audio before timing out. If no audio is
  #   received within this window, detection stops with an error.
  #
  #   @return [Integer, nil]
  optional :rtp_timeout, Integer

  # @!attribute timeout
  #   Maximum time in seconds to wait for a detection result before timing out.
  #
  #   @return [Integer, nil]
  optional :timeout, Integer

  # @!method initialize(enabled:, rtp_timeout: nil, timeout: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection} for more details.
  #
  #   Enables deepfake detection on the call. When enabled, audio from the remote
  #   party is streamed to a detection service that analyzes whether the voice is
  #   AI-generated. Results are delivered via the `call.deepfake_detection.result`
  #   webhook.
  #
  #   @param enabled [Boolean] Whether deepfake detection is enabled.
  #
  #   @param rtp_timeout [Integer] Maximum time in seconds to wait for RTP audio before timing out. If no audio is
  #
  #   @param timeout [Integer] Maximum time in seconds to wait for a detection result before timing out.
end

Instance Attribute Details

#enabled ⇒ Boolean

Whether deepfake detection is enabled.

Returns:

• (Boolean)

# File 'lib/telnyx/models/calls/action_answer_params.rb', line 319

required :enabled, Telnyx::Internal::Type::Boolean

#rtp_timeout ⇒ Integer^?

Maximum time in seconds to wait for RTP audio before timing out. If no audio is received within this window, detection stops with an error.

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/calls/action_answer_params.rb', line 326

optional :rtp_timeout, Integer

#timeout ⇒ Integer^?

Maximum time in seconds to wait for a detection result before timing out.

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/calls/action_answer_params.rb', line 332

optional :timeout, Integer