Class: Telnyx::Models::MeetingSessionCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/meeting_session_create_params.rb,
sig/telnyx/models/meeting_session_create_params.rbs

Overview

See Also:

  • Telnyx::Resources::MeetingSessions#create

Defined Under Namespace

Modules: CameraImage Classes: Assistant, Avatar

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(api_key:, avatar_id:, provider: :anam) ⇒ Object

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

Request options for attaching a bring-your-own-key avatar to the session.

Parameters:

  • api_key (String) —

    Bring-your-own-key API key for the avatar provider. The key is never stored or r

  • avatar_id (String) —

    Identifier of the avatar to use.

  • provider (Symbol, :anam) (defaults to: :anam) —

    Avatar provider identifier. Currently only "anam" is supported.




# File 'lib/telnyx/models/meeting_session_create_params.rb', line 221

Instance Attribute Details

#assistant ⇒ Telnyx::Models::MeetingSessionCreateParams::Assistant?

Request options for attaching a voice assistant to the session. Routing fields (call_control_connection_id, from, and loopback_sip_uri) are used only to establish the assistant call leg and are omitted from response objects. audio_gate is returned with id in the assistant response object.

Returns:



23
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 23

optional :assistant, -> { Telnyx::MeetingSessionCreateParams::Assistant }

#avatar ⇒ Telnyx::Models::MeetingSessionCreateParams::Avatar?

Request options for attaching a bring-your-own-key avatar to the session.

Returns:



29
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 29

optional :avatar, -> { Telnyx::MeetingSessionCreateParams::Avatar }

#barge_in ⇒ Boolean?

When enabled, a human participant speech_on event interrupts and stops the current bot audio; it does not bypass admission or initiate speech. Assistant sessions reject barge_in: true.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


37
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 37

optional :barge_in, Telnyx::Internal::Type::Boolean

#bot_name ⇒ String?

Display name for the bot in the meeting. Defaults to "Meeting Bot".

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 43

optional :bot_name, String

#camera_image ⇒ Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source, ...

Write-only static camera-tile image for this session, not a native account or participant profile photo. Supply exactly one JPEG source. When effective, the image is used as the bot's static camera/video output; presentation varies by meeting platform and recording configuration and is not guaranteed in recordings. An effective Avatar or Assistant webpage output takes precedence, so this input is ignored and a URL source is not fetched.

Returns:



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

optional :camera_image, union: -> { Telnyx::MeetingSessionCreateParams::CameraImage }

#idempotency_key ⇒ String?

Client-supplied idempotency key to safely retry creation requests without duplicating sessions. Lookup is scoped to the authenticated account and compares the key only; the request payload is not fingerprinted or compared.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :idempotency_key, String

#join_at ⇒ Time?

ISO-8601 timestamp in the future at which the bot should join. If omitted, the bot joins immediately.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


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

optional :join_at, Time

#meeting_url ⇒ String

The meeting URL the bot should join.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 14

required :meeting_url, String

#metadata ⇒ Hash{Symbol=>Object}?

Arbitrary key-value metadata attached to the session. The serialized JSON representation must not exceed 16384 characters at runtime.

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


76
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 76

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

#speak_on_enter ⇒ String?

Text the bot speaks when it enters the meeting.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :speak_on_enter, String

#summarize_on_end ⇒ Boolean?

If true, generate a summary artifact when the session ends.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :summarize_on_end, Telnyx::Internal::Type::Boolean

#voice ⇒ String?

Session-default voice identifier used for speak_on_enter and ordinary speak actions. A voice supplied on an individual speak action overrides this default for that utterance.

Parameters:

  • (String)

Returns:

  • (String, nil) 


96
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 96

optional :voice, String

#webhook_url ⇒ String?

HTTPS endpoint to receive session lifecycle callbacks. Static validation requires HTTPS, rejects embedded credentials and blocked hosts, and enforces egress policy. Validation makes no network request to the endpoint.

Parameters:

  • (String)

Returns:

  • (String, nil) 


104
 
# File 'lib/telnyx/models/meeting_session_create_params.rb', line 104

optional :webhook_url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/meeting_session_create_params.rb', line 194

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


98
 
# File 'sig/telnyx/models/meeting_session_create_params.rbs', line 98

def to_hash: -> {