Ably

Ably integration (Developer Tools). Imported from open-connector.

API key10 toolshttps://main.realtime.ably.net

GET

ably_batch_presence

Query current presence for multiple Ably channels.

/presence

2 parameters

Param	Type	Required	Description
channels	array	required	One or more Ably channel names.
separator	string	optional	The separator used when channels is provided as a string.

GET

ably_batch_presence_history

Query presence history for multiple Ably channels.

/channels/{channel}/presence/history

7 parameters

Param	Type	Required	Description
channels	array	required	One or more Ably channel names.
separator	string	optional	The separator used when channels is provided as a string.
start	integer	optional	A timestamp in milliseconds since the Unix epoch.
end	integer	optional	A timestamp in milliseconds since the Unix epoch.
limit	integer	optional	The maximum number of records to return.
direction	string	optional	The Ably pagination direction.
channel	string	required	Path parameter: channel

GET

ably_create_channel

Activate an Ably channel by retrieving its metadata.

/channels/{channel_id}

1 parameter

Param	Type	Required	Description
channel_id	string	required	The Ably channel ID or channel name.

DELETE

ably_delete_channel_subscription

Delete an Ably push notification subscription for a channel, device, or client.

/push/channelSubscriptions

3 parameters

Param	Type	Required	Description
channel	string	optional	The Ably channel ID or channel name.
client_id	string	optional	The Ably client ID to unsubscribe.
device_id	string	optional	The Ably device ID to unsubscribe.

GET

ably_get_channel_details

Retrieve Ably metadata and occupancy details for one channel.

/channels/{channel_id}

1 parameter

Param	Type	Required	Description
channel_id	string	required	The Ably channel ID or channel name.

GET

ably_get_channel_history

Retrieve message history for one Ably channel.

/channels/{channel_id}/messages

5 parameters

Param	Type	Required	Description
channel_id	string	required	The Ably channel ID or channel name.
start	integer	optional	A timestamp in milliseconds since the Unix epoch.
end	integer	optional	A timestamp in milliseconds since the Unix epoch.
limit	integer	optional	The maximum number of records to return.
direction	string	optional	The Ably pagination direction.

GET

ably_get_presence_history

Retrieve presence history for one Ably channel.

/channels/{channel_id}/presence/history

5 parameters

Param	Type	Required	Description
channel_id	string	required	The Ably channel ID or channel name.
start	integer	optional	A timestamp in milliseconds since the Unix epoch.
end	integer	optional	A timestamp in milliseconds since the Unix epoch.
limit	integer	optional	The maximum number of records to return.
direction	string	optional	The Ably pagination direction.

GET

ably_get_service_time

Retrieve Ably service time in milliseconds since the Unix epoch.

/time

GET

ably_get_stats

Retrieve Ably application usage statistics.

/stats

5 parameters

Param	Type	Required	Description
start	integer	optional	A timestamp in milliseconds since the Unix epoch.
end	integer	optional	A timestamp in milliseconds since the Unix epoch.
limit	integer	optional	The maximum number of records to return.
direction	string	optional	The Ably pagination direction.
unit	string	optional	The Ably statistics aggregation unit.

GET

ably_list_push_channel_subscriptions

List Ably push notification channel subscriptions.

/push/channelSubscriptions

5 parameters

Param	Type	Required	Description
channel	string	optional	The Ably channel ID or channel name.
client_id	string	optional	Filter subscriptions by Ably client ID.
device_id	string	optional	Filter subscriptions by Ably device ID.
concat_filters	boolean	optional	Whether to match either client_id or device_id when both are set.
limit	integer	optional	The maximum number of records to return.