discord-api-types/v9
Index
Enumerations
- ActivityFlags
- ActivityPlatform
- ActivityType
- AllowedMentionsTypes
- ApplicationCommandOptionType
- ApplicationCommandPermissionType
- ApplicationCommandType
- ApplicationFlags
- ApplicationRoleConnectionMetadataType
- AuditLogEvent
- AuditLogOptionsType
- AutoModerationActionType
- AutoModerationRuleEventType
- AutoModerationRuleKeywordPresetType
- AutoModerationRuleTriggerType
- ButtonStyle
- ChannelFlags
- ChannelType
- ComponentType
- ConnectionService
- ConnectionVisibility
- EmbedType
- ForumLayoutType
- GatewayCloseCodes
- GatewayDispatchEvents
- GatewayIntentBits
- GatewayOpcodes
- GuildDefaultMessageNotifications
- GuildExplicitContentFilter
- GuildFeature
- GuildHubType
- GuildMFALevel
- GuildMemberFlags
- GuildNSFWLevel
- GuildOnboardingPromptType
- GuildPremiumTier
- GuildScheduledEventEntityType
- GuildScheduledEventPrivacyLevel
- GuildScheduledEventStatus
- GuildSystemChannelFlags
- GuildVerificationLevel
- GuildWidgetStyle
- ImageFormat
- IntegrationExpireBehavior
- InteractionResponseType
- InteractionType
- InviteTargetType
- MembershipScreeningFieldType
- MessageActivityType
- MessageFlags
- MessageType
- OAuth2Scopes
- OverwriteType
- PresenceUpdateStatus
- SortOrderType
- StageInstancePrivacyLevel
- StickerFormatType
- StickerType
- TeamMemberMembershipState
- TextInputStyle
- ThreadAutoArchiveDuration
- ThreadMemberFlags
- UserFlags
- UserPremiumType
- VideoQualityMode
- WebhookType
Interfaces
- APIActionRowComponent
- APIAllowedMentions
- APIApplication
- APIApplicationCommand
- APIApplicationCommandAutocompleteResponse
- APIApplicationCommandChannelOption
- APIApplicationCommandInteractionDataIntegerOption
- APIApplicationCommandInteractionDataNumberOption
- APIApplicationCommandInteractionDataStringOption
- APIApplicationCommandInteractionDataSubcommandGroupOption
- APIApplicationCommandInteractionDataSubcommandOption
- APIApplicationCommandOptionBase
- APIApplicationCommandOptionChoice
- APIApplicationCommandPermission
- APIApplicationCommandSubcommandGroupOption
- APIApplicationCommandSubcommandOption
- APIApplicationInstallParams
- APIApplicationRoleConnection
- APIApplicationRoleConnectionMetadata
- APIAttachment
- APIAuditLog
- APIAuditLogEntry
- APIAuditLogOptions
- APIAutoModerationAction
- APIAutoModerationActionMetadata
- APIAutoModerationRule
- APIAutoModerationRuleTriggerMetadata
- APIBan
- APIBaseComponent
- APIBaseInteraction
- APIBaseSelectMenuComponent
- APIButtonComponentBase
- APIButtonComponentWithCustomId
- APIButtonComponentWithURL
- APIChannelBase
- APIChannelMention
- APIChannelPatchOverwrite
- APIChannelSelectComponent
- APIChatInputApplicationCommandInteractionData
- APICommandAutocompleteInteractionResponseCallbackData
- APIConnection
- APIDMChannel
- APIDMChannelBase
- APIEmbed
- APIEmbedAuthor
- APIEmbedField
- APIEmbedFooter
- APIEmbedImage
- APIEmbedProvider
- APIEmbedThumbnail
- APIEmbedVideo
- APIEmoji
- APIExtendedInvite
- APIExternalGuildScheduledEvent
- APIFollowedChannel
- APIGatewayBotInfo
- APIGatewayInfo
- APIGatewaySessionStartLimit
- APIGroupDMChannel
- APIGuild
- APIGuildApplicationCommandPermissions
- APIGuildChannel
- APIGuildCreateOverwrite
- APIGuildCreateRole
- APIGuildForumChannel
- APIGuildForumDefaultReactionEmoji
- APIGuildForumTag
- APIGuildIntegration
- APIGuildIntegrationApplication
- APIGuildMember
- APIGuildMembershipScreening
- APIGuildMembershipScreeningField
- APIGuildOnboarding
- APIGuildOnboardingPrompt
- APIGuildOnboardingPromptOption
- APIGuildPreview
- APIGuildScheduledEventEntityMetadata
- APIGuildScheduledEventUser
- APIGuildTextChannel
- APIGuildWelcomeScreen
- APIGuildWelcomeScreenChannel
- APIGuildWidget
- APIGuildWidgetChannel
- APIGuildWidgetMember
- APIGuildWidgetSettings
- APIIntegrationAccount
- APIInteractionDataOptionBase
- APIInteractionDataResolved
- APIInteractionDataResolvedChannel
- APIInteractionDataResolvedGuildMember
- APIInteractionGuildMember
- APIInteractionResponseChannelMessageWithSource
- APIInteractionResponseDeferredChannelMessageWithSource
- APIInteractionResponseDeferredMessageUpdate
- APIInteractionResponsePong
- APIInteractionResponseUpdateMessage
- APIInvite
- APIInviteStageInstance
- APIMessage
- APIMessageActivity
- APIMessageApplicationCommandInteractionData
- APIMessageApplicationCommandInteractionDataResolved
- APIMessageChannelSelectInteractionData
- APIMessageComponentBaseInteractionData
- APIMessageComponentEmoji
- APIMessageInteraction
- APIMessageMentionableSelectInteractionData
- APIMessageReference
- APIMessageRoleSelectInteractionData
- APIMessageStringSelectInteractionData
- APIMessageUserSelectInteractionData
- APIModalInteractionResponse
- APIModalInteractionResponseCallbackData
- APIModalSubmission
- APIOverwrite
- APIPartialChannel
- APIPartialEmoji
- APIPartialGuild
- APIReaction
- APIRole
- APIRoleTags
- APISelectMenuOption
- APIStageInstance
- APIStageInstanceGuildScheduledEvent
- APISticker
- APIStickerPack
- APIStringSelectComponent
- APITeam
- APITeamMember
- APITemplate
- APITemplateSerializedSourceGuild
- APITextBasedChannel
- APITextInputComponent
- APIThreadChannel
- APIThreadList
- APIThreadMember
- APIThreadMetadata
- APIUnavailableGuild
- APIUser
- APIUserApplicationCommandInteractionData
- APIVoiceChannelBase
- APIVoiceGuildScheduledEvent
- APIVoiceRegion
- APIWebhook
- CDNQuery
- GatewayActivity
- GatewayActivityButton
- GatewayActivityParty
- GatewayActivityTimestamps
- GatewayApplicationCommandPermissionsUpdateDispatchData
- GatewayAutoModerationActionExecutionDispatchData
- GatewayChannelPinsUpdateDispatchData
- GatewayGuildAuditLogEntryCreateDispatchData
- GatewayGuildBanModifyDispatchData
- GatewayGuildCreateDispatchData
- GatewayGuildEmojisUpdateDispatchData
- GatewayGuildIntegrationsUpdateDispatchData
- GatewayGuildMemberAddDispatchData
- GatewayGuildMemberRemoveDispatchData
- GatewayGuildMembersChunkDispatchData
- GatewayGuildRoleDeleteDispatchData
- GatewayGuildRoleModifyDispatchData
- GatewayGuildScheduledEventUserAddDispatchData
- GatewayGuildScheduledEventUserRemoveDispatchData
- GatewayGuildStickersUpdateDispatchData
- GatewayHeartbeat
- GatewayHeartbeatAck
- GatewayHeartbeatRequest
- GatewayHello
- GatewayHelloData
- GatewayIdentify
- GatewayIdentifyData
- GatewayIdentifyProperties
- GatewayIntegrationDeleteDispatchData
- GatewayInvalidSession
- GatewayInviteCreateDispatchData
- GatewayInviteDeleteDispatchData
- GatewayMessageDeleteBulkDispatchData
- GatewayMessageDeleteDispatchData
- GatewayMessageEventExtraFields
- GatewayMessageReactionRemoveEmojiDispatchData
- GatewayPresenceClientStatus
- GatewayPresenceUpdate
- GatewayPresenceUpdateData
- GatewayReadyDispatchData
- GatewayReconnect
- GatewayRequestGuildMembers
- GatewayRequestGuildMembersDataBase
- GatewayRequestGuildMembersDataWithQuery
- GatewayRequestGuildMembersDataWithUserIds
- GatewayResume
- GatewayResumeData
- GatewayThreadCreateDispatchData
- GatewayThreadListSync
- GatewayThreadMembersUpdate
- GatewayTypingStartDispatchData
- GatewayUpdatePresence
- GatewayVoiceServerUpdateDispatchData
- GatewayVoiceState
- GatewayVoiceStateUpdate
- GatewayVoiceStateUpdateData
- GatewayWebhooksUpdateDispatchData
- ModalSubmitActionRowComponent
- ModalSubmitComponent
- RESTAPIPartialCurrentUserGuild
- RESTGetAPIApplicationCommandsQuery
- RESTGetAPIAuditLogQuery
- RESTGetAPIChannelMessageReactionUsersQuery
- RESTGetAPIChannelMessagesQuery
- RESTGetAPIChannelThreadMemberQuery
- RESTGetAPIChannelThreadMembersQuery
- RESTGetAPIChannelThreadsArchivedQuery
- RESTGetAPICurrentUserGuildsQuery
- RESTGetAPIGuildBansQuery
- RESTGetAPIGuildMembersQuery
- RESTGetAPIGuildMembersSearchQuery
- RESTGetAPIGuildPruneCountQuery
- RESTGetAPIGuildPruneCountResult
- RESTGetAPIGuildQuery
- RESTGetAPIGuildScheduledEventQuery
- RESTGetAPIGuildScheduledEventUsersQuery
- RESTGetAPIGuildScheduledEventsQuery
- RESTGetAPIGuildVanityUrlResult
- RESTGetAPIGuildWidgetImageQuery
- RESTGetAPIInviteQuery
- RESTGetAPIOAuth2CurrentAuthorizationResult
- RESTGetAPIWebhookWithTokenMessageQuery
- RESTGetNitroStickerPacksResult
- RESTOAuth2AdvancedBotAuthorizationQuery
- RESTOAuth2AdvancedBotAuthorizationQueryResult
- RESTOAuth2AuthorizationQuery
- RESTOAuth2AuthorizationQueryResult
- RESTOAuth2BotAuthorizationQuery
- RESTOAuth2ImplicitAuthorizationQuery
- RESTPatchAPIChannelJSONBody
- RESTPatchAPIChannelMessageJSONBody
- RESTPatchAPICurrentGuildMemberJSONBody
- RESTPatchAPICurrentGuildMemberNicknameJSONBody
- RESTPatchAPICurrentUserJSONBody
- RESTPatchAPIGuildEmojiJSONBody
- RESTPatchAPIGuildJSONBody
- RESTPatchAPIGuildMemberJSONBody
- RESTPatchAPIGuildMemberVerificationJSONBody
- RESTPatchAPIGuildRoleJSONBody
- RESTPatchAPIGuildStickerJSONBody
- RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody
- RESTPatchAPIGuildVoiceStateUserJSONBody
- RESTPatchAPIStageInstanceJSONBody
- RESTPatchAPIWebhookJSONBody
- RESTPostAPIAutoModerationRuleJSONBody
- RESTPostAPIChannelFollowersJSONBody
- RESTPostAPIChannelInviteJSONBody
- RESTPostAPIChannelMessageJSONBody
- RESTPostAPIChannelMessagesBulkDeleteJSONBody
- RESTPostAPIChannelMessagesThreadsJSONBody
- RESTPostAPIChannelThreadsJSONBody
- RESTPostAPIChannelWebhookJSONBody
- RESTPostAPIChatInputApplicationCommandsJSONBody
- RESTPostAPIContextMenuApplicationCommandsJSONBody
- RESTPostAPICurrentUserCreateDMChannelJSONBody
- RESTPostAPIGuildEmojiJSONBody
- RESTPostAPIGuildPruneJSONBody
- RESTPostAPIGuildPruneResult
- RESTPostAPIGuildRoleJSONBody
- RESTPostAPIGuildScheduledEventJSONBody
- RESTPostAPIGuildStickerFormDataBody
- RESTPostAPIGuildTemplatesJSONBody
- RESTPostAPIGuildsJSONBody
- RESTPostAPIGuildsMFAJSONBody
- RESTPostAPIStageInstanceJSONBody
- RESTPostAPITemplateCreateGuildJSONBody
- RESTPostAPIWebhookWithTokenJSONBody
- RESTPostAPIWebhookWithTokenQuery
- RESTPostOAuth2AccessTokenResult
- RESTPostOAuth2AccessTokenURLEncodedData
- RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult
- RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult
- RESTPostOAuth2ClientCredentialsURLEncodedData
- RESTPostOAuth2RefreshTokenURLEncodedData
- RESTPutAPIApplicationCommandPermissionsJSONBody
- RESTPutAPIChannelPermissionJSONBody
- RESTPutAPIChannelRecipientJSONBody
- RESTPutAPICurrentUserApplicationRoleConnectionJSONBody
- RESTPutAPIGuildBanJSONBody
- RESTPutAPIGuildMemberJSONBody
References
Type Aliases
- APIActionRowComponentTypes
- APIApplicationCommandAttachmentOption
- APIApplicationCommandAutocompleteDMInteraction
- APIApplicationCommandAutocompleteGuildInteraction
- APIApplicationCommandAutocompleteInteraction
- APIApplicationCommandBasicOption
- APIApplicationCommandBooleanOption
- APIApplicationCommandDMInteraction
- APIApplicationCommandGuildInteraction
- APIApplicationCommandIntegerOption
- APIApplicationCommandInteraction
- APIApplicationCommandInteractionData
- APIApplicationCommandInteractionDataAttachmentOption
- APIApplicationCommandInteractionDataBasicOption
- APIApplicationCommandInteractionDataBooleanOption
- APIApplicationCommandInteractionDataChannelOption
- APIApplicationCommandInteractionDataMentionableOption
- APIApplicationCommandInteractionDataOption
- APIApplicationCommandInteractionDataRoleOption
- APIApplicationCommandInteractionDataUserOption
- APIApplicationCommandInteractionWrapper
- APIApplicationCommandMentionableOption
- APIApplicationCommandNumberOption
- APIApplicationCommandOption
- APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper
- APIApplicationCommandRoleOption
- APIApplicationCommandStringOption
- APIApplicationCommandUserOption
- APIAuditLogChange
- APIAuditLogChangeKey$Add
- APIAuditLogChangeKey$Remove
- APIAuditLogChangeKeyAFKChannelId
- APIAuditLogChangeKeyAFKTimeout
- APIAuditLogChangeKeyActions
- APIAuditLogChangeKeyAllow
- APIAuditLogChangeKeyApplicationId
- APIAuditLogChangeKeyArchived
- APIAuditLogChangeKeyAsset
- APIAuditLogChangeKeyAutoArchiveDuration
- APIAuditLogChangeKeyAvailable
- APIAuditLogChangeKeyAvatarHash
- APIAuditLogChangeKeyBannerHash
- APIAuditLogChangeKeyBitrate
- APIAuditLogChangeKeyChannelId
- APIAuditLogChangeKeyCode
- APIAuditLogChangeKeyColor
- APIAuditLogChangeKeyCommunicationDisabledUntil
- APIAuditLogChangeKeyDeaf
- APIAuditLogChangeKeyDefaultAutoArchiveDuration
- APIAuditLogChangeKeyDefaultMessageNotifications
- APIAuditLogChangeKeyDeny
- APIAuditLogChangeKeyDescription
- APIAuditLogChangeKeyDiscoverySplashHash
- APIAuditLogChangeKeyEnableEmoticons
- APIAuditLogChangeKeyEnabled
- APIAuditLogChangeKeyEntityType
- APIAuditLogChangeKeyEventType
- APIAuditLogChangeKeyExemptChannels
- APIAuditLogChangeKeyExemptRoles
- APIAuditLogChangeKeyExpireBehavior
- APIAuditLogChangeKeyExpireGracePeriod
- APIAuditLogChangeKeyExplicitContentFilter
- APIAuditLogChangeKeyFormatType
- APIAuditLogChangeKeyGuildId
- APIAuditLogChangeKeyHoist
- APIAuditLogChangeKeyIconHash
- APIAuditLogChangeKeyId
- APIAuditLogChangeKeyImageHash
- APIAuditLogChangeKeyInviterId
- APIAuditLogChangeKeyLocation
- APIAuditLogChangeKeyLocked
- APIAuditLogChangeKeyMFALevel
- APIAuditLogChangeKeyMaxAge
- APIAuditLogChangeKeyMaxUses
- APIAuditLogChangeKeyMentionable
- APIAuditLogChangeKeyMute
- APIAuditLogChangeKeyNSFW
- APIAuditLogChangeKeyName
- APIAuditLogChangeKeyNick
- APIAuditLogChangeKeyOwnerId
- APIAuditLogChangeKeyPermissionOverwrites
- APIAuditLogChangeKeyPermissions
- APIAuditLogChangeKeyPosition
- APIAuditLogChangeKeyPreferredLocale
- APIAuditLogChangeKeyPrivacyLevel
- APIAuditLogChangeKeyPruneDeleteDays
- APIAuditLogChangeKeyPublicUpdatesChannelId
- APIAuditLogChangeKeyRateLimitPerUser
- APIAuditLogChangeKeyRegion
- APIAuditLogChangeKeyRulesChannelId
- APIAuditLogChangeKeySnowflake
- APIAuditLogChangeKeySplashHash
- APIAuditLogChangeKeyStatus
- APIAuditLogChangeKeySystemChannelId
- APIAuditLogChangeKeyTags
- APIAuditLogChangeKeyTemporary
- APIAuditLogChangeKeyTopic
- APIAuditLogChangeKeyTriggerMetadata
- APIAuditLogChangeKeyTriggerType
- APIAuditLogChangeKeyType
- APIAuditLogChangeKeyUserLimit
- APIAuditLogChangeKeyUses
- APIAuditLogChangeKeyVanityURLCode
- APIAuditLogChangeKeyVerificationLevel
- APIAuditLogChangeKeyWidgetChannelId
- APIAuditLogChangeKeyWidgetEnabled
- APIButtonComponent
- APIChannel
- APIChatInputApplicationCommandDMInteraction
- APIChatInputApplicationCommandGuildInteraction
- APIChatInputApplicationCommandInteraction
- APIChatInputApplicationCommandInteractionDataResolved
- APIContextMenuDMInteraction
- APIContextMenuGuildInteraction
- APIContextMenuInteraction
- APIContextMenuInteractionData
- APIDMInteraction
- APIDMInteractionWrapper
- APIGuildCategoryChannel
- APIGuildChannelResolvable
- APIGuildCreatePartialChannel
- APIGuildIntegrationType
- APIGuildInteraction
- APIGuildInteractionWrapper
- APIGuildScheduledEvent
- APIGuildStageVoiceChannel
- APIGuildVoiceChannel
- APIInteraction
- APIInteractionResponse
- APIInteractionResponseCallbackData
- APIInviteGuild
- APIMentionableSelectComponent
- APIMessageActionRowComponent
- APIMessageApplicationCommandDMInteraction
- APIMessageApplicationCommandGuildInteraction
- APIMessageApplicationCommandInteraction
- APIMessageButtonInteractionData
- APIMessageComponent
- APIMessageComponentButtonInteraction
- APIMessageComponentDMInteraction
- APIMessageComponentGuildInteraction
- APIMessageComponentInteraction
- APIMessageComponentInteractionData
- APIMessageComponentSelectMenuInteraction
- APIMessageReferenceSend
- APIMessageSelectMenuInteractionData
- APIModalActionRowComponent
- APIModalComponent
- APIModalSubmitDMInteraction
- APIModalSubmitGuildInteraction
- APIModalSubmitInteraction
- APINewsChannel
- APIPingInteraction
- APIRoleSelectComponent
- APISelectMenuComponent
- APIStickerItem
- APITextChannel
- APIUserApplicationCommandDMInteraction
- APIUserApplicationCommandGuildInteraction
- APIUserApplicationCommandInteraction
- APIUserApplicationCommandInteractionDataResolved
- APIUserInteractionDataResolved
- APIUserSelectComponent
- AchievementIconFormat
- ApplicationAssetFormat
- ApplicationCoverFormat
- ApplicationIconFormat
- AuditLogRuleTriggerType
- DefaultUserAvatar
- DefaultUserAvatarAssets
- EmojiFormat
- GatewayActivityAssets
- GatewayActivityEmoji
- GatewayActivitySecrets
- GatewayActivityUpdateData
- GatewayApplicationCommandPermissionsUpdateDispatch
- GatewayAutoModerationActionExecutionDispatch
- GatewayAutoModerationRuleCreateDispatch
- GatewayAutoModerationRuleCreateDispatchData
- GatewayAutoModerationRuleDeleteDispatch
- GatewayAutoModerationRuleDeleteDispatchData
- GatewayAutoModerationRuleModifyDispatch
- GatewayAutoModerationRuleModifyDispatchData
- GatewayAutoModerationRuleUpdateDispatch
- GatewayAutoModerationRuleUpdateDispatchData
- GatewayChannelCreateDispatch
- GatewayChannelCreateDispatchData
- GatewayChannelDeleteDispatch
- GatewayChannelDeleteDispatchData
- GatewayChannelModifyDispatch
- GatewayChannelModifyDispatchData
- GatewayChannelPinsUpdateDispatch
- GatewayChannelUpdateDispatch
- GatewayChannelUpdateDispatchData
- GatewayDispatchPayload
- GatewayGuildAuditLogEntryCreateDispatch
- GatewayGuildBanAddDispatch
- GatewayGuildBanAddDispatchData
- GatewayGuildBanModifyDispatch
- GatewayGuildBanRemoveDispatch
- GatewayGuildBanRemoveDispatchData
- GatewayGuildCreateDispatch
- GatewayGuildDeleteDispatch
- GatewayGuildDeleteDispatchData
- GatewayGuildEmojisUpdateDispatch
- GatewayGuildIntegrationsUpdateDispatch
- GatewayGuildMemberAddDispatch
- GatewayGuildMemberRemoveDispatch
- GatewayGuildMemberUpdateDispatch
- GatewayGuildMemberUpdateDispatchData
- GatewayGuildMembersChunkDispatch
- GatewayGuildModifyDispatch
- GatewayGuildModifyDispatchData
- GatewayGuildRoleCreateDispatch
- GatewayGuildRoleCreateDispatchData
- GatewayGuildRoleDeleteDispatch
- GatewayGuildRoleModifyDispatch
- GatewayGuildRoleUpdateDispatch
- GatewayGuildRoleUpdateDispatchData
- GatewayGuildScheduledEventCreateDispatch
- GatewayGuildScheduledEventCreateDispatchData
- GatewayGuildScheduledEventDeleteDispatch
- GatewayGuildScheduledEventDeleteDispatchData
- GatewayGuildScheduledEventUpdateDispatch
- GatewayGuildScheduledEventUpdateDispatchData
- GatewayGuildScheduledEventUserAddDispatch
- GatewayGuildScheduledEventUserRemoveDispatch
- GatewayGuildStickersUpdateDispatch
- GatewayGuildUpdateDispatch
- GatewayGuildUpdateDispatchData
- GatewayHeartbeatData
- GatewayIntegrationCreateDispatch
- GatewayIntegrationCreateDispatchData
- GatewayIntegrationDeleteDispatch
- GatewayIntegrationUpdateDispatch
- GatewayIntegrationUpdateDispatchData
- GatewayInteractionCreateDispatch
- GatewayInteractionCreateDispatchData
- GatewayInvalidSessionData
- GatewayInviteCreateDispatch
- GatewayInviteDeleteDispatch
- GatewayMessageCreateDispatch
- GatewayMessageCreateDispatchData
- GatewayMessageDeleteBulkDispatch
- GatewayMessageDeleteDispatch
- GatewayMessageReactionAddDispatch
- GatewayMessageReactionAddDispatchData
- GatewayMessageReactionRemoveAllDispatch
- GatewayMessageReactionRemoveAllDispatchData
- GatewayMessageReactionRemoveDispatch
- GatewayMessageReactionRemoveDispatchData
- GatewayMessageReactionRemoveEmojiDispatch
- GatewayMessageUpdateDispatch
- GatewayMessageUpdateDispatchData
- GatewayPresenceUpdateDispatch
- GatewayPresenceUpdateDispatchData
- GatewayReadyDispatch
- GatewayReceivePayload
- GatewayRequestGuildMembersData
- GatewayResumedDispatch
- GatewaySendPayload
- GatewayStageInstanceCreateDispatch
- GatewayStageInstanceCreateDispatchData
- GatewayStageInstanceDeleteDispatch
- GatewayStageInstanceDeleteDispatchData
- GatewayStageInstanceUpdateDispatch
- GatewayStageInstanceUpdateDispatchData
- GatewayThreadCreateDispatch
- GatewayThreadDeleteDispatch
- GatewayThreadDeleteDispatchData
- GatewayThreadListSyncDispatch
- GatewayThreadListSyncDispatchData
- GatewayThreadMemberUpdateDispatch
- GatewayThreadMemberUpdateDispatchData
- GatewayThreadMembersUpdateDispatch
- GatewayThreadMembersUpdateDispatchData
- GatewayThreadModifyDispatch
- GatewayThreadUpdateDispatch
- GatewayThreadUpdateDispatchData
- GatewayTypingStartDispatch
- GatewayUserUpdateDispatch
- GatewayUserUpdateDispatchData
- GatewayVoiceServerUpdateDispatch
- GatewayVoiceStateUpdateDispatch
- GatewayVoiceStateUpdateDispatchData
- GatewayWebhooksUpdateDispatch
- GetAPIVoiceRegionsResult
- GuildBannerFormat
- GuildChannelType
- GuildDiscoverySplashFormat
- GuildIconFormat
- GuildMemberAvatarFormat
- GuildMemberBannerFormat
- GuildScheduledEventCoverFormat
- GuildSplashFormat
- GuildTextChannelType
- PartialAPIMessageInteractionGuildMember
- RESTDeleteAPIAutoModerationRuleResult
- RESTDeleteAPIChannelAllMessageReactionsResult
- RESTDeleteAPIChannelMessageOwnReaction
- RESTDeleteAPIChannelMessageReactionResult
- RESTDeleteAPIChannelMessageResult
- RESTDeleteAPIChannelMessageUserReactionResult
- RESTDeleteAPIChannelPermissionResult
- RESTDeleteAPIChannelPinResult
- RESTDeleteAPIChannelRecipientResult
- RESTDeleteAPIChannelResult
- RESTDeleteAPIChannelThreadMembersResult
- RESTDeleteAPICurrentUserGuildResult
- RESTDeleteAPIGuildBanResult
- RESTDeleteAPIGuildEmojiResult
- RESTDeleteAPIGuildIntegrationResult
- RESTDeleteAPIGuildMemberResult
- RESTDeleteAPIGuildMemberRoleResult
- RESTDeleteAPIGuildResult
- RESTDeleteAPIGuildRoleResult
- RESTDeleteAPIGuildScheduledEventResult
- RESTDeleteAPIGuildStickerResult
- RESTDeleteAPIGuildTemplateResult
- RESTDeleteAPIInteractionFollowupResult
- RESTDeleteAPIInteractionOriginalResponseResult
- RESTDeleteAPIInviteResult
- RESTDeleteAPIStageInstanceResult
- RESTDeleteAPIWebhookResult
- RESTDeleteAPIWebhookWithTokenMessageResult
- RESTDeleteAPIWebhookWithTokenResult
- RESTGetAPIApplicationCommandPermissionsResult
- RESTGetAPIApplicationCommandResult
- RESTGetAPIApplicationCommandsResult
- RESTGetAPIApplicationGuildCommandResult
- RESTGetAPIApplicationGuildCommandsQuery
- RESTGetAPIApplicationGuildCommandsResult
- RESTGetAPIApplicationRoleConnectionMetadataResult
- RESTGetAPIAuditLogResult
- RESTGetAPIAutoModerationRuleResult
- RESTGetAPIAutoModerationRulesResult
- RESTGetAPIChannelInvitesResult
- RESTGetAPIChannelMessageReactionUsersResult
- RESTGetAPIChannelMessageResult
- RESTGetAPIChannelMessagesResult
- RESTGetAPIChannelPinsResult
- RESTGetAPIChannelResult
- RESTGetAPIChannelThreadMemberResult
- RESTGetAPIChannelThreadMembersResult
- RESTGetAPIChannelThreadsArchivedPrivateResult
- RESTGetAPIChannelThreadsArchivedPublicResult
- RESTGetAPIChannelThreadsResult
- RESTGetAPIChannelUsersThreadsArchivedResult
- RESTGetAPIChannelWebhooksResult
- RESTGetAPICurrentUserApplicationRoleConnectionResult
- RESTGetAPICurrentUserConnectionsResult
- RESTGetAPICurrentUserGuildsResult
- RESTGetAPICurrentUserResult
- RESTGetAPIGatewayBotResult
- RESTGetAPIGatewayResult
- RESTGetAPIGuildApplicationCommandsPermissionsResult
- RESTGetAPIGuildBanResult
- RESTGetAPIGuildBansResult
- RESTGetAPIGuildChannelsResult
- RESTGetAPIGuildEmojiResult
- RESTGetAPIGuildEmojisResult
- RESTGetAPIGuildIntegrationsResult
- RESTGetAPIGuildInvitesResult
- RESTGetAPIGuildMemberResult
- RESTGetAPIGuildMemberVerificationResult
- RESTGetAPIGuildMembersResult
- RESTGetAPIGuildMembersSearchResult
- RESTGetAPIGuildOnboardingResult
- RESTGetAPIGuildPreviewResult
- RESTGetAPIGuildResult
- RESTGetAPIGuildRolesResult
- RESTGetAPIGuildScheduledEventResult
- RESTGetAPIGuildScheduledEventUsersResult
- RESTGetAPIGuildScheduledEventsResult
- RESTGetAPIGuildStickerResult
- RESTGetAPIGuildStickersResult
- RESTGetAPIGuildTemplatesResult
- RESTGetAPIGuildThreadsResult
- RESTGetAPIGuildVoiceRegionsResult
- RESTGetAPIGuildWebhooksResult
- RESTGetAPIGuildWelcomeScreenResult
- RESTGetAPIGuildWidgetImageResult
- RESTGetAPIGuildWidgetJSONResult
- RESTGetAPIGuildWidgetSettingsResult
- RESTGetAPIInteractionFollowupResult
- RESTGetAPIInteractionOriginalResponseResult
- RESTGetAPIInviteResult
- RESTGetAPIOAuth2CurrentApplicationResult
- RESTGetAPIStageInstanceResult
- RESTGetAPIStickerResult
- RESTGetAPITemplateResult
- RESTGetAPIUserResult
- RESTGetAPIVoiceRegionsResult
- RESTGetAPIWebhookResult
- RESTGetAPIWebhookWithTokenMessageResult
- RESTGetAPIWebhookWithTokenResult
- RESTGetCurrentUserGuildMemberResult
- RESTOAuth2ImplicitAuthorizationURLFragmentResult
- RESTPatchAPIApplicationCommandJSONBody
- RESTPatchAPIApplicationCommandResult
- RESTPatchAPIApplicationGuildCommandJSONBody
- RESTPatchAPIApplicationGuildCommandResult
- RESTPatchAPIAutoModerationRuleJSONBody
- RESTPatchAPIAutoModerationRuleResult
- RESTPatchAPIChannelMessageFormDataBody
- RESTPatchAPIChannelMessageResult
- RESTPatchAPIChannelResult
- RESTPatchAPICurrentGuildMemberNicknameResult
- RESTPatchAPICurrentUserResult
- RESTPatchAPIGuildChannelPositionsJSONBody
- RESTPatchAPIGuildChannelPositionsResult
- RESTPatchAPIGuildEmojiResult
- RESTPatchAPIGuildMemberResult
- RESTPatchAPIGuildMemberVerificationResult
- RESTPatchAPIGuildResult
- RESTPatchAPIGuildRolePositionsJSONBody
- RESTPatchAPIGuildRolePositionsResult
- RESTPatchAPIGuildRoleResult
- RESTPatchAPIGuildScheduledEventJSONBody
- RESTPatchAPIGuildScheduledEventResult
- RESTPatchAPIGuildStickerResult
- RESTPatchAPIGuildTemplateJSONBody
- RESTPatchAPIGuildTemplateResult
- RESTPatchAPIGuildVoiceStateCurrentMemberResult
- RESTPatchAPIGuildVoiceStateUserResult
- RESTPatchAPIGuildWelcomeScreenJSONBody
- RESTPatchAPIGuildWelcomeScreenResult
- RESTPatchAPIGuildWidgetSettingsJSONBody
- RESTPatchAPIGuildWidgetSettingsResult
- RESTPatchAPIInteractionFollowupFormDataBody
- RESTPatchAPIInteractionFollowupJSONBody
- RESTPatchAPIInteractionFollowupResult
- RESTPatchAPIInteractionOriginalResponseFormDataBody
- RESTPatchAPIInteractionOriginalResponseJSONBody
- RESTPatchAPIInteractionOriginalResponseResult
- RESTPatchAPIStageInstanceResult
- RESTPatchAPIWebhookResult
- RESTPatchAPIWebhookWithTokenJSONBody
- RESTPatchAPIWebhookWithTokenMessageFormDataBody
- RESTPatchAPIWebhookWithTokenMessageJSONBody
- RESTPatchAPIWebhookWithTokenMessageResult
- RESTPatchAPIWebhookWithTokenResult
- RESTPostAPIApplicationCommandsJSONBody
- RESTPostAPIApplicationCommandsResult
- RESTPostAPIApplicationGuildCommandsJSONBody
- RESTPostAPIApplicationGuildCommandsResult
- RESTPostAPIAutoModerationRuleResult
- RESTPostAPIChannelFollowersResult
- RESTPostAPIChannelInviteResult
- RESTPostAPIChannelMessageCrosspostResult
- RESTPostAPIChannelMessageFormDataBody
- RESTPostAPIChannelMessageResult
- RESTPostAPIChannelMessagesBulkDeleteResult
- RESTPostAPIChannelMessagesThreadsResult
- RESTPostAPIChannelThreadsResult
- RESTPostAPIChannelTypingResult
- RESTPostAPIChannelWebhookResult
- RESTPostAPICurrentUserCreateDMChannelResult
- RESTPostAPIGuildChannelJSONBody
- RESTPostAPIGuildChannelResult
- RESTPostAPIGuildEmojiResult
- RESTPostAPIGuildForumThreadsFormDataBody
- RESTPostAPIGuildForumThreadsJSONBody
- RESTPostAPIGuildRoleResult
- RESTPostAPIGuildScheduledEventResult
- RESTPostAPIGuildStickerResult
- RESTPostAPIGuildTemplatesResult
- RESTPostAPIGuildsMFAResult
- RESTPostAPIGuildsResult
- RESTPostAPIInteractionCallbackFormDataBody
- RESTPostAPIInteractionCallbackJSONBody
- RESTPostAPIInteractionFollowupFormDataBody
- RESTPostAPIInteractionFollowupJSONBody
- RESTPostAPIInteractionFollowupResult
- RESTPostAPIStageInstanceResult
- RESTPostAPITemplateCreateGuildResult
- RESTPostAPIWebhookWithTokenFormDataBody
- RESTPostAPIWebhookWithTokenGitHubQuery
- RESTPostAPIWebhookWithTokenGitHubResult
- RESTPostAPIWebhookWithTokenGitHubWaitResult
- RESTPostAPIWebhookWithTokenResult
- RESTPostAPIWebhookWithTokenSlackQuery
- RESTPostAPIWebhookWithTokenSlackResult
- RESTPostAPIWebhookWithTokenSlackWaitResult
- RESTPostAPIWebhookWithTokenWaitResult
- RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult
- RESTPostOAuth2ClientCredentialsResult
- RESTPostOAuth2RefreshTokenResult
- RESTPutAPIApplicationCommandPermissionsResult
- RESTPutAPIApplicationCommandsJSONBody
- RESTPutAPIApplicationCommandsResult
- RESTPutAPIApplicationGuildCommandsJSONBody
- RESTPutAPIApplicationGuildCommandsResult
- RESTPutAPIApplicationRoleConnectionMetadataJSONBody
- RESTPutAPIApplicationRoleConnectionMetadataResult
- RESTPutAPIChannelMessageReactionResult
- RESTPutAPIChannelPermissionResult
- RESTPutAPIChannelPinResult
- RESTPutAPIChannelRecipientResult
- RESTPutAPIChannelThreadMembersResult
- RESTPutAPICurrentUserApplicationRoleConnectionResult
- RESTPutAPIGuildApplicationCommandsPermissionsJSONBody
- RESTPutAPIGuildApplicationCommandsPermissionsResult
- RESTPutAPIGuildBanResult
- RESTPutAPIGuildMemberResult
- RESTPutAPIGuildMemberRoleResult
- RESTPutAPIGuildTemplateSyncResult
- RoleIconFormat
- StickerFormat
- StickerPackBannerFormat
- TeamIconFormat
- TextChannelType
- UserAvatarFormat
- UserBannerFormat
Variables
References
FormattingPatterns
Re-exports FormattingPatterns
GatewayURLQuery
Re-exports GatewayURLQuery
Locale
Re-exports Locale
LocaleString
Re-exports LocaleString
LocalizationMap
Re-exports LocalizationMap
PermissionFlagsBits
Re-exports PermissionFlagsBits
RESTError
Re-exports RESTError
RESTErrorData
Re-exports RESTErrorData
RESTErrorFieldInformation
Re-exports RESTErrorFieldInformation
RESTErrorGroupWrapper
Re-exports RESTErrorGroupWrapper
RESTJSONErrorCodes
Re-exports RESTJSONErrorCodes
RESTRateLimit
Re-exports RESTRateLimit
RPCCloseEventCodes
Re-exports RPCCloseEventCodes
RPCErrorCodes
Re-exports RPCErrorCodes
Snowflake
Re-exports Snowflake
Utils
Renames and re-exports discord-api-types/utils/v9
Type Aliases
APIActionRowComponentTypes
APIApplicationCommandAttachmentOption
APIApplicationCommandAutocompleteDMInteraction
APIApplicationCommandAutocompleteGuildInteraction
APIApplicationCommandAutocompleteInteraction
APIApplicationCommandBasicOption
APIApplicationCommandBooleanOption
APIApplicationCommandDMInteraction
APIApplicationCommandGuildInteraction
APIApplicationCommandIntegerOption
APIApplicationCommandInteraction
APIApplicationCommandInteractionData
APIApplicationCommandInteractionDataAttachmentOption
APIApplicationCommandInteractionDataBasicOption
APIApplicationCommandInteractionDataBooleanOption
APIApplicationCommandInteractionDataChannelOption
APIApplicationCommandInteractionDataMentionableOption
APIApplicationCommandInteractionDataOption
APIApplicationCommandInteractionDataRoleOption
APIApplicationCommandInteractionDataUserOption
APIApplicationCommandInteractionWrapper
APIApplicationCommandMentionableOption
APIApplicationCommandNumberOption
APIApplicationCommandOption
APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper
Type parameters
APIApplicationCommandRoleOption
APIApplicationCommandStringOption
APIApplicationCommandUserOption
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
APIAuditLogChangeKeyActions
Returned when an auto moderation rule’s actions is changed
APIAuditLogChangeKeyAllow
Returned when an overwrite’s allowed permissions bitfield is changed
APIAuditLogChangeKeyApplicationId
The application ID of the added or removed Webhook or Bot
APIAuditLogChangeKeyArchived
APIAuditLogChangeKeyAsset
Empty string
APIAuditLogChangeKeyAutoArchiveDuration
APIAuditLogChangeKeyAvailable
Returned when a sticker’s availability is changed
APIAuditLogChangeKeyAvatarHash
Returned when a user’s avatar_hash is changed
APIAuditLogChangeKeyBannerHash
Returned when a guild’s banner hash is changed
APIAuditLogChangeKeyBitrate
Returned when a voice channel’s bitrate is changed
APIAuditLogChangeKeyChannelId
Returned when an invite’s or guild scheduled event’s channel_id is changed
APIAuditLogChangeKeyCode
Returned when an invite’s code is changed
APIAuditLogChangeKeyColor
Returned when a role’s color is changed
APIAuditLogChangeKeyCommunicationDisabledUntil
Returned when a user’s timeout is changed
APIAuditLogChangeKeyDeaf
Returned when a user’s deaf status is changed
APIAuditLogChangeKeyDefaultAutoArchiveDuration
APIAuditLogChangeKeyDefaultMessageNotifications
Returned when a guild’s default_message_notifications is changed
APIAuditLogChangeKeyDeny
Returned when an overwrite’s denied permissions bitfield is changed
APIAuditLogChangeKeyDescription
Returned when a guild’s or sticker’s or guild scheduled event’s description is changed
APIAuditLogChangeKeyDiscoverySplashHash
Returned when a guild’s discovery splash is changed
APIAuditLogChangeKeyEnableEmoticons
Returned when an integration’s enable_emoticons is changed
APIAuditLogChangeKeyEnabled
Returned when an auto moderation rule’s enabled status is changed
APIAuditLogChangeKeyEntityType
Returned when entity type of a guild scheduled event is changed
APIAuditLogChangeKeyEventType
Returned when an auto moderation rule’s event type is changed
APIAuditLogChangeKeyExemptChannels
Returned when an auto moderation rule’s exempt channels is changed
APIAuditLogChangeKeyExemptRoles
Returned when an auto moderation rule’s exempt roles 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
APIAuditLogChangeKeyFormatType
Returned when a sticker’s format_type is changed
APIAuditLogChangeKeyGuildId
Returned when a sticker’s guild_id is changed
APIAuditLogChangeKeyHoist
Returned when a role’s hoist status is changed
APIAuditLogChangeKeyIconHash
Returned when a guild’s icon is changed
APIAuditLogChangeKeyId
The ID of the changed entity - sometimes used in conjunction with other keys
APIAuditLogChangeKeyImageHash
Returned when a guild’s scheduled event’s cover image is changed
APIAuditLogChangeKeyInviterId
Returned when an invite’s inviter_id is changed
APIAuditLogChangeKeyLocation
Returned when location of a guild scheduled event is changed
APIAuditLogChangeKeyLocked
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 an entity’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
APIAuditLogChangeKeyPosition
Returned when a channel’s position is changed
APIAuditLogChangeKeyPreferredLocale
Returned when a guild’s preferred_locale is changed
APIAuditLogChangeKeyPrivacyLevel
Returned when privacy level of a stage instance or guild scheduled event is changed
APIAuditLogChangeKeyPruneDeleteDays
Returned when there is a change in number of days after which inactive and role-unassigned members are kicked
APIAuditLogChangeKeyPublicUpdatesChannelId
Returned when a guild’s public_updates_channel_id is changed
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
APIAuditLogChangeKeyRulesChannelId
Returned when a guild’s rules_channel_id is changed
APIAuditLogChangeKeySnowflake
Represents a change where the key is a snowflake. Currently, the only known instance of this is returned when permissions for a command were updated (
<insert name of object here>
)APIAuditLogChangeKeySplashHash
Returned when a guild’s splash is changed
APIAuditLogChangeKeyStatus
Returned when status of a guild scheduled event is changed
APIAuditLogChangeKeySystemChannelId
Returned when a guild’s system_channel_id is changed
APIAuditLogChangeKeyTags
Returned when a sticker’s related emoji is changed
APIAuditLogChangeKeyTemporary
Returned when an invite’s temporary status is changed
APIAuditLogChangeKeyTopic
Returned when a channel’s topic is changed
APIAuditLogChangeKeyTriggerMetadata
Returned when an auto moderation rule’s trigger metadata is changed
APIAuditLogChangeKeyTriggerType
Returned when an auto moderation rule’s trigger type is changed (only in rule creation or deletion)
APIAuditLogChangeKeyType
The type of entity created
APIAuditLogChangeKeyUserLimit
Returned when a voice channel’s user_limit is changed
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
APIButtonComponent
APIChannel
APIChatInputApplicationCommandDMInteraction
APIChatInputApplicationCommandGuildInteraction
APIChatInputApplicationCommandInteraction
APIChatInputApplicationCommandInteractionDataResolved
APIContextMenuDMInteraction
APIContextMenuGuildInteraction
APIContextMenuInteraction
APIContextMenuInteractionData
APIDMInteraction
APIDMInteractionWrapper
Type parameters
- Original: APIBaseInteraction<InteractionType, unknown>
APIGuildCategoryChannel
APIGuildChannelResolvable
APIGuildCreatePartialChannel
APIGuildIntegrationType
APIGuildInteraction
APIGuildInteractionWrapper
Type parameters
- Original: APIBaseInteraction<InteractionType, unknown>
APIGuildScheduledEvent
APIGuildStageVoiceChannel
APIGuildVoiceChannel
APIInteraction
APIInteractionResponse
APIInteractionResponseCallbackData
APIInviteGuild
APIMentionableSelectComponent
APIMessageActionRowComponent
APIMessageApplicationCommandDMInteraction
APIMessageApplicationCommandGuildInteraction
APIMessageApplicationCommandInteraction
APIMessageButtonInteractionData
APIMessageComponent
APIMessageComponentButtonInteraction
APIMessageComponentDMInteraction
APIMessageComponentGuildInteraction
APIMessageComponentInteraction
APIMessageComponentInteractionData
APIMessageComponentSelectMenuInteraction
APIMessageReferenceSend
APIMessageSelectMenuInteractionData
APIModalActionRowComponent
APIModalComponent
APIModalSubmitDMInteraction
APIModalSubmitGuildInteraction
APIModalSubmitInteraction
APINewsChannel
APIPingInteraction
APIRoleSelectComponent
APISelectMenuComponent
APIStickerItem
APITextChannel
APIUserApplicationCommandDMInteraction
APIUserApplicationCommandGuildInteraction
APIUserApplicationCommandInteraction
APIUserApplicationCommandInteractionDataResolved
APIUserInteractionDataResolved
users and optional members from APIInteractionDataResolved, for user commands and user selects
APIUserSelectComponent
AchievementIconFormat
ApplicationAssetFormat
ApplicationCoverFormat
ApplicationIconFormat
AuditLogRuleTriggerType
DefaultUserAvatar
DefaultUserAvatarAssets
EmojiFormat
GatewayActivityAssets
GatewayActivityEmoji
GatewayActivitySecrets
GatewayActivityUpdateData
GatewayApplicationCommandPermissionsUpdateDispatch
GatewayAutoModerationActionExecutionDispatch
GatewayAutoModerationRuleCreateDispatch
GatewayAutoModerationRuleCreateDispatchData
GatewayAutoModerationRuleDeleteDispatch
GatewayAutoModerationRuleDeleteDispatchData
GatewayAutoModerationRuleModifyDispatch
GatewayAutoModerationRuleModifyDispatchData
GatewayAutoModerationRuleUpdateDispatch
GatewayAutoModerationRuleUpdateDispatchData
GatewayChannelCreateDispatch
GatewayChannelCreateDispatchData
GatewayChannelDeleteDispatch
GatewayChannelDeleteDispatchData
GatewayChannelModifyDispatch
GatewayChannelModifyDispatchData
GatewayChannelPinsUpdateDispatch
GatewayChannelUpdateDispatch
GatewayChannelUpdateDispatchData
GatewayDispatchPayload
GatewayGuildAuditLogEntryCreateDispatch
GatewayGuildBanAddDispatch
GatewayGuildBanAddDispatchData
GatewayGuildBanModifyDispatch
GatewayGuildBanRemoveDispatch
GatewayGuildBanRemoveDispatchData
GatewayGuildCreateDispatch
GatewayGuildDeleteDispatch
GatewayGuildDeleteDispatchData
GatewayGuildEmojisUpdateDispatch
GatewayGuildIntegrationsUpdateDispatch
GatewayGuildMemberAddDispatch
GatewayGuildMemberRemoveDispatch
GatewayGuildMemberUpdateDispatch
GatewayGuildMemberUpdateDispatchData
GatewayGuildMembersChunkDispatch
GatewayGuildModifyDispatch
GatewayGuildModifyDispatchData
GatewayGuildRoleCreateDispatch
GatewayGuildRoleCreateDispatchData
GatewayGuildRoleDeleteDispatch
GatewayGuildRoleModifyDispatch
GatewayGuildRoleUpdateDispatch
GatewayGuildRoleUpdateDispatchData
GatewayGuildScheduledEventCreateDispatch
GatewayGuildScheduledEventCreateDispatchData
GatewayGuildScheduledEventDeleteDispatch
GatewayGuildScheduledEventDeleteDispatchData
GatewayGuildScheduledEventUpdateDispatch
GatewayGuildScheduledEventUpdateDispatchData
GatewayGuildScheduledEventUserAddDispatch
GatewayGuildScheduledEventUserRemoveDispatch
GatewayGuildStickersUpdateDispatch
GatewayGuildUpdateDispatch
GatewayGuildUpdateDispatchData
GatewayHeartbeatData
GatewayIntegrationCreateDispatch
GatewayIntegrationCreateDispatchData
GatewayIntegrationDeleteDispatch
GatewayIntegrationUpdateDispatch
GatewayIntegrationUpdateDispatchData
GatewayInteractionCreateDispatch
GatewayInteractionCreateDispatchData
GatewayInvalidSessionData
GatewayInviteCreateDispatch
GatewayInviteDeleteDispatch
GatewayMessageCreateDispatch
GatewayMessageCreateDispatchData
GatewayMessageDeleteBulkDispatch
GatewayMessageDeleteDispatch
GatewayMessageReactionAddDispatch
GatewayMessageReactionAddDispatchData
GatewayMessageReactionRemoveAllDispatch
GatewayMessageReactionRemoveAllDispatchData
GatewayMessageReactionRemoveDispatch
GatewayMessageReactionRemoveDispatchData
GatewayMessageReactionRemoveEmojiDispatch
GatewayMessageUpdateDispatch
GatewayMessageUpdateDispatchData
GatewayPresenceUpdateDispatch
GatewayPresenceUpdateDispatchData
GatewayReadyDispatch
GatewayReceivePayload
GatewayRequestGuildMembersData
GatewayResumedDispatch
GatewaySendPayload
GatewayStageInstanceCreateDispatch
GatewayStageInstanceCreateDispatchData
GatewayStageInstanceDeleteDispatch
GatewayStageInstanceDeleteDispatchData
GatewayStageInstanceUpdateDispatch
GatewayStageInstanceUpdateDispatchData
GatewayThreadCreateDispatch
GatewayThreadDeleteDispatch
GatewayThreadDeleteDispatchData
GatewayThreadListSyncDispatch
GatewayThreadListSyncDispatchData
GatewayThreadMemberUpdateDispatch
GatewayThreadMemberUpdateDispatchData
GatewayThreadMembersUpdateDispatch
GatewayThreadMembersUpdateDispatchData
GatewayThreadModifyDispatch
GatewayThreadUpdateDispatch
GatewayThreadUpdateDispatchData
GatewayTypingStartDispatch
GatewayUserUpdateDispatch
GatewayUserUpdateDispatchData
GatewayVoiceServerUpdateDispatch
GatewayVoiceStateUpdateDispatch
GatewayVoiceStateUpdateDispatchData
GatewayWebhooksUpdateDispatch
GetAPIVoiceRegionsResult
GuildBannerFormat
GuildChannelType
GuildDiscoverySplashFormat
GuildIconFormat
GuildMemberAvatarFormat
GuildMemberBannerFormat
GuildScheduledEventCoverFormat
GuildSplashFormat
GuildTextChannelType
PartialAPIMessageInteractionGuildMember
RESTDeleteAPIAutoModerationRuleResult
RESTDeleteAPIChannelAllMessageReactionsResult
RESTDeleteAPIChannelMessageOwnReaction
RESTDeleteAPIChannelMessageReactionResult
RESTDeleteAPIChannelMessageResult
RESTDeleteAPIChannelMessageUserReactionResult
RESTDeleteAPIChannelPermissionResult
RESTDeleteAPIChannelPinResult
RESTDeleteAPIChannelRecipientResult
RESTDeleteAPIChannelResult
RESTDeleteAPIChannelThreadMembersResult
RESTDeleteAPICurrentUserGuildResult
RESTDeleteAPIGuildBanResult
RESTDeleteAPIGuildEmojiResult
RESTDeleteAPIGuildIntegrationResult
RESTDeleteAPIGuildMemberResult
RESTDeleteAPIGuildMemberRoleResult
RESTDeleteAPIGuildResult
RESTDeleteAPIGuildRoleResult
RESTDeleteAPIGuildScheduledEventResult
RESTDeleteAPIGuildStickerResult
RESTDeleteAPIGuildTemplateResult
RESTDeleteAPIInteractionFollowupResult
RESTDeleteAPIInteractionOriginalResponseResult
RESTDeleteAPIInviteResult
RESTDeleteAPIStageInstanceResult
RESTDeleteAPIWebhookResult
RESTDeleteAPIWebhookWithTokenMessageResult
RESTDeleteAPIWebhookWithTokenResult
RESTGetAPIApplicationCommandPermissionsResult
RESTGetAPIApplicationCommandResult
RESTGetAPIApplicationCommandsResult
RESTGetAPIApplicationGuildCommandResult
RESTGetAPIApplicationGuildCommandsQuery
RESTGetAPIApplicationGuildCommandsResult
RESTGetAPIApplicationRoleConnectionMetadataResult
RESTGetAPIAuditLogResult
RESTGetAPIAutoModerationRuleResult
RESTGetAPIAutoModerationRulesResult
RESTGetAPIChannelInvitesResult
RESTGetAPIChannelMessageReactionUsersResult
RESTGetAPIChannelMessageResult
RESTGetAPIChannelMessagesResult
RESTGetAPIChannelPinsResult
RESTGetAPIChannelResult
RESTGetAPIChannelThreadMemberResult
RESTGetAPIChannelThreadMembersResult
RESTGetAPIChannelThreadsArchivedPrivateResult
RESTGetAPIChannelThreadsArchivedPublicResult
RESTGetAPIChannelThreadsResult
RESTGetAPIChannelUsersThreadsArchivedResult
RESTGetAPIChannelWebhooksResult
RESTGetAPICurrentUserApplicationRoleConnectionResult
RESTGetAPICurrentUserConnectionsResult
RESTGetAPICurrentUserGuildsResult
RESTGetAPICurrentUserResult
RESTGetAPIGatewayBotResult
RESTGetAPIGatewayResult
RESTGetAPIGuildApplicationCommandsPermissionsResult
RESTGetAPIGuildBanResult
RESTGetAPIGuildBansResult
RESTGetAPIGuildChannelsResult
RESTGetAPIGuildEmojiResult
RESTGetAPIGuildEmojisResult
RESTGetAPIGuildIntegrationsResult
RESTGetAPIGuildInvitesResult
RESTGetAPIGuildMemberResult
RESTGetAPIGuildMemberVerificationResult
RESTGetAPIGuildMembersResult
RESTGetAPIGuildMembersSearchResult
RESTGetAPIGuildOnboardingResult
RESTGetAPIGuildPreviewResult
RESTGetAPIGuildResult
RESTGetAPIGuildRolesResult
RESTGetAPIGuildScheduledEventResult
RESTGetAPIGuildScheduledEventUsersResult
RESTGetAPIGuildScheduledEventsResult
RESTGetAPIGuildStickerResult
RESTGetAPIGuildStickersResult
RESTGetAPIGuildTemplatesResult
RESTGetAPIGuildThreadsResult
RESTGetAPIGuildVoiceRegionsResult
RESTGetAPIGuildWebhooksResult
RESTGetAPIGuildWelcomeScreenResult
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).
RESTGetAPIGuildWidgetJSONResult
RESTGetAPIGuildWidgetSettingsResult
RESTGetAPIInteractionFollowupResult
RESTGetAPIInteractionOriginalResponseResult
RESTGetAPIInviteResult
RESTGetAPIOAuth2CurrentApplicationResult
RESTGetAPIStageInstanceResult
RESTGetAPIStickerResult
RESTGetAPITemplateResult
RESTGetAPIUserResult
RESTGetAPIVoiceRegionsResult
RESTGetAPIWebhookResult
RESTGetAPIWebhookWithTokenMessageResult
RESTGetAPIWebhookWithTokenResult
RESTGetCurrentUserGuildMemberResult
RESTOAuth2ImplicitAuthorizationURLFragmentResult
RESTPatchAPIApplicationCommandJSONBody
RESTPatchAPIApplicationCommandResult
RESTPatchAPIApplicationGuildCommandJSONBody
RESTPatchAPIApplicationGuildCommandResult
RESTPatchAPIAutoModerationRuleJSONBody
RESTPatchAPIAutoModerationRuleResult
RESTPatchAPIChannelMessageFormDataBody
RESTPatchAPIChannelMessageResult
RESTPatchAPIChannelResult
RESTPatchAPICurrentGuildMemberNicknameResult
RESTPatchAPICurrentUserResult
RESTPatchAPIGuildChannelPositionsJSONBody
RESTPatchAPIGuildChannelPositionsResult
RESTPatchAPIGuildEmojiResult
RESTPatchAPIGuildMemberResult
RESTPatchAPIGuildMemberVerificationResult
RESTPatchAPIGuildResult
RESTPatchAPIGuildRolePositionsJSONBody
RESTPatchAPIGuildRolePositionsResult
RESTPatchAPIGuildRoleResult
RESTPatchAPIGuildScheduledEventJSONBody
RESTPatchAPIGuildScheduledEventResult
RESTPatchAPIGuildStickerResult
RESTPatchAPIGuildTemplateJSONBody
RESTPatchAPIGuildTemplateResult
RESTPatchAPIGuildVoiceStateCurrentMemberResult
RESTPatchAPIGuildVoiceStateUserResult
RESTPatchAPIGuildWelcomeScreenJSONBody
RESTPatchAPIGuildWelcomeScreenResult
RESTPatchAPIGuildWidgetSettingsJSONBody
RESTPatchAPIGuildWidgetSettingsResult
RESTPatchAPIInteractionFollowupFormDataBody
RESTPatchAPIInteractionFollowupJSONBody
RESTPatchAPIInteractionFollowupResult
RESTPatchAPIInteractionOriginalResponseFormDataBody
RESTPatchAPIInteractionOriginalResponseJSONBody
RESTPatchAPIInteractionOriginalResponseResult
RESTPatchAPIStageInstanceResult
RESTPatchAPIWebhookResult
RESTPatchAPIWebhookWithTokenJSONBody
RESTPatchAPIWebhookWithTokenMessageFormDataBody
RESTPatchAPIWebhookWithTokenMessageJSONBody
RESTPatchAPIWebhookWithTokenMessageResult
RESTPatchAPIWebhookWithTokenResult
RESTPostAPIApplicationCommandsJSONBody
RESTPostAPIApplicationCommandsResult
RESTPostAPIApplicationGuildCommandsJSONBody
RESTPostAPIApplicationGuildCommandsResult
RESTPostAPIAutoModerationRuleResult
RESTPostAPIChannelFollowersResult
RESTPostAPIChannelInviteResult
RESTPostAPIChannelMessageCrosspostResult
RESTPostAPIChannelMessageFormDataBody
RESTPostAPIChannelMessageResult
RESTPostAPIChannelMessagesBulkDeleteResult
RESTPostAPIChannelMessagesThreadsResult
RESTPostAPIChannelThreadsResult
RESTPostAPIChannelTypingResult
RESTPostAPIChannelWebhookResult
RESTPostAPICurrentUserCreateDMChannelResult
RESTPostAPIGuildChannelJSONBody
RESTPostAPIGuildChannelResult
RESTPostAPIGuildEmojiResult
RESTPostAPIGuildForumThreadsFormDataBody
RESTPostAPIGuildForumThreadsJSONBody
RESTPostAPIGuildRoleResult
RESTPostAPIGuildScheduledEventResult
RESTPostAPIGuildStickerResult
RESTPostAPIGuildTemplatesResult
RESTPostAPIGuildsMFAResult
RESTPostAPIGuildsResult
RESTPostAPIInteractionCallbackFormDataBody
RESTPostAPIInteractionCallbackJSONBody
RESTPostAPIInteractionFollowupFormDataBody
RESTPostAPIInteractionFollowupJSONBody
RESTPostAPIInteractionFollowupResult
RESTPostAPIStageInstanceResult
RESTPostAPITemplateCreateGuildResult
RESTPostAPIWebhookWithTokenFormDataBody
RESTPostAPIWebhookWithTokenGitHubQuery
RESTPostAPIWebhookWithTokenGitHubResult
RESTPostAPIWebhookWithTokenGitHubWaitResult
Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
the wait query parameter set to true
RESTPostAPIWebhookWithTokenResult
RESTPostAPIWebhookWithTokenSlackQuery
RESTPostAPIWebhookWithTokenSlackResult
RESTPostAPIWebhookWithTokenSlackWaitResult
Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
the wait query parameter set to true
RESTPostAPIWebhookWithTokenWaitResult
Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
the wait query parameter set to true
RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult
RESTPostOAuth2ClientCredentialsResult
RESTPostOAuth2RefreshTokenResult
RESTPutAPIApplicationCommandPermissionsResult
RESTPutAPIApplicationCommandsJSONBody
RESTPutAPIApplicationCommandsResult
RESTPutAPIApplicationGuildCommandsJSONBody
RESTPutAPIApplicationGuildCommandsResult
RESTPutAPIApplicationRoleConnectionMetadataJSONBody
RESTPutAPIApplicationRoleConnectionMetadataResult
RESTPutAPIChannelMessageReactionResult
RESTPutAPIChannelPermissionResult
RESTPutAPIChannelPinResult
RESTPutAPIChannelRecipientResult
RESTPutAPIChannelThreadMembersResult
RESTPutAPICurrentUserApplicationRoleConnectionResult
RESTPutAPIGuildApplicationCommandsPermissionsJSONBody
RESTPutAPIGuildApplicationCommandsPermissionsResult
RESTPutAPIGuildBanResult
RESTPutAPIGuildMemberResult
RESTPutAPIGuildMemberRoleResult
RESTPutAPIGuildTemplateSyncResult
RoleIconFormat
StickerFormat
StickerPackBannerFormat
TeamIconFormat
TextChannelType
UserAvatarFormat
UserBannerFormat
Variables
constAPIApplicationCommandPermissionsConstant
Type declaration
AllChannels: (guildId: string | bigint) => string
Parameters
guildId: string | bigint
Returns string
Everyone: (guildId: string | bigint) => string
Parameters
guildId: string | bigint
Returns string
constAPIVersion
constCDNRoutes
Type declaration
achievementIcon: function
Route for:
- GET
/app-assets/{application.id}/achievements/{achievement.id}/icons/{achievement.icon}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
applicationId: string
achievementId: string
achievementIconHash: string
format: AchievementIconFormat
Returns `/app-assets/${string}/achievements/${string}/icons/${string}.jpeg` | `/app-assets/${string}/achievements/${string}/icons/${string}.png` | `/app-assets/${string}/achievements/${string}/icons/${string}.webp`
- GET
applicationAsset: function
Route for:
- GET
/app-assets/{application.id}/{application.asset_id}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
applicationId: string
applicationAssetId: string
format: ApplicationAssetFormat
Returns `/app-assets/${string}/${string}.jpeg` | `/app-assets/${string}/${string}.png` | `/app-assets/${string}/${string}.webp`
- GET
applicationCover: function
Route for:
- GET
/app-icons/{application.id}/{application.cover_image}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
applicationId: string
applicationCoverImage: string
format: ApplicationCoverFormat
Returns `/app-icons/${string}/${string}.jpeg` | `/app-icons/${string}/${string}.png` | `/app-icons/${string}/${string}.webp`
- GET
applicationIcon: function
Route for:
- GET
/app-icons/{application.id}/{application.icon}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
applicationId: string
applicationIcon: string
format: ApplicationIconFormat
Returns `/app-icons/${string}/${string}.jpeg` | `/app-icons/${string}/${string}.png` | `/app-icons/${string}/${string}.webp`
- GET
defaultUserAvatar: function
Route for:
- GET
/embed/avatars/{user.discriminator % 5}.png
The
userDiscriminatorparameter should be the user discriminator modulo 5 (e.g. 1337 % 5 = 2)This route supports the extension: PNG
Parameters
userDiscriminator: DefaultUserAvatarAssets
Returns /embed/avatars/0.png | /embed/avatars/2.png | /embed/avatars/1.png | /embed/avatars/3.png | /embed/avatars/4.png | /embed/avatars/5.png
- GET
emoji: function
Route for:
- GET
/emojis/{emoji.id}.{png|jpeg|webp|gif}
As this route supports GIFs, the hash will begin with
a_if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF
Parameters
emojiId: string
format: EmojiFormat
Returns `/emojis/${string}.jpeg` | `/emojis/${string}.png` | `/emojis/${string}.webp` | `/emojis/${string}.gif`
- GET
guildBanner: function
Route for:
- GET
/banners/{guild.id}/{guild.banner}.{png|jpeg|webp|gif}
As this route supports GIFs, the hash will begin with
a_if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF
Parameters
guildId: string
guildBanner: string
format: GuildBannerFormat
Returns `/banners/${string}/${string}.jpeg` | `/banners/${string}/${string}.png` | `/banners/${string}/${string}.webp` | `/banners/${string}/${string}.gif`
- GET
guildDiscoverySplash: function
Route for:
- GET
/discovery-splashes/{guild.id}/{guild.discovery_splash}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
guildId: string
guildDiscoverySplash: string
format: GuildDiscoverySplashFormat
Returns `/discovery-splashes/${string}/${string}.jpeg` | `/discovery-splashes/${string}/${string}.png` | `/discovery-splashes/${string}/${string}.webp`
- GET
guildIcon: function
Route for:
- GET
/guilds/{guild.id}/icons/{guild.id}.{png|jpeg|webp|gif}
As this route supports GIFs, the hash will begin with
a_if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF
Parameters
guildId: string
guildIcon: string
format: GuildIconFormat
Returns `icons/${string}/${string}.jpeg` | `icons/${string}/${string}.png` | `icons/${string}/${string}.webp` | `icons/${string}/${string}.gif`
- GET
guildMemberAvatar: function
Route for:
- GET
/guilds/{guild.id}/users/{user.id}/{guild_member.avatar}.{png|jpeg|webp|gif}
As this route supports GIFs, the hash will begin with
a_if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF
Parameters
guildId: string
userId: string
memberAvatar: string
format: GuildMemberAvatarFormat
Returns `/guilds/${string}/users/${string}/avatars/${string}.jpeg` | `/guilds/${string}/users/${string}/avatars/${string}.png` | `/guilds/${string}/users/${string}/avatars/${string}.webp` | `/guilds/${string}/users/${string}/avatars/${string}.gif`
- GET
guildMemberBanner: function
Route for:
- GET
/guilds/${guild.id}/users/${user.id}/banners/${guild_member.banner}.{png|jpeg|webp|gif}
This route supports the extensions: PNG, JPEG, WebP, GIF
Parameters
guildId: string
userId: string
guildMemberBanner: string
format: GuildMemberBannerFormat
Returns `/guilds/${string}/users/${string}/banners/${string}.jpeg` | `/guilds/${string}/users/${string}/banners/${string}.png` | `/guilds/${string}/users/${string}/banners/${string}.webp` | `/guilds/${string}/users/${string}/banners/${string}.gif`
- GET
guildScheduledEventCover: function
Route for:
- GET
/guild-events/{guild_scheduled_event.id}/{guild_scheduled_event.image}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
guildScheduledEventId: string
guildScheduledEventCoverImage: string
format: GuildScheduledEventCoverFormat
Returns `/guild-events/${string}/${string}.jpeg` | `/guild-events/${string}/${string}.png` | `/guild-events/${string}/${string}.webp`
- GET
guildSplash: function
Route for:
- GET
/splashes/{guild.id}/{guild.splash}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
guildId: string
guildSplash: string
format: GuildSplashFormat
Returns `/splashes/${string}/${string}.jpeg` | `/splashes/${string}/${string}.png` | `/splashes/${string}/${string}.webp`
- GET
roleIcon: function
Route for:
- GET
/role-icons/{role.id}/{role.icon}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
roleId: string
roleIcon: string
format: RoleIconFormat
Returns `/role-icons/${string}/${string}.jpeg` | `/role-icons/${string}/${string}.png` | `/role-icons/${string}/${string}.webp`
- GET
sticker: function
Route for:
- GET
/stickers/{sticker.id}.{png|json}
This route supports the extensions: PNG, Lottie, GIF
Parameters
stickerId: string
format: StickerFormat
Returns `/stickers/${string}.png` | `/stickers/${string}.gif` | `/stickers/${string}.json`
- GET
stickerPackBanner: function
Route for:
- GET
/app-assets/710982414301790216/store/{sticker_pack.banner.asset_id}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
stickerPackBannerAssetId: string
format: StickerPackBannerFormat
Returns `/app-assets/710982414301790216/store/${string}.jpeg` | `/app-assets/710982414301790216/store/${string}.png` | `/app-assets/710982414301790216/store/${string}.webp`
- GET
storePageAsset: function
Route for:
- GET
/app-assets/${application.id}/store/${asset.id}.{png|jpeg|webp}}
This route supports the extensions: PNG, JPEG, WebP
Parameters
applicationId: string
assetId: string
Returns `/app-assets/${string}/store/${string}.png`
- GET
teamIcon: function
Route for:
- GET
team-icons/{team.id}/{team.icon}.{png|jpeg|webp}
This route supports the extensions: PNG, JPEG, WebP
Parameters
teamId: string
teamIcon: string
format: TeamIconFormat
Returns `/team-icons/${string}/${string}.jpeg` | `/team-icons/${string}/${string}.png` | `/team-icons/${string}/${string}.webp`
- GET
userAvatar: function
Route for:
- GET
/avatars/{user.id}/{user.avatar}.{png|jpeg|webp|gif}
As this route supports GIFs, the hash will begin with
a_if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF
Parameters
userId: string
userAvatar: string
format: UserAvatarFormat
Returns `/avatars/${string}/${string}.jpeg` | `/avatars/${string}/${string}.png` | `/avatars/${string}/${string}.webp` | `/avatars/${string}/${string}.gif`
- GET
userBanner: function
Route for:
- GET
/banners/{user.id}/{user.banner}.{png|jpeg|webp|gif}
As this route supports GIFs, the hash will begin with
a_if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF
Parameters
userId: string
userBanner: string
format: UserBannerFormat
Returns `/banners/${string}/${string}.jpeg` | `/banners/${string}/${string}.png` | `/banners/${string}/${string}.webp` | `/banners/${string}/${string}.gif`
- GET
constGatewayVersion
constOAuth2Routes
Type declaration
authorizationURL: https://discord.com/api/v9/oauth2/authorize
tokenRevocationURL: https://discord.com/api/v9/oauth2/token/revoke
tokenURL: https://discord.com/api/v9/oauth2/token
constRouteBases
Type declaration
api: https://discord.com/api/v9
cdn: https://cdn.discordapp.com
gift: https://discord.gift
invite: https://discord.gg
scheduledEvent: https://discord.com/events
template: https://discord.new
constRoutes
Type declaration
applicationCommand: function
Route for:
- GET
/applications/{application.id}/commands/{command.id} - PATCH
/applications/{application.id}/commands/{command.id} - DELETE
/applications/{application.id}/commands/{command.id}
Parameters
applicationId: string
commandId: string
Returns `/applications/${string}/commands/${string}`
- GET
applicationCommandPermissions: function
Route for:
- GET
/applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions - PUT
/applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions
Parameters
applicationId: string
guildId: string
commandId: string
Returns `/applications/${string}/guilds/${string}/commands/${string}/permissions`
- GET
applicationCommands: function
Route for:
- GET
/applications/{application.id}/commands - PUT
/applications/{application.id}/commands - POST
/applications/{application.id}/commands
Parameters
applicationId: string
Returns `/applications/${string}/commands`
- GET
applicationGuildCommand: function
Route for:
- GET
/applications/{application.id}/guilds/{guild.id}/commands/{command.id} - PATCH
/applications/{application.id}/guilds/{guild.id}/commands/{command.id} - DELETE
/applications/{application.id}/guilds/{guild.id}/commands/{command.id}
Parameters
applicationId: string
guildId: string
commandId: string
Returns `/applications/${string}/guilds/${string}/commands/${string}`
- GET
applicationGuildCommands: function
Route for:
- GET
/applications/{application.id}/guilds/{guild.id}/commands - PUT
/applications/{application.id}/guilds/{guild.id}/commands - POST
/applications/{application.id}/guilds/{guild.id}/commands
Parameters
applicationId: string
guildId: string
Returns `/applications/${string}/guilds/${string}/commands`
- GET
applicationRoleConnectionMetadata: function
Route for:
- GET
/applications/{application.id}/role-connections/metadata - PUT
/applications/{application.id}/role-connections/metadata
Parameters
applicationId: string
Returns `/applications/${string}/role-connections/metadata`
- GET
channel: function
Route for:
- GET
/channels/{channel.id} - PATCH
/channels/{channel.id} - DELETE
/channels/{channel.id}
Parameters
channelId: string
Returns `/channels/${string}`
- GET
channelBulkDelete: function
Route for:
- POST
/channels/{channel.id}/messages/bulk-delete
Parameters
channelId: string
Returns `/channels/${string}/messages/bulk-delete`
- POST
channelFollowers: function
Route for:
- POST
/channels/{channel.id}/followers
Parameters
channelId: string
Returns `/channels/${string}/followers`
- POST
channelInvites: function
Route for:
- GET
/channels/{channel.id}/invites - POST
/channels/{channel.id}/invites
Parameters
channelId: string
Returns `/channels/${string}/invites`
- GET
channelJoinedArchivedThreads: function
Route for:
- GET
/channels/{channel.id}/users/@me/threads/archived/prviate
Parameters
channelId: string
Returns `/channels/${string}/users/@me/threads/archived/private`
- 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 `/channels/${string}/messages/${string}`
- GET
channelMessageAllReactions: function
Route for:
- DELETE
/channels/{channel.id}/messages/{message.id}/reactions
Parameters
channelId: string
messageId: string
Returns `/channels/${string}/messages/${string}/reactions`
- DELETE
channelMessageCrosspost: function
Route for:
- POST
/channels/{channel.id}/messages/{message.id}/crosspost
Parameters
channelId: string
messageId: string
Returns `/channels/${string}/messages/${string}/crosspost`
- POST
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 `/channels/${string}/messages/${string}/reactions/${string}/@me`
- PUT
channelMessageReaction: 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 `/channels/${string}/messages/${string}/reactions/${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 `/channels/${string}/messages/${string}/reactions/${string}/${string}`
- DELETE
channelMessages: function
Route for:
- GET
/channels/{channel.id}/messages - POST
/channels/{channel.id}/messages
Parameters
channelId: string
Returns `/channels/${string}/messages`
- GET
channelPermission: function
Route for:
- PUT
/channels/{channel.id}/permissions/{overwrite.id} - DELETE
/channels/{channel.id}/permissions/{overwrite.id}
Parameters
channelId: string
overwriteId: string
Returns `/channels/${string}/permissions/${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 `/channels/${string}/pins/${string}`
- PUT
channelPins: function
Route for:
- GET
/channels/{channel.id}/pins
Parameters
channelId: string
Returns `/channels/${string}/pins`
- 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 `/channels/${string}/recipients/${string}`
- PUT
channelThreads: function
Route for:
- GET
/channels/{channel.id}/threads/active(deprecated, removed in API v10, use List Active Guild Threads instead.) - GET
/channels/{channel.id}/threads/archived/public - GET
/channels/{channel.id}/threads/archived/private
Parameters
channelId: string
optionalarchived: public | private
Returns `/channels/${string}/threads/active` | `/channels/${string}/threads/archived/public` | `/channels/${string}/threads/archived/private`
- GET
channelTyping: function
Route for:
- POST
/channels/{channel.id}/typing
Parameters
channelId: string
Returns `/channels/${string}/typing`
- POST
channelWebhooks: function
Route for:
- GET
/channels/{channel.id}/webhooks - POST
/channels/{channel.id}/webhooks
Parameters
channelId: string
Returns `/channels/${string}/webhooks`
- GET
gateway: function
Route for:
- GET
/gateway
Returns /gateway
- GET
gatewayBot: function
Route for:
- GET
/gateway/bot
Returns /gateway/bot
- GET
guild: function
Route for:
- GET
/guilds/{guild.id} - PATCH
/guilds/{guild.id} - DELETE
/guilds/{guild.id}
Parameters
guildId: string
Returns `/guilds/${string}`
- GET
guildActiveThreads: function
Route for:
- GET
/guilds/{guild.id}/threads/active
Parameters
guildId: string
Returns `/guilds/${string}/threads/active`
- GET
guildApplicationCommandsPermissions: function
Route for:
- GET
/applications/{application.id}/guilds/{guild.id}/commands/permissions - PUT
/applications/{application.id}/guilds/{guild.id}/commands/permissions
Parameters
applicationId: string
guildId: string
Returns `/applications/${string}/guilds/${string}/commands/permissions`
- GET
guildAuditLog: function
Route for:
- GET
/guilds/{guild.id}/audit-logs
Parameters
guildId: string
Returns `/guilds/${string}/audit-logs`
- GET
guildAutoModerationRule: function
Routes for:
- GET
/guilds/{guild.id}/auto-moderation/rules/{rule.id} - PATCH
/guilds/{guild.id}/auto-moderation/rules/{rule.id} - DELETE
/guilds/{guild.id}/auto-moderation/rules/{rule.id}
Parameters
guildId: string
ruleId: string
Returns `/guilds/${string}/auto-moderation/rules/${string}`
- GET
guildAutoModerationRules: function
Route for:
- GET
/guilds/{guild.id}/auto-moderation/rules - POST
/guilds/{guild.id}/auto-moderation/rules
Parameters
guildId: string
Returns `/guilds/${string}/auto-moderation/rules`
- 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 `/guilds/${string}/bans/${string}`
- GET
guildBans: function
Route for:
- GET
/guilds/{guild.id}/bans
Parameters
guildId: string
Returns `/guilds/${string}/bans`
- GET
guildChannels: function
Route for:
- GET
/guilds/{guild.id}/channels - POST
/guilds/{guild.id}/channels - PATCH
/guilds/{guild.id}/channels
Parameters
guildId: string
Returns `/guilds/${string}/channels`
- GET
guildCurrentMemberNickname: function
Route for:
- PATCH
/guilds/{guild.id}/members/@me/nick
Parameters
guildId: string
Returns `/guilds/${string}/members/@me/nick`
- 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 `/guilds/${string}/emojis/${string}`
- GET
guildEmojis: function
Route for:
- GET
/guilds/{guild.id}/emojis - POST
/guilds/{guild.id}/emojis
Parameters
guildId: string
Returns `/guilds/${string}/emojis`
- GET
guildIntegration: function
Route for:
- DELETE
/guilds/{guild.id}/integrations/{integration.id}
Parameters
guildId: string
integrationId: string
Returns `/guilds/${string}/integrations/${string}`
- DELETE
guildIntegrations: function
Route for:
- GET
/guilds/{guild.id}/integrations
Parameters
guildId: string
Returns `/guilds/${string}/integrations`
- GET
guildInvites: function
Route for:
- GET
/guilds/{guild.id}/invites
Parameters
guildId: string
Returns `/guilds/${string}/invites`
- GET
guildMFA: function
Route for:
- POST
/guilds/{guild.id}/mfa
Parameters
guildId: string
Returns `/guilds/${string}/mfa`
- POST
guildMember: function
Route for:
- GET
/guilds/{guild.id}/members/{user.id} - PUT
/guilds/{guild.id}/members/{user.id} - PATCH
/guilds/{guild.id}/members/@me - PATCH
/guilds/{guild.id}/members/{user.id} - DELETE
/guilds/{guild.id}/members/{user.id}
Parameters
guildId: string
userId: string = '@me'
Returns `/guilds/${string}/members/${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 `/guilds/${string}/members/${string}/roles/${string}`
- PUT
guildMemberVerification: function
Route for:
- GET
/guilds/{guild.id}/member-verification - PATCH
/guilds/{guild.id}/member-verification
Parameters
guildId: string
Returns `/guilds/${string}/member-verification`
- GET
guildMembers: function
Route for:
- GET
/guilds/{guild.id}/members
Parameters
guildId: string
Returns `/guilds/${string}/members`
- GET
guildMembersSearch: function
Route for:
- GET
/guilds/{guild.id}/members/search
Parameters
guildId: string
Returns `/guilds/${string}/members/search`
- GET
guildOnboarding: function
Route for:
- GET
/guilds/${guild.id}/onboarding
Parameters
guildId: string
Returns `/guilds/${string}/onboarding`
- GET
guildPreview: function
Route for:
- GET
/guilds/{guild.id}/preview
Parameters
guildId: string
Returns `/guilds/${string}/preview`
- GET
guildPrune: function
Route for:
- GET
/guilds/{guild.id}/prune - POST
/guilds/{guild.id}/prune
Parameters
guildId: string
Returns `/guilds/${string}/prune`
- 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 `/guilds/${string}/roles/${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 `/guilds/${string}/roles`
- GET
guildScheduledEvent: function
Route for:
- GET
/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id} - PATCH
/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id} - DELETE
/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}
Parameters
guildId: string
guildScheduledEventId: string
Returns `/guilds/${string}/scheduled-events/${string}`
- GET
guildScheduledEventUsers: function
Route for:
- GET
/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}/users
Parameters
guildId: string
guildScheduledEventId: string
Returns `/guilds/${string}/scheduled-events/${string}/users`
- GET
guildScheduledEvents: function
Route for:
- GET
/guilds/{guild.id}/scheduled-events - POST
/guilds/{guild.id}/scheduled-events
Parameters
guildId: string
Returns `/guilds/${string}/scheduled-events`
- GET
guildSticker: function
Route for:
- GET
/guilds/{guild.id}/stickers/{sticker.id} - PATCH
/guilds/{guild.id}/stickers/{sticker.id} - DELETE
/guilds/{guild.id}/stickers/{sticker.id}
Parameters
guildId: string
stickerId: string
Returns `/guilds/${string}/stickers/${string}`
- GET
guildStickers: function
Route for:
- GET
/guilds/{guild.id}/stickers - POST
/guilds/{guild.id}/stickers
Parameters
guildId: string
Returns `/guilds/${string}/stickers`
- GET
guildTemplate: function
Route for:
- PUT
/guilds/{guild.id}/templates/{template.code} - PATCH
/guilds/{guild.id}/templates/{template.code} - DELETE
/guilds/{guild.id}/templates/{template.code}
Parameters
guildId: string
code: string
Returns `/guilds/${string}/templates/${string}`
- PUT
guildTemplates: function
Route for:
- GET
/guilds/{guild.id}/templates - POST
/guilds/{guild.id}/templates
Parameters
guildId: string
Returns `/guilds/${string}/templates`
- GET
guildVanityUrl: function
Route for:
- GET
/guilds/{guild.id}/vanity-url
Parameters
guildId: string
Returns `/guilds/${string}/vanity-url`
- GET
guildVoiceRegions: function
Route for:
- GET
/guilds/{guild.id}/regions
Parameters
guildId: string
Returns `/guilds/${string}/regions`
- GET
guildVoiceState: function
Route for:
- PATCH
/guilds/{guild.id}/voice-states/@me - PATCH
/guilds/{guild.id}/voice-states/{user.id}
Parameters
guildId: string
userId: string = '@me'
Returns `/guilds/${string}/voice-states/${string}`
- PATCH
guildWebhooks: function
Route for:
- GET
/guilds/{guild.id}/webhooks
Parameters
guildId: string
Returns `/guilds/${string}/webhooks`
- GET
guildWelcomeScreen: function
Route for:
- GET
/guilds/{guild.id}/welcome-screen - PATCH
/guilds/{guild.id}/welcome-screen
Parameters
guildId: string
Returns `/guilds/${string}/welcome-screen`
- GET
guildWidgetImage: function
Route for:
- GET
/guilds/{guild.id}/widget.png
Parameters
guildId: string
Returns `/guilds/${string}/widget.png`
- GET
guildWidgetJSON: function
Route for:
- GET
/guilds/{guild.id}/widget.json
Parameters
guildId: string
Returns `/guilds/${string}/widget.json`
- GET
guildWidgetSettings: function
Route for:
- GET
/guilds/{guild.id}/widget - PATCH
/guilds/{guild.id}/widget
Parameters
guildId: string
Returns `/guilds/${string}/widget`
- GET
guilds: function
Route for:
- POST
/guilds
Returns /guilds
- POST
interactionCallback: function
Route for:
- POST
/interactions/{interaction.id}/{interaction.token}/callback
Parameters
interactionId: string
interactionToken: string
Returns `/interactions/${string}/${string}/callback`
- POST
invite: function
Route for:
- GET
/invites/{invite.code} - DELETE
/invites/{invite.code}
Parameters
code: string
Returns `/invites/${string}`
- GET
nitroStickerPacks: function
Route for:
- GET
/sticker-packs
Returns /sticker-packs
- GET
oauth2Authorization: function
Route for:
- GET
/oauth2/authorize
Returns /oauth2/authorize
- GET
oauth2CurrentApplication: function
Route for:
- GET
/oauth2/applications/@me
Returns /oauth2/applications/@me
- GET
oauth2CurrentAuthorization: function
Route for:
- GET
/oauth2/@me
Returns /oauth2/@me
- GET
oauth2TokenExchange: function
Route for:
- POST
/oauth2/token
Returns /oauth2/token
- POST
oauth2TokenRevocation: function
Route for:
- POST
/oauth2/token/revoke
Returns /oauth2/token/revoke
- POST
stageInstance: function
Route for:
- GET
/stage-instances/{channel.id} - PATCH
/stage-instances/{channel.id} - DELETE
/stage-instances/{channel.id}
Parameters
channelId: string
Returns `/stage-instances/${string}`
- GET
stageInstances: function
Route for:
- POST
/stage-instances
Returns /stage-instances
- POST
sticker: function
Route for:
- GET
/stickers/{sticker.id}
Parameters
stickerId: string
Returns `/stickers/${string}`
- GET
template: function
Route for:
- GET
/guilds/templates/{template.code} - POST
/guilds/templates/{template.code}
Parameters
code: string
Returns `/guilds/templates/${string}`
- GET
threadMembers: function
Route for:
- GET
/channels/{thread.id}/thread-members - GET
/channels/{thread.id}/thread-members/{user.id} - PUT
/channels/{thread.id}/thread-members/@me - PUT
/channels/{thread.id}/thread-members/{user.id} - DELETE
/channels/{thread.id}/thread-members/@me - DELETE
/channels/{thread.id}/thread-members/{user.id}
Parameters
threadId: string
optionaluserId: string
Returns `/channels/${string}/thread-members` | `/channels/${string}/thread-members/${string}`
- GET
threads: function
Route for:
- POST
/channels/{channel.id}/threads - POST
/channels/{channel.id}/messages/{message.id}/threads
Parameters
parentId: string
optionalmessageId: string
Returns `/channels/${string}/threads` | `/channels/${string}/messages/${string}/threads`
- POST
user: function
Route for:
- GET
/users/@me - GET
/users/{user.id} - PATCH
/users/@me
Parameters
userId: string = '@me'
Returns `/users/${string}`
- GET
userApplicationRoleConnection: function
Route for:
- GET
/users/@me/applications/{application.id}/role-connection - PUT
/users/@me/applications/{application.id}/role-connection
Parameters
applicationId: string
Returns `/users/@me/applications/${string}/role-connection`
- GET
userChannels: function
Route for:
- POST
/users/@me/channels
Returns /users/@me/channels
- POST
userConnections: function
Route for:
- GET
/users/@me/connections
Returns /users/@me/connections
- GET
userGuild: function
Route for:
- DELETE
/users/@me/guilds/{guild.id}
Parameters
guildId: string
Returns `/users/@me/guilds/${string}`
- DELETE
userGuildMember: function
Route for:
- GET
/users/@me/guilds/{guild.id}/member
Parameters
guildId: string
Returns `/users/@me/guilds/${string}/member`
- GET
userGuilds: function
Route for:
- GET
/users/@me/guilds
Returns /users/@me/guilds
- GET
voiceRegions: function
Route for:
- GET
/voice/regions
Returns /voice/regions
- 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}
- POST
/webhooks/{application.id}/{interaction.token}
Parameters
webhookId: string
optionalwebhookToken: string
Returns `/webhooks/${string}` | `/webhooks/${string}/${string}`
- GET
webhookMessage: function
Route for:
- GET
/webhooks/{webhook.id}/{webhook.token}/messages/@original - GET
/webhooks/{webhook.id}/{webhook.token}/messages/{message.id} - PATCH
/webhooks/{webhook.id}/{webhook.token}/messages/@original - PATCH
/webhooks/{webhook.id}/{webhook.token}/messages/{message.id} - DELETE
/webhooks/{webhook.id}/{webhook.token}/messages/@original - DELETE
/webhooks/{webhook.id}/{webhook.token}/messages/{message.id}
- PATCH
/webhooks/{application.id}/{interaction.token}/messages/@original - PATCH
/webhooks/{application.id}/{interaction.token}/messages/{message.id} - DELETE
/webhooks/{application.id}/{interaction.token}/messages/{message.id}
Parameters
webhookId: string
webhookToken: string
messageId: string = '@original'
Returns `/webhooks/${string}/${string}/messages/${string}`
- GET
webhookPlatform: function
Route for:
- POST
/webhooks/{webhook.id}/{webhook.token}/github - POST
/webhooks/{webhook.id}/{webhook.token}/slack
Parameters
webhookId: string
webhookToken: string
platform: github | slack
Returns `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`
- POST
https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object