Class: Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb

Overview

See Also:

Defined Under Namespace

Modules: AmdStatusCallbackMethod, Beep, ConferenceRecord, ConferenceRecordingStatusCallbackMethod, ConferenceStatusCallbackMethod, ConferenceTrim, MachineDetection, RecordingChannels, RecordingStatusCallbackMethod, RecordingTrack, StatusCallbackMethod, Trim Classes: CustomHeader

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(name:, value:) ⇒ Object

Parameters:

  • name (String) —

    The name of the custom header

  • value (String) —

    The value of the custom header




# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 408

Instance Attribute Details

#account_sid ⇒ String

Returns:

  • (String) 


16
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 16

required :account_sid, String

#amd_status_callback ⇒ String?

The URL the result of answering machine detection will be sent to.

Returns:

  • (String, nil) 


22
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 22

optional :amd_status_callback, String, api_name: :AmdStatusCallback

#amd_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘AmdStatusCallback`. Defaults to `POST`.

Returns:



28
29
30
31
32
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 28

optional :amd_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::AmdStatusCallbackMethod
},
api_name: :AmdStatusCallbackMethod

#application_sid ⇒ String?

The SID of the TeXML application that will handle the new participant’s call. Required unless joining an existing conference by its ConferenceSid.

Returns:

  • (String, nil) 


39
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 39

optional :application_sid, String, api_name: :ApplicationSid

#beep ⇒ Symbol, ...

Whether to play a notification beep to the conference when the participant enters and exits.

Returns:



46
47
48
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 46

optional :beep,
enum: -> { Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::Beep },
api_name: :Beep

#call_sid_to_coach ⇒ String?

The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.

Returns:

  • (String, nil) 


64
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 64

optional :call_sid_to_coach, String, api_name: :CallSidToCoach

#caller_id ⇒ String?

To be used as the caller id name (SIP From Display Name) presented to the destination (‘To` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and `-_~!.+` special characters. If ommited, the display name will be the same as the number in the `From` field.

Returns:

  • (String, nil) 


57
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 57

optional :caller_id, String, api_name: :CallerId

#cancel_playback_on_detect_message_end ⇒ Boolean?

Whether to cancel ongoing playback on ‘greeting ended` detection. Defaults to `true`.

Returns:

  • (Boolean, nil) 


71
72
73
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 71

optional :cancel_playback_on_detect_message_end,
Telnyx::Internal::Type::Boolean,
api_name: :CancelPlaybackOnDetectMessageEnd

#cancel_playback_on_machine_detection ⇒ Boolean?

Whether to cancel ongoing playback on ‘machine` detection. Defaults to `true`.

Returns:

  • (Boolean, nil) 


79
80
81
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 79

optional :cancel_playback_on_machine_detection,
Telnyx::Internal::Type::Boolean,
api_name: :CancelPlaybackOnMachineDetection

#coaching ⇒ Boolean?

Whether the participant is coaching another call. When ‘true`, `CallSidToCoach` has to be given.

Returns:

  • (Boolean, nil) 


88
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 88

optional :coaching, Telnyx::Internal::Type::Boolean, api_name: :Coaching

#conference_record ⇒ Symbol, ...

Whether to record the conference the participant is joining. Defualts to ‘do-not-record`. The boolean values `true` and `false` are synonymous with `record-from-start` and `do-not-record` respectively.

Returns:



96
97
98
99
100
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 96

optional :conference_record,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::ConferenceRecord
},
api_name: :ConferenceRecord

#conference_recording_status_callback ⇒ String?

The URL the conference recording callbacks will be sent to.

Returns:

  • (String, nil) 


106
107
108
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 106

optional :conference_recording_status_callback,
String,
api_name: :ConferenceRecordingStatusCallback

#conference_recording_status_callback_event ⇒ String?

The changes to the conference recording’s state that should generate a call to ‘RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`. `failed` and `absent` are synonymous.

Returns:

  • (String, nil) 


117
118
119
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 117

optional :conference_recording_status_callback_event,
String,
api_name: :ConferenceRecordingStatusCallbackEvent

#conference_recording_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘ConferenceRecordingStatusCallback`. Defaults to `POST`.

Returns:



126
127
128
129
130
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 126

optional :conference_recording_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::ConferenceRecordingStatusCallbackMethod
},
api_name: :ConferenceRecordingStatusCallbackMethod

