Skip to content

Valgorithms/discord-api-v10-preview

Repository files navigation

OpenAPIClient-php

Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: BotToken
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$channel_id = 'channel_id_example'; // string
$user_id = 'user_id_example'; // string
$add_group_dm_user_request = new \OpenAPI\Client\Model\AddGroupDmUserRequest(); // \OpenAPI\Client\Model\AddGroupDmUserRequest

try {
    $result = $apiInstance->addGroupDmUser($channel_id, $user_id, $add_group_dm_user_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addGroupDmUser: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://discord.com/api/v10

Class Method HTTP request Description
DefaultApi addGroupDmUser PUT /channels/{channel_id}/recipients/{user_id}
DefaultApi addGuildMember PUT /guilds/{guild_id}/members/{user_id}
DefaultApi addGuildMemberRole PUT /guilds/{guild_id}/members/{user_id}/roles/{role_id}
DefaultApi addLobbyMember PUT /lobbies/{lobby_id}/members/{user_id}
DefaultApi addMyMessageReaction PUT /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/@me
DefaultApi addThreadMember PUT /channels/{channel_id}/thread-members/{user_id}
DefaultApi applicationsGetActivityInstance GET /applications/{application_id}/activity-instances/{instance_id}
DefaultApi banUserFromGuild PUT /guilds/{guild_id}/bans/{user_id}
DefaultApi botPartnerSdkToken POST /partner-sdk/token/bot
DefaultApi bulkBanUsersFromGuild POST /guilds/{guild_id}/bulk-ban
DefaultApi bulkDeleteMessages POST /channels/{channel_id}/messages/bulk-delete
DefaultApi bulkSetApplicationCommands PUT /applications/{application_id}/commands
DefaultApi bulkSetGuildApplicationCommands PUT /applications/{application_id}/guilds/{guild_id}/commands
DefaultApi bulkUpdateGuildChannels PATCH /guilds/{guild_id}/channels
DefaultApi bulkUpdateGuildRoles PATCH /guilds/{guild_id}/roles
DefaultApi bulkUpdateLobbyMembers POST /lobbies/{lobby_id}/members/bulk
DefaultApi consumeEntitlement POST /applications/{application_id}/entitlements/{entitlement_id}/consume
DefaultApi createApplicationCommand POST /applications/{application_id}/commands
DefaultApi createApplicationEmoji POST /applications/{application_id}/emojis
DefaultApi createAutoModerationRule POST /guilds/{guild_id}/auto-moderation/rules
DefaultApi createChannelInvite POST /channels/{channel_id}/invites
DefaultApi createDm POST /users/@me/channels
DefaultApi createEntitlement POST /applications/{application_id}/entitlements
DefaultApi createGuildApplicationCommand POST /applications/{application_id}/guilds/{guild_id}/commands
DefaultApi createGuildChannel POST /guilds/{guild_id}/channels
DefaultApi createGuildEmoji POST /guilds/{guild_id}/emojis
DefaultApi createGuildRole POST /guilds/{guild_id}/roles
DefaultApi createGuildScheduledEvent POST /guilds/{guild_id}/scheduled-events
DefaultApi createGuildSoundboardSound POST /guilds/{guild_id}/soundboard-sounds
DefaultApi createGuildSticker POST /guilds/{guild_id}/stickers
DefaultApi createGuildTemplate POST /guilds/{guild_id}/templates
DefaultApi createInteractionResponse POST /interactions/{interaction_id}/{interaction_token}/callback
DefaultApi createLinkedLobbyGuildInviteForSelf POST /lobbies/{lobby_id}/members/@me/invites
DefaultApi createLinkedLobbyGuildInviteForUser POST /lobbies/{lobby_id}/members/{user_id}/invites
DefaultApi createLobby POST /lobbies
DefaultApi createLobbyMessage POST /lobbies/{lobby_id}/messages
DefaultApi createMessage POST /channels/{channel_id}/messages
DefaultApi createOrJoinLobby PUT /lobbies
DefaultApi createPin PUT /channels/{channel_id}/messages/pins/{message_id}
DefaultApi createStageInstance POST /stage-instances
DefaultApi createThread POST /channels/{channel_id}/threads
DefaultApi createThreadFromMessage POST /channels/{channel_id}/messages/{message_id}/threads
DefaultApi createWebhook POST /channels/{channel_id}/webhooks
DefaultApi crosspostMessage POST /channels/{channel_id}/messages/{message_id}/crosspost
DefaultApi deleteAllMessageReactions DELETE /channels/{channel_id}/messages/{message_id}/reactions
DefaultApi deleteAllMessageReactionsByEmoji DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}
DefaultApi deleteApplicationCommand DELETE /applications/{application_id}/commands/{command_id}
DefaultApi deleteApplicationEmoji DELETE /applications/{application_id}/emojis/{emoji_id}
DefaultApi deleteApplicationUserRoleConnection DELETE /users/@me/applications/{application_id}/role-connection
DefaultApi deleteAutoModerationRule DELETE /guilds/{guild_id}/auto-moderation/rules/{rule_id}
DefaultApi deleteChannel DELETE /channels/{channel_id}
DefaultApi deleteChannelPermissionOverwrite DELETE /channels/{channel_id}/permissions/{overwrite_id}
DefaultApi deleteEntitlement DELETE /applications/{application_id}/entitlements/{entitlement_id}
DefaultApi deleteGroupDmUser DELETE /channels/{channel_id}/recipients/{user_id}
DefaultApi deleteGuild DELETE /guilds/{guild_id}
DefaultApi deleteGuildApplicationCommand DELETE /applications/{application_id}/guilds/{guild_id}/commands/{command_id}
DefaultApi deleteGuildEmoji DELETE /guilds/{guild_id}/emojis/{emoji_id}
DefaultApi deleteGuildIntegration DELETE /guilds/{guild_id}/integrations/{integration_id}
DefaultApi deleteGuildMember DELETE /guilds/{guild_id}/members/{user_id}
DefaultApi deleteGuildMemberRole DELETE /guilds/{guild_id}/members/{user_id}/roles/{role_id}
DefaultApi deleteGuildRole DELETE /guilds/{guild_id}/roles/{role_id}
DefaultApi deleteGuildScheduledEvent DELETE /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}
DefaultApi deleteGuildSoundboardSound DELETE /guilds/{guild_id}/soundboard-sounds/{sound_id}
DefaultApi deleteGuildSticker DELETE /guilds/{guild_id}/stickers/{sticker_id}
DefaultApi deleteGuildTemplate DELETE /guilds/{guild_id}/templates/{code}
DefaultApi deleteLobbyMember DELETE /lobbies/{lobby_id}/members/{user_id}
DefaultApi deleteMessage DELETE /channels/{channel_id}/messages/{message_id}
DefaultApi deleteMyMessageReaction DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/@me
DefaultApi deleteOriginalWebhookMessage DELETE /webhooks/{webhook_id}/{webhook_token}/messages/@original
DefaultApi deletePin DELETE /channels/{channel_id}/messages/pins/{message_id}
DefaultApi deleteStageInstance DELETE /stage-instances/{channel_id}
DefaultApi deleteThreadMember DELETE /channels/{channel_id}/thread-members/{user_id}
DefaultApi deleteUserMessageReaction DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/{user_id}
DefaultApi deleteWebhook DELETE /webhooks/{webhook_id}
DefaultApi deleteWebhookByToken DELETE /webhooks/{webhook_id}/{webhook_token}
DefaultApi deleteWebhookMessage DELETE /webhooks/{webhook_id}/{webhook_token}/messages/{message_id}
DefaultApi deprecatedCreatePin PUT /channels/{channel_id}/pins/{message_id}
DefaultApi deprecatedDeletePin DELETE /channels/{channel_id}/pins/{message_id}
DefaultApi deprecatedListPins GET /channels/{channel_id}/pins
DefaultApi editLobby PATCH /lobbies/{lobby_id}
DefaultApi editLobbyChannelLink PATCH /lobbies/{lobby_id}/channel-linking
DefaultApi executeGithubCompatibleWebhook POST /webhooks/{webhook_id}/{webhook_token}/github
DefaultApi executeSlackCompatibleWebhook POST /webhooks/{webhook_id}/{webhook_token}/slack
DefaultApi executeWebhook POST /webhooks/{webhook_id}/{webhook_token}
DefaultApi followChannel POST /channels/{channel_id}/followers
DefaultApi getActiveGuildThreads GET /guilds/{guild_id}/threads/active
DefaultApi getAnswerVoters GET /channels/{channel_id}/polls/{message_id}/answers/{answer_id}
DefaultApi getApplication GET /applications/{application_id}
DefaultApi getApplicationCommand GET /applications/{application_id}/commands/{command_id}
DefaultApi getApplicationEmoji GET /applications/{application_id}/emojis/{emoji_id}
DefaultApi getApplicationRoleConnectionsMetadata GET /applications/{application_id}/role-connections/metadata
DefaultApi getApplicationUserRoleConnection GET /users/@me/applications/{application_id}/role-connection
DefaultApi getAutoModerationRule GET /guilds/{guild_id}/auto-moderation/rules/{rule_id}
DefaultApi getBotGateway GET /gateway/bot
DefaultApi getChannel GET /channels/{channel_id}
DefaultApi getEntitlement GET /applications/{application_id}/entitlements/{entitlement_id}
DefaultApi getEntitlements GET /applications/{application_id}/entitlements
DefaultApi getGateway GET /gateway
DefaultApi getGuild GET /guilds/{guild_id}
DefaultApi getGuildApplicationCommand GET /applications/{application_id}/guilds/{guild_id}/commands/{command_id}
DefaultApi getGuildApplicationCommandPermissions GET /applications/{application_id}/guilds/{guild_id}/commands/{command_id}/permissions
DefaultApi getGuildBan GET /guilds/{guild_id}/bans/{user_id}
DefaultApi getGuildEmoji GET /guilds/{guild_id}/emojis/{emoji_id}
DefaultApi getGuildMember GET /guilds/{guild_id}/members/{user_id}
DefaultApi getGuildNewMemberWelcome GET /guilds/{guild_id}/new-member-welcome
DefaultApi getGuildPreview GET /guilds/{guild_id}/preview
DefaultApi getGuildRole GET /guilds/{guild_id}/roles/{role_id}
DefaultApi getGuildScheduledEvent GET /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}
DefaultApi getGuildSoundboardSound GET /guilds/{guild_id}/soundboard-sounds/{sound_id}
DefaultApi getGuildSticker GET /guilds/{guild_id}/stickers/{sticker_id}
DefaultApi getGuildTemplate GET /guilds/templates/{code}
DefaultApi getGuildVanityUrl GET /guilds/{guild_id}/vanity-url
DefaultApi getGuildWebhooks GET /guilds/{guild_id}/webhooks
DefaultApi getGuildWelcomeScreen GET /guilds/{guild_id}/welcome-screen
DefaultApi getGuildWidget GET /guilds/{guild_id}/widget.json
DefaultApi getGuildWidgetPng GET /guilds/{guild_id}/widget.png
DefaultApi getGuildWidgetSettings GET /guilds/{guild_id}/widget
DefaultApi getGuildsOnboarding GET /guilds/{guild_id}/onboarding
DefaultApi getLobby GET /lobbies/{lobby_id}
DefaultApi getLobbyMessages GET /lobbies/{lobby_id}/messages
DefaultApi getMessage GET /channels/{channel_id}/messages/{message_id}
DefaultApi getMyApplication GET /applications/@me
DefaultApi getMyGuildMember GET /users/@me/guilds/{guild_id}/member
DefaultApi getMyOauth2Application GET /oauth2/applications/@me
DefaultApi getMyOauth2Authorization GET /oauth2/@me
DefaultApi getMyUser GET /users/@me
DefaultApi getOpenidConnectUserinfo GET /oauth2/userinfo
DefaultApi getOriginalWebhookMessage GET /webhooks/{webhook_id}/{webhook_token}/messages/@original
DefaultApi getPublicKeys GET /oauth2/keys
DefaultApi getSelfVoiceState GET /guilds/{guild_id}/voice-states/@me
DefaultApi getSoundboardDefaultSounds GET /soundboard-default-sounds
DefaultApi getStageInstance GET /stage-instances/{channel_id}
DefaultApi getSticker GET /stickers/{sticker_id}
DefaultApi getStickerPack GET /sticker-packs/{pack_id}
DefaultApi getThreadMember GET /channels/{channel_id}/thread-members/{user_id}
DefaultApi getUser GET /users/{user_id}
DefaultApi getVoiceState GET /guilds/{guild_id}/voice-states/{user_id}
DefaultApi getWebhook GET /webhooks/{webhook_id}
DefaultApi getWebhookByToken GET /webhooks/{webhook_id}/{webhook_token}
DefaultApi getWebhookMessage GET /webhooks/{webhook_id}/{webhook_token}/messages/{message_id}
DefaultApi guildSearch GET /guilds/{guild_id}/messages/search
DefaultApi inviteResolve GET /invites/{code}
DefaultApi inviteRevoke DELETE /invites/{code}
DefaultApi joinThread PUT /channels/{channel_id}/thread-members/@me
DefaultApi leaveGuild DELETE /users/@me/guilds/{guild_id}
DefaultApi leaveLobby DELETE /lobbies/{lobby_id}/members/@me
DefaultApi leaveThread DELETE /channels/{channel_id}/thread-members/@me
DefaultApi listApplicationCommands GET /applications/{application_id}/commands
DefaultApi listApplicationEmojis GET /applications/{application_id}/emojis
DefaultApi listAutoModerationRules GET /guilds/{guild_id}/auto-moderation/rules
DefaultApi listChannelInvites GET /channels/{channel_id}/invites
DefaultApi listChannelWebhooks GET /channels/{channel_id}/webhooks
DefaultApi listGuildApplicationCommandPermissions GET /applications/{application_id}/guilds/{guild_id}/commands/permissions
DefaultApi listGuildApplicationCommands GET /applications/{application_id}/guilds/{guild_id}/commands
DefaultApi listGuildAuditLogEntries GET /guilds/{guild_id}/audit-logs
DefaultApi listGuildBans GET /guilds/{guild_id}/bans
DefaultApi listGuildChannels GET /guilds/{guild_id}/channels
DefaultApi listGuildEmojis GET /guilds/{guild_id}/emojis
DefaultApi listGuildIntegrations GET /guilds/{guild_id}/integrations
DefaultApi listGuildInvites GET /guilds/{guild_id}/invites
DefaultApi listGuildMembers GET /guilds/{guild_id}/members
DefaultApi listGuildRoles GET /guilds/{guild_id}/roles
DefaultApi listGuildScheduledEventUsers GET /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}/users
DefaultApi listGuildScheduledEvents GET /guilds/{guild_id}/scheduled-events
DefaultApi listGuildSoundboardSounds GET /guilds/{guild_id}/soundboard-sounds
DefaultApi listGuildStickers GET /guilds/{guild_id}/stickers
DefaultApi listGuildTemplates GET /guilds/{guild_id}/templates
DefaultApi listGuildVoiceRegions GET /guilds/{guild_id}/regions
DefaultApi listMessageReactionsByEmoji GET /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}
DefaultApi listMessages GET /channels/{channel_id}/messages
DefaultApi listMyConnections GET /users/@me/connections
DefaultApi listMyGuilds GET /users/@me/guilds
DefaultApi listMyPrivateArchivedThreads GET /channels/{channel_id}/users/@me/threads/archived/private
DefaultApi listPins GET /channels/{channel_id}/messages/pins
DefaultApi listPrivateArchivedThreads GET /channels/{channel_id}/threads/archived/private
DefaultApi listPublicArchivedThreads GET /channels/{channel_id}/threads/archived/public
DefaultApi listStickerPacks GET /sticker-packs
DefaultApi listThreadMembers GET /channels/{channel_id}/thread-members
DefaultApi listVoiceRegions GET /voice/regions
DefaultApi partnerSdkToken POST /partner-sdk/token
DefaultApi partnerSdkUnmergeProvisionalAccount POST /partner-sdk/provisional-accounts/unmerge
DefaultApi pollExpire POST /channels/{channel_id}/polls/{message_id}/expire
DefaultApi previewPruneGuild GET /guilds/{guild_id}/prune
DefaultApi pruneGuild POST /guilds/{guild_id}/prune
DefaultApi putGuildsOnboarding PUT /guilds/{guild_id}/onboarding
DefaultApi searchGuildMembers GET /guilds/{guild_id}/members/search
DefaultApi sendSoundboardSound POST /channels/{channel_id}/send-soundboard-sound
DefaultApi setChannelPermissionOverwrite PUT /channels/{channel_id}/permissions/{overwrite_id}
DefaultApi setGuildApplicationCommandPermissions PUT /applications/{application_id}/guilds/{guild_id}/commands/{command_id}/permissions
DefaultApi setGuildMfaLevel POST /guilds/{guild_id}/mfa
DefaultApi syncGuildTemplate PUT /guilds/{guild_id}/templates/{code}
DefaultApi threadSearch GET /channels/{channel_id}/threads/search
DefaultApi triggerTypingIndicator POST /channels/{channel_id}/typing
DefaultApi unbanUserFromGuild DELETE /guilds/{guild_id}/bans/{user_id}
DefaultApi updateApplication PATCH /applications/{application_id}
DefaultApi updateApplicationCommand PATCH /applications/{application_id}/commands/{command_id}
DefaultApi updateApplicationEmoji PATCH /applications/{application_id}/emojis/{emoji_id}
DefaultApi updateApplicationRoleConnectionsMetadata PUT /applications/{application_id}/role-connections/metadata
DefaultApi updateApplicationUserRoleConnection PUT /users/@me/applications/{application_id}/role-connection
DefaultApi updateAutoModerationRule PATCH /guilds/{guild_id}/auto-moderation/rules/{rule_id}
DefaultApi updateChannel PATCH /channels/{channel_id}
DefaultApi updateGuild PATCH /guilds/{guild_id}
DefaultApi updateGuildApplicationCommand PATCH /applications/{application_id}/guilds/{guild_id}/commands/{command_id}
DefaultApi updateGuildEmoji PATCH /guilds/{guild_id}/emojis/{emoji_id}
DefaultApi updateGuildMember PATCH /guilds/{guild_id}/members/{user_id}
DefaultApi updateGuildRole PATCH /guilds/{guild_id}/roles/{role_id}
DefaultApi updateGuildScheduledEvent PATCH /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}
DefaultApi updateGuildSoundboardSound PATCH /guilds/{guild_id}/soundboard-sounds/{sound_id}
DefaultApi updateGuildSticker PATCH /guilds/{guild_id}/stickers/{sticker_id}
DefaultApi updateGuildTemplate PATCH /guilds/{guild_id}/templates/{code}
DefaultApi updateGuildWelcomeScreen PATCH /guilds/{guild_id}/welcome-screen
DefaultApi updateGuildWidgetSettings PATCH /guilds/{guild_id}/widget
DefaultApi updateMessage PATCH /channels/{channel_id}/messages/{message_id}
DefaultApi updateMyApplication PATCH /applications/@me
DefaultApi updateMyGuildMember PATCH /guilds/{guild_id}/members/@me
DefaultApi updateMyUser PATCH /users/@me
DefaultApi updateOriginalWebhookMessage PATCH /webhooks/{webhook_id}/{webhook_token}/messages/@original
DefaultApi updateSelfVoiceState PATCH /guilds/{guild_id}/voice-states/@me
DefaultApi updateStageInstance PATCH /stage-instances/{channel_id}
DefaultApi updateVoiceState PATCH /guilds/{guild_id}/voice-states/{user_id}
DefaultApi updateWebhook PATCH /webhooks/{webhook_id}
DefaultApi updateWebhookByToken PATCH /webhooks/{webhook_id}/{webhook_token}
DefaultApi updateWebhookMessage PATCH /webhooks/{webhook_id}/{webhook_token}/messages/{message_id}
DefaultApi uploadApplicationAttachment POST /applications/{application_id}/attachment

