discord-api-types/v6
Index
Enumerations
- ActivityFlags
- ActivityType
- AllowedMentionsTypes
- AuditLogEvent
- AuditLogOptionsType
- ChannelType
- ConnectionVisibility
- EmbedType
- GatewayCloseCodes
- GatewayDispatchEvents
- GatewayIntentBits
- GatewayOPCodes
- GuildDefaultMessageNotifications
- GuildExplicitContentFilter
- GuildFeature
- GuildMFALevel
- GuildPremiumTier
- GuildSystemChannelFlags
- GuildVerificationLevel
- GuildWidgetStyle
- IntegrationExpireBehavior
- InviteTargetUserType
- MessageActivityType
- MessageFlags
- MessageType
- OverwriteType
- PresenceUpdateStatus
- TeamMemberMembershipState
- UserFlags
- UserPremiumType
- VoiceCloseCodes
- VoiceOPCodes
- WebhookType
Interfaces
- APIAllowedMentionsSend
- APIApplication
- APIAttachment
- APIAuditLog
- APIAuditLogChangeKeyID
- APIAuditLogEntry
- APIAuditLogOptions
- APIBan
- APIChannel
- APIChannelMention
- APIConnection
- APIEmbed
- APIEmbedAuthor
- APIEmbedField
- APIEmbedFooter
- APIEmbedImage
- APIEmbedProvider
- APIEmbedThumbnail
- APIEmbedVideo
- APIEmoji
- APIExtendedInvite
- APIFollowedChannel
- APIGatewayBotInfo
- APIGatewayInfo
- APIGatewaySessionStartLimit
- APIGuild
- APIGuildCreateOverwrite
- APIGuildCreateRole
- APIGuildIntegration
- APIGuildIntegrationApplication
- APIGuildMember
- APIGuildPreview
- APIGuildWelcomeScreen
- APIGuildWelcomeScreenChannel
- APIGuildWidgetSettings
- APIIntegrationAccount
- APIInvite
- APIMessage
- APIMessageActivity
- APIMessageApplication
- APIMessageReference
- APIOverwrite
- APIOverwriteSend
- APIPartialChannel
- APIPartialEmoji
- APIPartialGuild
- APIReaction
- APIRole
- APIRoleTags
- APITeam
- APITeamMember
- APIUnavailableGuild
- APIUser
- APIVoiceRegion
- APIWebhook
- GatewayActivity
- GatewayActivityParty
- GatewayActivityTimestamps
- GatewayHeartbeat
- GatewayHeartbeatAck
- GatewayHeartbeatRequest
- GatewayHello
- GatewayIdentify
- GatewayIdentifyProperties
- GatewayInvalidSession
- GatewayPresenceUpdate
- GatewayPresenceUpdateData
- GatewayReconnect
- GatewayRequestGuildMembers
- GatewayResume
- GatewayUpdatePresence
- GatewayVoiceState
- GatewayVoiceStateUpdate
- RESTAPIPartialCurrentUserGuild
- RESTGetAPIAuditLogQuery
- RESTGetAPIChannelMessageReactionsQuery
- RESTGetAPIChannelMessagesQuery
- RESTGetAPICurrentUserGuildsQuery
- RESTGetAPIGuildIntegrationsQuery
- RESTGetAPIGuildMembersQuery
- RESTGetAPIGuildMembersSearchQuery
- RESTGetAPIGuildPruneCountQuery
- RESTGetAPIGuildPruneCountResult
- RESTGetAPIGuildQuery
- RESTGetAPIGuildVanityUrlResult
- RESTGetAPIGuildWidgetImageQuery
- RESTGetAPIInviteQuery
- RESTOAuth2AdvancedBotAuthorizationQuery
- RESTOAuth2AdvancedBotAuthorizationQueryResult
- RESTOAuth2AuthorizationQuery
- RESTOAuth2AuthorizationQueryResult
- RESTOAuth2BotAuthorizationQuery
- RESTOAuth2ImplicitAuthorizationQuery
- RESTPatchAPIChannelJSONBody
- RESTPatchAPIChannelMessageJSONBody
- RESTPatchAPICurrentGuildMemberNicknameJSONBody
- RESTPatchAPICurrentUserJSONBody
- RESTPatchAPIGuildEmojiJSONBody
- RESTPatchAPIGuildIntegrationJSONBody
- RESTPatchAPIGuildJSONBody
- RESTPatchAPIGuildMemberJSONBody
- RESTPatchAPIGuildRoleJSONBody
- RESTPatchAPIWebhookJSONBody
- RESTPostAPIChannelFollowersJSONBody
- RESTPostAPIChannelInviteJSONBody
- RESTPostAPIChannelMessageJSONBody
- RESTPostAPIChannelMessagesBulkDeleteJSONBody
- RESTPostAPIChannelWebhookJSONBody
- RESTPostAPICurrentUserCreateDMChannelJSONBody
- RESTPostAPIGuildEmojiJSONBody
- RESTPostAPIGuildIntegrationJSONBody
- RESTPostAPIGuildPruneJSONBody
- RESTPostAPIGuildPruneResult
- RESTPostAPIGuildRoleJSONBody
- RESTPostAPIGuildsJSONBody
- RESTPostAPIWebhookWithTokenJSONBody
- RESTPostAPIWebhookWithTokenQuery
- RESTPostOAuth2AccessTokenResult
- RESTPostOAuth2AccessTokenURIEncodedData
- RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult
- RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult
- RESTPostOAuth2ClientCredentialsURIEncodedData
- RESTPostOAuth2RefreshTokenURIEncodedData
- RESTPutAPIChannelPermissionsJSONBody
- RESTPutAPIChannelRecipientJSONBody
- RESTPutAPIGuildBanJSONBody
- RESTPutAPIGuildMemberJSONBody
References
Type aliases
- APIAuditLogChange
- APIAuditLogChangeKey$Add
- APIAuditLogChangeKey$Remove
- APIAuditLogChangeKeyAFKChannelID
- APIAuditLogChangeKeyAFKTimeout
- APIAuditLogChangeKeyAllow
- APIAuditLogChangeKeyAllowNew
- APIAuditLogChangeKeyApplicationID
- APIAuditLogChangeKeyAvatarHash
- APIAuditLogChangeKeyBitrate
- APIAuditLogChangeKeyChannelID
- APIAuditLogChangeKeyCode
- APIAuditLogChangeKeyColor
- APIAuditLogChangeKeyDeaf
- APIAuditLogChangeKeyDefaultMessageNotifications
- APIAuditLogChangeKeyDeny
- APIAuditLogChangeKeyDenyNew
- APIAuditLogChangeKeyEnableEmoticons
- APIAuditLogChangeKeyExpireBehavior
- APIAuditLogChangeKeyExpireGracePeriod
- APIAuditLogChangeKeyExplicitContentFilter
- APIAuditLogChangeKeyHoist
- APIAuditLogChangeKeyIconHash
- APIAuditLogChangeKeyInviterID
- APIAuditLogChangeKeyMFALevel
- APIAuditLogChangeKeyMaxAge
- APIAuditLogChangeKeyMaxUses
- APIAuditLogChangeKeyMentionable
- APIAuditLogChangeKeyMute
- APIAuditLogChangeKeyNSFW
- APIAuditLogChangeKeyName
- APIAuditLogChangeKeyNick
- APIAuditLogChangeKeyOwnerID
- APIAuditLogChangeKeyPermissionOverwrites
- APIAuditLogChangeKeyPermissions
- APIAuditLogChangeKeyPermissionsNew
- APIAuditLogChangeKeyPosition
- APIAuditLogChangeKeyPruneDeleteDays
- APIAuditLogChangeKeyRateLimitPerUser
- APIAuditLogChangeKeyRegion
- APIAuditLogChangeKeySplashHash
- APIAuditLogChangeKeySystemChannelID
- APIAuditLogChangeKeyTemporary
- APIAuditLogChangeKeyTopic
- APIAuditLogChangeKeyType
- APIAuditLogChangeKeyUses
- APIAuditLogChangeKeyVanityURLCode
- APIAuditLogChangeKeyVerificationLevel
- APIAuditLogChangeKeyWidgetChannelID
- APIAuditLogChangeKeyWidgetEnabled
- APIGuildCreatePartialChannel
- APIGuildWidget
- GatewayActivityAssets
- GatewayActivityEmoji
- GatewayActivitySecrets
- GatewayChannelCreateDispatch
- GatewayChannelDeleteDispatch
- GatewayChannelModifyDispatch
- GatewayChannelPinsUpdateDispatch
- GatewayChannelUpdateDispatch
- GatewayDispatchPayload
- GatewayGuildBanAddDispatch
- GatewayGuildBanModifyDispatch
- GatewayGuildBanRemoveDispatch
- GatewayGuildCreateDispatch
- GatewayGuildDeleteDispatch
- GatewayGuildEmojisUpdateDispatch
- GatewayGuildIntegrationsUpdateDispatch
- GatewayGuildMemberAddDispatch
- GatewayGuildMemberRemoveDispatch
- GatewayGuildMemberUpdateDispatch
- GatewayGuildMembersChunkDispatch
- GatewayGuildModifyDispatch
- GatewayGuildRoleCreateDispatch
- GatewayGuildRoleDeleteDispatch
- GatewayGuildRoleModifyDispatch
- GatewayGuildRoleUpdateDispatch
- GatewayGuildUpdateDispatch
- GatewayInviteCreateDispatch
- GatewayInviteDeleteDispatch
- GatewayMessageCreateDispatch
- GatewayMessageDeleteBulkDispatch
- GatewayMessageDeleteDispatch
- GatewayMessageReactionAddDispatch
- GatewayMessageReactionRemoveAllDispatch
- GatewayMessageReactionRemoveDispatch
- GatewayMessageReactionRemoveEmojiDispatch
- GatewayMessageUpdateDispatch
- GatewayPresenceClientStatus
- GatewayPresenceUpdateDispatch
- GatewayReadyDispatch
- GatewayReceivePayload
- GatewayResumedDispatch
- GatewaySendPayload
- GatewayTypingStartDispatch
- GatewayUserUpdateDispatch
- GatewayVoiceServerUpdateDispatch
- GatewayVoiceStateUpdateDispatch
- GatewayWebhooksUpdateDispatch
- GetAPIVoiceRegionsResult
- RESTDeleteAPIChannelAllMessageReactionsResult
- RESTDeleteAPIChannelMessageReactionResult
- RESTDeleteAPIChannelMessageResult
- RESTDeleteAPIChannelPermissionsResult
- RESTDeleteAPIChannelPinResult
- RESTDeleteAPIChannelRecipientResult
- RESTDeleteAPIChannelResult
- RESTDeleteAPICurrentUserGuildResult
- RESTDeleteAPIGuildBanResult
- RESTDeleteAPIGuildEmojiResult
- RESTDeleteAPIGuildIntegrationResult
- RESTDeleteAPIGuildMemberResult
- RESTDeleteAPIGuildMemberRoleResult
- RESTDeleteAPIGuildResult
- RESTDeleteAPIGuildRoleResult
- RESTDeleteAPIInviteResult
- RESTDeleteAPIWebhookResult
- RESTDeleteAPIWebhookWithTokenResult
- RESTGetAPIAuditLogResult
- RESTGetAPIChannelInvitesResult
- RESTGetAPIChannelMessageReactionsResult
- RESTGetAPIChannelMessageResult
- RESTGetAPIChannelMessagesResult
- RESTGetAPIChannelPinsResult
- RESTGetAPIChannelResult
- RESTGetAPIChannelWebhooksResult
- RESTGetAPICurrentUserConnectionsResult
- RESTGetAPICurrentUserGuildsResult
- RESTGetAPICurrentUserResult
- RESTGetAPIGatewayBotResult
- RESTGetAPIGatewayResult
- RESTGetAPIGuildBanResult
- RESTGetAPIGuildBansResult
- RESTGetAPIGuildChannelsResult
- RESTGetAPIGuildEmojiResult
- RESTGetAPIGuildEmojisResult
- RESTGetAPIGuildIntegrationsResult
- RESTGetAPIGuildInvitesResult
- RESTGetAPIGuildMemberResult
- RESTGetAPIGuildMembersResult
- RESTGetAPIGuildMembersSearchResult
- RESTGetAPIGuildPreviewResult
- RESTGetAPIGuildResult
- RESTGetAPIGuildRolesResult
- RESTGetAPIGuildVoiceRegionsResult
- RESTGetAPIGuildWebhooksResult
- RESTGetAPIGuildWidgetImageResult
- RESTGetAPIGuildWidgetResult
- RESTGetAPIGuildWidgetSettingsResult
- RESTGetAPIInviteResult
- RESTGetAPIOauth2CurrentApplicationResult
- RESTGetAPIUserResult
- RESTGetAPIWebhookResult
- RESTGetAPIWebhookWithTokenResult
- RESTOAuth2ImplicitAuthorizationURIFragmentResult
- RESTPatchAPIChannelMessageResult
- RESTPatchAPIChannelResult
- RESTPatchAPICurrentGuildMemberNicknameResult
- RESTPatchAPICurrentUserResult
- RESTPatchAPIGuildChannelPositionsJSONBody
- RESTPatchAPIGuildChannelPositionsResult
- RESTPatchAPIGuildEmojiResult
- RESTPatchAPIGuildIntegrationResult
- RESTPatchAPIGuildMemberResult
- RESTPatchAPIGuildResult
- RESTPatchAPIGuildRolePositionsJSONBody
- RESTPatchAPIGuildRolePositionsResult
- RESTPatchAPIGuildRoleResult
- RESTPatchAPIGuildWidgetJSONBody
- RESTPatchAPIGuildWidgetResult
- RESTPatchAPIGuildWidgetSettingsJSONBody
- RESTPatchAPIGuildWidgetSettingsResult
- RESTPatchAPIWebhookResult
- RESTPatchAPIWebhookWithTokenJSONBody
- RESTPatchAPIWebhookWithTokenResult
- RESTPostAPIChannelFollowersResult
- RESTPostAPIChannelMessageCrosspostResult
- RESTPostAPIChannelMessageFormDataBody
- RESTPostAPIChannelMessageResult
- RESTPostAPIChannelMessagesBulkDeleteResult
- RESTPostAPIChannelTypingResult
- RESTPostAPIChannelWebhookResult
- RESTPostAPICurrentUserCreateDMChannelResult
- RESTPostAPIGuildChannelJSONBody
- RESTPostAPIGuildChannelResult
- RESTPostAPIGuildEmojiResult
- RESTPostAPIGuildIntegrationResult
- RESTPostAPIGuildIntegrationSyncResult
- RESTPostAPIGuildRoleResult
- RESTPostAPIGuildsResult
- RESTPostAPIWebhookWithTokenFormDataBody
- RESTPostAPIWebhookWithTokenGitHubQuery
- RESTPostAPIWebhookWithTokenResult
- RESTPostAPIWebhookWithTokenSlackQuery
- RESTPostAPIWebhookWithTokenWaitResult
- RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult
- RESTPostOAuth2ClientCredentialsResult
- RESTPostOAuth2RefreshTokenResult
- RESTPutAPIChannelMessageReactionResult
- RESTPutAPIChannelPermissionsResult
- RESTPutAPIChannelPinResult
- RESTPutAPIChannelRecipientResult
- RESTPutAPIGuildBanResult
- RESTPutAPIGuildMemberResult
- RESTPutAPIGuildMemberRoleResult
Variables
References
FormattingPatterns
GatewayURLQuery
Locale
LocaleString
RESTJSONErrorCodes
Snowflake
Type aliases
APIAuditLogChange
APIAuditLogChangeKey$Add
Returned when new role(s) are added
APIAuditLogChangeKey$Remove
Returned when role(s) are removed
APIAuditLogChangeKeyAFKChannelID
Returned when a guild’s afk_channel_id is changed
APIAuditLogChangeKeyAFKTimeout
Returned when a guild’s afk_timeout is changed
APIAuditLogChangeKeyAllow
Returned when an overwrite’s allowed permissions bitfield is changed
APIAuditLogChangeKeyAllowNew
Returned when an overwrite’s allowed permissions bitfield is changed
APIAuditLogChangeKeyApplicationID
The application ID of the added or removed Webhook or Bot
APIAuditLogChangeKeyAvatarHash
Returned when a user’s avatar_hash is changed
APIAuditLogChangeKeyBitrate
Returned when a voice channel’s bitrate is changed
APIAuditLogChangeKeyChannelID
Returned when an invite’s channel_id is changed
APIAuditLogChangeKeyCode
Returned when an invite’s code is changed
APIAuditLogChangeKeyColor
Returned when a role’s color is changed
APIAuditLogChangeKeyDeaf
Returned when a user’s deaf status is changed
APIAuditLogChangeKeyDefaultMessageNotifications
Returned when a guild’s default_message_notifications is changed
APIAuditLogChangeKeyDeny
Returned when an overwrite’s denied permissions bitfield is changed
APIAuditLogChangeKeyDenyNew
Returned when an overwrite’s denied permissions bitfield is changed
APIAuditLogChangeKeyEnableEmoticons
Returned when an integration’s enable_emoticons is changed
APIAuditLogChangeKeyExpireBehavior
Returned when an integration’s expire_behavior is changed
APIAuditLogChangeKeyExpireGracePeriod
Returned when an integration’s expire_grace_period is changed
APIAuditLogChangeKeyExplicitContentFilter
Returned when a guild’s explicit_content_filter is changed
APIAuditLogChangeKeyHoist
Returned when a role’s hoist status is changed
APIAuditLogChangeKeyIconHash
Returned when a guild’s icon is changed
APIAuditLogChangeKeyInviterID
Returned when an invite’s inviter_id is changed
APIAuditLogChangeKeyMFALevel
Returned when a guild’s mfa_level is changed
APIAuditLogChangeKeyMaxAge
Returned when an invite’s max_age is changed
APIAuditLogChangeKeyMaxUses
Returned when an invite’s max_uses is changed
APIAuditLogChangeKeyMentionable
Returned when a role’s mentionable status is changed
APIAuditLogChangeKeyMute
Returned when a user’s mute status is changed
APIAuditLogChangeKeyNSFW
Returned when a channel’s NSFW restriction is changed
APIAuditLogChangeKeyName
Returned when a guild’s name is changed
APIAuditLogChangeKeyNick
Returned when a user’s nick is changed
APIAuditLogChangeKeyOwnerID
Returned when a guild’s owner ID is changed
APIAuditLogChangeKeyPermissionOverwrites
Returned when a channel’s permission overwrites is changed
APIAuditLogChangeKeyPermissions
Returned when a permission bitfield is changed
APIAuditLogChangeKeyPermissionsNew
Returned when a permission bitfield is changed
APIAuditLogChangeKeyPosition
Returned when a channel’s position is changed
APIAuditLogChangeKeyPruneDeleteDays
Returned when there is a change in number of days after which inactive and role-unassigned members are kicked
APIAuditLogChangeKeyRateLimitPerUser
Returned when a channel’s amount of seconds a user has to wait before sending another message is changed
APIAuditLogChangeKeyRegion
Returned when a guild’s region is changed
APIAuditLogChangeKeySplashHash
Returned when a guild’s splash is changed
APIAuditLogChangeKeySystemChannelID
Returned when a guild’s system_channel_id is changed
APIAuditLogChangeKeyTemporary
Returned when an invite’s temporary status is changed
APIAuditLogChangeKeyTopic
Returned when a channel’s topic is changed
APIAuditLogChangeKeyType
The type of entity created
APIAuditLogChangeKeyUses
Returned when an invite’s uses is changed
APIAuditLogChangeKeyVanityURLCode
Returned when a guild’s vanity_url_code is changed
APIAuditLogChangeKeyVerificationLevel
Returned when a guild’s verification_level is changed
APIAuditLogChangeKeyWidgetChannelID
Returned when a guild’s widget_channel_id is changed
APIAuditLogChangeKeyWidgetEnabled
Returned when a guild’s widget is enabled
APIGuildCreatePartialChannel
APIGuildWidget
GatewayActivityAssets
GatewayActivityEmoji
GatewayActivitySecrets
GatewayChannelCreateDispatch
GatewayChannelDeleteDispatch
GatewayChannelModifyDispatch
GatewayChannelPinsUpdateDispatch
GatewayChannelUpdateDispatch
GatewayDispatchPayload
GatewayGuildBanAddDispatch
GatewayGuildBanModifyDispatch
GatewayGuildBanRemoveDispatch
GatewayGuildCreateDispatch
GatewayGuildDeleteDispatch
GatewayGuildEmojisUpdateDispatch
GatewayGuildIntegrationsUpdateDispatch
GatewayGuildMemberAddDispatch
GatewayGuildMemberRemoveDispatch
GatewayGuildMemberUpdateDispatch
GatewayGuildMembersChunkDispatch
GatewayGuildModifyDispatch
GatewayGuildRoleCreateDispatch
GatewayGuildRoleDeleteDispatch
GatewayGuildRoleModifyDispatch
GatewayGuildRoleUpdateDispatch
GatewayGuildUpdateDispatch
GatewayInviteCreateDispatch
GatewayInviteDeleteDispatch
GatewayMessageCreateDispatch
GatewayMessageDeleteBulkDispatch
GatewayMessageDeleteDispatch
GatewayMessageReactionAddDispatch
GatewayMessageReactionRemoveAllDispatch
GatewayMessageReactionRemoveDispatch
GatewayMessageReactionRemoveEmojiDispatch
GatewayMessageUpdateDispatch
GatewayPresenceClientStatus
GatewayPresenceUpdateDispatch
GatewayReadyDispatch
GatewayReceivePayload
GatewayResumedDispatch
GatewaySendPayload
GatewayTypingStartDispatch
GatewayUserUpdateDispatch
GatewayVoiceServerUpdateDispatch
GatewayVoiceStateUpdateDispatch
GatewayWebhooksUpdateDispatch
GetAPIVoiceRegionsResult
RESTDeleteAPIChannelAllMessageReactionsResult
RESTDeleteAPIChannelMessageReactionResult
RESTDeleteAPIChannelMessageResult
RESTDeleteAPIChannelPermissionsResult
RESTDeleteAPIChannelPinResult
RESTDeleteAPIChannelRecipientResult
RESTDeleteAPIChannelResult
RESTDeleteAPICurrentUserGuildResult
RESTDeleteAPIGuildBanResult
RESTDeleteAPIGuildEmojiResult
RESTDeleteAPIGuildIntegrationResult
RESTDeleteAPIGuildMemberResult
RESTDeleteAPIGuildMemberRoleResult
RESTDeleteAPIGuildResult
RESTDeleteAPIGuildRoleResult
RESTDeleteAPIInviteResult
RESTDeleteAPIWebhookResult
RESTDeleteAPIWebhookWithTokenResult
RESTGetAPIAuditLogResult
RESTGetAPIChannelInvitesResult
RESTGetAPIChannelMessageReactionsResult
RESTGetAPIChannelMessageResult
RESTGetAPIChannelMessagesResult
RESTGetAPIChannelPinsResult
RESTGetAPIChannelResult
RESTGetAPIChannelWebhooksResult
RESTGetAPICurrentUserConnectionsResult
RESTGetAPICurrentUserGuildsResult
RESTGetAPICurrentUserResult
RESTGetAPIGatewayBotResult
RESTGetAPIGatewayResult
RESTGetAPIGuildBanResult
RESTGetAPIGuildBansResult
RESTGetAPIGuildChannelsResult
RESTGetAPIGuildEmojiResult
RESTGetAPIGuildEmojisResult
RESTGetAPIGuildIntegrationsResult
RESTGetAPIGuildInvitesResult
RESTGetAPIGuildMemberResult
RESTGetAPIGuildMembersResult
RESTGetAPIGuildMembersSearchResult
RESTGetAPIGuildPreviewResult
RESTGetAPIGuildResult
RESTGetAPIGuildRolesResult
RESTGetAPIGuildVoiceRegionsResult
RESTGetAPIGuildWebhooksResult
RESTGetAPIGuildWidgetImageResult
Note: while the return type is ArrayBuffer
, the expected result is
a buffer of sorts (depends if in browser or on node.js/deno).
RESTGetAPIGuildWidgetResult
RESTGetAPIGuildWidgetSettingsResult
RESTGetAPIInviteResult
RESTGetAPIOauth2CurrentApplicationResult
RESTGetAPIUserResult
RESTGetAPIWebhookResult
RESTGetAPIWebhookWithTokenResult
RESTOAuth2ImplicitAuthorizationURIFragmentResult
RESTPatchAPIChannelMessageResult
RESTPatchAPIChannelResult
RESTPatchAPICurrentGuildMemberNicknameResult
RESTPatchAPICurrentUserResult
RESTPatchAPIGuildChannelPositionsJSONBody
RESTPatchAPIGuildChannelPositionsResult
RESTPatchAPIGuildEmojiResult
RESTPatchAPIGuildIntegrationResult
RESTPatchAPIGuildMemberResult
RESTPatchAPIGuildResult
RESTPatchAPIGuildRolePositionsJSONBody
RESTPatchAPIGuildRolePositionsResult
RESTPatchAPIGuildRoleResult
RESTPatchAPIGuildWidgetJSONBody
RESTPatchAPIGuildWidgetResult
RESTPatchAPIGuildWidgetSettingsJSONBody
RESTPatchAPIGuildWidgetSettingsResult
RESTPatchAPIWebhookResult
RESTPatchAPIWebhookWithTokenJSONBody
RESTPatchAPIWebhookWithTokenResult
RESTPostAPIChannelFollowersResult
RESTPostAPIChannelMessageCrosspostResult
RESTPostAPIChannelMessageFormDataBody
RESTPostAPIChannelMessageResult
RESTPostAPIChannelMessagesBulkDeleteResult
RESTPostAPIChannelTypingResult
RESTPostAPIChannelWebhookResult
RESTPostAPICurrentUserCreateDMChannelResult
RESTPostAPIGuildChannelJSONBody
RESTPostAPIGuildChannelResult
RESTPostAPIGuildEmojiResult
RESTPostAPIGuildIntegrationResult
RESTPostAPIGuildIntegrationSyncResult
RESTPostAPIGuildRoleResult
RESTPostAPIGuildsResult
RESTPostAPIWebhookWithTokenFormDataBody
RESTPostAPIWebhookWithTokenGitHubQuery
RESTPostAPIWebhookWithTokenResult
RESTPostAPIWebhookWithTokenSlackQuery
RESTPostAPIWebhookWithTokenWaitResult
Received when a call to POST /webhooks/{webhook.id}/{webhook.token}
receives
the wait
query parameter set to true
RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult
RESTPostOAuth2ClientCredentialsResult
RESTPostOAuth2RefreshTokenResult
RESTPutAPIChannelMessageReactionResult
RESTPutAPIChannelPermissionsResult
RESTPutAPIChannelPinResult
RESTPutAPIChannelRecipientResult
RESTPutAPIGuildBanResult
RESTPutAPIGuildMemberResult
RESTPutAPIGuildMemberRoleResult
Variables
constAPIVersion
constGatewayVersion
constPermissionFlagsBits
These flags are exported as BigInt
s and NOT numbers. For most of them, you can
convert them in a number by wrapping it in Number()
, however be careful as any
further bits added may cause issues if done so. Try to use BigInts as much as possible
or modules that can replicate them in some way.
Type declaration
ADD_REACTIONS: [object Object]
ADMINISTRATOR: [object Object]
ATTACH_FILES: [object Object]
BAN_MEMBERS: [object Object]
CHANGE_NICKNAME: [object Object]
CONNECT: [object Object]
CREATE_INSTANT_INVITE: [object Object]
DEAFEN_MEMBERS: [object Object]
EMBED_LINKS: [object Object]
KICK_MEMBERS: [object Object]
MANAGE_CHANNELS: [object Object]
MANAGE_EMOJIS: [object Object]
MANAGE_GUILD: [object Object]
MANAGE_MESSAGES: [object Object]
MANAGE_NICKNAMES: [object Object]
MANAGE_ROLES: [object Object]
MANAGE_WEBHOOKS: [object Object]
MENTION_EVERYONE: [object Object]
MOVE_MEMBERS: [object Object]
MUTE_MEMBERS: [object Object]
PRIORITY_SPEAKER: [object Object]
READ_MESSAGE_HISTORY: [object Object]
SEND_MESSAGES: [object Object]
SEND_TTS_MESSAGES: [object Object]
SPEAK: [object Object]
STREAM: [object Object]
USE_EXTERNAL_EMOJIS: [object Object]
USE_VAD: [object Object]
VIEW_AUDIT_LOG: [object Object]
VIEW_CHANNEL: [object Object]
VIEW_GUILD_INSIGHTS: [object Object]
constRoutes
Type declaration
channel: function
Route for:
- GET
/channels/{channel.id}
- PATCH
/channels/{channel.id}
- DELETE
/channels/{channel.id}
Parameters
channelID: string
Returns string
- GET
channelBulkDelete: function
Route for:
- POST
/channels/{channel.id}/messages/bulk-delete
Parameters
channelID: string
Returns string
- POST
channelCrosspost: function
Route for:
- POST
/channels/{channel.id}/messages/{message.id}/crosspost
Parameters
channelID: string
messageID: string
Returns string
- POST
channelFollowers: function
Route for:
- POST
/channels/{channel.id}/followers
Parameters
channelID: string
Returns string
- POST
channelInvite: function
Route for:
- GET
/channels/{channel.id}/invites
- POST
/channels/{channel.id}/invites
Parameters
channelID: string
Returns string
- GET
channelMessage: function
Route for:
- GET
/channels/{channel.id}/messages/{message.id}
- PATCH
/channels/{channel.id}/messages/{message.id}
- DELETE
/channels/{channel.id}/messages/{message.id}
Parameters
channelID: string
messageID: string
Returns string
- GET
channelMessageAllReactions: function
Route for:
- DELETE
/channels/{channel.id}/messages/{message.id}/reactions
Parameters
channelID: string
messageID: string
Returns string
- DELETE
channelMessageOwnReaction: function
Route for:
- PUT
/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me
- DELETE
/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me
Note: You need to URL encode the emoji yourself.
Parameters
channelID: string
messageID: string
emoji: string
Returns string
- PUT
channelMessageSpecificReaction: function
Route for:
- GET
/channels/{channel.id}/messages/{message.id}/reactions/{emoji}
- DELETE
/channels/{channel.id}/messages/{message.id}/reactions/{emoji}
Note: You need to URL encode the emoji yourself.
Parameters
channelID: string
messageID: string
emoji: string
Returns string
- GET
channelMessageUserReaction: function
Route for:
- DELETE
/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/{user.id}
Note: You need to URL encode the emoji yourself.
Parameters
channelID: string
messageID: string
emoji: string
userID: string
Returns string
- DELETE
channelMessages: function
Route for:
- GET
/channels/{channel.id}/messages
- POST
/channels/{channel.id}/messages
Parameters
channelID: string
Returns string
- GET
channelPermissions: function
Route for:
- PUT
/channels/{channel.id}/permissions/{overwrite.id}
- DELETE
/channels/{channel.id}/permissions/{overwrite.id}
Parameters
channelID: string
overwriteID: string
Returns string
- PUT
channelPin: function
Route for:
- PUT
/channels/{channel.id}/pins/{message.id}
- DELETE
/channels/{channel.id}/pins/{message.id}
Parameters
channelID: string
messageID: string
Returns string
- PUT
channelPins: function
Route for:
- GET
/channels/{channel.id}/pins
Parameters
channelID: string
Returns string
- GET
channelRecipient: function
Route for:
- PUT
/channels/{channel.id}/recipients/{user.id}
- DELETE
/channels/{channel.id}/recipients/{user.id}
Parameters
channelID: string
userID: string
Returns string
- PUT
channelTyping: function
Route for:
- POST
/channels/{channel.id}/typing
Parameters
channelID: string
Returns string
- POST
channelWebhook: function
Route for:
- POST
/channels/{channel.id}/webhooks
- GET
/channels/{channel.id}/webhooks
Parameters
channelID: string
Returns string
- POST
gateway: function
Route for:
- GET
/gateway
Returns string
- GET
gatewayBot: function
Route for:
- GET
/gateway/bot
Returns string
- GET
guild: function
Route for:
- GET
/guilds/{guild.id}
- PATCH
/guilds/{guild.id}
- DELETE
/guilds/{guild.id}
Parameters
guildID: string
Returns string
- GET
guildAuditLog: function
Route for:
- GET
/guilds/{guild.id}/audit-logs
Parameters
guildID: string
Returns string
- GET
guildBan: function
Route for:
- GET
/guilds/{guild.id}/bans/{user.id}
- PUT
/guilds/{guild.id}/bans/{user.id}
- DELETE
/guilds/{guild.id}/bans/{user.id}
Parameters
guildID: string
userID: string
Returns string
- GET
guildBans: function
Route for:
- GET
/guilds/{guild.id}/bans
Parameters
guildID: string
Returns string
- GET
guildChannels: function
Route for:
- GET
/guilds/{guild.id}/channels
- POST
/guilds/{guild.id}/channels
- PATCH
/guilds/{guild.id}/channels
Parameters
guildID: string
Returns string
- GET
guildCurrentMemberNickname: function
Route for:
- PATCH
/guilds/{guild.id}/members/@me/nick
Parameters
guildID: string
Returns string
- PATCH
guildEmoji: function
Route for:
- GET
/guilds/{guild.id}/emojis/{emoji.id}
- PATCH
/guilds/{guild.id}/emojis/{emoji.id}
- DELETE
/guilds/{guild.id}/emojis/{emoji.id}
Parameters
guildID: string
emojiID: string
Returns string
- GET
guildEmojis: function
Route for:
- GET
/guilds/{guild.id}/emojis
- POST
/guilds/{guild.id}/emojis
Parameters
guildID: string
Returns string
- GET
guildIntegration: function
Route for:
- PATCH
/guilds/{guild.id}/integrations/{integration.id}
- DELETE
/guilds/{guild.id}/integrations/{integration.id}
Parameters
guildID: string
integrationID: string
Returns string
- PATCH
guildIntegrationSync: function
Route for:
- POST
/guilds/{guild.id}/integrations/{integration.id}/sync
Parameters
guildID: string
integrationID: string
Returns string
- POST
guildIntegrations: function
Route for:
- GET
/guilds/{guild.id}/integrations
- POST
/guilds/{guild.id}/integrations
Parameters
guildID: string
Returns string
- GET
guildInvites: function
Route for:
- GET
/guilds/{guild.id}/invites
Parameters
guildID: string
Returns string
- GET
guildMember: function
Route for:
- GET
/guilds/{guild.id}/members/{user.id}
- PUT
/guilds/{guild.id}/members/{user.id}
- PATCH
/guilds/{guild.id}/members/{user.id}
- DELETE
/guilds/{guild.id}/members/{user.id}
Parameters
guildID: string
userID: string
Returns string
- GET
guildMemberRole: function
Route for:
- PUT
/guilds/{guild.id}/members/{user.id}/roles/{role.id}
- DELETE
/guilds/{guild.id}/members/{user.id}/roles/{role.id}
Parameters
guildID: string
memberID: string
roleID: string
Returns string
- PUT
guildMembers: function
Route for:
- GET
/guilds/{guild.id}/members
Parameters
guildID: string
Returns string
- GET
guildMembersSearch: function
Route for:
- GET
/guilds/{guild.id}/members/search
Parameters
guildID: string
Returns string
- GET
guildPreview: function
Route for:
- GET
/guilds/{guild.id}/preview
Parameters
guildID: string
Returns string
- GET
guildPrune: function
Route for:
- GET
/guilds/{guild.id}/prune
- POST
/guilds/{guild.id}/prune
Parameters
guildID: string
Returns string
- GET
guildRole: function
Route for:
- PATCH
/guilds/{guild.id}/roles/{role.id}
- DELETE
/guilds/{guild.id}/roles/{role.id}
Parameters
guildID: string
roleID: string
Returns string
- PATCH
guildRoles: function
Route for:
- GET
/guilds/{guild.id}/roles
- POST
/guilds/{guild.id}/roles
- PATCH
/guilds/{guild.id}/roles
Parameters
guildID: string
Returns string
- GET
guildVanityUrl: function
Route for:
- GET
/guilds/{guild.id}/vanity-url
Parameters
guildID: string
Returns string
- GET
guildVoiceRegions: function
Route for:
- GET
/guilds/{guild.id}/regions
Parameters
guildID: string
Returns string
- GET
guildWebhooks: function
Route for:
- GET
/guilds/{guild.id}/webhooks
Parameters
guildID: string
Returns string
- GET
guildWidget: function
Parameters
guildID: string
Returns string
guildWidgetImage: function
Route for:
- GET
/guilds/{guild.id}/widget.png
Parameters
guildID: string
Returns string
- GET
guildWidgetSettings: function
Route for:
- GET
/guilds/{guild.id}/widget
- PATCH
/guilds/{guild.id}/widget
Parameters
guildID: string
Returns string
- GET
guilds: function
Route for:
- POST
/guilds
Returns string
- POST
invite: function
Route for:
- GET
/invites/{invite.code}
- DELETE
/invites/{invite.code}
Parameters
code: string
Returns string
- GET
oauth2CurrentApplication: function
Route for:
- GET
/oauth2/applications/@me
Returns string
- GET
user: function
Route for:
- GET
/users/@me
- GET
/users/{user.id}
- PATCH
/users/@me
Parameters
userID: string = '@me'
Returns string
- GET
userChannels: function
Route for:
- POST
/users/@me/channels
Returns string
- POST
userConnections: function
Route for:
- GET
/users/@me/connections
Returns string
- GET
userGuild: function
Route for:
- DELETE
/users/@me/guilds/{guild.id}
Parameters
guildID: string
Returns string
- DELETE
userGuilds: function
Route for:
- GET
/users/@me/guilds
Returns string
- GET
voiceRegions: function
Route for:
- GET
/voice/regions
Returns string
- GET
webhook: function
Route for:
- GET
/webhooks/{webhook.id}
- GET
/webhooks/{webhook.id}/{webhook.token}
- PATCH
/webhooks/{webhook.id}
- PATCH
/webhooks/{webhook.id}/{webhook.token}
- DELETE
/webhooks/{webhook.id}
- DELETE
/webhooks/{webhook.id}/{webhook.token}
- POST
/webhooks/{webhook.id}/{webhook.token}
Parameters
webhookID: string
optionalwebhookToken: string
Returns string
- GET
webhookPlatform: function
Route for:
- POST
/webhooks/{webhook.id}/{webhook.token}/slack
- POST
/webhooks/{webhook.id}/{webhook.token}/github
Parameters
webhookID: string
webhookToken: string
platform: github | slack
Returns string
- POST
https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure
API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.