Document Soundboard #6260

advaith1 · 2023-06-28T06:36:17Z

Documents soundboard sounds and management. When a soundboard sound is used, Voice Channel Effect Send is emitted, which is documented in #6025

airhorn sounds intensify

some notes:

Bots cannot use soundboard
Looks like GUILD_SOUNDBOARD_SOUND_CREATE, GUILD_SOUNDBOARD_SOUND_UPDATE, and GUILD_SOUNDBOARD_SOUND_DELETE are not tied to any intent currently, so they are sent to all bots
- They should probably be tied to GUILD_EMOJIS_AND_STICKERS (1 << 3), which should be renamed to GUILD_EXPRESSIONS
There is no GET route for individual sounds or a guild's list of sounds. Guild sound lists can currently only be retrieved via the Gateway. GET routes should be added
PATCHing a sound currently clears the sound's volume and emoji if those aren't included in the request.
- The PR documents this current behavior, let me know once it is fixed
~~Looks like id and sound_id are always the same, but id is optional~~ id is deprecated, removed from docs

edit: fixed all of these :)

valdotle · 2023-06-28T08:41:35Z

docs/resources/Soundboard.md

+| emoji_id      | ?snowflake                                      | the id of this sound's custom emoji                                                          |
+| emoji_name    | ?string                                         | the unicode character of this sound's standard emoji                                         |
+| override_path | ?string                                         | the filename of this sound (for default sounds)                                              |
+| guild_id?     | snowflake                                       | the id of the guild this sound is in                                                         |


docs/resources/Soundboard.md

valdotle · 2023-06-28T09:03:10Z

docs/resources/Soundboard.md

