voice_get_user_state
voice_get_user_state
Section titled “voice_get_user_state”Category: voice
Fetch a user’s voice state in a guild (/guilds/\{guild.id\}/voice-states/\{user.id\}).
When to use
Section titled “When to use”When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to query |
user_id | string | yes | Member whose voice state to fetch |
Returns
Section titled “Returns”voice state shape (channel, mute/deaf flags, request_to_speak_timestamp).
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Discord guild (server) ID |
channel_id | unknown | yes | |
user_id | string | yes | Discord user ID |
session_id | string | yes | |
deaf | boolean | yes | |
mute | boolean | yes | |
self_deaf | boolean | yes | |
self_mute | boolean | yes | |
self_stream | boolean | no | |
self_video | boolean | yes | |
suppress | boolean | yes | |
request_to_speak_timestamp | unknown | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |