Class: Telnyx::Models::MeetingSession

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::MeetingSession

Defined in:

lib/telnyx/models/meeting_session.rb,
sig/telnyx/models/meeting_session.rbs

Defined Under Namespace

Modules: AssistantState, AvatarState, Platform, Status Classes: Assistant, Avatar, Config

Instance Attribute Summary

• #account_id ⇒ String

  Identifier of the owning account.

• #assistant ⇒ Telnyx::Models::MeetingSession::Assistant^?

  Assistant configuration if an assistant is attached, otherwise null.

• #assistant_state ⇒ Symbol, ...

  Current state of the assistant, or null if no assistant is attached.

• #assistant_state_changed_at ⇒ Time^?

  Timestamp of the last assistant state change, or null.

• #avatar ⇒ Telnyx::Models::MeetingSession::Avatar^?

  Avatar configuration if an avatar is attached, otherwise null.

• #avatar_state ⇒ Symbol, ...

  Current state of the avatar connection, or null if no avatar is attached.

• #avatar_state_changed_at ⇒ Time^?

  Timestamp of the last avatar state change, or null.

• #bot_name ⇒ String

  Display name of the bot in the meeting.

• #config ⇒ Telnyx::Models::MeetingSession::Config
• #created_at ⇒ Time

  Timestamp when the session was created.

• #ended_at ⇒ Time^?

  Timestamp when the session ended, or null if ongoing.

• #failure_reason ⇒ String^?

  Human-readable failure reason if the session failed, or null.

• #id ⇒ String

  Unique identifier for the meeting session.

• #join_at ⇒ Time^?

  Scheduled join time, or null for immediate join.

• #joined_at ⇒ Time^?

  Timestamp when the session first became active, or null if it never became active.

• #meeting_url ⇒ String

  The meeting URL the bot joins.

• #metadata ⇒ Hash{Symbol=>Object}

  Arbitrary key-value metadata attached to the session.

• #platform ⇒ Symbol, Telnyx::Models::MeetingSession::Platform

  Detected meeting platform.

• #provider ⇒ String

  Provider handling the meeting session.

• #recording ⇒ Boolean

  Whether the session is being recorded.

• #status ⇒ Symbol, Telnyx::Models::MeetingSession::Status

  Lifecycle status.

• #status_detail ⇒ String^?

  Additional human-readable detail about the status, or null.

• #updated_at ⇒ Time

  Timestamp of the last update to the session.

• #webhook_url ⇒ String^?

  Webhook endpoint for session lifecycle callbacks, or null if not configured.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(barge_in:, speak_on_enter:, summarize_on_end:, voice:) ⇒ Object constructor

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

• #to_hash ⇒ {

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(barge_in:, speak_on_enter:, summarize_on_end:, voice:) ⇒ Object

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

Parameters:

• barge_in (Boolean) —

  When enabled, a human participant speech_on event interrupts and stops the cur

• speak_on_enter (String, nil) —

  Text spoken on meeting entry, or null if not set.

• summarize_on_end (Boolean) —

  Whether a summary artifact is generated on session end.

• voice (String, nil) —

  Configured voice identifier, or null if not set.

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

Instance Attribute Details

#account_id ⇒ String

Identifier of the owning account.

Parameters:

• value (String)

Returns:

• (String)

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

required :account_id, String

#assistant ⇒ Telnyx::Models::MeetingSession::Assistant^?

Assistant configuration if an assistant is attached, otherwise null.

Parameters:

• value (Telnyx::MeetingSession::Assistant, nil)

Returns:

• (Telnyx::Models::MeetingSession::Assistant, nil)

# File 'lib/telnyx/models/meeting_session.rb', line 22

required :assistant, -> { Telnyx::MeetingSession::Assistant }, nil?: true

#assistant_state ⇒ Symbol, ...

Current state of the assistant, or null if no assistant is attached.

Parameters:

• value (Telnyx::Models::MeetingSession::assistant_state, nil)

Returns:

• (Symbol, Telnyx::Models::MeetingSession::AssistantState, nil)

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

required :assistant_state, enum: -> { Telnyx::MeetingSession::AssistantState }, nil?: true

#assistant_state_changed_at ⇒ Time^?

Timestamp of the last assistant state change, or null.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/meeting_session.rb', line 34

required :assistant_state_changed_at, Time, nil?: true

#avatar ⇒ Telnyx::Models::MeetingSession::Avatar^?