#conference_recording_timeout ⇒ Integer?

The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the 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) 


139
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 139

optional :conference_recording_timeout, Integer, api_name: :ConferenceRecordingTimeout

#conference_status_callback ⇒ String?

The URL the conference callbacks will be sent to.

Returns:

  • (String, nil) 


145
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 145

optional :conference_status_callback, String, api_name: :ConferenceStatusCallback

#conference_status_callback_event ⇒ String?

The changes to the conference’s state that should generate a call to ‘ConferenceStatusCallback`. Can be: `start`, `end`, `join` and `leave`. Separate multiple values with a space. By default no callbacks are sent.

Returns:

  • (String, nil) 


153
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 153

optional :conference_status_callback_event, String, api_name: :ConferenceStatusCallbackEvent

#conference_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘ConferenceStatusCallback`. Defaults to `POST`.

Returns:



159
160
161
162
163
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 159

optional :conference_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::ConferenceStatusCallbackMethod
},
api_name: :ConferenceStatusCallbackMethod

#conference_trim ⇒ Symbol, ...

Whether to trim any leading and trailing silence from the conference recording. Defaults to ‘trim-silence`.

Returns:



170
171
172
173
174
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 170

optional :conference_trim,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::ConferenceTrim
},
api_name: :ConferenceTrim

#custom_headers ⇒ Array<Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams::CustomHeader>?

Custom HTTP headers to be sent with the call. Each header should be an object with ‘name’ and ‘value’ properties.

Returns:



181
182
183
184
185
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 181

optional :custom_headers,
-> {
  Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::CustomHeader]
},
api_name: :CustomHeaders

#early_media ⇒ Boolean?

Whether participant shall be bridged to conference before the participant answers (from early media if available). Defaults to ‘false`.

Returns:

  • (Boolean, nil) 


192
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 192

optional :early_media, Telnyx::Internal::Type::Boolean, api_name: :EarlyMedia

#end_conference_on_exit ⇒ Boolean?

Whether to end the conference when the participant leaves. Defaults to ‘false`.

Returns:

  • (Boolean, nil) 


198
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 198

optional :end_conference_on_exit, Telnyx::Internal::Type::Boolean, api_name: :EndConferenceOnExit

#from ⇒ String?

The phone number of the party that initiated the call. Phone numbers are formatted with a ‘+` and country code.

Returns:

  • (String, nil) 


205
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 205

optional :from, String, api_name: :From

#label ⇒ String?

A unique label for the participant that will be added to the conference. The label can be used to reference the participant for updates via the TeXML REST API.

Returns:

  • (String, nil) 


213
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 213

optional :label, String, api_name: :Label

#machine_detection ⇒ Symbol, ...

Whether to detect if a human or an answering machine picked up the call. Use ‘Enable` if you would like to ne notified as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine.

Returns:



222
223
224
225
226
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 222

optional :machine_detection,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::MachineDetection
},
api_name: :MachineDetection

#machine_detection_silence_timeout ⇒ Integer?

If initial silence duration is greater than this value, consider it a machine. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


233
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 233

optional :machine_detection_silence_timeout, Integer, api_name: :MachineDetectionSilenceTimeout

#machine_detection_speech_end_threshold ⇒ Integer?

Silence duration threshold after a greeting message or voice for it be considered human. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


240
241
242
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 240

optional :machine_detection_speech_end_threshold,
Integer,
api_name: :MachineDetectionSpeechEndThreshold

#machine_detection_speech_threshold ⇒ Integer?

Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


249
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 249

optional :machine_detection_speech_threshold, Integer, api_name: :MachineDetectionSpeechThreshold

#machine_detection_timeout ⇒ Integer?

How long answering machine detection should go on for before sending an ‘Unknown` result. Given in milliseconds.

Returns:

  • (Integer, nil) 


256
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 256

optional :machine_detection_timeout, Integer, api_name: :MachineDetectionTimeout

#max_participants ⇒ Integer?

The maximum number of participants in the conference. Can be a positive integer from 2 to 800. The default value is 250.

Returns:

  • (Integer, nil) 


263
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 263

