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

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/calls/action_answer_params.rb,
sig/telnyx/models/calls/action_answer_params.rbs

Overview

See Also:

• Telnyx::Resources::Calls::Actions#answer

Defined Under Namespace

Modules: PreferredCodecs, Record, RecordChannels, RecordFormat, RecordTrack, RecordTrim, StreamTrack, WebhookURLMethod, WebhookURLsMethod Classes: DeepfakeDetection, WebhookRetriesPolicy

Constant Summary

Telnyx =

Returns:

• (:CallAssistantRequest)

Instance Attribute Summary

• #assistant ⇒ Telnyx::Models::CallAssistantRequest^?

  AI Assistant configuration.

• #billing_group_id ⇒ String^?

  Use this field to set the Billing Group ID for the call.

• #call_control_id ⇒ String
• #client_state ⇒ String^?

  Use this field to add state to every subsequent webhook.

• #command_id ⇒ String^?

  Use this field to avoid duplicate commands.

• #conversation_relay_config ⇒ Telnyx::Models::ConversationRelayEmbeddedConfig^?

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

• #custom_headers ⇒ Array<Telnyx::Models::CustomSipHeader>^?

  Custom headers to be added to the SIP INVITE response.

• #deepfake_detection ⇒ Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection^?

  Enables deepfake detection on the call.

• #preferred_codecs ⇒ Symbol, ...

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

• #record ⇒ Symbol, ...

  Start recording automatically after an event.

• #record_channels ⇒ Symbol, ...

  Defines which channel should be recorded ('single' or 'dual') when record is specified.

• #record_custom_file_name ⇒ String^?

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

• #record_format ⇒ Symbol, ...

  Defines the format of the recording ('wav' or 'mp3') when record is specified.

• #record_max_length ⇒ Integer^?

  Defines the maximum length for the recording in seconds when record is specified.

• #record_timeout_secs ⇒ Integer^?

  The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when record is specified.

• #record_track ⇒ Symbol, ...

  The audio track to be recorded.

• #record_trim ⇒ Symbol, ...

  When set to trim-silence, silence will be removed from the beginning and end of the recording.

• #send_silence_when_idle ⇒ Boolean^?

  Generate silence RTP packets when no transmission available.

• #sip_headers ⇒ Array<Telnyx::Models::SipHeader>^?

  SIP headers to be added to the SIP INVITE response.

• #sound_modifications ⇒ Telnyx::Models::SoundModifications^?

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

• #stream_bidirectional_codec ⇒ Symbol, ...

  Indicates codec for bidirectional streaming RTP payloads.

• #stream_bidirectional_mode ⇒ Symbol, ...

  Configures method of bidirectional streaming (mp3, rtp).

• #stream_bidirectional_target_legs ⇒ Symbol, ...

  Specifies which call legs should receive the bidirectional stream audio.

• #stream_codec ⇒ Symbol, ...

  Specifies the codec to be used for the streamed audio.

• #stream_track ⇒ Symbol, ...

  Specifies which track should be streamed.

• #stream_url ⇒ String^?

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

• #transcription ⇒ Boolean^?

  Enable transcription upon call answer.

• #transcription_config ⇒ Telnyx::Models::Calls::TranscriptionStartRequest^?
• #webhook_retries_policies ⇒ Hash{Symbol=>Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy}^?

  A map of event types to retry policies.

• #webhook_url ⇒ String^?

  Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.

• #webhook_url_method ⇒ Symbol, ...

  HTTP request type used for webhook_url.

• #webhook_urls ⇒ Hash{Symbol=>String}^?

  A map of event types to webhook URLs.

• #webhook_urls_method ⇒ Symbol, ...

  HTTP request method to invoke webhook_urls.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(retries_ms: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see WebhookRetriesPolicy for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(retries_ms: nil) ⇒ Object

Some parameter documentations has been truncated, see WebhookRetriesPolicy for more details.

Parameters:

• retries_ms (Array<Integer>) (defaults to: nil) —

  Array of delays in milliseconds between retry attempts. Total sum cannot exceed

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

Instance Attribute Details

#assistant ⇒ Telnyx::Models::CallAssistantRequest^?

AI Assistant configuration. All fields except id are optional — the assistant's stored configuration will be used as fallback for any omitted fields.

Returns:

• (Telnyx::Models::CallAssistantRequest, nil)

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

optional :assistant, -> { Telnyx::CallAssistantRequest }

#billing_group_id ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :billing_group_id, String

#call_control_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :call_control_id, String

#client_state ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :client_state, String

#command_id ⇒ String^?

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :command_id, String

#conversation_relay_config ⇒ Telnyx::Models::ConversationRelayEmbeddedConfig^?

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.

Returns:

• (Telnyx::Models::ConversationRelayEmbeddedConfig, nil)

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

optional :conversation_relay_config, -> { Telnyx::ConversationRelayEmbeddedConfig }

#custom_headers ⇒ Array<Telnyx::Models::CustomSipHeader>^?

Custom headers to be added to the SIP INVITE response.

Returns:

• (Array<Telnyx::Models::CustomSipHeader>, nil)

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

optional :custom_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CustomSipHeader] }

#deepfake_detection ⇒ Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection^?

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.

Returns:

• (Telnyx::Models::Calls::ActionAnswerParams::DeepfakeDetection, nil)

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

optional :deepfake_detection, -> { Telnyx::Calls::ActionAnswerParams::DeepfakeDetection }

#preferred_codecs ⇒ Symbol, ...

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

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::PreferredCodecs, nil)

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

optional :preferred_codecs, enum: -> { Telnyx::Calls::ActionAnswerParams::PreferredCodecs }

#record ⇒ Symbol, ...