Avatar configuration if an avatar is attached, otherwise null.

Parameters:

• value (Telnyx::MeetingSession::Avatar, nil)

Returns:

• (Telnyx::Models::MeetingSession::Avatar, nil)

# File 'lib/telnyx/models/meeting_session.rb', line 40

required :avatar, -> { Telnyx::MeetingSession::Avatar }, nil?: true

#avatar_state ⇒ Symbol, ...

Current state of the avatar connection, or null if no avatar is attached.

Parameters:

• value (Telnyx::Models::MeetingSession::avatar_state, nil)

Returns:

• (Symbol, Telnyx::Models::MeetingSession::AvatarState, nil)

# File 'lib/telnyx/models/meeting_session.rb', line 46

required :avatar_state, enum: -> { Telnyx::MeetingSession::AvatarState }, nil?: true

#avatar_state_changed_at ⇒ Time^?

Timestamp of the last avatar state change, or null.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/meeting_session.rb', line 52

required :avatar_state_changed_at, Time, nil?: true

#bot_name ⇒ String

Display name of the bot in the meeting.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/meeting_session.rb', line 58

required :bot_name, String

#config ⇒ Telnyx::Models::MeetingSession::Config

Parameters:

• value (Telnyx::MeetingSession::Config)

Returns:

• (Telnyx::Models::MeetingSession::Config)

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

required :config, -> { Telnyx::MeetingSession::Config }

#created_at ⇒ Time

Timestamp when the session was created.

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

#ended_at ⇒ Time^?

Timestamp when the session ended, or null if ongoing.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/meeting_session.rb', line 75

required :ended_at, Time, nil?: true

#failure_reason ⇒ String^?

Human-readable failure reason if the session failed, or null.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :failure_reason, String, nil?: true

#id ⇒ String

Unique identifier for the meeting session.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/meeting_session.rb', line 10

required :id, String

#join_at ⇒ Time^?

Scheduled join time, or null for immediate join.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

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

required :join_at, Time, nil?: true

#joined_at ⇒ Time^?

Timestamp when the session first became active, or null if it never became active. This remains positive admission evidence after terminal transitions.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

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

required :joined_at, Time, nil?: true

#meeting_url ⇒ String

The meeting URL the bot joins.

Parameters:

• value (String)

Returns:

• (String)

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

required :meeting_url, String

#metadata ⇒ Hash{Symbol=>Object}

Arbitrary key-value metadata attached to the session.

Parameters:

• value (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object})

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

required :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#platform ⇒ Symbol, Telnyx::Models::MeetingSession::Platform

Detected meeting platform.

Parameters:

• value (Telnyx::Models::MeetingSession::platform)

Returns:

• (Symbol, Telnyx::Models::MeetingSession::Platform)

# File 'lib/telnyx/models/meeting_session.rb', line 112

required :platform, enum: -> { Telnyx::MeetingSession::Platform }

#provider ⇒ String

Provider handling the meeting session.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/meeting_session.rb', line 118

required :provider, String

#recording ⇒ Boolean

Whether the session is being recorded.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/telnyx/models/meeting_session.rb', line 124

required :recording, Telnyx::Internal::Type::Boolean

#status ⇒ Symbol, Telnyx::Models::MeetingSession::Status

Lifecycle status. waiting_for_admission means the bot reached the meeting lobby and may require host approval. active means the bot entered the meeting/media path. ended alone does not prove attendance; use non-null joined_at as positive evidence that the session became active. admission_denied is reserved for an explicit provider denial, while cancellation or another termination can end a never-admitted session as ended.

Parameters:

• value (Telnyx::Models::MeetingSession::status)

Returns:

• (Symbol, Telnyx::Models::MeetingSession::Status)

# File 'lib/telnyx/models/meeting_session.rb', line 135

required :status, enum: -> { Telnyx::MeetingSession::Status }

#status_detail ⇒ String^?

Additional human-readable detail about the status, or null.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/meeting_session.rb', line 141

required :status_detail, String, nil?: true

#updated_at ⇒ Time

Timestamp of the last update to the session.

Parameters:

• value (Time)

Returns:

• (Time)

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

required :updated_at, Time

#webhook_url ⇒ String^?

Webhook endpoint for session lifecycle callbacks, or null if not configured.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :webhook_url, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/meeting_session.rb', line 241

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/meeting_session.rbs', line 107

def to_hash: -> {