v2

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

History

Get message history for a channel

get/channels/{channel_id}/messages

Path parameters

channel_idstring required

The Channel's ID.

Query parameters

startstring

limitinteger

endstring

direction'forwards' | 'backwards'

Response

namestring

The event name, if provided.

datastring

The string encoded payload, with the encoding specified below.

idstring

A Unique ID that can be specified by the publisher for idempotent publishing.

timestampinteger

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

encodingstring

This will typically be empty as all messages 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.

clientIdstring

The client ID of the publisher of this message.

connectionIdstring

The connection ID of the publisher of this message.

All 22 operations