Interface

APIChannel

Full channel object from GET /channels/{id} or GET /guilds/{id}/channels.

Extends Omit

Properties

NameTypeDescription
applied_tags?Snowflake[]Tag IDs applied to a forum or media post (max 5).
available_tags?APIForumTag[]Tags that can be applied to posts in a forum or media channel.
bitrate?number | nullVoice bitrate (kbps).
content_warning_level?ContentWarningLevelContent warning level.
content_warning_text?string | nullContent warning custom text.
default_auto_archive_duration?number | nullDefault auto-archive duration in minutes for new threads.
default_forum_layout?ForumLayoutDefault layout for forum posts.
default_reaction_emoji?APIDefaultReactionEmoji | nullDefault reaction for new posts.
default_sort_order?ForumSortOrder | nullDefault sort order for posts.
default_tag_setting?ForumTagSettingDefault tag search setting for a forum or media channel.
default_thread_rate_limit_per_user?numberSlowmode in seconds copied onto new threads.
flags?numberChannel flags bitfield.
guild_id?SnowflakeGuild ID (absent for DMs).
icon?string | nullChannel icon hash.
last_message_id?Snowflake | nullLast message ID in this channel.
last_pin_timestamp?string | nullISO-8601 timestamp of last pin.
member?APIThreadMemberThread membership for the current user.
member_count?numberApproximate number of thread members, capped at 50.
member_ids_preview?Snowflake[]Recently joined member IDs of a forum or media post, newest first.
message_count?numberMessages in the thread, excluding the starter and deleted messages.
name?stringChannel name.
nicks?Record<string, string>User-specific nicknames in group DMs (user_id -> nick).
nsfw?booleanWhether the channel is NSFW.
nsfw_override?boolean | nullPer-channel NSFW override (null inherits).
owner_id?Snowflake | nullOwner ID (group DMs).
parent_id?Snowflake | nullParent category ID.
permission_overwrites?APIChannelOverwrite[]Permission overwrites.
position?numberSort position in the channel list.
rate_limit_per_user?numberSlowmode delay in seconds.
recipients?APIUser[]DM/group DM recipients.
rtc_region?string | nullVoice RTC region ID.
thread_metadata?APIThreadMetadataThread-specific fields. Present on thread channels.
topic?string | nullChannel topic.
total_message_sent?numberMessages ever sent in the thread. This count is never decremented.
url?string | nullExternal URL (link channels, type 998).
user_limit?number | nullVoice user limit (0 = unlimited).
voice_connection_limit?number | nullMax active voice connections per user in this channel.