Start recording automatically after an event. Disabled by default.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::Record, nil)

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

optional :record, enum: -> { Telnyx::Calls::ActionAnswerParams::Record }

#record_channels ⇒ Symbol, ...

Defines which channel should be recorded ('single' or 'dual') when record is specified.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordChannels, nil)

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

optional :record_channels, enum: -> { Telnyx::Calls::ActionAnswerParams::RecordChannels }

#record_custom_file_name ⇒ String^?

The custom recording file name to be used instead of the default call_leg_id. Telnyx will still add a Unix timestamp suffix.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :record_custom_file_name, String

#record_format ⇒ Symbol, ...

Defines the format of the recording ('wav' or 'mp3') when record is specified.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordFormat, nil)

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

optional :record_format, enum: -> { Telnyx::Calls::ActionAnswerParams::RecordFormat }

#record_max_length ⇒ Integer^?

Defines the maximum length for the recording in seconds when record is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :record_max_length, Integer

#record_timeout_secs ⇒ Integer^?

The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when record is specified. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :record_timeout_secs, Integer

#record_track ⇒ Symbol, ...

The audio track to be recorded. Can be either both, inbound or outbound. If only single track is specified (inbound, outbound), channels configuration is ignored and it will be recorded as mono (single channel).

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordTrack, nil)

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

optional :record_track, enum: -> { Telnyx::Calls::ActionAnswerParams::RecordTrack }

#record_trim ⇒ Symbol, ...

When set to trim-silence, silence will be removed from the beginning and end of the recording.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::RecordTrim, nil)

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

optional :record_trim, enum: -> { Telnyx::Calls::ActionAnswerParams::RecordTrim }

#send_silence_when_idle ⇒ Boolean^?

Generate silence RTP packets when no transmission available.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

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

optional :send_silence_when_idle, Telnyx::Internal::Type::Boolean

#sip_headers ⇒ Array<Telnyx::Models::SipHeader>^?

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

Returns:

• (Array<Telnyx::Models::SipHeader>, nil)

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

optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::SipHeader] }

#sound_modifications ⇒ Telnyx::Models::SoundModifications^?

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

Returns:

• (Telnyx::Models::SoundModifications, nil)

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

optional :sound_modifications, -> { Telnyx::SoundModifications }

#stream_bidirectional_codec ⇒ Symbol, ...

Indicates codec for bidirectional streaming RTP payloads. Used only with stream_bidirectional_mode=rtp. Case sensitive.

Returns:

• (Symbol, Telnyx::Models::StreamBidirectionalCodec, nil)

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

optional :stream_bidirectional_codec, enum: -> { Telnyx::StreamBidirectionalCodec }

#stream_bidirectional_mode ⇒ Symbol, ...

Configures method of bidirectional streaming (mp3, rtp).

Returns:

• (Symbol, Telnyx::Models::StreamBidirectionalMode, nil)

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

optional :stream_bidirectional_mode, enum: -> { Telnyx::StreamBidirectionalMode }

#stream_bidirectional_target_legs ⇒ Symbol, ...

Specifies which call legs should receive the bidirectional stream audio.

Returns:

• (Symbol, Telnyx::Models::StreamBidirectionalTargetLegs, nil)

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

optional :stream_bidirectional_target_legs, enum: -> { Telnyx::StreamBidirectionalTargetLegs }

#stream_codec ⇒ Symbol, ...

Specifies the codec to be used for the streamed audio. When set to 'default' or when transcoding is not possible, the codec from the call will be used.

Returns:

• (Symbol, Telnyx::Models::StreamCodec, nil)

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

optional :stream_codec, enum: -> { Telnyx::StreamCodec }

#stream_track ⇒ Symbol, ...

Specifies which track should be streamed.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::StreamTrack, nil)

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

optional :stream_track, enum: -> { Telnyx::Calls::ActionAnswerParams::StreamTrack }

#stream_url ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :stream_url, String

#transcription ⇒ Boolean^?

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

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

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

optional :transcription, Telnyx::Internal::Type::Boolean

#transcription_config ⇒ Telnyx::Models::Calls::TranscriptionStartRequest^?

Returns:

• (Telnyx::Models::Calls::TranscriptionStartRequest, nil)

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

optional :transcription_config, -> { Telnyx::Calls::TranscriptionStartRequest }

#webhook_retries_policies ⇒ Hash{Symbol=>Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy}^?

A map of event types to retry policies. Each retry policy contains an array of retries_ms specifying the delays between retry attempts in milliseconds. Maximum 5 retries, total delay cannot exceed 60 seconds.

Returns:

• (Hash{Symbol=>Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy}, nil)

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

optional :webhook_retries_policies,
-> { Telnyx::Internal::Type::HashOf[Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy] }

#webhook_url ⇒ String^?

Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :webhook_url, String

#webhook_url_method ⇒ Symbol, ...

HTTP request type used for webhook_url.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLMethod, nil)

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

optional :webhook_url_method, enum: -> { Telnyx::Calls::ActionAnswerParams::WebhookURLMethod }

#webhook_urls ⇒ Hash{Symbol=>String}^?

A map of event types to webhook URLs. When an event of the specified type occurs, the webhook URL associated with that event type will be called instead of webhook_url. Events not mapped here will use the default webhook_url.

Parameters:

• (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String}, nil)

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

optional :webhook_urls, Telnyx::Internal::Type::HashOf[String]

#webhook_urls_method ⇒ Symbol, ...

HTTP request method to invoke webhook_urls.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLsMethod, nil)

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

optional :webhook_urls_method, enum: -> { Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/calls/action_answer_params.rbs', line 255

def to_hash: -> {