Voice Resource

Voice State Object

Used to represent a user's voice connection status.

Voice State Structure
FieldTypeDescription
guild_id?snowflakethe guild id this voice state is for
channel_id?snowflakethe channel id this user is connected to
user_idsnowflakethe user id this voice state is for
member?guild member objectthe guild member this voice state is for
session_idstringthe session id for this voice state
deafbooleanwhether this user is deafened by the server
mutebooleanwhether this user is muted by the server
self_deafbooleanwhether this user is locally deafened
self_mutebooleanwhether this user is locally muted
self_stream?booleanwhether this user is streaming using "Go Live"
self_videobooleanwhether this user's camera is enabled
suppressbooleanwhether this user is muted by the current user
request_to_speak_timestamp?ISO8601 timestampthe time at which the user requested to speak
Example Voice State
json
{
"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
FieldTypeDescription
idstringunique ID for the region
namestringname of the region
vipbooleantrue if this is a vip-only server
optimalbooleantrue for a single server that is closest to the current user's client
deprecatedbooleanwhether this is a deprecated voice region (avoid switching to these)
custombooleanwhether this is a custom voice region (used for events/etc)

Endpoints

List Voice Regions

GET/voice/regions

Returns an array of voice region objects that can be used when creating servers.