Voz
Voice resources are used to interact with voice in Discord. For more information on connecting to voice, see the Voice Connections topic.
Used to represent a user's voice connection status.
guild_id? 1
?snowflake
The guild ID this voice state is for
channel_id
?snowflake
The channel ID this user is connected to
lobby_id?
snowflake
The ID of the lobby this user is connected to
user_id
snowflake
The user ID this voice state is for
session_id
string
The session ID this voice state is from
deaf
boolean
Whether this user is deafened by the guild, if any
mute
boolean
Whether this user is muted by the guild, if any
self_deaf
boolean
Whether this user is locally deafened
self_mute
boolean
Whether this user is locally muted
self_stream?
boolean
Whether this user is streaming using "Go Live"
self_video
boolean
Whether this user's camera is enabled
suppress
boolean
Whether this user's permission to speak is denied
request_to_speak_timestamp
?ISO8601 timestamp
When which the user requested to speak
user_volume? 2
float
Volume level of the user (0-100)
1 Omitted in the Gateway guild object.
2 Only available in OAuth2 contexts. For regular connections, user volumes are available in audio settings.
{ "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"}id
string
The unique ID for the region
name
string
The name of the region
optimal
boolean
Whether this is the closest to the current user's client
deprecated
boolean
Whether this is a deprecated voice region (avoid switching to these)
custom
boolean
Whether this is a custom voice region (used for events, etc.)
GET/voice/regions
Returns an array of voice region objects that can be used when setting a voice channel's .
GET/guilds/{guild.id}/regions
Returns a list of voice region objects that can be used when setting a voice channel's . Unlike the similar Get Voice Regions route, this returns VIP servers when the guild is VIP-enabled.
PUT/voice/public-keys
Uploads a persistent public key used for voice encryption. Returns a 204 empty response on success.
POST/voice/{user.id}/match-public-key
Verifies a user's persistent public key for voice encryption against their uploaded ones.
key_version
integer
The version of the persistent key protocol (currently 1)
is_match
boolean
Whether the public key matches one of the user's uploaded persistent public keys
GET/voice-filters/catalog
Returns the voice filters that can be used by the client.
models?
array[string]
The IDs of the ONNX models to return in the response
limited_time_voices
limited time voices object
The current sets of limited time voice filters available
models? 1
map[str, voice filter model object]
The ONNX machine learning models used by the voice filters
1 This field is empty if no models were provided in the query parameter in voice filter module versions 6 and above.
current_set
array[string]
The currently free voice filters
current_set_end
ISO8601 timestamp
When the current set will no longer be free
current_set_start
ISO8601 timestamp
When the current set will start being free
next_set
array[string]
The next set of voice filters that will be free
next_set_end
ISO8601 timestamp
When the next set ends
next_set_start
ISO8601 timestamp
When the next set starts
url
string
The CDN URL to the ONNX model
id
string
The ID of the voice filter
models? 1
array[string]
The IDs of the ONNX models used by the voice filter
requires_premium
boolean
Whether the voice filter requires a premium (Nitro) subscription
limited_time_free_ends?
ISO8601 timestamp
When the voice filter will no longer be free to use
limited_time_free_starts?
ISO8601 timestamp
When the voice filter will start being free to use
available
boolean
Whether the voice filter is available to use
1 This field is no longer used and is serialized as an empty object in voice filter module versions 6 and above.
{ "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 } ]}GET/guilds/{guild.id}/voice-states/@me
Returns the current user's voice state object in the guild.
GET/guilds/{guild.id}/voice-states/{user.id}
Returns the specified user's voice state object in the guild.
PATCH/guilds/{guild.id}/voice-states/@me
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.
channel_id?
snowflake
The ID of the channel the user is currently in
suppress?
boolean
Whether the user is suppressed in the channel
request_to_speak_timestamp?
?ISO8601 timestamp
When the user requested to speak
PATCH/guilds/{guild.id}/voice-states/{user.id}
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.
channel_id
snowflake
The ID of the channel the user is currently in
suppress?
boolean
Whether the user is suppressed in the channel
POST/channels/{channel.id}/voice-channel-effects
Sends a voice channel effect to a voice channel. Returns a 204 empty response on success. Fires a Voice Channel Effect Send Gateway event.
animation_id?
?integer
The ID of the emoji animation (0-20, default 0)
emoji_id?
?snowflake
The ID of the custom emoji to send
emoji_name?
?string
The emoji name or unicode character of the emoji to send
Voice Channel Effect Animation Type
0
PREMIUM
A fun animation, requires a premium (Nitro) subscription
1
BASIC
The standard animation
PATCH/streams/{stream_key}/stream
Modifies the stream. User must be the owner of the stream. Returns a 204 empty response on success. Fires a Stream Update Gateway event.
GET/streams/{stream_key}/preview
Returns a URL to a stream preview for the given stream key. Requires the permission in the stream's channel.
url
string
The CDN URL to the stream preview
POST/streams/{stream_key}/preview
Uploads a stream preview for the given stream key. User must be the owner of the stream. Returns a 204 empty response on success.
POST/streams/{stream_key}/preview/video
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.
file
file contents
The stream preview video to upload
POST/streams/{stream_key}/notify
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.