# social.colibri.voice.moderate

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.voice.moderate)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.voice.moderate/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.voice.moderate/examples)

## Definitions

### `social.colibri.voice.moderate`

**Type**: `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).

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | 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.

## Raw Schema

```json
{
  "id": "social.colibri.voice.moderate",
  "defs": {
    "main": {
      "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)."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```