social.colibri.beta.voice.moderate
Acts on someone in a voice channel. An absent field leaves the current value unchanged.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | voice.beta.colibri.social |
| Indexed |
Procedure
procedure · POSTInput
application/jsonThe voice channel the subject is in.
deafened
booleanWhether the subject cannot hear others. Absent leaves the current value unchanged.
disconnect
booleanWhether to disconnect the subject from the channel.
moveTo
string · space-refThe voice channel to move the subject to. It must be in the same space as the channel.
muted
booleanWhether the subject's microphone is muted. Absent leaves the current value unchanged.
Who to act on.
Output
application/jsonErrors
AuthRequired
The request has no valid service auth.
Forbidden
The requesting user lacks the voice.moderate permission.
ChannelNotFound
No channel matches the given space reference.
NotInVoice
The subject is not currently connected to the channel.
NotVoiceChannel
The moveTo channel is not a voice channel in the same space.
DestinationForbidden
The subject cannot speak in the moveTo channel.
VoiceUnavailable
This AppView has no voice SFU running.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Moderates a member's participation in a voice channel: server-mute, server-deafen, or force-disconnect. Requires the `voice.moderate` community permission and the caller must outrank the target. Server-mute/deafen are enforced by the SFU and persist for the room's lifetime, disconnect is transient (the target may rejoin).