MessageEnvelope

Wrapper around a message with streaming/sequencing metadata

kind
enum
const:
message
required

Envelope type
message_snapshot
Type:
required

A full chat message as delivered by the server inside a MessageEnvelope. Contains both client-provided and server-managed fields.

Properties: 12
operation
Type: enum
required

Controls how the client should process the message

values
replacecompleteerror
proto
enum
const:
1
required

Protocol version. Clients should ignore envelopes with an unrecognized version.
sequence
Type: integer
required

Monotonically increasing sequence number for ordering envelopes within a message
timestamp
Type: stringFormat: date-time
required

ISO 8601 timestamp of when the envelope was created
error
Type: string

Error description (present when operation is error)