Class: Telnyx::Models::CallConversationEndedWebhookEvent::Data::Payload

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/call_conversation_ended_webhook_event.rb

Overview

See Also:

Defined Under Namespace

Modules: CallingPartyType

Instance Attribute Summary collapse

Instance Method Summary collapse

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(assistant_id: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, calling_party_type: nil, client_state: nil, connection_id: nil, conversation_id: nil, duration_sec: nil, from: nil, llm_model: nil, stt_model: nil, to: nil, tts_model_id: nil, tts_provider: nil, tts_voice_id: nil) ⇒ Object

Parameters:

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

    Unique identifier of the assistant involved in the call.

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

    Call ID used to issue commands via Call Control API.

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

    ID that is unique to the call leg.

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

    ID that is unique to the call session (group of related call legs).

  • calling_party_type (Symbol, Telnyx::Models::CallConversationEndedWebhookEvent::Data::Payload::CallingPartyType) (defaults to: nil) —

    The type of calling party connection.

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

    Base64-encoded state received from a command.

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

    Call Control App ID (formerly Telnyx connection ID) used in the call.

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

    ID unique to the conversation or insight group generated for the call.

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

    Duration of the conversation in seconds.

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

    The caller’s number or identifier.

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

    The large language model used during the conversation.

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

    The speech-to-text model used in the conversation.

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

    The callee’s number or SIP address.

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

    The model ID used for text-to-speech synthesis.

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

    The text-to-speech provider used in the call.

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

    Voice ID used for TTS.




# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 175

Instance Attribute Details

#assistant_id ⇒ String?

Unique identifier of the assistant involved in the call.

Returns:

  • (String, nil) 


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

optional :assistant_id, String

#call_control_id ⇒ String?

Call ID used to issue commands via Call Control API.

Returns:

  • (String, nil) 


88
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 88

optional :call_control_id, String

#call_leg_id ⇒ String?

ID that is unique to the call leg.

Returns:

  • (String, nil) 


94
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 94

optional :call_leg_id, String

#call_session_id ⇒ String?

ID that is unique to the call session (group of related call legs).

Returns:

  • (String, nil) 


100
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 100

optional :call_session_id, String

#calling_party_type ⇒ Symbol, ...

The type of calling party connection.

Returns:



106
107
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 106

optional :calling_party_type,
enum: -> { Telnyx::CallConversationEndedWebhookEvent::Data::Payload::CallingPartyType }

#client_state ⇒ String?

Base64-encoded state received from a command.

Returns:

  • (String, nil) 


113
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 113

optional :client_state, String

#connection_id ⇒ String?

Call Control App ID (formerly Telnyx connection ID) used in the call.

Returns:

  • (String, nil) 


119
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 119

optional :connection_id, String

#conversation_id ⇒ String?

ID unique to the conversation or insight group generated for the call.

Returns:

  • (String, nil) 


125
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 125

optional :conversation_id, String

#duration_sec ⇒ Integer?

Duration of the conversation in seconds.

Returns:

  • (Integer, nil) 


131
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 131

optional :duration_sec, Integer

#from ⇒ String?

The caller’s number or identifier.

Returns:

  • (String, nil) 


137
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 137

optional :from, String

#llm_model ⇒ String?

The large language model used during the conversation.

Returns:

  • (String, nil) 


143
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 143

optional :llm_model, String

#stt_model ⇒ String?

The speech-to-text model used in the conversation.

Returns:

  • (String, nil) 


149
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 149

optional :stt_model, String

#to ⇒ String?

The callee’s number or SIP address.

Returns:

  • (String, nil) 


155
 
# File 'lib/telnyx/models/call_conversation_ended_webhook_event.rb', line 155

optional :to, String

#tts_model_id ⇒ String?

The model ID used for text-to-speech synthesis.

Returns:

  • (String, nil) 


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

optional :tts_model_id, String

#tts_provider ⇒ String?

The text-to-speech provider used in the call.

Returns:

  • (String, nil) 


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

optional :tts_provider, String

#tts_voice_id ⇒ String?

Voice ID used for TTS.

Returns:

  • (String, nil) 


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

optional :tts_voice_id, String