optional :max_participants, Integer, api_name: :MaxParticipants

#muted ⇒ Boolean?

Whether the participant should be muted.

Returns:

  • (Boolean, nil) 


269
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 269

optional :muted, Telnyx::Internal::Type::Boolean, api_name: :Muted

#preferred_codecs ⇒ String?

The list of comma-separated codecs to be offered on a call.

Returns:

  • (String, nil) 


275
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 275

optional :preferred_codecs, String, api_name: :PreferredCodecs

#record ⇒ Boolean?

Whether to record the entire participant’s call leg. Defaults to ‘false`.

Returns:

  • (Boolean, nil) 


281
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 281

optional :record, Telnyx::Internal::Type::Boolean, api_name: :Record

#recording_channels ⇒ Symbol, ...

The number of channels in the final recording. Defaults to ‘mono`.

Returns:



287
288
289
290
291
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 287

optional :recording_channels,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::RecordingChannels
},
api_name: :RecordingChannels

#recording_status_callback ⇒ String?

The URL the recording callbacks will be sent to.

Returns:

  • (String, nil) 


297
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 297

optional :recording_status_callback, String, api_name: :RecordingStatusCallback

#recording_status_callback_event ⇒ String?

The changes to the recording’s state that should generate a call to ‘RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.

Returns:

  • (String, nil) 


305
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 305

optional :recording_status_callback_event, String, api_name: :RecordingStatusCallbackEvent

#recording_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘RecordingStatusCallback`. Defaults to `POST`.

Returns:



311
312
313
314
315
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 311

optional :recording_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::RecordingStatusCallbackMethod
},
api_name: :RecordingStatusCallbackMethod

#recording_track ⇒ Symbol, ...

The audio track to record for the call. The default is ‘both`.

Returns:



321
322
323
324
325
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 321

optional :recording_track,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::RecordingTrack
},
api_name: :RecordingTrack

#sip_auth_password ⇒ String?

The password to use for SIP authentication.

Returns:

  • (String, nil) 


331
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 331

optional :sip_auth_password, String, api_name: :SipAuthPassword

#sip_auth_username ⇒ String?

The username to use for SIP authentication.

Returns:

  • (String, nil) 


337
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 337

optional :sip_auth_username, String, api_name: :SipAuthUsername

#start_conference_on_enter ⇒ Boolean?

Whether to start the conference when the participant enters. Defaults to ‘true`.

Returns:

  • (Boolean, nil) 


343
344
345
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 343

optional :start_conference_on_enter,
Telnyx::Internal::Type::Boolean,
api_name: :StartConferenceOnEnter

#status_callback ⇒ String?

URL destination for Telnyx to send status callback events to for the call.

Returns:

  • (String, nil) 


351
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 351

optional :status_callback, String, api_name: :StatusCallback

#status_callback_event ⇒ String?

The changes to the call’s state that should generate a call to ‘StatusCallback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.

Returns:

  • (String, nil) 


359
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 359

optional :status_callback_event, String, api_name: :StatusCallbackEvent

#status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘StatusCallback`.

Returns:



365
366
367
368
369
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 365

optional :status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::StatusCallbackMethod
},
api_name: :StatusCallbackMethod

#time_limit ⇒ Integer?

The maximum duration of the call in seconds.

Returns:

  • (Integer, nil) 


375
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 375

optional :time_limit, Integer, api_name: :TimeLimit

#timeout_seconds ⇒ Integer?

The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 120, inclusive. The default value is 30.

Returns:

  • (Integer, nil) 


383
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 383

optional :timeout_seconds, Integer, api_name: :Timeout

#to ⇒ String?

The phone number of the called party. Phone numbers are formatted with a ‘+` and country code.

Returns:

  • (String, nil) 


390
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 390

optional :to, String, api_name: :To

#trim ⇒ Symbol, ...

Whether to trim any leading and trailing silence from the recording. Defaults to ‘trim-silence`.

Returns:



397
398
399
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 397

optional :trim,
enum: -> { Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::Trim },
api_name: :Trim

#wait_url ⇒ String?

The URL to call for an audio file to play while the participant is waiting for the conference to start.

Returns:

  • (String, nil) 


406
 
# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 406

optional :wait_url, String, api_name: :WaitUrl

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb', line 520