Skip to content
Console
On this page

List realtime members

Lists the clients present in a channel now.

Lists the clients present in a channel now.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members
  • Scope events:read
  • Effect read — nothing is written.
  • Collection realtime_members
  • Query page_size, page_token
  • Pagination the answer carries realtime_members and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringThe realtime channel. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.

Response

FieldTypeWhat it is
realtime_membersRealtimeMember[]The page, by client id.
next_page_tokenstringThe token of the next page; empty on the last page.

RealtimeMember

FieldTypeWhat it is
namestring…/realtime_channels/{realtime_channel}/realtime_members/{realtime_member}.
uidstringrtb_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
client_idstringThe client id its token names. Output only.
datavalueThe member's presence data (set at enter, changed by an update). Output only.
enter_timetimestampWhen the member entered. Output only.
connection_countint32Open connections of this client in the channel. Output only.
joinedboolPersistent Chat membership, independent of online connections. Output only.
last_read_cursorstringLast acknowledged stream cursor; updates never move backwards. Output only.
unread_countint64Unread visible Chat messages from other members, excluding blocked senders. Output only.
mutedboolSuppress this conversation's notification intents. Output only.
rolestringMember or moderator, assigned by the tenant backend. Output only.
pinnedboolThis channel is an official, verified support conversation. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"