Soundboard

​

Overview

​

Endpoints

​

List Default Soundboard Sounds

export const listDefaultSoundboardSounds: Fetcher<
  null,
  SoundboardSound[]
> = async () => get(`/soundboard-default-sounds`);

​

Notes

• These are global sounds available to all Discord users
• No authentication required for this endpoint

​

List Guild Soundboard Sounds

export const listGuildSoundboardSounds: Fetcher<
  typeof listGuildSoundboardSoundsSchema,
  SoundboardSound[]
> = async ({ guild }) => get(`/guilds/${guild}/soundboard-sounds`);

​

Parameters

• guild - Guild ID (snowflake)

​

Get Guild Soundboard Sound

export const getGuildSoundboardSound: Fetcher<
  typeof getGuildSoundboardSoundSchema,
  SoundboardSound
> = async ({ guild, sound }) =>
  get(`/guilds/${guild}/soundboard-sounds/${sound}`);

​

Parameters

• guild - Guild ID (snowflake)
• sound - Sound ID (snowflake)

​

Create Guild Soundboard Sound

export const createGuildSoundboardSound: Fetcher<
  typeof createGuildSoundboardSoundSchema,
  SoundboardSound
> = async ({ guild, body }) => post(`/guilds/${guild}/soundboard-sounds`, body);

​

Parameters

• guild - Guild ID (snowflake)
• body.name - Name of the soundboard sound (required, 2-32 characters)
• body.sound - The mp3 or ogg sound data, base64 encoded, similar to image data (required, data URI)
• body.volumn - The volume of the soundboard sound, from 0 to 1 (optional, defaults to 1)
• body.emojiId - The ID of the custom emoji for the soundboard sound (optional, nullable, snowflake)
• body.emojiName - The unicode character of a standard emoji for the soundboard sound (optional, nullable)

​

Notes

• Soundboard sounds have a max file size of 512kb and a max duration of 5.2 seconds
• This endpoint supports the X-Audit-Log-Reason header

​

Modify Guild Soundboard Sound

export const modifyGuildSoundboardSound: Fetcher<
  typeof modifyGuildSoundboardSoundSchema,
  SoundboardSound
> = async ({ guild, sound, body }) =>
  patch(`/guilds/${guild}/soundboard-sounds/${sound}`, body);

​

Parameters

• guild - Guild ID (snowflake)
• sound - Sound ID (snowflake)
• body.name - Name of the soundboard sound (optional, 2-32 characters)
• body.volumn - The volume of the soundboard sound, from 0 to 1 (optional, nullable)
• body.emojiId - The ID of the custom emoji for the soundboard sound (optional, nullable, snowflake)
• body.emojiName - The unicode character of a standard emoji for the soundboard sound (optional, nullable)

​

Notes

• All parameters to this endpoint are optional
• This endpoint supports the X-Audit-Log-Reason header

​

Delete Guild Soundboard Sound

export const deleteGuildSoundboardSound: Fetcher<
  typeof deleteGuildSoundboardSoundSchema
> = async ({ guild, sound }) =>
  remove(`/guilds/${guild}/soundboard-sounds/${sound}`);

​

Parameters

• guild - Guild ID (snowflake)
• sound - Sound ID (snowflake)

​

Send Soundboard Sound

export const sendSoundboardSound: Fetcher<
  typeof sendSoundboardSoundSchema
> = async ({ channel, body }) =>
  post(`/channels/${channel}/send-soundboard-sound`, body);

​

Parameters

• channel - Voice channel ID (snowflake)
• body.soundId - The ID of the soundboard sound to play (required, snowflake)
• body.sourceGuildId - The ID of the guild the soundboard sound is from (optional, required to play sounds from different servers)

​

Notes

• Requires the SPEAK and USE_SOUNDBOARD permissions
• Also requires the USE_EXTERNAL_SOUNDS permission if the sound is from a different server
• User must be connected to the voice channel
• User’s voice state cannot have deaf, self_deaf, mute, or suppress enabled

​

Exports

​

Schema Exports

• listGuildSoundboardSoundsSchema
• getGuildSoundboardSoundSchema
• createGuildSoundboardSoundSchema
• modifyGuildSoundboardSoundSchema
• deleteGuildSoundboardSoundSchema
• sendSoundboardSoundSchema

​

Handler Exports

• listDefaultSoundboardSounds
• listDefaultSoundboardSoundsSafe
• listGuildSoundboardSounds
• listGuildSoundboardSoundsSafe
• getGuildSoundboardSound
• getGuildSoundboardSoundSafe
• createGuildSoundboardSound
• createGuildSoundboardSoundSafe
• modifyGuildSoundboardSound
• modifyGuildSoundboardSoundSafe
• deleteGuildSoundboardSound
• deleteGuildSoundboardSoundSafe
• sendSoundboardSound
• sendSoundboardSoundSafe

​

Query Exports

• listDefaultSoundboardSoundsQuery
• listGuildSoundboardSoundsQuery
• getGuildSoundboardSoundQuery

​

Procedure Exports

• listDefaultSoundboardSoundsProcedure
• listGuildSoundboardSoundsProcedure
• getGuildSoundboardSoundProcedure
• createGuildSoundboardSoundProcedure
• modifyGuildSoundboardSoundProcedure
• deleteGuildSoundboardSoundProcedure
• sendSoundboardSoundProcedure

​

Usage Example

import {
  listDefaultSoundboardSounds,
  listGuildSoundboardSounds,
  createGuildSoundboardSound,
  modifyGuildSoundboardSound,
  sendSoundboardSound,
  deleteGuildSoundboardSound
} from '@discordkit/client';

// List all default sounds
const defaultSounds = await listDefaultSoundboardSounds();

// List guild-specific sounds
const guildSounds = await listGuildSoundboardSounds({
  guild: '123456789'
});

// Create a new soundboard sound
const newSound = await createGuildSoundboardSound({
  guild: '123456789',
  body: {
    name: 'Epic Sound',
    sound: 'data:audio/mpeg;base64,//uQx...', // base64 encoded mp3/ogg
    volumn: 0.8,
    emojiName: '🎵'
  }
});

// Modify a soundboard sound
const updatedSound = await modifyGuildSoundboardSound({
  guild: '123456789',
  sound: newSound.id,
  body: {
    name: 'Even More Epic Sound',
    volumn: 0.9
  }
});

// Send a soundboard sound in a voice channel
await sendSoundboardSound({
  channel: '987654321',
  body: {
    soundId: newSound.id
  }
});

// Delete a soundboard sound
await deleteGuildSoundboardSound({
  guild: '123456789',
  sound: newSound.id
});

​

Sound Format Requirements

• Supported formats: MP3 or OGG
• Maximum file size: 512kb
• Maximum duration: 5.2 seconds
• Audio must be base64 encoded as a data URI

​

Permissions

• CREATE_GUILD_EXPRESSIONS - Required to create sounds
• MANAGE_GUILD_EXPRESSIONS - Required to modify/delete sounds created by others
• USE_SOUNDBOARD - Required to play sounds
• USE_EXTERNAL_SOUNDS - Required to play sounds from other servers
• SPEAK - Required to send sounds in voice channels