RestRoutes
Documentation / @discordeno/rest / RestRoutes
Interface: RestRoutes
Defined in: typings/routes.ts:24
Properties
application
application: () =>
string
Defined in: typings/routes.ts:343
Route to get and edit information about the current application.
Returns
string
applicationActivityInstance
applicationActivityInstance: (
applicationId,instanceId) =>string
Defined in: typings/routes.ts:345
Route for get an activity instance
Parameters
applicationId
instanceId
string
Returns
string
applicationEmoji
applicationEmoji: (
applicationId,emojiId) =>string
Defined in: typings/routes.ts:339
Route to get / edit / delete an application emoji
Parameters
applicationId
emojiId
Returns
string
applicationEmojis
applicationEmojis: (
applicationId) =>string
Defined in: typings/routes.ts:335
Route to list / create an application emoji
Parameters
applicationId
Returns
string
applicationRoleConnectionMetadata
applicationRoleConnectionMetadata: (
applicationId) =>string
Defined in: typings/routes.ts:337
Route to list / update application role connection metadata records
Parameters
applicationId
Returns
string
channels
channels:
object
Defined in: typings/routes.ts:42
Routes for channel related endpoints.
bulk
bulk: (
channelId) =>string
Route for handling bulk messages in a channel.
Parameters
channelId
Returns
string
channel
channel: (
channelId) =>string
Route for a specific channel.
Parameters
channelId
Returns
string
crosspost
crosspost: (
channelId,messageId) =>string
Route for handling crossposting a specific message.
Parameters
channelId
messageId
Returns
string
dm
dm: () =>
string
Route for non-specific dm channel.
Returns
string
dmRecipient
dmRecipient: (
channelId,userId) =>string
Route to add a user to an exiting group DM, requires an access token with the OAuth2 gdm.join scope
Parameters
channelId
userId
Returns
string
follow
follow: (
channelId) =>string
Route for following a specific channel.
Parameters
channelId
Returns
string
forum
forum: (
channelId) =>string
Route for managing a forum with a message.
Parameters
channelId
Returns
string
invites
invites: (
channelId) =>string
Route for a specific channel's invites.
Parameters
channelId
Returns
string
message
message: (
channelId,id) =>string
Route for a specific message
Parameters
channelId
id
Returns
string
messagePin
messagePin: (
channelId,messageId) =>string
Route for handling a specific pin.
Parameters
channelId
messageId
Returns
string
messagePins
messagePins: (
channelId,options?) =>string
Route for handling a channel's pins.
Parameters
channelId
options?
Returns
string
messages
messages: (
channelId,options?) =>string
Route for handling non-specific messages.
Parameters
channelId
options?
Returns
string
overwrite
overwrite: (
channelId,overwriteId) =>string
Route for handling a specific overwrite.
Parameters
channelId
overwriteId
Returns
string
pin
pin: (
channelId,messageId) =>string
Route for handling a specific pin.
Parameters
channelId
messageId
Returns
string
pins
pins: (
channelId) =>string
Route for handling a channel's pins.
Parameters
channelId
Returns
string
polls
polls:
object
polls.expire
expire: (
channelId,messageId) =>string
Parameters
channelId
messageId
Returns
string
polls.votes
votes: (
channelId,messageId,answerId,options?) =>string
Parameters
channelId
messageId
answerId
number
options?
Returns
string
reactions
reactions:
object
Routes for handling reactions on a message.
reactions.all
all: (
channelId,messageId) =>string
Route for handling all the reactions on a message.
Parameters
channelId
messageId
Returns
string
reactions.bot
bot: (
channelId,messageId,emoji) =>string
Route for handling a bots reaction.
Parameters
channelId
messageId
emoji
string
Returns
string
reactions.emoji
emoji: (
channelId,messageId,emoji,options?) =>string
Route for handling all reactions for a single emoji on a message.
Parameters
channelId
messageId
emoji
string
options?
Returns
string
reactions.message
message: (
channelId,messageId,emoji,options?) =>string
Route for handling a specific reaction on a message.
Parameters
channelId
messageId
emoji
string
options?
Returns
string
reactions.user
user: (
channelId,messageId,emoji,userId) =>string
Route for handling a user's reactions.
Parameters
channelId
messageId
emoji
string
userId
Returns
string
stage
stage: (
channelId) =>string
Route for handling a specific stage
Parameters
channelId
Returns
string
stages
stages: () =>
string
Route for handling non-specific stages
Returns
string
threads
threads:
object
Routes for handling thread related to a channel.
threads.active
active: (
guildId) =>string
Route for active threads.
Parameters
guildId
Returns
string
threads.all
all: (
channelId) =>string
Route for thread without a message.
Parameters
channelId
Returns
string
threads.archived
archived: (
channelId) =>string
Route for handling archived threads.
Parameters
channelId
Returns
string
threads.getUser
getUser: (
channelId,userId,options?) =>string
Route for getting a specific member in a thread.
Parameters
channelId
userId
options?
Returns
string
threads.joined
joined: (
channelId,options?) =>string
Route for handling private archived threads that the bot has joined.
Parameters
channelId
options?
Returns
string
threads.me
me: (
channelId) =>string
Route for the bot member in a thread.
Parameters
channelId
Returns
string
threads.members
members: (
channelId,options?) =>string
Route for members in a thread.
Parameters
channelId
options?
Returns
string
threads.message
message: (
channelId,messageId) =>string
Route for thread a specific message.
Parameters
channelId
messageId
Returns
string
threads.private
private: (
channelId,options?) =>string
Route for handling private archived threads.
Parameters
channelId
options?
Returns
string
threads.public
public: (
channelId,options?) =>string
Route for handling publically archived threads.
Parameters
channelId
options?
Returns
string
threads.user
user: (
channelId,userId) =>string
Route for a specific member in a thread apart from the route for getting the member.
Parameters
channelId
userId
Returns
string
typing
typing: (
channelId) =>string
Route for handling typing indicators in a c«hannel.
Parameters
channelId
Returns
string
webhooks
webhooks: (
channelId) =>string
Route for non-specific webhook in a channel.
Parameters
channelId
Returns
string
currentUser
currentUser: () =>
string
Defined in: typings/routes.ts:341
Get information about the current OAuth2 user / bot user. If used with a OAuth2 token requires the identify OAuth2 scope
Returns
string
gatewayBot
gatewayBot: () =>
string
Defined in: typings/routes.ts:28
Returns
string
guilds
guilds:
object
Defined in: typings/routes.ts:125
Routes for guild related endpoints.
all
all: () =>
string
Routes for handling a non-specific guild.
Returns
string
auditlogs
auditlogs: (
guildId,options?) =>string
Route for handling audit logs in a guild.
Parameters
guildId
options?
Returns
string
automod
automod:
object
Routes for a guilds automoderation.
automod.rule
rule: (
guildId,ruleId) =>string
Route for handling a specific automoderation rule guild's
Parameters
guildId
ruleId
Returns
string
automod.rules
rules: (
guildId) =>string
Route for handling a guild's automoderation.
Parameters
guildId
Returns
string
channels
channels: (
guildId) =>string
Route for handling non-specific channels in a guild
Parameters
guildId
Returns
string
emoji
emoji: (
guildId,id) =>string
Route for handling a specific emoji.
Parameters
guildId
id
Returns
string
emojis
emojis: (
guildId) =>string
Route for handling non-specific emojis.
Parameters
guildId
Returns
string
events
events:
object
Routes for handling a guild's scheduled events.
events.event
event: (
guildId,eventId,withUserCount?) =>string
Route for handling a specific scheduled event.
Parameters
guildId
eventId
withUserCount?
boolean
Returns
string
events.events
events: (
guildId,withUserCount?) =>string
Route for handling non-specific scheduled event.
Parameters
guildId
withUserCount?
boolean
Returns
string
events.users
users: (
guildId,eventId,options?) =>string
Route for handling a scheduled event users.
Parameters
guildId
eventId
options?
Returns
string
guild
guild: (
guildId,withCounts?) =>string
Route for handling a specific guild.
Parameters
guildId
withCounts?
boolean
Returns
string
incidentActions
incidentActions: (
guildId) =>string
Route for guild incident actions
Parameters
guildId
Returns
string
integration
integration: (
guildId,integrationId) =>string
Route for handling a specific integration.
Parameters
guildId
integrationId
Returns
string
integrations
integrations: (
guildId) =>string
Route for handling non-specific integrations.
Parameters
guildId
Returns
string
invite
invite: (
inviteCode,options?) =>string
Route for handling a specific guild invite.
Parameters
inviteCode
string
options?
Returns
string
invites
invites: (
guildId) =>string
Route for handling non-specific invites in a guild.
Parameters
guildId
Returns
string
inviteTargetUsers
inviteTargetUsers: (
inviteCode) =>string
Route for a specific invite's target users
Parameters
inviteCode
string
Returns
string
inviteTargetUsersJobStatus
inviteTargetUsersJobStatus: (
inviteCode) =>string
Route for a specific invite's target users
Parameters
inviteCode
string
Returns
string
leave
leave: (
guildId) =>string
Route for handling a bot leaving a guild.
Parameters
guildId
Returns
string
members
members:
object
Routes for handling a guild's members.
members.ban
ban: (
guildId,userId) =>string
Route for handling a specific guild member's ban.
Parameters
guildId
userId
Returns
string
members.bans
bans: (
guildId,options?) =>string
Route for handling non-specific bans in a guild.
Parameters
guildId
options?
Returns
string
members.bot
bot: (
guildId) =>string
Route for handling a the bot guild member.
Parameters
guildId
Returns
string
members.bulkBan
bulkBan: (
guildId) =>string
Route for bulk-banning members.
Parameters
guildId
Returns
string
members.currentMember
currentMember: (
guildId) =>string
Route to get the authenticated user. Requires the guilds.members.read OAuth2 scope
Parameters
guildId
Returns
string
members.member
member: (
guildId,userId) =>string
Route for handling a specific guild member.
Parameters
guildId
userId
Returns
string
members.members
members: (
guildId,options?) =>string
Route for handling non-specific guild members.
Parameters
guildId
options?
Returns
string
members.prune
prune: (
guildId,options?) =>string
Route for handling pruning guild members.
Parameters
guildId
options?
Returns
string
members.search
search: (
guildId,query,options?) =>string
Route for handling member searching in a guild.
Parameters
guildId
query
string
options?
limit?
number
Returns
string
messagesSearch
messagesSearch: (
guildId,options?) =>string
Route for searching a guild's messages.
Parameters
guildId
options?
Returns
string
onboarding
onboarding: (
guildId) =>string
Route for the onboarding
Parameters
guildId
Returns
string
preview
preview: (
guildId) =>string
Route for handling a guild's preview.
Parameters
guildId
Returns
string
prune
prune: (
guildId,options?) =>string
Route for handling pruning of a guild.
Parameters
guildId
options?
Returns
string
regions
regions: (
guildId) =>string
Route for handling a guild's regions.
Parameters
guildId
Returns
string
roles
roles:
object
Routes for handling a guild's roles.
roles.all
all: (
guildId) =>string
Route for handling a guild's roles.
Parameters
guildId
Returns
string
roles.member
member: (
guildId,memberId,roleId) =>string
Route for handling a members roles in a guild.
Parameters
guildId
memberId
roleId
Returns
string
roles.memberCounts
memberCounts: (
guildId) =>string
Route for the role member counts
Parameters
guildId
Returns
string
roles.one
one: (
guildId,roleId) =>string
Route for handling a specific guild role.
Parameters
guildId
roleId
Returns
string
sticker
sticker: (
guildId,stickerId) =>string
Route for handling non-specific guild stickers.
Parameters
guildId
stickerId
Returns
string
stickers
stickers: (
guildId) =>string
Route for handling a specific guild sticker.
Parameters
guildId
Returns
string
templates
templates:
object
Routes for handling a guild's templates.
templates.all
all: (
guildId) =>string
Route for handling non-specific guild's templates.
Parameters
guildId
Returns
string
templates.code
code: (
code) =>string
Route for handling a specifc guild's templates with a code only.
Parameters
code
string
Returns
string
templates.guild
guild: (
guildId,code) =>string
Route for handling a specific guild's template with a guild id and code.
Parameters
guildId
code
string
Returns
string
userGuilds
userGuilds: (
options?) =>string
Route for fetching an user guilds. Requires guilds OAuth2 scope
Parameters
options?
Returns
string
vanity
vanity: (
guildId) =>string
Route for handling a guild's vanity url.
Parameters
guildId
Returns
string
voice
voice: (
guildId,userId?) =>string
Route for handling a voice state.
Parameters
guildId
userId?
Returns
string
webhooks
webhooks: (
guildId) =>string
Route for handling non-specific webhooks in a guild
Parameters
guildId
Returns
string
welcome
welcome: (
guildId) =>string
Route for handling a guild's welcome screen.
Parameters
guildId
Returns
string
widget
widget: (
guildId) =>string
Route for handling a guild's widget.
Parameters
guildId
Returns
string
widgetJson
widgetJson: (
guildId) =>string
Route for handling a guild's widget in the form of json.
Parameters
guildId
Returns
string
interactions
interactions:
object
Defined in: typings/routes.ts:241
Routes for interaction related endpoints.
commands
commands:
object
Routes for interaction command related endpoints.
commands.command
command: (
applicationId,commandId,withLocalizations?) =>string
Route for a specific command.
Parameters
applicationId
commandId
withLocalizations?
boolean
Returns
string
commands.commands
commands: (
applicationId,withLocalizations?) =>string
Route for non-specific commands.
Parameters
applicationId
withLocalizations?
boolean
Returns
string
commands.guilds
guilds:
object
Route for guild related commands.
commands.guilds.all
all: (
applicationId,guildId,withLocalizations?) =>string
Route for non-specific guild commands.
Parameters
applicationId
guildId
withLocalizations?
boolean
Returns
string
commands.guilds.one
one: (
applicationId,guildId,commandId) =>string
Route for a specific guild command.
Parameters
applicationId
guildId
commandId
Returns
string
commands.permission
permission: (
applicationId,guildId,commandId) =>string
Route for a specific command's permission.
Parameters
applicationId
guildId
commandId
Returns
string
commands.permissions
permissions: (
applicationId,guildId) =>string
Route for non-specific command permissions.
Parameters
applicationId
guildId
Returns
string
responses
responses:
object
Routes for interaction response related endpoints.
responses.callback
callback: (
interactionId,token,options?) =>string
Route for handling a callback response with id and token.
Parameters
interactionId
token
string
options?
Returns
string
responses.message
message: (
applicationId,token,messageId) =>string
Route for handling a followup message from a interaction response.
Parameters
applicationId
token
string
messageId
Returns
string
responses.original
original: (
interactionId,token) =>string
Route for handling the original response using id and token.
Parameters
interactionId
token
string
Returns
string
lobby
lobby:
object
Defined in: typings/routes.ts:312
Routes realted to lobbies
create
create: () =>
string
Route to create a lobby
Returns
string
inviteSelf
inviteSelf: (
lobbyId) =>string
Route to invite self to the lobby's linked channel
Parameters
lobbyId
Returns
string
inviteUser
inviteUser: (
lobbyId,userId) =>string
Route to invite a specific user to the lobby's linked channel
Parameters
lobbyId
userId
Returns
string
leave
leave: (
lobbyId) =>string
Route to leave a lobby
Parameters
lobbyId
Returns
string
link
link: (
lobbyId) =>string
Route to link a lobby
Parameters
lobbyId
Returns
string
lobby
lobby: (
lobbyId) =>string
Route to get a specific lobby
Parameters
lobbyId
Returns
string
member
member: (
lobbyId,userId) =>string
Route to add/remove a member from a lobby
Parameters
lobbyId
userId
Returns
string
membersBulk
membersBulk: (
lobbyId) =>string
Route to bulk update members of a lobby
Parameters
lobbyId
Returns
string
messages
messages: (
lobbyId,options?) =>string
Route to lobby messages
Parameters
lobbyId
options?
Returns
string
moderationMetadata
moderationMetadata: (
lobbyId,messageId) =>string
Route to set the lobby moderation metadata
Parameters
lobbyId
messageId
Returns
string
monetization
monetization:
object
Defined in: typings/routes.ts:286
Routes related to monetization (entitlements and SKU)
consumeEntitlement
consumeEntitlement: (
applicationId,entitlementId) =>string
Route to consume an entitlement
Parameters
applicationId
entitlementId
Returns
string
entitlement
entitlement: (
applicationId,entitlementId) =>string
Route to delete an entitlement
Parameters
applicationId
entitlementId
Returns
string
entitlements
entitlements: (
applicationId,options?) =>string
Route to list / create entitlements
Parameters
applicationId
options?
Returns
string
skus
skus: (
applicationId) =>string
Route to list the SKUs
Parameters
applicationId
Returns
string
subscription
subscription: (
skuId,subscriptionId) =>string
Route to get a SKU subscription
Parameters
skuId
subscriptionId
Returns
string
subscriptions
subscriptions: (
skuId,options?) =>string
Route to list the SKU subscriptions
Parameters
skuId
options?
Returns
string
oauth2
oauth2:
object
Defined in: typings/routes.ts:271
Routes related to OAuth2
application
application: () =>
string
Route to get information about the current application.
Returns
string
connections
connections: () =>
string
Route to get the connection the user has. Requires the connections OAuth2 scope
Returns
string
currentAuthorization
currentAuthorization: () =>
string
Route to get information about the current authorization. Requires an access token
Returns
string
roleConnections
roleConnections: (
applicationId) =>string
Route to handling role-connection for an application
Parameters
applicationId
Returns
string
tokenExchange
tokenExchange: () =>
string
Route to generate a new access token
Returns
string
tokenRevoke
tokenRevoke: () =>
string
Route to revoke an OAuth2 access_token
Returns
string
regions
regions: () =>
string
Defined in: typings/routes.ts:349
Route for handling all voice regions.
Returns
string
soundboard
soundboard:
object
Defined in: typings/routes.ts:301
Routes related to soundboard sounds
guildSound
guildSound: (
guildId,soundId) =>string
Route for get/edit/delete of a guild sound
Parameters
guildId
soundId
Returns
string
guildSounds
guildSounds: (
guildId) =>string
Route for list/create a guild sounds
Parameters
guildId
Returns
string
listDefault
listDefault: () =>
string
List the discord default soundboard sounds
Returns
string
sendSound
sendSound: (
channelId) =>string
Send a soundboard sound to a voice channel the user is connected to.
Parameters
channelId
Returns
string
sticker
sticker: (
stickerId) =>string
Defined in: typings/routes.ts:347
Route for handling a sticker.
Parameters
stickerId
Returns
string
stickerPack
stickerPack: (
stickerPackId) =>string
Defined in: typings/routes.ts:31
Parameters
stickerPackId
Returns
string
stickerPacks
stickerPacks: () =>
string
Defined in: typings/routes.ts:30
Returns
string
user
user: (
id) =>string
Defined in: typings/routes.ts:26
A specific user route.
Parameters
id
Returns
string
webhooks
webhooks:
object
Defined in: typings/routes.ts:33
Routes for webhook related routes.
id
id: (
webhookId) =>string
Route for webhook with a id.
Parameters
webhookId
Returns
string
message
message: (
webhookId,token,messageId,options?) =>string
Route for handling a message that was sent through a webhook.
Parameters
webhookId
token
string
messageId
options?
threadId?
withComponents?
boolean
Returns
string
webhook
webhook: (
webhookId,token,options?) =>string
Route for handling a webhook with a token.
Parameters
webhookId
token
string
options?
threadId?
wait?
boolean
withComponents?
boolean
Returns
string