Skip to content

Realtime

realtime_presence_get

Get the current presence roster for a channel.

Tool

realtime_presence_get

Get the current presence roster for a channel.

Get the current presence roster for a channel. Roster is deduplicated by identity (connections counts live sockets); a per-connection view is deferred — the store is identity-keyed.

Behavior

HTTP
GET /realtime/presence

Arguments

NameTypeRequiredDescription
channelstringChannel name, "namespace:rest"

Response

FieldTypeAlwaysDescription
channelstringChannel name
membersarrayCurrent roster, deduplicated by identity

Try it

Get the current presence roster for a channel.

When to use

Get the current presence roster for a channel. Roster is deduplicated by identity (connections counts live sockets); a per-connection view is deferred — the store is identity-keyed.

Example

Ask your agent something like this:

Get the current presence roster for a channel.

The agent will invoke realtime_presence_get with these arguments:

{
  "channel": "<channel>"
}

Esc

Start typing to search the docs.

navigateselect