Skip to main content

Type Alias: Message

type Message: components["schemas"]["Message"];

Properties​

PropertyTypeRequiredDescription
idstringYesMessage ID (example: "msg_123")
sessionIdstringYesSession ID (example: "sess_789")
seqnumberYesPer-session sequence number, starting at 1 and gap-free. Use it as the after cursor of the messages route and as the value of If-None-Match when polling. (example: 42)
type"user" | "system"NoMessage type: user (transcribed speech) or system (join/leave events) (example: "user")
participantIdstringNoParticipant who spoke (null for system messages)
externalUserIdstringNoExternal user ID of the speaker from ODIN (null for system messages)
senderNamestringYesSender name (or [System] for system messages) (example: "Alice")
contentstringYesMessage content (example: "Hello team!")
timestampstringYesTimestamp (example: "2023-10-01T10:05:00Z")
hasDebugAudiobooleanNoWhether a debug audio WAV file is available for download. Only computed when the request includes debugAudio (or on the legacy full-list read); otherwise omitted.
annotationsMessageAnnotation[]NoPlugin annotations of this message. Only present when the request includes annotations.

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/sessions.ts:24