+
+Users can play soundboard sounds in voice channels, triggering a Voice Channel Effect Send Gateway event for users connected to the voice channel. Bots cannot play soundboard sounds. Soundboard use is controlled by the `USE_SOUNDBOARD` and `USE_EXTERNAL_SOUNDS` [permissions](#DOCS_TOPICS_PERMISSIONS).
+
+There is a set of [default sounds](#DOCS_RESOURCES_SOUNDBOARD/list-soundboard-default-sounds) available to all users. Soundboard sounds can also be [created in a guild](#DOCS_RESOURCES_SOUNDBOARD/create-guild-soundboard-sound); users will be able to use the sounds in the guild, and Nitro subscribers can use them in all guilds.


Suggested change

There is a set of [default sounds](#DOCS_RESOURCES_SOUNDBOARD/list-soundboard-default-sounds) available to all users. Soundboard sounds can also be [created in a guild](#DOCS_RESOURCES_SOUNDBOARD/create-guild-soundboard-sound); users will be able to use the sounds in the guild, and Nitro subscribers can use them in all guilds.

There is a set of [default sounds](#DOCS_RESOURCES_SOUNDBOARD/list-soundboard-default-sounds) available to all users. Soundboard sounds can also be [created in a guild](#DOCS_RESOURCES_SOUNDBOARD/create-guild-soundboard-sound); users will be able to use the sounds in this guild, and Nitro subscribers can use them in any guild.

docs/resources/Soundboard.md

valdotle · 2023-06-28T09:10:03Z

docs/resources/Soundboard.md

+| Field         | Type                                            | Description                                                                                  |
+| ------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| name          | string                                          | the name of this sound                                                                       |
+| sound_id      | snowflake                                       | the id of this sound                                                                         |


docs/resources/Soundboard.md

valdotle · 2023-06-28T09:18:04Z

docs/resources/Soundboard.md

+| available?    | boolean                                         | whether this sound can be used (for guild sounds), may be false due to loss of Server Boosts |
+| user?         | [user](#DOCS_RESOURCES_USER/user-object) object | the user who created this sound                                                              |
+
+### Sound Files


maybe that could be integrated into the reference section somehow, since that's the only place where CDN endpoints are currently listed...

Co-authored-by: Valle <[email protected]>

docs/resources/Soundboard.md

cobaltt7 · 2023-08-18T23:26:05Z

is there a status on this?

MinnDevelopment · 2023-09-02T21:16:32Z

What is holding this back?

codeofandrin · 2023-10-21T13:53:47Z

What is holding this back?

Maybe the conflicts

codeofandrin · 2023-10-22T18:50:14Z

override_path doesn't exist anymore. For default sounds the /soundboard-sounds/sound_id is used as well for the CDN path. E.g. https://cdn.discordapp.com/soundboard-sounds/7 is the "ba dum tss" sound.
Also, there's no format. Means, if you download it you have to change the format yourself in order to play the sound, looks like this is not intended.

codeofandrin · 2023-10-26T20:35:08Z

soundboard_sounds field is available in the Guild Create event. Has to be added to the extra fields: https://discord.com/developers/docs/topics/gateway-events#guild-create-guild-create-extra-fields

codeofandrin · 2023-10-29T18:56:29Z

The SOUNDBOARD_SOUNDS event is missing in the receive events list.

advaith1 · 2024-07-29T21:14:28Z

heads up we are removing the user_id field on soundboard sounds. you will still get user if you have Manage Expressions

codeofandrin · 2024-08-06T14:56:00Z

GET /guilds/{guild_id}/soundboard-sounds and GET /guilds/{guild_id}/soundboard-sounds/{sound_id} are missing.

/guilds/{guild_id}/soundboard-sounds returns items which is a list of sound objects:

{
    "items": [
        {
            "available": true,
            "emoji_id": null,
            ...
        },
        ...
    ]
}

advaith1 · 2024-08-06T16:49:05Z

yeah I made those endpoints last week and didn't update the pr yet because there are some other things we are changing

codeofandrin · 2024-08-07T10:20:51Z

heads up we are removing the user_id field on soundboard sounds. you will still get user if you have Manage Expressions

user_id is still sent instead of user in the GUILD_CREATE event. Will this also be changed?

advaith1 · 2024-08-07T15:05:11Z

I think we will only send the user field over API and gateway will eventually not include user data, like emoji and stickers

codeofandrin

Typos + add information when CREATE_GUILD_EXPRESSIONS perm is sufficient in get soundboard sounds.

docs/resources/Soundboard.md

Lulalaby · 2024-09-05T12:56:10Z

docs/resources/Soundboard.md

+| Field      | Type                                            | Description                                                               |
+|------------|-------------------------------------------------|---------------------------------------------------------------------------|
+| name       | string                                          | the name of this sound                                                    |
+| sound_id   | snowflake                                       | the id of this sound                                                      |


why is it sound_id instead of id like for other snowflake objects?

there used to be an id field, they got rid of it and perhaps didn't see a point in breaking and changing the name

colinloretz

🎁 🚀

See discord/discord-api-docs#6260 and discord/discord-api-docs#7207.

Document Soundboard

b8f501e

valdotle reviewed Jun 28, 2023

View reviewed changes

typo

024e9f1

Co-authored-by: Valle <[email protected]>

valdotle reviewed Jun 28, 2023

View reviewed changes

docs/resources/Soundboard.md Outdated Show resolved Hide resolved

fix guild_ids desc

c08c6a9

advaith1 mentioned this pull request Jun 28, 2023

feat: soundboard discordjs/discord-api-types#780

Closed

sebm253 mentioned this pull request Jun 28, 2023

Add Soundboard disgoorg/disgo#283

Merged

3 tasks

teaishealthy mentioned this pull request Jun 30, 2023

Add Support for Discord Soundboard nextcord/nextcord#1047

Open

shiftinv mentioned this pull request Jul 3, 2023

feat: soundboard DisnakeDev/disnake#1068

Merged

8 tasks

Panthr75 mentioned this pull request Jul 14, 2023

[Feature] Soundboard support discord-net/Discord.Net#2667

Draft

9 tasks

valdotle mentioned this pull request Jul 17, 2023

Document permission splits for expressions and events #6305

Merged

teaishealthy mentioned this pull request Aug 17, 2023

feat: soundboard nextcord/nextcord#1112

Draft

7 tasks

JustaSqu1d mentioned this pull request Aug 19, 2023

Soundboard Pycord-Development/pycord#2216

Closed

seailz mentioned this pull request Sep 3, 2023

[Feature Request] Soundboard discord-jar/discord.jar#221

Open

3 tasks

codeofandrin mentioned this pull request Oct 29, 2023

Support for Soundboard and VC effects Rapptz/discord.py#9349

Merged

6 tasks

bsian03 mentioned this pull request Jan 17, 2024

Hello! abalabahaha/eris#1464

Open

55 tasks

colinloretz self-assigned this May 13, 2024

colinloretz self-requested a review May 14, 2024 20:44

advaith1 added 3 commits May 15, 2024 08:53

Merge branch 'main' into soundboard

d99a5c1

update table formatting

8aef30a

updates

ea41d44

advaith1 force-pushed the soundboard branch from 5693da8 to ea41d44 Compare May 16, 2024 06:25

add audit log events

e78e753

sebm253 mentioned this pull request May 16, 2024

Add GuildVoiceChannelEffectSend disgoorg/disgo#282

Merged

1 task

advaith1 added 4 commits August 14, 2024 17:04

updates

8b05cc6

Merge branch 'main' into pr/6260

6a61661

changelog

4c2c182

fix links

292f14f

This comment was marked as resolved.

Sign in to view

codeofandrin reviewed Aug 15, 2024

View reviewed changes

docs/resources/Soundboard.md Outdated Show resolved Hide resolved

docs/resources/Soundboard.md Show resolved Hide resolved

fix get permissions

ea5fd67

valdotle reviewed Aug 17, 2024

View reviewed changes

docs/resources/Soundboard.md Outdated Show resolved Hide resolved

advaith1 added 5 commits August 26, 2024 15:46

Merge branch 'main' into pr/6260

1b89fe9

link to vc effect event

7359836

constants

5a13333

re-add changelog

3c61875

fix link again

451010c

Lulalaby reviewed Sep 5, 2024

View reviewed changes

advaith1 added 2 commits September 19, 2024 22:36

fixes and examples

f4c5ff3

delete extra line

8069f6a

colinloretz approved these changes Sep 20, 2024

View reviewed changes

advaith1 merged commit 90b8e8c into discord:main Sep 20, 2024

Fleny113 mentioned this pull request Sep 22, 2024

feat(bot,rest,gateway,utils,types)!: Add soundboard support discordeno/discordeno#3919

Merged

socram03 mentioned this pull request Sep 27, 2024

feat: Soundboard API tiramisulabs/seyfert#267

Merged

7 tasks

This was referenced Oct 4, 2024

feat: soundboard discordjs/discord-api-types#1113

Merged

feat: add soundboard discordjs/discord.js#10536

Merged

sdanialraza mentioned this pull request Nov 5, 2024

fix: add missing soundboard types discordjs/discord-api-types#1134

Merged

Nihlus added a commit to Remora/Remora.Discord that referenced this pull request Feb 12, 2025

Implement support for soundboards.

55330cd

See discord/discord-api-docs#6260 and discord/discord-api-docs#7207.

mazylol pushed a commit to mazylol/discord-api-docs that referenced this pull request Jul 3, 2025

Document Soundboard (discord#6260)

ac5a39c

	\| guild_id? \| snowflake \| the id of the guild this sound is in \|
	\| guild_id? \| snowflake \| the id of the guild this sound belongs to \|


		Users can play soundboard sounds in voice channels, triggering a Voice Channel Effect Send Gateway event for users connected to the voice channel. Bots cannot play soundboard sounds. Soundboard use is controlled by the `USE_SOUNDBOARD` and `USE_EXTERNAL_SOUNDS` [permissions](#DOCS_TOPICS_PERMISSIONS).

		There is a set of [default sounds](#DOCS_RESOURCES_SOUNDBOARD/list-soundboard-default-sounds) available to all users. Soundboard sounds can also be [created in a guild](#DOCS_RESOURCES_SOUNDBOARD/create-guild-soundboard-sound); users will be able to use the sounds in the guild, and Nitro subscribers can use them in all guilds.

	\| sound_id \| snowflake \| the id of this sound \|
	\| sound_id \| snowflake \| the id of this [sound](#DOCS_RESOURCES_SOUNDBOARD/sound-files) \|

Document Soundboard #6260

Document Soundboard #6260

Uh oh!

Conversation

advaith1 commented Jun 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

valdotle Jun 28, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

valdotle Jun 28, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

valdotle Jun 28, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

valdotle Jun 28, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cobaltt7 commented Aug 18, 2023

Uh oh!

MinnDevelopment commented Sep 2, 2023

Uh oh!

codeofandrin commented Oct 21, 2023

Uh oh!

codeofandrin commented Oct 22, 2023

Uh oh!

codeofandrin commented Oct 26, 2023

Uh oh!

codeofandrin commented Oct 29, 2023

Uh oh!

advaith1 commented Jul 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codeofandrin commented Aug 6, 2024

Uh oh!

advaith1 commented Aug 6, 2024

Uh oh!

codeofandrin commented Aug 7, 2024

Uh oh!

advaith1 commented Aug 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

codeofandrin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lulalaby Sep 5, 2024

Choose a reason for hiding this comment

Uh oh!

sebm253 Sep 5, 2024

Choose a reason for hiding this comment

Uh oh!

colinloretz left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

advaith1 commented Jun 28, 2023 •

edited

Loading

advaith1 commented Jul 29, 2024 •

edited

Loading

advaith1 commented Aug 7, 2024 •

edited

Loading