Skip to main content
WSS
id
type:string
required

Identifier of the Meeting Session owned by the authenticated account.

bearerAuth
type:http

Telnyx API v2 key sent in the Authorization upgrade header.

headers
type:object
Authorization
type:string
required

Telnyx API v2 key using the Bearer scheme (the production gateway requires the exact Bearer capitalization), exactly one ASCII space, and a non-empty token containing no ASCII control or whitespace character (U+0000 through U+0020), comma, or DEL (U+007F). Example uses a fake value: Bearer KEY_FAKE_EXAMPLE_ONLY.

Example: Bearer KEY_FAKE_EXAMPLE_ONLY
query
type:object
after_seq
type:number

Event-store cursor. Catch-up returns stored events whose top-level seq is greater than this value. Missing or non-finite values are treated as 0.

after_transcript_seq
type:number

Transcript-store cursor. Catch-up returns transcript segments whose seq is greater than this value. Missing or non-finite values are treated as 0.

Speak command
type:object

Synthesizes text and plays it into the meeting. Set interrupt to stop current speech before playing the new utterance. No success acknowledgement is sent.

Stop speaking command
type:object

Stops audio currently being spoken by the meeting bot.

Send chat command
type:object

Sends a text chat message into the meeting.

Catch-up event frame
type:object

Durable event replayed from the event store after connection. Unlike a live event frame, this shape always contains the stored top-level seq.

Live event frame
type:object

Best-effort live bus event. The server adds kind: event and spreads the bus envelope. The top-level seq is optional and is normally absent. The example shows a live transcript event; its payload embeds the durable transcript sequence number even though the frame has no top-level event-store sequence.

Transcript catch-up frame
type:object

Durable transcript segment replayed from the transcript store. This standalone shape is used for transcript catch-up; live transcript segments arrive as LiveEventFrame messages with type transcript.segment.

Replay truncated frame
type:object

More than 1,000 records matched the supplied cursor in the named store. The server fetched up to 1,001, sent the first 1,000, and withheld at least one. Exactly 1,000 matching records produce no marker. Reconnect using the last sequence number received for that store as its corresponding cursor.

Application error frame
type:object

Error produced after the WebSocket has been established. invalid_frame covers binary frames, malformed JSON, and commands that do not match the strict command schemas. command_queue_full means eight commands are already active or queued. Other listed values are command-processing errors. Handshake failures are HTTP responses, not this frame.