Class: Telnyx::Models::Calls::ActionGatherParams

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

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(call_control_id:, client_state: nil, command_id: nil, gather_id: nil, initial_timeout_millis: nil, inter_digit_timeout_millis: nil, maximum_digits: nil, minimum_digits: nil, terminating_digit: nil, timeout_millis: nil, valid_digits: nil, request_options: {}) ⇒ Object

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

Parameters:

  • call_control_id (String)
  • 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

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

    An id that will be sent back in the corresponding ‘call.gather.ended` webhook. W

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

    The number of milliseconds to wait for the first DTMF.

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

    The number of milliseconds to wait for input between digits.

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

    The maximum number of digits to fetch. This parameter has a maximum value of 128

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

    The minimum number of digits to fetch. This parameter has a minimum value of 1.

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

    The digit used to terminate input if fewer than ‘maximum_digits` digits have bee

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

    The number of milliseconds to wait to complete the request.

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

    A list of all digits accepted as valid.

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



# File 'lib/telnyx/models/calls/action_gather_params.rb', line 81

Instance Attribute Details

#call_control_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/calls/action_gather_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.

Returns:

  • (String, nil) 


21
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 21

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) 


28
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 28

optional :command_id, String

#gather_id ⇒ String?

An id that will be sent back in the corresponding ‘call.gather.ended` webhook. Will be randomly generated if not specified.

Returns:

  • (String, nil) 


35
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 35

optional :gather_id, String

#initial_timeout_millis ⇒ Integer?

The number of milliseconds to wait for the first DTMF.

Returns:

  • (Integer, nil) 


41
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 41

optional :initial_timeout_millis, Integer

#inter_digit_timeout_millis ⇒ Integer?

The number of milliseconds to wait for input between digits.

Returns:

  • (Integer, nil) 


47
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 47

optional :inter_digit_timeout_millis, Integer

#maximum_digits ⇒ Integer?

The maximum number of digits to fetch. This parameter has a maximum value of 128.

Returns:

  • (Integer, nil) 


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

optional :maximum_digits, Integer

#minimum_digits ⇒ Integer?

The minimum number of digits to fetch. This parameter has a minimum value of 1.

Returns:

  • (Integer, nil) 


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

optional :minimum_digits, Integer

#terminating_digit ⇒ String?

The digit used to terminate input if fewer than ‘maximum_digits` digits have been gathered.

Returns:

  • (String, nil) 


67
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 67

optional :terminating_digit, String

#timeout_millis ⇒ Integer?

The number of milliseconds to wait to complete the request.

Returns:

  • (Integer, nil) 


73
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 73

optional :timeout_millis, Integer

#valid_digits ⇒ String?

A list of all digits accepted as valid.

Returns:

  • (String, nil) 


79
 
# File 'lib/telnyx/models/calls/action_gather_params.rb', line 79

optional :valid_digits, String