DiscordPHP-Http Documentation

Endpoint
in package
implements EndpointInterface uses EndpointTrait

Table of Contents

Interfaces

EndpointInterface

Constants

APPLICATION  : mixed = 'applications/:application_id'
GET, PATCH
APPLICATION_ACTIVITY_INSTANCE  : mixed = 'applications/:application_id/activity-instance...
GET
APPLICATION_ATTACHMENT  : mixed = 'applications/:application_id/attachment'
POST
APPLICATION_CURRENT  : mixed = 'applications/@me'
GET, PATCH
APPLICATION_EMOJI  : mixed = 'applications/:application_id/emojis/:emoji_id'
GET, PATCH, DELETE
APPLICATION_EMOJIS  : mixed = 'applications/:application_id/emojis'
GET, POST
APPLICATION_ENTITLEMENT  : mixed = self::APPLICATION_ENTITLEMENTS . '/:entitlement...
GET, DELETE
APPLICATION_ENTITLEMENT_CONSUME  : mixed = self::APPLICATION_ENTITLEMENT . '/consume'
POST
APPLICATION_ENTITLEMENTS  : mixed = 'applications/:application_id/entitlements'
GET, POST
APPLICATION_IDENTITIES_BY_EXTERNAL_ID  : mixed = self::APPLICATION . '/application-identities/:p...
GET
APPLICATION_ROLE_CONNECTION_METADATA  : mixed = 'applications/:application_id/role-connections/...
GET, PUT
APPLICATION_SKUS  : mixed = 'applications/:application_id/skus'
GET
APPLICATION_USER_IDENTITY_PROFILE  : mixed = self::APPLICATION . '/users/:user_id/identities...
GET, PATCH
AUDIT_LOG  : mixed = 'guilds/:guild_id/audit-logs'
GET
CHANNEL  : mixed = 'channels/:channel_id'
GET, PATCH, DELETE
CHANNEL_CROSSPOST_MESSAGE  : mixed = self::CHANNEL . '/messages/:message_id/crosspost'
POST
CHANNEL_FOLLOW  : mixed = self::CHANNEL . '/followers'
POST
CHANNEL_INVITES  : mixed = self::CHANNEL . '/invites'
GET, POST
CHANNEL_MESSAGE  : mixed = self::CHANNEL . '/messages/:message_id'
GET, PATCH, DELETE
CHANNEL_MESSAGE_THREADS  : mixed = self::CHANNEL_MESSAGE . '/threads'
POST
CHANNEL_MESSAGES  : mixed = self::CHANNEL . '/messages'
GET, POST
CHANNEL_MESSAGES_BULK_DELETE  : mixed = self::CHANNEL . '/messages/bulk-delete'
POST
CHANNEL_MESSAGES_PIN  : mixed = self::CHANNEL . '/messages/pins/:message_id'
PUT, DELETE
CHANNEL_MESSAGES_PINS  : mixed = self::CHANNEL . '/messages/pins'
GET
CHANNEL_PERMISSIONS  : mixed = self::CHANNEL . '/permissions/:overwrite_id'
PUT, DELETE
CHANNEL_PIN  : mixed = self::CHANNEL . '/pins/:message_id'
CHANNEL_PINS  : mixed = self::CHANNEL . '/pins'
CHANNEL_RECIPIENT  : mixed = self::CHANNEL . '/recipients/:user_id'
PUT, DELETE
CHANNEL_SEND_SOUNDBOARD_SOUND  : mixed = self::CHANNEL . '/send-soundboard-sound'
POST
CHANNEL_THREADS  : mixed = self::CHANNEL . '/threads'
POST
CHANNEL_THREADS_ARCHIVED_PRIVATE  : mixed = self::CHANNEL_THREADS . '/archived/private'
GET
CHANNEL_THREADS_ARCHIVED_PRIVATE_ME  : mixed = self::CHANNEL . '/users/@me/threads/archived/pr...
GET
CHANNEL_THREADS_ARCHIVED_PUBLIC  : mixed = self::CHANNEL_THREADS . '/archived/public'
GET
CHANNEL_THREADS_SEARCH  : mixed = self::CHANNEL_THREADS . '/search'
GET
CHANNEL_TYPING  : mixed = self::CHANNEL . '/typing'
POST
CHANNEL_VOICE_STATUS  : mixed = self::CHANNEL . '/voice-status'
PUT
CHANNEL_WEBHOOKS  : mixed = self::CHANNEL . '/webhooks'
GET, POST
CREATE_INTERACTION_FOLLOW_UP  : mixed = 'webhooks/:application_id/:interaction_token'
POST
GATEWAY  : mixed = 'gateway'
GET
GATEWAY_BOT  : mixed = self::GATEWAY . '/bot'
GET
GLOBAL_APPLICATION_COMMAND  : mixed = self::GLOBAL_APPLICATION_COMMANDS . '/:command_id'
GET, PATCH, DELETE
GLOBAL_APPLICATION_COMMANDS  : mixed = 'applications/:application_id/commands'
GET, POST, PUT
GUILD  : mixed = 'guilds/:guild_id'
GET, PATCH, DELETE
GUILD_APPLICATION_COMMAND  : mixed = self::GUILD_APPLICATION_COMMANDS . '/:command_id'
GET, PATCH, DELETE
GUILD_APPLICATION_COMMAND_PERMISSIONS  : mixed = self::GUILD_APPLICATION_COMMANDS . '/:command_i...
GET, PUT
GUILD_APPLICATION_COMMANDS  : mixed = 'applications/:application_id/guilds/:guild_id/...
GET, POST, PUT
GUILD_APPLICATION_COMMANDS_PERMISSIONS  : mixed = self::GUILD_APPLICATION_COMMANDS . '/permissions'
GET, PUT
GUILD_AUTO_MODERATION_RULE  : mixed = self::GUILD . '/auto-moderation/rules/:auto_mod...
GET, PATCH, DELETE
GUILD_AUTO_MODERATION_RULES  : mixed = self::GUILD . '/auto-moderation/rules'
GET, POST
GUILD_BAN  : mixed = self::GUILD . '/bans/:user_id'
GET, PUT, DELETE
GUILD_BAN_BULK  : mixed = self::GUILD . '/bulk-ban'
POST
GUILD_BANS  : mixed = self::GUILD . '/bans'
GET
GUILD_CHANNELS  : mixed = self::GUILD . '/channels'
GET, POST, PATCH
GUILD_EMOJI  : mixed = self::GUILD . '/emojis/:emoji_id'
GET, PATCH, DELETE
GUILD_EMOJIS  : mixed = self::GUILD . '/emojis'
GET, POST
GUILD_INCIDENT_ACTIONS  : mixed = self::GUILD . '/incident-actions'
PUT
GUILD_INTEGRATION  : mixed = self::GUILD . '/integrations/:integration_id'
PATCH, DELETE
GUILD_INTEGRATION_SYNC  : mixed = self::GUILD . '/integrations/:integration_id/sync'
POST
GUILD_INTEGRATIONS  : mixed = self::GUILD . '/integrations'
GET, POST
GUILD_INVITES  : mixed = self::GUILD . '/invites'
GET, POST
GUILD_JOIN_REQUEST  : mixed = self::GUILD_JOIN_REQUESTS . '/:join_request_id'
PATCH
GUILD_JOIN_REQUESTS  : mixed = self::GUILD . '/requests'
GET
GUILD_MEMBER  : mixed = self::GUILD . '/members/:user_id'
GET, PATCH, PUT, DELETE
GUILD_MEMBER_ROLE  : mixed = self::GUILD . '/members/:user_id/roles/:role_id'
PUT, DELETE
GUILD_MEMBER_SELF  : mixed = self::GUILD . '/members/@me'
PATCH
GUILD_MEMBER_SELF_NICK  : mixed = self::GUILD . '/members/@me/nick'
GUILD_MEMBERS  : mixed = self::GUILD . '/members'
GET
GUILD_MEMBERS_SEARCH  : mixed = self::GUILD . '/members/search'
GET
GUILD_MEMBERSHIP_SCREENING  : mixed = self::GUILD . '/member-verification'
GET, PATCH
GUILD_MESSAGES_SEARCH  : mixed = self::GUILD . '/messages/search'
GET
GUILD_MFA  : mixed = self::GUILD . '/mfa'
POST
GUILD_NEW_MEMBER_WELCOME  : mixed = self::GUILD . '/new-member-welcome'
GET
GUILD_ONBOARDING  : mixed = self::GUILD . '/onboarding'
GET, PUT
GUILD_PREVIEW  : mixed = self::GUILD . '/preview'
GET
GUILD_PRUNE  : mixed = self::GUILD . '/prune'
GET, POST
GUILD_REGIONS  : mixed = self::GUILD . '/regions'
GET
GUILD_ROLE  : mixed = self::GUILD . '/roles/:role_id'
GET, POST, PATCH, DELETE
GUILD_ROLES  : mixed = self::GUILD . '/roles'
GET, POST, PATCH
GUILD_ROLES_MEMBER_COUNTS  : mixed = self::GUILD . '/roles/member-counts'
GET
GUILD_SCHEDULED_EVENT  : mixed = self::GUILD_SCHEDULED_EVENTS . '/:guild_schedul...
GET, PATCH, DELETE
GUILD_SCHEDULED_EVENT_EXCEPTION  : mixed = self::GUILD_SCHEDULED_EVENT_EXCEPTIONS . '/:eve...
PATCH, DELETE
GUILD_SCHEDULED_EVENT_EXCEPTION_USERS  : mixed = self::GUILD_SCHEDULED_EVENT . '/:event_exceptio...
GET
GUILD_SCHEDULED_EVENT_EXCEPTIONS  : mixed = self::GUILD_SCHEDULED_EVENT . '/exceptions'
GET, POST
GUILD_SCHEDULED_EVENT_USERS  : mixed = self::GUILD_SCHEDULED_EVENT . '/users'
GET
GUILD_SCHEDULED_EVENT_USERS_COUNT  : mixed = self::GUILD_SCHEDULED_EVENT_USERS . '/counts'
GET
GUILD_SCHEDULED_EVENTS  : mixed = self::GUILD . '/scheduled-events'
GET, POST
GUILD_SOUNDBOARD_SOUND  : mixed = self::GUILD . '/soundboard-sounds/:sound_id'
GET, PATCH, DELETE
GUILD_SOUNDBOARD_SOUNDS  : mixed = self::GUILD . '/soundboard-sounds'
GET, POST
GUILD_STICKER  : mixed = self::GUILD . '/stickers/:sticker_id'
GET, PATCH, DELETE
GUILD_STICKERS  : mixed = self::GUILD . '/stickers'
GET, POST
GUILD_TEMPLATE  : mixed = self::GUILD . '/templates/:template_code'
PUT, PATCH, DELETE
GUILD_TEMPLATES  : mixed = self::GUILD . '/templates'
GET, POST
GUILD_THREADS_ACTIVE  : mixed = self::GUILD . '/threads/active'
GET
GUILD_USER_CURRENT_VOICE_STATE  : mixed = self::GUILD . '/voice-states/@me'
GET, PATCH
GUILD_USER_VOICE_STATE  : mixed = self::GUILD . '/voice-states/:user_id'
GET, PATCH
GUILD_VANITY_URL  : mixed = self::GUILD . '/vanity-url'
GET
GUILD_WEBHOOKS  : mixed = self::GUILD . '/webhooks'
GET
GUILD_WELCOME_SCREEN  : mixed = self::GUILD . '/welcome-screen'
GET, PATCH
GUILD_WIDGET  : mixed = self::GUILD . '/widget.json'
GET
GUILD_WIDGET_IMAGE  : mixed = self::GUILD . '/widget.png'
GET
GUILD_WIDGET_SETTINGS  : mixed = self::GUILD . '/widget'
GET, PATCH
GUILDS  : mixed = 'guilds'
POST
GUILDS_TEMPLATE  : mixed = self::GUILDS . '/templates/:template_code'
GET, POST
INTERACTION_FOLLOW_UP  : mixed = self::CREATE_INTERACTION_FOLLOW_UP . '/messages...
GET, PATCH, DELETE
INTERACTION_RESPONSE  : mixed = 'interactions/:interaction_id/:interaction_toke...
POST
INVITE  : mixed = 'invites/:code'
GET, DELETE
INVITE_TARGET_USERS  : mixed = self::INVITE . '/target-users'
GET, PUT
INVITE_TARGET_USERS_ADD  : mixed = self::INVITE_TARGET_USERS . '/:user_id'
PUT
INVITE_TARGET_USERS_BULK_ADD  : mixed = self::INVITE_TARGET_USERS . '/bulk-add'
POST
INVITE_TARGET_USERS_BULK_DELETE  : mixed = self::INVITE_TARGET_USERS . '/bulk-delete'
POST
INVITE_TARGET_USERS_JOB_STATUS  : mixed = self::INVITE_TARGET_USERS . '/job-status'
GET
INVITE_TARGET_USERS_REMOVE  : mixed = self::INVITE_TARGET_USERS . '/:user_id'
DELETE
LIST_VOICE_REGIONS  : mixed = 'voice/regions'
GET
LOBBIES  : mixed = 'lobbies'
POST, PUT
LOBBY  : mixed = self::LOBBIES . '/:lobby_id'
GET, PATCH, DELETE
LOBBY_CHANNEL_LINKING  : mixed = self::LOBBY . '/channel-linking'
PATCH
LOBBY_MEMBER  : mixed = self::LOBBY . '/members/:user_id'
PUT, DELETE
LOBBY_MEMBER_INVITES  : mixed = self::LOBBY . '/members/:user_id/invites'
POST
LOBBY_MEMBER_ME_INVITES  : mixed = self::LOBBY . '/members/@me/invites'
POST
LOBBY_MEMBERS_BULK  : mixed = self::LOBBY . '/members/bulk'
POST
LOBBY_MESSAGE_MODERATION_METADATA  : mixed = self::LOBBY . '/messages/:message_id/moderation...
PUT
LOBBY_MESSAGES  : mixed = self::LOBBY . '/messages'
GET, POST
LOBBY_SELF  : mixed = self::LOBBY . '/members/@me'
DELETE
MAJOR_PARAMETERS  : array<string|int, string> = ['channel_id', 'guild_id', 'webhook_id', 'threa...
A list of parameters considered 'major' by Discord.
MESSAGE_POLL_ANSWER  : mixed = self::MESSAGE_POLL . '/answers/:answer_id'
GET
MESSAGE_POLL_EXPIRE  : mixed = self::MESSAGE_POLL . '/expire'
POST
MESSAGE_REACTION_ALL  : mixed = self::CHANNEL . '/messages/:message_id/reactions'
GET, DELETE
MESSAGE_REACTION_EMOJI  : mixed = self::CHANNEL . '/messages/:message_id/reaction...
GET, DELETE
OAUTH2_APPLICATIONS_ME  : mixed = 'oauth2/applications/@me'
GET
OAUTH2_KEYS  : mixed = 'oauth2/keys'
GET
OAUTH2_ME  : mixed = 'oauth2/@me'
GET
OAUTH2_TOKEN  : mixed = 'oauth2/token'
POST
OAUTH2_TOKEN_REVOKE  : mixed = self::OAUTH2_TOKEN . '/revoke'
POST
OAUTH2_USERINFO  : mixed = 'oauth2/userinfo'
GET
ORIGINAL_INTERACTION_RESPONSE  : mixed = self::CREATE_INTERACTION_FOLLOW_UP . '/messages...
GET, PATCH, DELETE
OWN_MESSAGE_REACTION  : mixed = self::CHANNEL . '/messages/:message_id/reaction...
PUT, DELETE
PARTNER_SDK_CHILD_TOKEN  : mixed = 'partner-sdk/child-token'
POST
PARTNER_SDK_DMS_MESSAGE_MODERATION_METADATA  : mixed = 'partner-sdk/dms/:user_id_1/:user_id_2/messages...
PUT
PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE  : mixed = 'partner-sdk/provisional-accounts/unmerge'
POST
PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE_BOT  : mixed = self::PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE...
POST
PARTNER_SDK_TOKEN  : mixed = 'partner-sdk/token'
POST
PARTNER_SDK_TOKEN_BOT  : mixed = self::PARTNER_SDK_TOKEN . '/bot'
POST
REGEX  : string = '/:([^\/]*)/'
Regex to identify parameters in endpoints.
SKU_SUBSCRIPTION  : mixed = self::SKU_SUBSCRIPTIONS . '/:subscription_id'
GET
SKU_SUBSCRIPTIONS  : mixed = '/skus/:sku_id/subscriptions'
GET
SOUNDBOARD_DEFAULT_SOUNDS  : mixed = 'soundboard-default-sounds'
GET
STAGE_INSTANCE  : mixed = 'stage-instances/:channel_id'
GET, PATCH, DELETE
STAGE_INSTANCES  : mixed = 'stage-instances'
POST
STICKER  : mixed = 'stickers/:sticker_id'
GET
STICKER_PACK  : mixed = self::STICKER_PACKS . '/:pack_id'
GET
STICKER_PACKS  : mixed = 'sticker-packs'
GET
THREAD  : mixed = 'channels/:thread_id'
GET, PATCH, DELETE
THREAD_MEMBER  : mixed = self::THREAD_MEMBERS . '/:user_id'
GET, PUT, DELETE
THREAD_MEMBER_ME  : mixed = self::THREAD_MEMBERS . '/@me'
PUT, DELETE
THREAD_MEMBERS  : mixed = self::THREAD . '/thread-members'
GET
USER  : mixed = 'users/:user_id'
GET
USER_APPLICATION_IDENTITIES  : mixed = self::USER . '/application-identities/:applicat...
GET
USER_APPLICATION_IDENTITY_DELETE  : mixed = self::USER_APPLICATION_IDENTITIES . '/:provider...
POST
USER_CURRENT  : mixed = 'users/@me'
GET, PATCH
USER_CURRENT_APPLICATION_ENTITLEMENTS  : mixed = self::USER_CURRENT . '/applications/:applicatio...
GET
USER_CURRENT_APPLICATION_ROLE_CONNECTION  : mixed = self::USER_CURRENT . '/applications/:applicatio...
GET, PUT, DELETE
USER_CURRENT_CHANNELS  : mixed = self::USER_CURRENT . '/channels'
GET, POST
USER_CURRENT_CONNECTIONS  : mixed = self::USER_CURRENT . '/connections'
GET
USER_CURRENT_GUILD  : mixed = self::USER_CURRENT . '/guilds/:guild_id'
DELETE
USER_CURRENT_GUILDS  : mixed = self::USER_CURRENT . '/guilds'
GET
USER_CURRENT_MEMBER  : mixed = self::USER_CURRENT_GUILD . '/member'
GET
USER_MESSAGE_REACTION  : mixed = self::CHANNEL . '/messages/:message_id/reaction...
DELETE
WEBHOOK  : mixed = 'webhooks/:webhook_id'
GET, PATCH, DELETE
WEBHOOK_EXECUTE  : mixed = self::WEBHOOK_TOKEN
POST
WEBHOOK_EXECUTE_GITHUB  : mixed = self::WEBHOOK_EXECUTE . '/github'
POST
WEBHOOK_EXECUTE_SLACK  : mixed = self::WEBHOOK_EXECUTE . '/slack'
POST
WEBHOOK_MESSAGE  : mixed = self::WEBHOOK_TOKEN . '/messages/:message_id'
GET, PATCH, DELETE
WEBHOOK_TOKEN  : mixed = 'webhooks/:webhook_id/:webhook_token'
GET, PATCH, DELETE
MESSAGE_POLL  : mixed = self::CHANNEL . '/polls/:message_id'
GET

Properties

$args  : array<string|int, string>
Array of arguments to substitute into the endpoint.
$endpoint  : string
The string version of the endpoint, including all parameters.
$query  : array<string|int, mixed>
Array of query data to be appended to the end of the endpoint with `http_build_query`.
$vars  : array<string|int, string>
Array of placeholders to be replaced in the endpoint.

Methods

__construct()  : mixed
Creates an endpoint class.
__toString()  : string
Converts the endpoint to a string.
addQuery()  : void
Adds a key-value query pair to the endpoint.
bind()  : Endpoint
Creates an endpoint class and binds arguments to the newly created instance.
bindArgs()  : this
Binds a list of arguments to the endpoint.
bindAssoc()  : this
Binds an associative array to the endpoint.
toAbsoluteEndpoint()  : string
Converts the endpoint into the absolute endpoint with placeholders replaced.
isMajorParameter()  : bool
Checks if a parameter is a major parameter.

Constants

APPLICATION

GET, PATCH

public mixed APPLICATION = 'applications/:application_id'

APPLICATION_ACTIVITY_INSTANCE

GET

public mixed APPLICATION_ACTIVITY_INSTANCE = 'applications/:application_id/activity-instances/:instance_id'

APPLICATION_ATTACHMENT

POST

public mixed APPLICATION_ATTACHMENT = 'applications/:application_id/attachment'

APPLICATION_CURRENT

GET, PATCH

public mixed APPLICATION_CURRENT = 'applications/@me'

APPLICATION_EMOJI

GET, PATCH, DELETE

public mixed APPLICATION_EMOJI = 'applications/:application_id/emojis/:emoji_id'

APPLICATION_EMOJIS

GET, POST

public mixed APPLICATION_EMOJIS = 'applications/:application_id/emojis'

APPLICATION_ENTITLEMENT

GET, DELETE

public mixed APPLICATION_ENTITLEMENT = self::APPLICATION_ENTITLEMENTS . '/:entitlement_id'

APPLICATION_ENTITLEMENT_CONSUME

POST

public mixed APPLICATION_ENTITLEMENT_CONSUME = self::APPLICATION_ENTITLEMENT . '/consume'

APPLICATION_ENTITLEMENTS

GET, POST

public mixed APPLICATION_ENTITLEMENTS = 'applications/:application_id/entitlements'

APPLICATION_IDENTITIES_BY_EXTERNAL_ID

GET

public mixed APPLICATION_IDENTITIES_BY_EXTERNAL_ID = self::APPLICATION . '/application-identities/:provider_type/:provider_issued_user_id'

APPLICATION_ROLE_CONNECTION_METADATA

GET, PUT

public mixed APPLICATION_ROLE_CONNECTION_METADATA = 'applications/:application_id/role-connections/metadata'

APPLICATION_SKUS

GET

public mixed APPLICATION_SKUS = 'applications/:application_id/skus'

APPLICATION_USER_IDENTITY_PROFILE

GET, PATCH

public mixed APPLICATION_USER_IDENTITY_PROFILE = self::APPLICATION . '/users/:user_id/identities/:provider_issued_user_id/profile'

AUDIT_LOG

GET

public mixed AUDIT_LOG = 'guilds/:guild_id/audit-logs'

CHANNEL

GET, PATCH, DELETE

public mixed CHANNEL = 'channels/:channel_id'

CHANNEL_CROSSPOST_MESSAGE

POST

public mixed CHANNEL_CROSSPOST_MESSAGE = self::CHANNEL . '/messages/:message_id/crosspost'

CHANNEL_FOLLOW

POST

public mixed CHANNEL_FOLLOW = self::CHANNEL . '/followers'

CHANNEL_INVITES

GET, POST

public mixed CHANNEL_INVITES = self::CHANNEL . '/invites'

CHANNEL_MESSAGE

GET, PATCH, DELETE

public mixed CHANNEL_MESSAGE = self::CHANNEL . '/messages/:message_id'

CHANNEL_MESSAGE_THREADS

POST

public mixed CHANNEL_MESSAGE_THREADS = self::CHANNEL_MESSAGE . '/threads'

CHANNEL_MESSAGES

GET, POST

public mixed CHANNEL_MESSAGES = self::CHANNEL . '/messages'

CHANNEL_MESSAGES_BULK_DELETE

POST

public mixed CHANNEL_MESSAGES_BULK_DELETE = self::CHANNEL . '/messages/bulk-delete'

CHANNEL_MESSAGES_PIN

PUT, DELETE

public mixed CHANNEL_MESSAGES_PIN = self::CHANNEL . '/messages/pins/:message_id'

CHANNEL_MESSAGES_PINS

GET

public mixed CHANNEL_MESSAGES_PINS = self::CHANNEL . '/messages/pins'

CHANNEL_PERMISSIONS

PUT, DELETE

public mixed CHANNEL_PERMISSIONS = self::CHANNEL . '/permissions/:overwrite_id'

CHANNEL_PIN

Use CHANNEL_MESSAGES_PIN

public mixed CHANNEL_PIN = self::CHANNEL . '/pins/:message_id'

CHANNEL_PINS

Use CHANNEL_MESSAGES_PINS

public mixed CHANNEL_PINS = self::CHANNEL . '/pins'

CHANNEL_RECIPIENT

PUT, DELETE

public mixed CHANNEL_RECIPIENT = self::CHANNEL . '/recipients/:user_id'

CHANNEL_SEND_SOUNDBOARD_SOUND

POST

public mixed CHANNEL_SEND_SOUNDBOARD_SOUND = self::CHANNEL . '/send-soundboard-sound'

CHANNEL_THREADS

POST

public mixed CHANNEL_THREADS = self::CHANNEL . '/threads'

CHANNEL_THREADS_ARCHIVED_PRIVATE

GET

public mixed CHANNEL_THREADS_ARCHIVED_PRIVATE = self::CHANNEL_THREADS . '/archived/private'

CHANNEL_THREADS_ARCHIVED_PRIVATE_ME

GET

public mixed CHANNEL_THREADS_ARCHIVED_PRIVATE_ME = self::CHANNEL . '/users/@me/threads/archived/private'

CHANNEL_THREADS_ARCHIVED_PUBLIC

GET

public mixed CHANNEL_THREADS_ARCHIVED_PUBLIC = self::CHANNEL_THREADS . '/archived/public'

CHANNEL_THREADS_SEARCH

GET

public mixed CHANNEL_THREADS_SEARCH = self::CHANNEL_THREADS . '/search'

CHANNEL_TYPING

POST

public mixed CHANNEL_TYPING = self::CHANNEL . '/typing'

CHANNEL_VOICE_STATUS

PUT

public mixed CHANNEL_VOICE_STATUS = self::CHANNEL . '/voice-status'

CHANNEL_WEBHOOKS

GET, POST

public mixed CHANNEL_WEBHOOKS = self::CHANNEL . '/webhooks'

CREATE_INTERACTION_FOLLOW_UP

POST

public mixed CREATE_INTERACTION_FOLLOW_UP = 'webhooks/:application_id/:interaction_token'

GATEWAY

GET

public mixed GATEWAY = 'gateway'

GATEWAY_BOT

GET

public mixed GATEWAY_BOT = self::GATEWAY . '/bot'

GLOBAL_APPLICATION_COMMAND

GET, PATCH, DELETE

public mixed GLOBAL_APPLICATION_COMMAND = self::GLOBAL_APPLICATION_COMMANDS . '/:command_id'

GLOBAL_APPLICATION_COMMANDS

GET, POST, PUT

public mixed GLOBAL_APPLICATION_COMMANDS = 'applications/:application_id/commands'

GUILD

GET, PATCH, DELETE

public mixed GUILD = 'guilds/:guild_id'

GUILD_APPLICATION_COMMAND

GET, PATCH, DELETE

public mixed GUILD_APPLICATION_COMMAND = self::GUILD_APPLICATION_COMMANDS . '/:command_id'

GUILD_APPLICATION_COMMAND_PERMISSIONS

GET, PUT

public mixed GUILD_APPLICATION_COMMAND_PERMISSIONS = self::GUILD_APPLICATION_COMMANDS . '/:command_id/permissions'

GUILD_APPLICATION_COMMANDS

GET, POST, PUT

public mixed GUILD_APPLICATION_COMMANDS = 'applications/:application_id/guilds/:guild_id/commands'

GUILD_APPLICATION_COMMANDS_PERMISSIONS

GET, PUT

public mixed GUILD_APPLICATION_COMMANDS_PERMISSIONS = self::GUILD_APPLICATION_COMMANDS . '/permissions'

GUILD_AUTO_MODERATION_RULE

GET, PATCH, DELETE

public mixed GUILD_AUTO_MODERATION_RULE = self::GUILD . '/auto-moderation/rules/:auto_moderation_rule_id'

GUILD_AUTO_MODERATION_RULES

GET, POST

public mixed GUILD_AUTO_MODERATION_RULES = self::GUILD . '/auto-moderation/rules'

GUILD_BAN

GET, PUT, DELETE

public mixed GUILD_BAN = self::GUILD . '/bans/:user_id'

GUILD_BAN_BULK

POST

public mixed GUILD_BAN_BULK = self::GUILD . '/bulk-ban'

GUILD_BANS

GET

public mixed GUILD_BANS = self::GUILD . '/bans'

GUILD_CHANNELS

GET, POST, PATCH

public mixed GUILD_CHANNELS = self::GUILD . '/channels'

GUILD_EMOJI

GET, PATCH, DELETE

public mixed GUILD_EMOJI = self::GUILD . '/emojis/:emoji_id'

GUILD_EMOJIS

GET, POST

public mixed GUILD_EMOJIS = self::GUILD . '/emojis'

GUILD_INCIDENT_ACTIONS

PUT

public mixed GUILD_INCIDENT_ACTIONS = self::GUILD . '/incident-actions'

GUILD_INTEGRATION

PATCH, DELETE

public mixed GUILD_INTEGRATION = self::GUILD . '/integrations/:integration_id'

GUILD_INTEGRATION_SYNC

POST

public mixed GUILD_INTEGRATION_SYNC = self::GUILD . '/integrations/:integration_id/sync'

GUILD_INTEGRATIONS

GET, POST

public mixed GUILD_INTEGRATIONS = self::GUILD . '/integrations'

GUILD_INVITES

GET, POST

public mixed GUILD_INVITES = self::GUILD . '/invites'

GUILD_JOIN_REQUEST

PATCH

public mixed GUILD_JOIN_REQUEST = self::GUILD_JOIN_REQUESTS . '/:join_request_id'

GUILD_JOIN_REQUESTS

GET

public mixed GUILD_JOIN_REQUESTS = self::GUILD . '/requests'

GUILD_MEMBER

GET, PATCH, PUT, DELETE

public mixed GUILD_MEMBER = self::GUILD . '/members/:user_id'

GUILD_MEMBER_ROLE

PUT, DELETE

public mixed GUILD_MEMBER_ROLE = self::GUILD . '/members/:user_id/roles/:role_id'

GUILD_MEMBER_SELF

PATCH

public mixed GUILD_MEMBER_SELF = self::GUILD . '/members/@me'

GUILD_MEMBER_SELF_NICK

Use GUILD_MEMBER_SELF

public mixed GUILD_MEMBER_SELF_NICK = self::GUILD . '/members/@me/nick'

GUILD_MEMBERS

GET

public mixed GUILD_MEMBERS = self::GUILD . '/members'

GUILD_MEMBERS_SEARCH

GET

public mixed GUILD_MEMBERS_SEARCH = self::GUILD . '/members/search'

GUILD_MEMBERSHIP_SCREENING

GET, PATCH

public mixed GUILD_MEMBERSHIP_SCREENING = self::GUILD . '/member-verification'

GUILD_MESSAGES_SEARCH

GET

public mixed GUILD_MESSAGES_SEARCH = self::GUILD . '/messages/search'

GUILD_MFA

POST

public mixed GUILD_MFA = self::GUILD . '/mfa'

GUILD_NEW_MEMBER_WELCOME

GET

public mixed GUILD_NEW_MEMBER_WELCOME = self::GUILD . '/new-member-welcome'

GUILD_ONBOARDING

GET, PUT

public mixed GUILD_ONBOARDING = self::GUILD . '/onboarding'

GUILD_PREVIEW

GET

public mixed GUILD_PREVIEW = self::GUILD . '/preview'

GUILD_PRUNE

GET, POST

public mixed GUILD_PRUNE = self::GUILD . '/prune'

GUILD_REGIONS

GET

public mixed GUILD_REGIONS = self::GUILD . '/regions'

GUILD_ROLE

GET, POST, PATCH, DELETE

public mixed GUILD_ROLE = self::GUILD . '/roles/:role_id'

GUILD_ROLES

GET, POST, PATCH

public mixed GUILD_ROLES = self::GUILD . '/roles'

GUILD_ROLES_MEMBER_COUNTS

GET

public mixed GUILD_ROLES_MEMBER_COUNTS = self::GUILD . '/roles/member-counts'

GUILD_SCHEDULED_EVENT

GET, PATCH, DELETE

public mixed GUILD_SCHEDULED_EVENT = self::GUILD_SCHEDULED_EVENTS . '/:guild_scheduled_event_id'

GUILD_SCHEDULED_EVENT_EXCEPTION

PATCH, DELETE

public mixed GUILD_SCHEDULED_EVENT_EXCEPTION = self::GUILD_SCHEDULED_EVENT_EXCEPTIONS . '/:event_exception_id'

GUILD_SCHEDULED_EVENT_EXCEPTION_USERS

GET

public mixed GUILD_SCHEDULED_EVENT_EXCEPTION_USERS = self::GUILD_SCHEDULED_EVENT . '/:event_exception_id/users'

GUILD_SCHEDULED_EVENT_EXCEPTIONS

GET, POST

public mixed GUILD_SCHEDULED_EVENT_EXCEPTIONS = self::GUILD_SCHEDULED_EVENT . '/exceptions'

GUILD_SCHEDULED_EVENT_USERS

GET

public mixed GUILD_SCHEDULED_EVENT_USERS = self::GUILD_SCHEDULED_EVENT . '/users'

GUILD_SCHEDULED_EVENT_USERS_COUNT

GET

public mixed GUILD_SCHEDULED_EVENT_USERS_COUNT = self::GUILD_SCHEDULED_EVENT_USERS . '/counts'

GUILD_SCHEDULED_EVENTS

GET, POST

public mixed GUILD_SCHEDULED_EVENTS = self::GUILD . '/scheduled-events'

GUILD_SOUNDBOARD_SOUND

GET, PATCH, DELETE

public mixed GUILD_SOUNDBOARD_SOUND = self::GUILD . '/soundboard-sounds/:sound_id'

GUILD_SOUNDBOARD_SOUNDS

GET, POST

public mixed GUILD_SOUNDBOARD_SOUNDS = self::GUILD . '/soundboard-sounds'

GUILD_STICKER

GET, PATCH, DELETE

public mixed GUILD_STICKER = self::GUILD . '/stickers/:sticker_id'

GUILD_STICKERS

GET, POST

public mixed GUILD_STICKERS = self::GUILD . '/stickers'

GUILD_TEMPLATE

PUT, PATCH, DELETE

public mixed GUILD_TEMPLATE = self::GUILD . '/templates/:template_code'

GUILD_TEMPLATES

GET, POST

public mixed GUILD_TEMPLATES = self::GUILD . '/templates'

GUILD_THREADS_ACTIVE

GET

public mixed GUILD_THREADS_ACTIVE = self::GUILD . '/threads/active'

GUILD_USER_CURRENT_VOICE_STATE

GET, PATCH

public mixed GUILD_USER_CURRENT_VOICE_STATE = self::GUILD . '/voice-states/@me'

GUILD_USER_VOICE_STATE

GET, PATCH

public mixed GUILD_USER_VOICE_STATE = self::GUILD . '/voice-states/:user_id'

GUILD_VANITY_URL

GET

public mixed GUILD_VANITY_URL = self::GUILD . '/vanity-url'

GUILD_WEBHOOKS

GET

public mixed GUILD_WEBHOOKS = self::GUILD . '/webhooks'

GUILD_WELCOME_SCREEN

GET, PATCH

public mixed GUILD_WELCOME_SCREEN = self::GUILD . '/welcome-screen'

GUILD_WIDGET

GET

public mixed GUILD_WIDGET = self::GUILD . '/widget.json'

GUILD_WIDGET_IMAGE

GET

public mixed GUILD_WIDGET_IMAGE = self::GUILD . '/widget.png'

GUILD_WIDGET_SETTINGS

GET, PATCH

public mixed GUILD_WIDGET_SETTINGS = self::GUILD . '/widget'

GUILDS

POST

public mixed GUILDS = 'guilds'

GUILDS_TEMPLATE

GET, POST

public mixed GUILDS_TEMPLATE = self::GUILDS . '/templates/:template_code'

INTERACTION_FOLLOW_UP

GET, PATCH, DELETE

public mixed INTERACTION_FOLLOW_UP = self::CREATE_INTERACTION_FOLLOW_UP . '/messages/:message_id'

INTERACTION_RESPONSE

POST

public mixed INTERACTION_RESPONSE = 'interactions/:interaction_id/:interaction_token/callback'

INVITE

GET, DELETE

public mixed INVITE = 'invites/:code'

INVITE_TARGET_USERS

GET, PUT

public mixed INVITE_TARGET_USERS = self::INVITE . '/target-users'

INVITE_TARGET_USERS_ADD

PUT

public mixed INVITE_TARGET_USERS_ADD = self::INVITE_TARGET_USERS . '/:user_id'

INVITE_TARGET_USERS_BULK_ADD

POST

public mixed INVITE_TARGET_USERS_BULK_ADD = self::INVITE_TARGET_USERS . '/bulk-add'

INVITE_TARGET_USERS_BULK_DELETE

POST

public mixed INVITE_TARGET_USERS_BULK_DELETE = self::INVITE_TARGET_USERS . '/bulk-delete'

INVITE_TARGET_USERS_JOB_STATUS

GET

public mixed INVITE_TARGET_USERS_JOB_STATUS = self::INVITE_TARGET_USERS . '/job-status'

INVITE_TARGET_USERS_REMOVE

DELETE

public mixed INVITE_TARGET_USERS_REMOVE = self::INVITE_TARGET_USERS . '/:user_id'

LIST_VOICE_REGIONS

GET

public mixed LIST_VOICE_REGIONS = 'voice/regions'

LOBBIES

POST, PUT

public mixed LOBBIES = 'lobbies'

LOBBY

GET, PATCH, DELETE

public mixed LOBBY = self::LOBBIES . '/:lobby_id'

LOBBY_CHANNEL_LINKING

PATCH

public mixed LOBBY_CHANNEL_LINKING = self::LOBBY . '/channel-linking'

LOBBY_MEMBER

PUT, DELETE

public mixed LOBBY_MEMBER = self::LOBBY . '/members/:user_id'

LOBBY_MEMBER_INVITES

POST

public mixed LOBBY_MEMBER_INVITES = self::LOBBY . '/members/:user_id/invites'

LOBBY_MEMBER_ME_INVITES

POST

public mixed LOBBY_MEMBER_ME_INVITES = self::LOBBY . '/members/@me/invites'

LOBBY_MEMBERS_BULK

POST

public mixed LOBBY_MEMBERS_BULK = self::LOBBY . '/members/bulk'

LOBBY_MESSAGE_MODERATION_METADATA

PUT

public mixed LOBBY_MESSAGE_MODERATION_METADATA = self::LOBBY . '/messages/:message_id/moderation-metadata'

LOBBY_MESSAGES

GET, POST

public mixed LOBBY_MESSAGES = self::LOBBY . '/messages'

LOBBY_SELF

DELETE

public mixed LOBBY_SELF = self::LOBBY . '/members/@me'

MESSAGE_POLL_ANSWER

GET

public mixed MESSAGE_POLL_ANSWER = self::MESSAGE_POLL . '/answers/:answer_id'

MESSAGE_POLL_EXPIRE

POST

public mixed MESSAGE_POLL_EXPIRE = self::MESSAGE_POLL . '/expire'

MESSAGE_REACTION_ALL

GET, DELETE

public mixed MESSAGE_REACTION_ALL = self::CHANNEL . '/messages/:message_id/reactions'

MESSAGE_REACTION_EMOJI

GET, DELETE

public mixed MESSAGE_REACTION_EMOJI = self::CHANNEL . '/messages/:message_id/reactions/:emoji'

OAUTH2_APPLICATIONS_ME

GET

public mixed OAUTH2_APPLICATIONS_ME = 'oauth2/applications/@me'

OAUTH2_KEYS

GET

public mixed OAUTH2_KEYS = 'oauth2/keys'

OAUTH2_ME

GET

public mixed OAUTH2_ME = 'oauth2/@me'

OAUTH2_TOKEN

POST

public mixed OAUTH2_TOKEN = 'oauth2/token'

OAUTH2_TOKEN_REVOKE

POST

public mixed OAUTH2_TOKEN_REVOKE = self::OAUTH2_TOKEN . '/revoke'

OAUTH2_USERINFO

GET

public mixed OAUTH2_USERINFO = 'oauth2/userinfo'

ORIGINAL_INTERACTION_RESPONSE

GET, PATCH, DELETE

public mixed ORIGINAL_INTERACTION_RESPONSE = self::CREATE_INTERACTION_FOLLOW_UP . '/messages/@original'

OWN_MESSAGE_REACTION

PUT, DELETE

public mixed OWN_MESSAGE_REACTION = self::CHANNEL . '/messages/:message_id/reactions/:emoji/@me'

PARTNER_SDK_CHILD_TOKEN

POST

public mixed PARTNER_SDK_CHILD_TOKEN = 'partner-sdk/child-token'

PARTNER_SDK_DMS_MESSAGE_MODERATION_METADATA

PUT

public mixed PARTNER_SDK_DMS_MESSAGE_MODERATION_METADATA = 'partner-sdk/dms/:user_id_1/:user_id_2/messages/:message_id/moderation-metadata'

PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE

POST

public mixed PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE = 'partner-sdk/provisional-accounts/unmerge'

PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE_BOT

POST

public mixed PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE_BOT = self::PARTNER_SDK_PROVISIONAL_ACCOUNTS_UNMERGE . '/bot'

PARTNER_SDK_TOKEN

POST

public mixed PARTNER_SDK_TOKEN = 'partner-sdk/token'

PARTNER_SDK_TOKEN_BOT

POST

public mixed PARTNER_SDK_TOKEN_BOT = self::PARTNER_SDK_TOKEN . '/bot'

REGEX

Regex to identify parameters in endpoints.

public string REGEX = '/:([^\/]*)/'

SKU_SUBSCRIPTION

GET

public mixed SKU_SUBSCRIPTION = self::SKU_SUBSCRIPTIONS . '/:subscription_id'

SKU_SUBSCRIPTIONS

GET

public mixed SKU_SUBSCRIPTIONS = '/skus/:sku_id/subscriptions'

SOUNDBOARD_DEFAULT_SOUNDS

GET

public mixed SOUNDBOARD_DEFAULT_SOUNDS = 'soundboard-default-sounds'

STAGE_INSTANCE

GET, PATCH, DELETE

public mixed STAGE_INSTANCE = 'stage-instances/:channel_id'

STAGE_INSTANCES

POST

public mixed STAGE_INSTANCES = 'stage-instances'

STICKER

GET

public mixed STICKER = 'stickers/:sticker_id'

STICKER_PACK

GET

public mixed STICKER_PACK = self::STICKER_PACKS . '/:pack_id'

STICKER_PACKS

GET

public mixed STICKER_PACKS = 'sticker-packs'

THREAD

GET, PATCH, DELETE

public mixed THREAD = 'channels/:thread_id'

THREAD_MEMBER

GET, PUT, DELETE

public mixed THREAD_MEMBER = self::THREAD_MEMBERS . '/:user_id'

THREAD_MEMBER_ME

PUT, DELETE

public mixed THREAD_MEMBER_ME = self::THREAD_MEMBERS . '/@me'

THREAD_MEMBERS

GET

public mixed THREAD_MEMBERS = self::THREAD . '/thread-members'

USER

GET

public mixed USER = 'users/:user_id'

USER_APPLICATION_IDENTITIES

GET

public mixed USER_APPLICATION_IDENTITIES = self::USER . '/application-identities/:application_id'

USER_APPLICATION_IDENTITY_DELETE

POST

public mixed USER_APPLICATION_IDENTITY_DELETE = self::USER_APPLICATION_IDENTITIES . '/:provider_type/:provider_issued_user_id/delete'

USER_CURRENT

GET, PATCH

public mixed USER_CURRENT = 'users/@me'

USER_CURRENT_APPLICATION_ENTITLEMENTS

GET

public mixed USER_CURRENT_APPLICATION_ENTITLEMENTS = self::USER_CURRENT . '/applications/:application_id/entitlements'

USER_CURRENT_APPLICATION_ROLE_CONNECTION

GET, PUT, DELETE

public mixed USER_CURRENT_APPLICATION_ROLE_CONNECTION = self::USER_CURRENT . '/applications/:application_id/role-connection'

USER_CURRENT_CHANNELS

GET, POST

public mixed USER_CURRENT_CHANNELS = self::USER_CURRENT . '/channels'

USER_CURRENT_CONNECTIONS

GET

public mixed USER_CURRENT_CONNECTIONS = self::USER_CURRENT . '/connections'

USER_CURRENT_GUILD

DELETE

public mixed USER_CURRENT_GUILD = self::USER_CURRENT . '/guilds/:guild_id'

USER_CURRENT_GUILDS

GET

public mixed USER_CURRENT_GUILDS = self::USER_CURRENT . '/guilds'

USER_CURRENT_MEMBER

GET

public mixed USER_CURRENT_MEMBER = self::USER_CURRENT_GUILD . '/member'

USER_MESSAGE_REACTION

DELETE

public mixed USER_MESSAGE_REACTION = self::CHANNEL . '/messages/:message_id/reactions/:emoji/:user_id'

WEBHOOK

GET, PATCH, DELETE

public mixed WEBHOOK = 'webhooks/:webhook_id'

WEBHOOK_EXECUTE

POST

public mixed WEBHOOK_EXECUTE = self::WEBHOOK_TOKEN

WEBHOOK_EXECUTE_GITHUB

POST

public mixed WEBHOOK_EXECUTE_GITHUB = self::WEBHOOK_EXECUTE . '/github'

WEBHOOK_EXECUTE_SLACK

POST

public mixed WEBHOOK_EXECUTE_SLACK = self::WEBHOOK_EXECUTE . '/slack'

WEBHOOK_MESSAGE

GET, PATCH, DELETE

public mixed WEBHOOK_MESSAGE = self::WEBHOOK_TOKEN . '/messages/:message_id'

WEBHOOK_TOKEN

GET, PATCH, DELETE

public mixed WEBHOOK_TOKEN = 'webhooks/:webhook_id/:webhook_token'

MESSAGE_POLL

GET

protected mixed MESSAGE_POLL = self::CHANNEL . '/polls/:message_id'

Properties

$args

Array of arguments to substitute into the endpoint.

protected array<string|int, string> $args = []

$endpoint

The string version of the endpoint, including all parameters.

protected string $endpoint

$query

Array of query data to be appended to the end of the endpoint with `http_build_query`.

protected array<string|int, mixed> $query = []

$vars

Array of placeholders to be replaced in the endpoint.

protected array<string|int, string> $vars = []

Methods

__construct()

Creates an endpoint class.

public __construct(string $endpoint) : mixed
Parameters
$endpoint : string

__toString()

Converts the endpoint to a string.

public __toString() : string

Alias of ->toAbsoluteEndpoint();.

Return values
string

addQuery()

Adds a key-value query pair to the endpoint.

public addQuery(string $key, string|bool $value) : void
Parameters
$key : string
$value : string|bool

bind()

Creates an endpoint class and binds arguments to the newly created instance.

public static bind(string $endpoint, array<string|int, string> ...$args) : Endpoint
Parameters
$endpoint : string
$args : array<string|int, string>
Return values
Endpoint

bindArgs()

Binds a list of arguments to the endpoint.

public bindArgs(array<string|int, string> ...$args) : this
Parameters
$args : array<string|int, string>
Return values
this

bindAssoc()

Binds an associative array to the endpoint.

public bindAssoc(array<string|int, string> $args) : this
Parameters
$args : array<string|int, string>
Return values
this

toAbsoluteEndpoint()

Converts the endpoint into the absolute endpoint with placeholders replaced.

public toAbsoluteEndpoint([bool $onlyMajorParameters = false ]) : string

Passing a true boolean in will only replace the major parameters. Used for rate limit buckets.

Parameters
$onlyMajorParameters : bool = false
Return values
string

isMajorParameter()

Checks if a parameter is a major parameter.

private static isMajorParameter(string $param) : bool
Parameters
$param : string
Return values
bool
On this page

Search results