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).
Parameters
Output
application/jsondid
stringdid
Required
DID of the moderated member.
Errors
AuthRequired
Missing, malformed, or unverifiable service auth. Forbidden
The caller lacks the permission this method requires. InvalidRequest
A parameter or body field was missing or malformed. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "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).",
"errors": [
{
"description": "Missing, malformed, or unverifiable service auth.",
"name": "AuthRequired"
},
{
"description": "The caller lacks the permission this method requires.",
"name": "Forbidden"
},
{
"description": "A parameter or body field was missing or malformed.",
"name": "InvalidRequest"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"did": {
"description": "DID of the moderated member.",
"format": "did",
"type": "string"
}
},
"required": [
"did"
],
"type": "object"
}
},
"parameters": {
"properties": {
"action": {
"description": "The moderation action to apply.",
"knownValues": [
"mute",
"unmute",
"deafen",
"undeafen",
"disconnect"
],
"type": "string"
},
"channel": {
"description": "AT-URI of the voice channel.",
"format": "at-uri",
"type": "string"
},
"community": {
"description": "AT-URI of the community the channel belongs to.",
"format": "at-uri",
"type": "string"
},
"target": {
"description": "DID of the member to moderate.",
"format": "did",
"type": "string"
}
},
"required": [
"community",
"channel",
"target",
"action"
],
"type": "params"
},
"type": "procedure"
}