Documentation for Set Voice Channel Status endpoint, permission, and related Gateway and audit log events.
Voice channel status has been available for some time, but we're now officially documenting the endpoint, permission, and related Gateway and audit log events so apps can integrate with it.
The Set Voice Channel Status endpoint (PUT /channels/{channel.id}/voice-status) allows apps to set a short string (up to 500 characters) describing what's happening in a voice channel.
Permission
Setting a channel's status requires the SET_VOICE_CHANNEL_STATUS permission (1 << 48), now documented in the permissions table. If the bot user is not connected to the voice channel, the MANAGE_CHANNELS permission is additionally required.
Gateway Events
Voice channel status and voice session start time are ephemeral and are not included on the channel object. To read them, apps send the Request Channel Info Gateway command (opcode 43) and receive a Channel Info event containing the requested fields (currently status and voice_start_time) for channels in the guild.
Two receive events are dispatched when these fields change:
- Voice Channel Status Update — fired when a channel's status changes.
- Voice Channel Start Time Update — fired when a voice session's start time changes.
Audit Log
Two audit log events track status changes: VOICE_CHANNEL_STATUS_UPDATE (192) and VOICE_CHANNEL_STATUS_DELETE (193). A status field in Optional Audit Entry Info carries the new status on VOICE_CHANNEL_STATUS_UPDATE entries.