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.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · query
Kindquery
Authoritychannel.beta.colibri.social
Indexed

Query

query · GET

Parameters

query string

around

string · record-key

Centres 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.

channel

requiredstring · space-ref

The channel or thread to list messages from.

cursor

string

Pagination cursor from a previous call.

limit

integer

Maximum number of messages to return.

  • minimum: 1
  • maximum: 100
  • default: 50

reverse

boolean

Whether to return the oldest messages first instead of the newest.

  • default: false

Output

application/json

cursor

string

Pagination cursor for the next page. With around, it continues towards older messages.

Only set with around, when newer messages remain. Pass it as cursor with reverse set to continue towards newer messages.

messages

requiredarray

The channel's messages.

threads

array

Threads 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.

itemsref

Authors whose older messages could not be loaded for this page because their PDS did not answer. The page may be missing some of their messages. Absent when the page is complete.

itemsstring · did

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 match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.