Skip to main content

Channel overview

A channel represents a messaging context between participants. Each channel has a type, a target ID, and maintains state such as unread count, last message, and notification settings.

Channel types

Channel typeClassDescription
Direct channelDirectChannelOne-to-one messaging between two users
Group channelGroupChannelMessaging within a group
Open channelOpenChannelA public channel that users can join and leave freely, similar to a live chat room
Community channelCommunityChannel / CommunitySubChannelLarge-scale community with subchannels
System channelSystem notifications sent from the server

Channel properties

Each channel object contains the following key properties:

PropertyTypeDescription
channelTypeChannelTypeThe type of the channel
channelIdstringThe unique identifier of the channel's target (user ID, group ID, etc.)
unreadCountnumberNumber of unread messages
latestMessageMessage<any> | nullThe most recent message in the channel
operationTimenumberTimestamp (ms) of the most recent operation
isPinnedbooleanWhether the channel is pinned
draftstringDraft text saved for the channel

Channel lifecycle

  • Channels are automatically created when a message is sent or received.
  • You can retrieve, pin, mute, and delete channels using the SDK API.
  • On the Web platform, channel lists are fetched from the server (no local persistence).

Next steps