Voice

Voice resources are used to interact with voice in Discord. For more information on connecting to voice, see the Voice Connections topic.

Voice State Object

Used to represent a user's voice connection status.

Voice State Structure

¹ Omitted in the Gateway guild object.

² Only available in OAuth2 contexts. For regular connections, user volumes are available in audio settings.

Example Voice State

{
  "channel_id": "157733188964188161",
  "user_id": "80351110224678912",
  "session_id": "90326bd25d71d39b9ef95b299e3872ff",
  "deaf": false,
  "mute": false,
  "self_deaf": false,
  "self_mute": true,
  "suppress": false,
  "request_to_speak_timestamp": "2021-03-31T18:45:31.297561+00:00"
}

Voice Region Object

Voice Region Structure

Endpoints

Returns an array of voice region objects that can be used when setting a voice channel's rtc_region.

Returns a list of voice region objects that can be used when setting a voice channel's rtc_region. Unlike the similar Get Voice Regions route, this returns VIP servers when the guild is VIP-enabled.

Uploads a persistent public key used for voice encryption. Returns a 204 empty response on success.

import base64
import requests
from cryptography.hazmat.primitives.asymmetric import ec
from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives import serialization

API_ENDPOINT = 'https://discord.com/api/v9'
private_key = ec.generate_private_key(ec.SECP256R1())
public_key = private_key.public_key().public_bytes(serialization.Encoding.X962, serialization.PublicFormat.CompressedPoint)

# https://datatracker.ietf.org/doc/html/rfc9000#name-variable-length-integer-enc
def encode_quic_varint(data: bytes) -> bytes:
    length = len(data)
    if length < 2**6:
        return bytes([length]) + data
    elif length < 2**14:
        return bytes([(1 << 6) | (length >> 8), length & 0xFF]) + data
    elif length < 2**30:
        return bytes([(2 << 6) | (length >> 24), (length >> 16) & 0xFF, (length >> 8) & 0xFF, length & 0xFF]) + data
    else:
        return bytes([(3 << 6) | (length >> 56), (length >> 48) & 0xFF, (length >> 40) & 0xFF, (length >> 32) & 0xFF, (length >> 24) & 0xFF, (length >> 16) & 0xFF, (length >> 8) & 0xFF, length & 0xFF]) + data

# https://datatracker.ietf.org/doc/html/rfc9420/#name-signing
def sign_with_label(private_key: ec.EllipticCurvePrivateKey, label: str, content: bytes) -> bytes:
    label_bytes = b'MLS 1.0 ' + label.encode('ascii')
    sign_content = encode_quic_varint(label_bytes) + encode_quic_varint(content)
    signature = private_key.sign(sign_content, ec.ECDSA(hashes.SHA256()))
    return signature

# The session ID is the static_client_session_id value from the READY payload
session_id = '00000000-0000-0000-0000-000000000000'.encode('ascii')
signature = sign_with_label(private_key, "DiscordSelfSignature", session_id + b':' + public_key)

data = {
    'key_version': 1,
    'public_key': 'data:application/octet-stream;base64,' + base64.b64encode(public_key).decode('utf-8'),
    'signature': 'data:application/octet-stream;base64,' + base64.b64encode(signature).decode('utf-8'),
}
headers = {
    'authorization': 'token',
    # Rest of headers here
}

r = requests.put('%s/voice/public-keys' % API_ENDPOINT, json=data, headers=headers)
r.raise_for_status()

JSON Params

Verifies a user's persistent public key for voice encryption against their uploaded ones.

JSON Params

Response Body

Returns the voice filters that can be used by the client.

Query String Params

Response Body

¹ This field is empty if no models were provided in the models query parameter in voice filter module versions 6 and above.

Limited Time Voices Structure

Voice Filter Model Structure

Voice Filter Structure

¹ This field is no longer used and is serialized as an empty object in voice filter module versions 6 and above.

Example Response

{
  "limited_time_voices": {
    "current_set": ["solara", "robot"],
    "current_set_start": "2025-05-22T00:00:00+00:00",
    "current_set_end": "2025-05-22T23:59:59+00:00",
    "next_set": ["tunes", "robot"],
    "next_set_start": "2025-05-23T00:00:00+00:00",
    "next_set_end": "2025-05-23T23:59:59+00:00"
  },
  "models": {
    "vocoder_large_1": {
      "url": "https://cdn.discordapp.com/assets/content/XXX.onnx"
    },
    "asr_large": {
      "url": "https://cdn.discordapp.com/assets/content/XXX.onnx"
    },
    "pitch_small_3": {
      "url": "https://cdn.discordapp.com/assets/content/XXX.onnx"
    }
  },
  "voices": [
    {
      "id": "skye",
      "models": ["vocoder_large_1", "asr_large", "pitch_small_3"],
      "requires_premium": true,
      "limited_time_free_ends": "2025-05-22T23:59:59+00:00",
      "limited_time_free_starts": "2025-05-22T00:00:00+00:00",
      "available": true
    }
  ]
}

Returns the current user's voice state object in the guild.

Returns the specified user's voice state object in the guild.

Updates the current user's voice state in the given guild ID. Returns a 204 empty response on success. Fires a Voice State Update Gateway event.

JSON Params

Updates another user's voice state in the given guild ID. Returns a 204 empty response on success. Fires a Voice State Update Gateway event.

JSON Params

Sends a voice channel effect to a voice channel. Returns a 204 empty response on success. Fires a Voice Channel Effect Send Gateway event.

JSON Params

Voice Channel Effect Animation Type

Modifies the stream. User must be the owner of the stream. Returns a 204 empty response on success. Fires a Stream Update Gateway event.

JSON Params

Returns a URL to a stream preview for the given stream key. Requires the CONNECT permission in the stream's channel.

Response Body

Uploads a stream preview for the given stream key. User must be the owner of the stream. Returns a 204 empty response on success.

JSON Params

Uploads a stream preview video for the given stream key. User must be the owner of the stream. Returns a 204 empty response on success.

Form Params

Broadcasts a stream notification to all friends of the current user that are in the same guild as the stream and have stream notifications enabled. User must be the owner of the stream and must be streaming in a guild. Returns a 204 empty response on success.