Channels annotations get

Use the ably channels annotations get command to get annotations for a channel message.

Synopsis

ably channels annotations get <channel-name> <message-serial> [options]

Arguments

channel-name

Required

The name of the channel containing the message.

message-serial

Required

The serial of the message to get annotations for.

Options

--limit

The maximum number of annotations to return. Defaults to 100.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

Get annotations for a message:

ably channels annotations get my-channel "msg-serial"

Get annotations with a limit:

ably channels annotations get my-channel "msg-serial" --limit 10

Get annotations and output in JSON format:

ably channels annotations get my-channel "msg-serial" --json

Get annotations and output in formatted JSON:

ably channels annotations get my-channel "msg-serial" --pretty-json

See also

• Channels — Explore all ably channels commands.
• CLI reference — Full list of available commands.