guild_list_voice_regions
guild_list_voice_regions
Section titled “guild_list_voice_regions”Category: guild
List voice regions available to a guild (incl. VIP regions).
When to use
Section titled “When to use”- Pick an
rtc_regionfor a voice/stage channel.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to query |
Returns
Section titled “Returns”\{regions:[\{id, name, optimal, deprecated, custom\}], count\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
regions | array | yes | |
count | integer | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |