Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Mute Status

AI-generated

Summary

Retrieve the mute status of a specific channel by specifying its type and unique identifier.

Inputs

  • Channel Type — The category of the channel such as "messaging" for one-on-one chats, "team" for group channels, or "livestream" for broadcast channels. Defaults to "messaging".
  • Channel ID (required) — The unique identifier of the channel (e.g., "general", "random", "team-alpha"). Combined with channel type to form the channel's CID.

Output shape

a single JSON object containing the mute status details of the specified channel.

The mute status is returned synchronously from the Stream Chat server client method channel(channelType, channelId).muteStatus(). This output includes whether the channel is muted and expiration if applicable, but exact fields depend on the Stream Chat API response.

Examples

Example 1: Retrieve the mute status of the "general" messaging channel.

Set Channel Type to "messaging" and Channel ID to "general".

Discussion