Reference

Request Access Token

Generates a secure authentication token for Ably clients with customizable permissions and expiration times. This enables you to control which clients can access specific channels and for how long.

List Channels

Discover all active channels in your Ably messaging system to see what communication channels are currently running, with optional details about who's using them.

Get Channel Details

Retrieve real-time information about a specific Ably channel, including its current status, occupancy metrics, and active users. Use this to monitor channel health and understand who's connected to your communication channels.

Get Channel History

Retrieve past messages from an Ably channel to review communication history, audit conversations, or recover messages that were missed during offline periods.

Batch Publish Messages

Send multiple messages to several channels at once, enabling efficient mass communication without waiting for each message to complete individually.

Publish Message to Channel

Sends a message to an Ably channel to instantly reach users subscribed to that channel, enabling real-time communication across your application or platform.

Get Message Versions

Retrieve the complete version history of a specific message from an Ably channel, including all edits and deletions with timestamps and metadata. This helps you track how messages have changed over time and understand the full communication record.

Publish Push Notification

Send push notifications directly to specific devices or users through Ably's infrastructure, enabling real-time alerts and engagement without building your own notification system.

Batch Publish Push Notifications

Send multiple push notifications to specific users in a single request, enabling efficient bulk communication without individual API calls. This is ideal when you need to notify large groups of users quickly and reliably.

Get Channel Presence

Retrieve a list of all clients currently connected and active on a specific channel to monitor who is present in real-time.

Get Channel Presence History

Retrieve a record of who was present on a channel and when they joined or left during a specific time period. This helps you track user activity and engagement on your communication channels.

Query Batch Presence

Check who is currently active across multiple communication channels at once, getting real-time presence data for all your channels in a single request.

Query Batch Presence History

Retrieve member presence history across multiple communication channels simultaneously, allowing you to see who was active and when across your entire platform in one request.

List Push Channels

Retrieve all channels that currently have active push notification subscriptions, helping you understand which communication channels are actively reaching your users via push notifications.

Register Push Device

Enable push notifications on a specific device by registering it with Ably's push notification system, supporting iOS, Android, and web platforms. This allows your app to send real-time alerts and updates directly to users' devices.

Get Push Device Registration

Retrieve complete details about a registered device for push notifications, including its platform, status, and recipient information. Use this to verify device registration status and troubleshoot notification delivery issues.

List Registered Push Devices

View all devices registered to receive push notifications in your Ably application, with options to filter by device or client ID and manage your notification audience.

Patch Push Device Registration

Update specific device registration settings in your push notification system without affecting other device properties. This is useful when you need to change only certain attributes like device type, platform, or notification recipient details.

Unregister All Push Devices

Remove all push notification registrations for devices matching your specified criteria, allowing you to stop sending notifications to unwanted or inactive devices. Use this to clean up your push notification subscriber list and prevent messages from reaching old or test devices.

Unregister Push Device

Remove a device from push notification delivery in Ably so it stops receiving notifications. Use this when a user uninstalls your app, logs out, or wants to opt out of push messages.

Update Push Device Registration

Modify or create device push notification settings in Ably to ensure mobile apps receive timely alerts and messages from your service.

Get Ably Service Time

Retrieves the current server time from Ably's service to ensure your application stays synchronized with accurate timestamps. This is essential for generating secure authentication tokens and preventing timing-related security issues in real-time messaging applications.

Get Application Stats

Retrieve detailed usage statistics for your Ably application, including message counts, data transfer, connections, and API requests across different time periods. Use this to monitor how your real-time communication features are performing and identify usage patterns.

Delete Channel Subscription

Remove a device or client from receiving push notifications for a specific channel, allowing you to stop sending updates to users who no longer need them.

List Push Channel Subscriptions

Retrieve all push notification subscriptions for your channels, with options to filter by channel, device, or client and view detailed subscription information. Use this to monitor which devices and users are receiving notifications and manage your notification audience.