API

Every ably.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Application

getServiceTime

application.getServiceTime Get the current Ably service time. Risk: read

await corsair.ably.api.application.getServiceTime({});

Input: empty object Output: number[]

getStats

application.getStats Retrieve application usage statistics. Risk: read

await corsair.ably.api.application.getStats({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`start`	`number`	No	—
`end`	`number`	No	—
`direction`	`forwards \| backwards`	No	—
`unit`	`minute \| hour \| day \| month`	No	—

Output: object[]

Output full type

{
}[]

requestAccessToken

application.requestAccessToken Request an Ably access token. Risk: write

await corsair.ably.api.application.requestAccessToken({});

Input

Name	Type	Required	Description
`keyName`	`string`	Yes	—
`clientId`	`string`	No	—
`ttl`	`number`	No	—
`capability`	`string`	No	—

Output

Name	Type	Required	Description
`token`	`string`	Yes	—
`expires`	`number`	No	—
`issued`	`number`	No	—
`capability`	`string`	No	—
`clientId`	`string`	No	—

Channels

batchPresence

channels.batchPresence Retrieve presence information for multiple channels. Risk: read

await corsair.ably.api.channels.batchPresence({});

Input

Name	Type	Required	Description
`channels`	`string[]`	Yes	—

Output: any[]

batchPresenceHistory

channels.batchPresenceHistory Retrieve presence history for multiple channels. Risk: read

await corsair.ably.api.channels.batchPresenceHistory({});

Input

Name	Type	Required	Description
`channels`	`string[]`	Yes	—
`limit`	`number`	No	—
`start`	`number`	No	—
`end`	`number`	No	—
`direction`	`forwards \| backwards`	No	—

Output: any[]

getChannelDetails

channels.getChannelDetails Retrieve details for an active channel. Risk: read

await corsair.ably.api.channels.getChannelDetails({});

Input

Name	Type	Required	Description
`channelId`	`string`	Yes	—

Output

Name	Type	Required	Description
`channelId`	`string`	No	—
`status`	`object`	No	—

status full type

{
  isActive?: boolean,
  occupancy?: {
    metrics?: {
    }
  }
}

getChannelHistory

channels.getChannelHistory Retrieve message history for a channel. Risk: read

await corsair.ably.api.channels.getChannelHistory({});

Input

Name	Type	Required	Description
`channelId`	`string`	Yes	—
`limit`	`number`	No	—
`start`	`number`	No	—
`end`	`number`	No	—
`direction`	`forwards \| backwards`	No	—

Output: object[]

Output full type

{
  id?: string,
  name?: string,
  data?: any,
  clientId?: string,
  connectionId?: string,
  timestamp?: number,
  encoding?: string,
  extras?: {
  }
}[]

getChannelPresence

channels.getChannelPresence Retrieve current channel presence members. Risk: read

await corsair.ably.api.channels.getChannelPresence({});

Input

Name	Type	Required	Description
`channelId`	`string`	Yes	—
`clientId`	`string`	No	—
`connectionId`	`string`	No	—

Output: object[]

Output full type

{
  id?: string,
  action?: string | number,
  clientId?: string,
  connectionId?: string,
  data?: any,
  timestamp?: number,
  encoding?: string
}[]

getMessageVersions

channels.getMessageVersions Retrieve historical versions of a message. Risk: read

await corsair.ably.api.channels.getMessageVersions({});

Input

Name	Type	Required	Description
`channelId`	`string`	Yes	—
`serial`	`string`	Yes	—

Output: object[]

Output full type

{
  id?: string,
  name?: string,
  data?: any,
  clientId?: string,
  connectionId?: string,
  timestamp?: number,
  encoding?: string,
  extras?: {
  }
}[]

getPresenceHistory

channels.getPresenceHistory Retrieve presence history for a channel. Risk: read

await corsair.ably.api.channels.getPresenceHistory({});

Input

Name	Type	Required	Description
`channelId`	`string`	Yes	—
`limit`	`number`	No	—
`start`	`number`	No	—
`end`	`number`	No	—
`direction`	`forwards \| backwards`	No	—

Output: object[]

Output full type

{
  id?: string,
  action?: string | number,
  clientId?: string,
  connectionId?: string,
  data?: any,
  timestamp?: number,
  encoding?: string
}[]

listChannels

channels.listChannels List active Ably channels. Risk: read

await corsair.ably.api.channels.listChannels({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`prefix`	`string`	No	—
`by`	`id \| value`	No	—
`next`	`object`	No	—

next full type

{
}

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`next`	`object`	No	—

items full type

(
  string | {
    channelId?: string,
    status?: {
      isActive?: boolean,
      occupancy?: {
        metrics?: {
        }
      }
    }
  }
)[]

next full type

{
}

publishBatchMessages

channels.publishBatchMessages Publish messages to multiple Ably channels. Risk: write

await corsair.ably.api.channels.publishBatchMessages({});

Input

Name	Type	Required	Description
`messages`	`object[]`	Yes	—

messages full type

{
  channels: string[],
  messages: {
    id?: string,
    name?: string,
    data?: any,
    clientId?: string,
    connectionId?: string,
    timestamp?: number,
    encoding?: string,
    extras?: {
    }
  }[]
}[]

Output: any[]

publishMessageToChannel

channels.publishMessageToChannel Publish a message to an Ably channel. Risk: write

await corsair.ably.api.channels.publishMessageToChannel({});

Input

Name	Type	Required	Description
`channelId`	`string`	Yes	—
`name`	`string`	No	—
`data`	`any`	Yes	—
`clientId`	`string`	No	—
`extras`	`object`	No	—

extras full type

{
}

Output: any

Push

createPushChannelSubscription

push.createPushChannelSubscription Subscribe a device or client to a push channel. Risk: write

await corsair.ably.api.push.createPushChannelSubscription({});

Input

Name	Type	Required	Description
`channel`	`string`	Yes	—
`deviceId`	`string`	No	—
`clientId`	`string`	No	—

Output: any

deleteChannelSubscription

push.deleteChannelSubscription Delete matching push channel subscriptions. Risk: destructive

await corsair.ably.api.push.deleteChannelSubscription({});

Input

Name	Type	Required	Description
`channel`	`string`	Yes	—
`deviceId`	`string`	No	—
`clientId`	`string`	No	—

Output: any

getPushDevice

push.getPushDevice Retrieve a push device registration. Risk: read

await corsair.ably.api.push.getPushDevice({});

Input

Name	Type	Required	Description
`deviceId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`clientId`	`string`	No	—
`platform`	`string`	No	—
`formFactor`	`string`	No	—
`metadata`	`object`	No	—
`updateToken`	`string`	No	—
`push`	`object`	No	—

metadata full type

{
}

push full type

{
  state?: string,
  recipient?: {
  }
}

listPushChannels

push.listPushChannels List channels with push subscribers. Risk: read

await corsair.ably.api.push.listPushChannels({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`prefix`	`string`	No	—
`next`	`object`	No	—

next full type

{
}

Output

Name	Type	Required	Description
`items`	`string[]`	Yes	—
`next`	`object`	No	—

next full type

{
}

listPushChannelSubscriptions

push.listPushChannelSubscriptions List push channel subscriptions. Risk: read

await corsair.ably.api.push.listPushChannelSubscriptions({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`channel`	`string`	No	—
`deviceId`	`string`	No	—
`clientId`	`string`	No	—
`next`	`object`	No	—

next full type

{
}

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`next`	`object`	No	—

items full type

{
  channel: string,
  deviceId?: string,
  clientId?: string
}[]

next full type

{
}

listRegisteredPushDevices

push.listRegisteredPushDevices List registered push notification devices. Risk: read

await corsair.ably.api.push.listRegisteredPushDevices({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`deviceId`	`string`	No	—
`clientId`	`string`	No	—
`next`	`object`	No	—

next full type

{
}

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`next`	`object`	No	—

items full type

{
  id: string,
  clientId?: string,
  platform?: string,
  formFactor?: string,
  metadata?: {
  },
  updateToken?: string,
  push?: {
    state?: string,
    recipient?: {
    }
  }
}[]

next full type

{
}

patchPushDeviceRegistration

push.patchPushDeviceRegistration Partially update a push device registration. Risk: write

await corsair.ably.api.push.patchPushDeviceRegistration({});

Input

Name	Type	Required	Description
`deviceId`	`string`	Yes	—
`clientId`	`string`	No	—
`metadata`	`object`	No	—
`push`	`object`	No	—

metadata full type

{
}

push full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`clientId`	`string`	No	—
`platform`	`string`	No	—
`formFactor`	`string`	No	—
`metadata`	`object`	No	—
`updateToken`	`string`	No	—
`push`	`object`	No	—

metadata full type

{
}

push full type

{
  state?: string,
  recipient?: {
  }
}

publishPushNotification

push.publishPushNotification Publish a push notification. Risk: write

await corsair.ably.api.push.publishPushNotification({});

Input

Name	Type	Required	Description
`recipient`	`object`	Yes	—
`data`	`object`	No	—
`notification`	`object`	No	—

recipient full type

{
}

data full type

{
}

notification full type

{
}

Output: any

publishPushNotificationsBatch

push.publishPushNotificationsBatch Publish a batch of push notifications. Risk: write

await corsair.ably.api.push.publishPushNotificationsBatch({});

Input

Name	Type	Required	Description
`notifications`	`object[]`	Yes	—

notifications full type

{
}[]

Output: any[]

registerPushDevice

push.registerPushDevice Register a device for push notifications. Risk: write

await corsair.ably.api.push.registerPushDevice({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`clientId`	`string`	No	—
`platform`	`ios \| android \| browser`	Yes	—
`formFactor`	`phone \| tablet \| desktop \| tv \| watch \| car \| embedded`	Yes	—
`metadata`	`object`	No	—
`updateToken`	`string`	No	—
`push`	`object`	Yes	—

metadata full type

{
}

push full type

{
  recipient: {
    transportType: fcm | apns | web
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`clientId`	`string`	No	—
`platform`	`string`	No	—
`formFactor`	`string`	No	—
`metadata`	`object`	No	—
`updateToken`	`string`	No	—
`push`	`object`	No	—

metadata full type

{
}

push full type

{
  state?: string,
  recipient?: {
  }
}

unregisterAllPushDevices

push.unregisterAllPushDevices Delete matching push device registrations. Risk: destructive

await corsair.ably.api.push.unregisterAllPushDevices({});

Input

Name	Type	Required	Description
`deviceId`	`string`	No	—
`clientId`	`string`	No	—

Output: any

unregisterPushDevice

push.unregisterPushDevice Delete a push device registration. Risk: destructive

await corsair.ably.api.push.unregisterPushDevice({});

Input

Name	Type	Required	Description
`deviceId`	`string`	Yes	—

Output: any

updatePushDevice

push.updatePushDevice Create or replace a push device registration. Risk: write

await corsair.ably.api.push.updatePushDevice({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`clientId`	`string`	No	—
`platform`	`ios \| android \| browser`	Yes	—
`formFactor`	`phone \| tablet \| desktop \| tv \| watch \| car \| embedded`	Yes	—
`metadata`	`object`	No	—
`updateToken`	`string`	No	—
`push`	`object`	Yes	—

metadata full type

{
}

push full type

{
  recipient: {
    transportType: fcm | apns | web
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`clientId`	`string`	No	—
`platform`	`string`	No	—
`formFactor`	`string`	No	—
`metadata`	`object`	No	—
`updateToken`	`string`	No	—
`push`	`object`	No	—

metadata full type

{
}

push full type

{
  state?: string,
  recipient?: {
  }
}

Overview

Plugins

Application

getServiceTime

getStats

requestAccessToken

Channels

batchPresence

batchPresenceHistory

getChannelDetails

getChannelHistory

getChannelPresence

getMessageVersions

getPresenceHistory

listChannels

publishBatchMessages

publishMessageToChannel

Push

createPushChannelSubscription

deleteChannelSubscription

getPushDevice

listPushChannels

listPushChannelSubscriptions

listRegisteredPushDevices

patchPushDeviceRegistration

publishPushNotification

publishPushNotificationsBatch

registerPushDevice

unregisterAllPushDevices

unregisterPushDevice

updatePushDevice

​Application

​getServiceTime

​getStats

​requestAccessToken

​Channels

​batchPresence

​batchPresenceHistory

​getChannelDetails

​getChannelHistory

​getChannelPresence

​getMessageVersions

​getPresenceHistory

​listChannels

​publishBatchMessages

​publishMessageToChannel

​Push

​createPushChannelSubscription

​deleteChannelSubscription

​getPushDevice

​listPushChannels

​listPushChannelSubscriptions

​listRegisteredPushDevices

​patchPushDeviceRegistration

​publishPushNotification

​publishPushNotificationsBatch

​registerPushDevice

​unregisterAllPushDevices

​unregisterPushDevice

​updatePushDevice

Application

getServiceTime

getStats

requestAccessToken

Channels

batchPresence

batchPresenceHistory

getChannelDetails

getChannelHistory

getChannelPresence

getMessageVersions

getPresenceHistory

listChannels

publishBatchMessages

publishMessageToChannel

Push

createPushChannelSubscription

deleteChannelSubscription

getPushDevice

listPushChannels

listPushChannelSubscriptions

listRegisteredPushDevices

patchPushDeviceRegistration

publishPushNotification

publishPushNotificationsBatch

registerPushDevice

unregisterAllPushDevices

unregisterPushDevice

updatePushDevice