Soundboard Resource
Users can play soundboard sounds in voice channels, triggering a Voice Channel Effect Send Gateway event for users connected to the voice channel.
There is a set of default sounds available to all users. Soundboard sounds can also be created in a guild; users will be able to use the sounds in the guild, and Nitro subscribers can use them in all guilds.
Soundboard sounds in a set of guilds can be retrieved over the Gateway using Request Soundboard Sounds.
Soundboard Sound Object
Section titled “Soundboard Sound Object”Soundboard Sound Structure
Section titled “Soundboard Sound Structure”| Field | Type | Description |
|---|---|---|
| name | string | the name of this sound |
| sound_id | snowflake | the id of this sound |
| volume | double | the volume of this sound, from 0 to 1 |
| emoji_id | ?snowflake | the id of this sound's custom emoji |
| emoji_name | ?string | the unicode character of this sound's standard emoji |
| guild_id? | snowflake | the id of the guild this sound is in |
| available | boolean | whether this sound can be used, may be false due to loss of Server Boosts |
| user? | user object | the user who created this sound |
Example Default Soundboard Sound
Section titled “Example Default Soundboard Sound”{
"name": "quack",
"sound_id": "1",
"volume": 1.0,
"emoji_id": null,
"emoji_name": "🦆",
"available": true
}Example Guild Soundboard Sound
Section titled “Example Guild Soundboard Sound”{
"name": "Yay",
"sound_id": "1106714396018884649",
"volume": 1,
"emoji_id": "989193655938064464",
"emoji_name": null,
"guild_id": "613425648685547541",
"available": true
}Sound Files
Section titled “Sound Files”A soundboard sound can be retrieved in MP3 or Ogg format at the URL:
https://cdn.discordapp.com/soundboard-sounds/{sound_id}Send Soundboard Sound
Section titled “Send Soundboard Sound”/channels/{channel.id}/send-soundboard-sound
Send a soundboard sound to a voice channel the user is connected to. Fires a Voice Channel Effect Send Gateway event.
Requires the SPEAK and USE_SOUNDBOARD permissions, and also the USE_EXTERNAL_SOUNDS permission if the sound is from a different server. Additionally, requires the user to be connected to the voice channel, having a voice state without deaf, self_deaf, mute, or suppress enabled.
JSON Params
Section titled “JSON Params”| Field | Type | Description |
|---|---|---|
| sound_id | snowflake | the id of the soundboard sound to play |
| source_guild_id? | snowflake | the id of the guild the soundboard sound is from, required to play sounds from different servers |
List Default Soundboard Sounds
Section titled “List Default Soundboard Sounds”/soundboard-default-sounds
Returns an array of soundboard sound objects that can be used by all users.
List Guild Soundboard Sounds
Section titled “List Guild Soundboard Sounds”/guilds/{guild.id}/soundboard-sounds
Returns a list of the guild's soundboard sounds. Includes user fields if the bot has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.
Response Structure
Section titled “Response Structure”| Field | Type |
|---|---|
| items | array of soundboard sound objects |
Get Guild Soundboard Sound
Section titled “Get Guild Soundboard Sound”/guilds/{guild.id}/soundboard-sounds/{sound.id}
Returns a soundboard sound object for the given sound id. Includes the user field if the bot has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.
Create Guild Soundboard Sound
Section titled “Create Guild Soundboard Sound”/guilds/{guild.id}/soundboard-sounds
Create a new soundboard sound for the guild. Requires the CREATE_GUILD_EXPRESSIONS permission. Returns the new soundboard sound object on success. Fires a Guild Soundboard Sound Create Gateway event.
JSON Params
Section titled “JSON Params”| Field | Type | Description |
|---|---|---|
| name | string | name of the soundboard sound (2-32 characters) |
| sound | data uri | the mp3 or ogg sound data, base64 encoded, similar to image data |
| volume? | ?double | the volume of the soundboard sound, from 0 to 1, defaults to 1 |
| emoji_id? | ?snowflake | the id of the custom emoji for the soundboard sound |
| emoji_name? | ?string | the unicode character of a standard emoji for the soundboard sound |
Modify Guild Soundboard Sound
Section titled “Modify Guild Soundboard Sound”/guilds/{guild.id}/soundboard-sounds/{sound.id}
Modify the given soundboard sound. For sounds created by the current user, requires either the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission. For other sounds, requires the MANAGE_GUILD_EXPRESSIONS permission. Returns the updated soundboard sound object on success. Fires a Guild Soundboard Sound Update Gateway event.
JSON Params
Section titled “JSON Params”| Field | Type | Description |
|---|---|---|
| name | string | name of the soundboard sound (2-32 characters) |
| volume | ?double | the volume of the soundboard sound, from 0 to 1 |
| emoji_id | ?snowflake | the id of the custom emoji for the soundboard sound |
| emoji_name | ?string | the unicode character of a standard emoji for the soundboard sound |
Delete Guild Soundboard Sound
Section titled “Delete Guild Soundboard Sound”/guilds/{guild.id}/soundboard-sounds/{sound.id}
Delete the given soundboard sound. For sounds created by the current user, requires either the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission. For other sounds, requires the MANAGE_GUILD_EXPRESSIONS permission. Returns 204 No Content on success. Fires a Guild Soundboard Sound Delete Gateway event.