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

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/calls/action_answer_params.rb

Overview

See Also:

Defined Under Namespace

Modules: PreferredCodecs, Record, RecordChannels, RecordFormat, RecordTrack, RecordTrim, StreamTrack, WebhookURLMethod

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: 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_url: nil, webhook_url_method: nil, request_options: {}) ⇒ Object

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

stream_

Parameters:

  • 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

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

    Custom headers to be added to the SIP INVITE response.

  • 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_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`.

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



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

Instance Attribute Details

#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.

Returns:

  • (String, nil) 


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

optional :billing_group_id, String

#client_state ⇒ String?

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

Returns:

  • (String, nil) 


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

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`.

Returns:

  • (String, nil) 


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

optional :command_id, String

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

Custom headers to be added to the SIP INVITE response.

Returns:



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

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

#preferred_codecs ⇒ Symbol, ...

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

Returns:



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

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

#record ⇒ Symbol, ...

Start recording automatically after an event. Disabled by default.

Returns:



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

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

#record_channels ⇒ Symbol, ...

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

Returns:



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

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.

Returns:

  • (String, nil) 


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

optional :record_custom_file_name, String

#record_format ⇒ Symbol, ...

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

Returns:



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

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).

Returns:

  • (Integer, nil) 


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

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).

Returns:

  • (Integer, nil) 


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

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:



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

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:



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

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

#send_silence_when_idle ⇒ Boolean?

Generate silence RTP packets when no transmission available.

Returns:

  • (Boolean, nil) 


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

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:



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

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:



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

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:



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

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

#stream_bidirectional_mode ⇒ Symbol, ...

Configures method of bidirectional streaming (mp3, rtp).

Returns:



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

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

#stream_bidirectional_target_legs ⇒ Symbol, ...

Specifies which call legs should receive the bidirectional stream audio.

Returns:



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

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:



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

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

#stream_track ⇒ Symbol, ...

Specifies which track should be streamed.

Returns:



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

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

#stream_url ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :stream_url, String

#transcription ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


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

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

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

Returns:



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

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

#webhook_url ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :webhook_url, String

#webhook_url_method ⇒ Symbol, ...

HTTP request type used for ‘webhook_url`.

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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