Skip to main content
Version: Next

APIGuildVoiceChannel

Hierarchy

Index

Properties

Properties

optionalbitrate

bitrate?: number

The bitrate (in bits) of the voice channel

optionalflags

flags?: ChannelFlags

optionalguild_id

guild_id?: string

The id of the guild (may be missing for some channel objects received over gateway guild dispatches)

id

id: string

The id of the channel

optionallast_message_id

last_message_id?: null | string

The id of the last message sent in this channel (may not point to an existing or valid message)

optionalname

name?: string

The name of the channel (2-100 characters)

optionalnsfw

nsfw?: boolean

Whether the channel is nsfw

optionalparent_id

parent_id?: null | string

ID of the parent category for a channel (each parent category can contain up to 50 channels)

OR

ID of the parent channel for a thread

optionalpermission_overwrites

permission_overwrites?: APIOverwrite[]

Explicit permission overwrites for members and roles

See https://discord.com/developers/docs/resources/channel#overwrite-object

optionalposition

position?: number

Sorting position of the channel

optionalrate_limit_per_user

rate_limit_per_user?: number

Amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission MANAGE_MESSAGES or MANAGE_CHANNELS, are unaffected

rate_limit_per_user also applies to thread creation. Users can send one message and create one thread during each rate_limit_per_user interval.

For thread channels, rate_limit_per_user is only returned if the field is set to a non-zero and non-null value. The absence of this field in API calls and Gateway events should indicate that slowmode has been reset to the default value.

optionalrtc_region

rtc_region?: null | string

Voice region id for the voice or stage channel, automatic when set to null

See https://discord.com/developers/docs/resources/voice#voice-region-object

type

type: GuildVoice

The type of the channel

See https://discord.com/developers/docs/resources/channel#channel-object-channel-types

optionaluser_limit

user_limit?: number

The user limit of the voice channel

optionalvideo_quality_mode

video_quality_mode?: VideoQualityMode

The camera video quality mode of the voice channel, 1 when not present

See https://discord.com/developers/docs/resources/channel#channel-object-video-quality-modes