Skip to Content
MosaicMosaicDocs
Tool Reference

ReadChannelMessages

Read a small structured window of top-level messages from a channel.

Starter documentation. Features and account details may differ from this deployment.

ReadChannelMessages

Read a small structured window of top-level messages from a channel. Use this for latest messages, bounded time ranges, cursor continuation, or a window around a message. For full thread replies, use ReadChannelThread.

Parameters

ParameterTypeRequiredDescription
channelIdstringYesChannel id to read.
windowType"latest" | "timeRange" | "aroundMessage" | "page" | "messages"YesType of channel timeline window to read.
fromstringNoInclusive lower bound for activity timestamps. Required when windowType is timeRange.
tostringNoExclusive upper bound for activity timestamps. Required when windowType is timeRange.
messageIdstringNoAnchor message id. Required when windowType is aroundMessage.
cursorstringNoOpaque cursor returned by this tool. Required when windowType is page.
direction"older" | "newer"NoDirection to read from the cursor. Required when windowType is page.
messageIdsstring[]NoTop-level message ids to read. Required when windowType is messages.
limitintegerNoMaximum number of top-level messages to return. Defaults to 25, maximum 100.
includeThreadPreviewsbooleanNoWhether to include thread preview replies on returned top-level messages. Defaults to true.
maxCharsPerMessageintegerNoMaximum characters to return per message/reply. Defaults to 4000, maximum 16000.

On this page