Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Presence in Channels

Lists who is present on a channel.

Lists who is present on a channel.

Not available yet. Sylphx Realtime is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

  • Path GET https://api.realtime.sylphx.com/v1/channels/channel/presence
  • Scope realtime:read
  • Effect read — nothing is written.
  • Collection channels
  • Query page_size, page_token
  • Host https://api.realtime.sylphx.com

#Request

FieldTypeWhat it is
channelstringThe channel, namespace:name. Required.
page_sizeint32At most this many members; default 100, at most 1,000.
page_tokenstringThe next_page_token of the previous page.

#Response

FieldTypeWhat it is
membersMember[]The members present.
next_page_tokenstringEmpty on the last page.

#Member

FieldTypeWhat it is
userstringThe user id from the token.
connection_idstringThe connection id, unique while the connection lives.
datavalueThe application's presence data, at most 4 KiB encoded.
enter_timetimestampWhen this connection entered.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.realtime.sylphx.com/v1/channels/channel/presence" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"