social.colibri.voice.moderate Documentation (EN)

main procedure

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

action string Required

The moderation action to apply.

channel stringat-uri Required

AT-URI of the voice channel.

community stringat-uri Required

AT-URI of the community the channel belongs to.

target stringdid Required

DID of the member to moderate.

Output

Encodingapplication/json

did 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.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

View raw schema

{
  "type": "procedure",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "Missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the permission this method requires."
    },
    {
      "name": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "DID of the moderated member."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community",
      "channel",
      "target",
      "action"
    ],
    "properties": {
      "action": {
        "type": "string",
        "description": "The moderation action to apply.",
        "knownValues": [
          "mute",
          "unmute",
          "deafen",
          "undeafen",
          "disconnect"
        ]
      },
      "target": {
        "type": "string",
        "format": "did",
        "description": "DID of the member to moderate."
      },
      "channel": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the voice channel."
      },
      "community": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the community the channel belongs to."
      }
    }
  },
  "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)."
}