Path parameters

• channel_id string Required

  The Channel's ID.

Query parameters

• clientId string
• connectionId string
• limit integer

  Default value is 100.

Responses

• 200

  OK

  Hide headers attributes Show headers attributes

  • link string Required

    Links to related resources, in the format defined by RFC 5988. This will potentially include a link with relation type next, first, and current, where appropiate.

    Format should match the following pattern: (<(.*)?>; rel=\"(first|current|last)?\",)*(<(.*)?>; rel=\"(first|current|last)?\")+.

  • x-ably-serverid string Required

    The ID for the server communicated with.

  Hide response attributes Show response attributes array[object]

  • id string

    Unique ID assigned by Ably to this presence update.

  • action string

    The event signified by a PresenceMessage.

    Values are ABSENT, PRESENT, ENTER, LEAVE, or UPDATE.

  • data string

    The presence update payload, if provided.

  • clientId string

    The client ID of the publisher of this presence update.

  • connectionId string

    The connection ID of the publisher of this presence update.

  • timestamp integer(int64)

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

  • encoding string

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

  • extras object

    Extras object. Currently only allows for push extra.

    Hide extras attribute Show extras attribute object

    • push object
      Hide push attributes Show push attributes object

      • data string

        Arbitrary key-value string-to-string payload.

      • notification object
        Hide notification attributes Show notification attributes object

        • title string

          Title to display at the notification.

        • body string

          Text below title on the expanded notification.

        • icon string

          Platform-specific icon for the notification.

        • sound string

          Platform-specific sound for the notification.

        • collapseKey string

          Platform-specific, used to group notifications together.

      • apns object

        Extends and overrides generic values when delivering via APNs. See examples

        Hide apns attribute Show apns attribute object

        • notification object
          Hide notification attributes Show notification attributes object

          • title string

            Title to display at the notification.

          • body string

            Text below title on the expanded notification.

          • icon string

            Platform-specific icon for the notification.

          • sound string

            Platform-specific sound for the notification.

          • collapseKey string

            Platform-specific, used to group notifications together.

      • fcm object

        Extends and overrides generic values when delivering via GCM/FCM. See examples

        Hide fcm attribute Show fcm attribute object

        • notification object
          Hide notification attributes Show notification attributes object

          • title string

            Title to display at the notification.

          • body string

            Text below title on the expanded notification.

          • icon string

            Platform-specific icon for the notification.

          • sound string

            Platform-specific sound for the notification.

          • collapseKey string

            Platform-specific, used to group notifications together.

      • web object

        Extends and overrides generic values when delivering via web. See examples

        Hide web attribute Show web attribute object

        • notification object
          Hide notification attributes Show notification attributes object

          • title string

            Title to display at the notification.

          • body string

            Text below title on the expanded notification.

          • icon string

            Platform-specific icon for the notification.

          • sound string

            Platform-specific sound for the notification.

          • collapseKey string

            Platform-specific, used to group notifications together.

• default

  Error

  Hide headers attributes Show headers attributes

  • x-ably-errorcode integer

    The error code.

  • x-ably-errormessage string

    The error message.

  • x-ably-serverid string Required

    The ID for the server communicated with.

  Hide response attributes Show response attributes object

  • message string

    Message explaining the error's cause.

  • code integer

    Error code.

  • statusCode integer

    Status error code.

  • href string

    Link to help with error.

  • serverId string

    Server ID with which error was encountered.