social.colibri.beta.voice.moderate

colibri.social

Documentation

Acts on someone in a voice channel. An absent field leaves the current value unchanged.

main procedure

Acts on someone in a voice channel. An absent field leaves the current value unchanged.

Input

Encodingapplication/json
channel stringspace-ref Required

The voice channel the subject is in.

deafened boolean Optional

Whether the subject cannot hear others. Absent leaves the current value unchanged.

disconnect boolean Optional

Whether to disconnect the subject from the channel.

muted boolean Optional

Whether the subject's microphone is muted. Absent leaves the current value unchanged.

subject stringdid Required

Who to act on.

Output

Encodingapplication/json

Errors

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.
VoiceUnavailable This AppView has no voice SFU running.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "channel",
        "subject"
      ],
      "properties": {
        "muted": {
          "type": "boolean",
          "description": "Whether the subject's microphone is muted. Absent leaves the current value unchanged."
        },
        "channel": {
          "type": "string",
          "format": "space-ref",
          "description": "The voice channel the subject is in."
        },
        "subject": {
          "type": "string",
          "format": "did",
          "description": "Who to act on."
        },
        "deafened": {
          "type": "boolean",
          "description": "Whether the subject cannot hear others. Absent leaves the current value unchanged."
        },
        "disconnect": {
          "type": "boolean",
          "description": "Whether to disconnect the subject from the channel."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "Forbidden",
      "description": "The requesting user lacks the voice.moderate permission."
    },
    {
      "name": "ChannelNotFound",
      "description": "No channel matches the given space reference."
    },
    {
      "name": "NotInVoice",
      "description": "The subject is not currently connected to the channel."
    },
    {
      "name": "VoiceUnavailable",
      "description": "This AppView has no voice SFU running."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "properties": {}
    },
    "encoding": "application/json"
  },
  "description": "Acts on someone in a voice channel. An absent field leaves the current value unchanged."
}

Lexicon Garden

@