Models

Authorization

Authentication schemes defined for the API:

BotToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

OAuth2

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://discord.com/api/oauth2/authorize
  • Scopes:
    • activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
    • activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
    • activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
    • applications.builds.read: allows your app to read build data for a user's applications
    • applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
    • applications.commands: allows your app to use commands in a guild
    • applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
    • applications.entitlements: allows your app to read entitlements for a user's applications
    • applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
    • bot: for oauth2 bots, this puts the bot in the user's selected guild by default
    • connections: allows /users/@me/connections to return linked third-party accounts
    • dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
    • email: enables /users/@me to return an email
    • gdm.join: allows your app to join users to a group dm
    • guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
    • guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
    • guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
    • identify: allows /users/@me without email
    • messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
    • openid: for OpenID Connect, this allows your app to receive user id and basic profile information
    • relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
    • rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
    • rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
    • rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
    • rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
    • rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
    • rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
    • rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
    • rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
    • rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
    • voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
    • webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants

OAuth2

  • Type: OAuth
  • Flow: application
  • Authorization URL: ``
  • Scopes:
    • activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
    • activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
    • activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
    • applications.builds.read: allows your app to read build data for a user's applications
    • applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
    • applications.commands: allows your app to use commands in a guild
    • applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
    • applications.commands.update: allows your app to update its commands using a Bearer token - client credentials grant only
    • applications.entitlements: allows your app to read entitlements for a user's applications
    • applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
    • bot: for oauth2 bots, this puts the bot in the user's selected guild by default
    • connections: allows /users/@me/connections to return linked third-party accounts
    • dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
    • email: enables /users/@me to return an email
    • gdm.join: allows your app to join users to a group dm
    • guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
    • guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
    • guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
    • identify: allows /users/@me without email
    • messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
    • openid: for OpenID Connect, this allows your app to receive user id and basic profile information
    • relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
    • rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
    • rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
    • rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
    • rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
    • rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
    • rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
    • rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
    • rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
    • rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
    • voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
    • webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://discord.com/api/oauth2/authorize
  • Scopes:
    • activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
    • activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
    • activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
    • applications.builds.read: allows your app to read build data for a user's applications
    • applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
    • applications.commands: allows your app to use commands in a guild
    • applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
    • applications.entitlements: allows your app to read entitlements for a user's applications
    • applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
    • bot: for oauth2 bots, this puts the bot in the user's selected guild by default
    • connections: allows /users/@me/connections to return linked third-party accounts
    • dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
    • email: enables /users/@me to return an email
    • gdm.join: allows your app to join users to a group dm
    • guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
    • guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
    • guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
    • identify: allows /users/@me without email
    • messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
    • openid: for OpenID Connect, this allows your app to receive user id and basic profile information
    • relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
    • role_connections.write: allows your app to update a user's connection and metadata for the app
    • rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
    • rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
    • rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
    • rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
    • rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
    • rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
    • rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
    • rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
    • rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
    • voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
    • webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 10
    • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages