social.colibri.beta.channel.listMessages
Lists messages in a channel or in a thread, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy. Messages moved in from another space are included in their move order, and messages moved out are absent.
Details · query
| Kind | query |
|---|---|
| Authority | channel.beta.colibri.social |
| Indexed |
Query
query · GETParameters
query stringaround
string · record-keyCentres the page on this message record key. The page holds up to limit messages, newest first: the newer half, then the message itself and the older half. cursor and reverse are ignored when this is set.
The channel or thread to list messages from.
cursor
stringPagination cursor from a previous call.
limit
integerMaximum number of messages to return.
minimum: 1maximum: 100default: 50
reverse
booleanWhether to return the oldest messages first instead of the newest.
default: false
Output
application/jsoncursor
stringPagination cursor for the next page. With around, it continues towards older messages.
forwardCursor
stringOnly set with around, when newer messages remain. Pass it as cursor with reverse set to continue towards newer messages.
The channel's messages.
threads
arrayThreads whose anchor message is in this page, so a client can draw a thread's marker under the message it was opened from without a second call. Threads the requesting user may not read are absent.
A thread.
Errors
AuthRequired
The request has no valid service auth.
Forbidden
The requesting user may not read this channel or thread.
ChannelNotFound
No channel or thread matches the given space reference.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Lists messages in a channel, newest first, paginated.
-
Lists a community's threads, most recently active first. Threads the requesting user may not read are absent rather than refused.
-
Returns the initial view of a channel: recent messages, the read cursor, and unseen notifications.
-
Returns a page of messages from a conversation.
-
Messages in a conversation, newest first.