Sign in

v2

latestOpenAPI 3.0.1raw.githubusercontent.com2024-06-24221444.3 KB
Status

Get presence of a channel

Get presence on a channel

get/channels/{channel_id}/presence

Path parameters

channel_idstring required

The Channel's ID.

Query parameters

clientIdstring
connectionIdstring
limitinteger

Response

OK

idstring

Unique ID assigned by Ably to this presence update.

action'ABSENT' | 'PRESENT' | 'ENTER' | 'LEAVE' | 'UPDATE'

The event signified by a PresenceMessage.

datastring

The presence update payload, if provided.

clientIdstring

The client ID of the publisher of this presence update.

connectionIdstring

The connection ID of the publisher of this presence update.

timestampinteger

Timestamp when the presence update was received by Ably, as milliseconds since the epoch.

encodingstring

This will typically be empty as all presence updates received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute will contain the remaining transformations not applied to the data payload.