Class: Telnyx::Models::Calls::ActionReferParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/calls/action_refer_params.rb

Overview

See Also:

• Resources::Calls::Actions#refer

Instance Attribute Summary

• #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 execution of duplicate commands.

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

  Custom headers to be added to the SIP INVITE.

• #sip_address ⇒ String

  The SIP URI to which the call will be referred to.

• #sip_auth_password ⇒ String^?

  SIP Authentication password used for SIP challenges.

• #sip_auth_username ⇒ String^?

  SIP Authentication username used for SIP challenges.

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

  SIP headers to be added to the request.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(call_control_id:, sip_address:, client_state: nil, command_id: nil, custom_headers: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, request_options: {}) ⇒ Object constructor

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

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:, sip_address:, client_state: nil, command_id: nil, custom_headers: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, request_options: {}) ⇒ Object

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

Parameters:

• call_control_id (String)
• sip_address (String) —

  The SIP URI to which the call will be referred to.

• 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 execution of duplicate commands. Telnyx will ignore subs

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

  Custom headers to be added to the SIP INVITE.

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

  SIP Authentication password used for SIP challenges.

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

  SIP Authentication username used for SIP challenges.

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

  SIP headers to be added to the request. Currently only User-to-User header is su

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

# File 'lib/telnyx/models/calls/action_refer_params.rb', line 62

Instance Attribute Details

#call_control_id ⇒ String

Returns:

• (String)

# File 'lib/telnyx/models/calls/action_refer_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)

# File 'lib/telnyx/models/calls/action_refer_params.rb', line 27

optional :client_state, String

#command_id ⇒ String^?

Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same ‘command_id` as one that has already been executed.

Returns:

• (String, nil)

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

optional :command_id, String

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

Custom headers to be added to the SIP INVITE.

Returns:

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

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

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

#sip_address ⇒ String

The SIP URI to which the call will be referred to.

Returns:

• (String)

# File 'lib/telnyx/models/calls/action_refer_params.rb', line 20

required :sip_address, String

#sip_auth_password ⇒ String^?

SIP Authentication password used for SIP challenges.

Returns:

• (String, nil)

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

optional :sip_auth_password, String

#sip_auth_username ⇒ String^?

SIP Authentication username used for SIP challenges.

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_refer_params.rb', line 53

optional :sip_auth_username, String

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

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

Returns:

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

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

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