Realtime members
A Realtime Member is one client present in a channel: connected with a token that names its client id, entered, and not yet left.
A Realtime Member is one client present in a channel: connected with a token that names its client id, entered, and not yet left.
Service Sylphx Events · Resource type events.sylphx.com/RealtimeMember · Name pattern orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}/realtime_members/{realtime_member} · Shape record
Fields
| Field | Type | What it is |
|---|---|---|
name | string | …/realtime_channels/{realtime_channel}/realtime_members/{realtime_member}. |
uid | string | rtb_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
client_id | string | The client id its token names. Output only. |
data | value | The member's presence data (set at enter, changed by an update). Output only. |
enter_time | timestamp | When the member entered. Output only. |
connection_count | int32 | Open connections of this client in the channel. Output only. |
joined | bool | Persistent Chat membership, independent of online connections. Output only. |
last_read_cursor | string | Last acknowledged stream cursor; updates never move backwards. Output only. |
unread_count | int64 | Unread visible Chat messages from other members, excluding blocked senders. Output only. |
muted | bool | Suppress this conversation's notification intents. Output only. |
role | string | Member or moderator, assigned by the tenant backend. Output only. |
pinned | bool | This channel is an official, verified support conversation. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets one client present in a channel. |
GET | list | Lists the clients present in a channel now. |
POST | read | Advances a member read cursor monotonically and sets mute. |
get
Gets one client present in a channel.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members/realtime-member · scope events:read · effect read · Request, response and examples
list
Lists the clients present in a channel now.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members · scope events:read · effect read · paginated · Request, response and examples
read
Advances a member read cursor monotonically and sets mute.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members/realtime-member:read · scope events:write · effect write · Request, response and examples