Skip to content

Commit 2b848c9

Browse files
authored
Move message docs to a new page (#7034)
1 parent 3cad697 commit 2b848c9

File tree

16 files changed

+932
-933
lines changed

16 files changed

+932
-933
lines changed

docs/Change_Log.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ All Application IDs created after `07/17/2024 12:00:00` UTC (applicationID great
4545

4646
#### July 15, 2024
4747

48-
We are slowly rolling out the message forwarding feature to users. This feature allows callers to create a message using `message_reference.type = FORWARD` and have the API generate a `message_snapshot` for the sent message. The feature has [some limitations](#DOCS_RESOURCES_CHANNEL/message-reference-types) and the snapshot is a minimal version of a standard `MessageObject`, but does capture the core parts of a message.
48+
We are slowly rolling out the message forwarding feature to users. This feature allows callers to create a message using `message_reference.type = FORWARD` and have the API generate a `message_snapshot` for the sent message. The feature has [some limitations](#DOCS_RESOURCES_MESSAGE/message-reference-types) and the snapshot is a minimal version of a standard `MessageObject`, but does capture the core parts of a message.
4949

5050
The resulting message will look something like:
5151
```json
@@ -76,7 +76,7 @@ We have applied stricter rate limits for this feature based on the following:
7676
###### API Updates since preview
7777

7878
This was [previously announced](https://discord.com/channels/613425648685547541/697138785317814292/1233463756160503859) but note that the final API has a few changes since the API was first previewed:
79-
- [`message snapshot`](#DOCS_RESOURCES_CHANNEL/message-snapshot-object) objects don't include a `guild` field anymore since the `message_reference` already provides that information
79+
- [`message snapshot`](#DOCS_RESOURCES_MESSAGE/message-snapshot-object) objects don't include a `guild` field anymore since the `message_reference` already provides that information
8080
- forwarded messages have a distinctive `message_reference` type of `FORWARD` now
8181

8282
## Banners in Get Current User Guilds
@@ -98,7 +98,7 @@ With this update, there are a few API and behavioral updates for user-installed
9898

9999
###### API Updates
100100

101-
- `user_id` has been removed from the `interaction_metadata` field on messages. Instead, you can use the `id` field in the nested `user` object. See the [Message Interaction Metadata Object](#DOCS_RESOURCES_CHANNEL/message-interaction-metadata-object) for details.
101+
- `user_id` has been removed from the `interaction_metadata` field on messages. Instead, you can use the `id` field in the nested `user` object. See the [Message Interaction Metadata Object](#DOCS_RESOURCES_MESSAGE/message-interaction-metadata-object) for details.
102102
- User-installed apps are now limited to creating a maximum of 5 [follow-ups](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/followup-messages) when responding to interactions. This only affects the [Create Followup Message endpoint](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/create-followup-message), and apps installed to the server are unaffected.
103103
- On [Interactions](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-object-interaction-structure), the value of `authorizing_integration_owners` is now correctly serialized as a string. Previously, the `"0"` value was incorrectly serialized as a number.
104104
- `app_permissions` on [Interactions](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-object-interaction-structure) now correctly represents the permissions for user-installed apps. Previously, the value was incorrect for user-installed apps.
@@ -213,9 +213,9 @@ This change introduces new concepts and fields across the API that apps will now
213213
- New `context` field for [Interactions](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-object-interaction-structure) indicates the [interaction context](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/interaction-contexts) where an interaction was triggered from.
214214
- New `authorizing_integration_owners` field for [Interactions](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-object-interaction-structure) includes a mapping of installation contexts that the interaction was authorized for, to related snowflakes for that context. Read [Authorizing Integration Owners Object](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-object-authorizing-integration-owners-object) for details.
215215
- `app_permissions` is now always serialized for interactions to indicate what [permissions](#DOCS_TOPICS_PERMISSIONS/permissions-bitwise-permission-flags) your app has access to in the context its' responding. For (G)DMs with other users, it will include the `ATTACH_FILES | EMBED_LINKS | MENTION_EVERYONE`, and for DMs with the app's bot user it will also contain `USE_EXTERNAL_EMOJIS` for the bot’s DM
216-
- New `interaction_metadata` on [Messages](#DOCS_RESOURCES_CHANNEL/message-object) that are created as part of an interaction response (either a response or follow-up). See [Message Interaction Metadata Object](#DOCS_RESOURCES_CHANNEL/message-interaction-metadata-object) for details.
216+
- New `interaction_metadata` on [Messages](#DOCS_RESOURCES_MESSAGE/message-object) that are created as part of an interaction response (either a response or follow-up). See [Message Interaction Metadata Object](#DOCS_RESOURCES_MESSAGE/message-interaction-metadata-object) for details.
217217
- `dm_permission` field for [Commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/application-command-object-application-command-structure) is deprecated. Apps should use `contexts` instead.
218-
- `interaction` field for [Messages](#DOCS_RESOURCES_CHANNEL/message-object) is deprecated. Apps should use `interaction_metadata` instead.
218+
- `interaction` field for [Messages](#DOCS_RESOURCES_MESSAGE/message-object) is deprecated. Apps should use `interaction_metadata` instead.
219219

220220
###### Limitations and Known Issues
221221

@@ -251,13 +251,13 @@ endpoints now require the `MANAGE_GUILD` permission alongside the existing `KICK
251251

252252
#### February 12, 2024
253253

254-
The [Create message](#DOCS_RESOURCES_CHANNEL/create-message) endpoint now supports an `enforce_nonce` parameter. When set to true, the message will be deduped for the same sender within a few minutes. If a message was created with the same nonce, no new message will be created and the previous message will be returned instead. This behavior will become the default for this endpoint in a future API version.
254+
The [Create message](#DOCS_RESOURCES_MESSAGE/create-message) endpoint now supports an `enforce_nonce` parameter. When set to true, the message will be deduped for the same sender within a few minutes. If a message was created with the same nonce, no new message will be created and the previous message will be returned instead. This behavior will become the default for this endpoint in a future API version.
255255

256256
## Limit Number of Fields in Embeds
257257

258258
#### December 19, 2023
259259

260-
[Embed objects](#DOCS_RESOURCES_CHANNEL/embed-object) are now limited more explicitly to 25 [embed fields](#DOCS_RESOURCES_CHANNEL/embed-object-embed-field-structure). If you pass more than 25 fields within the an embed's `fields` property, an error will be returned.
260+
[Embed objects](#DOCS_RESOURCES_MESSAGE/embed-object) are now limited more explicitly to 25 [embed fields](#DOCS_RESOURCES_MESSAGE/embed-object-embed-field-structure). If you pass more than 25 fields within the an embed's `fields` property, an error will be returned.
261261

262262
Previously, only the first 25 embed fields would be displayed within the embed but no error was returned.
263263

@@ -949,7 +949,7 @@ The `GET /guilds/{guild.id}/bans` endpoint has been migrated to require paginati
949949
- `GET /channels/{channel.id}/threads/active` is decommissioned in favor of [`GET /guilds/{guild.id}/threads/active`](#DOCS_RESOURCES_GUILD/list-active-guild-threads).
950950
- Starting in v10, you must specify the message content intent (`1 << 15`) to receive content-related fields in message dispatches. Read more in the [Gateway Intents documentation](#DOCS_TOPICS_GATEWAY/gateway-intents).
951951
- To specify a reason for an administrative action in audit logs, apps must now pass the `X-Audit-Log-Reason` header rather than the `reason` parameter for all endpoints. Read more in the [Audit Logs documentation](#DOCS_RESOURCES_AUDIT_LOG).
952-
- Message routes (like [`POST /channels/{channel.id}/messages`](#DOCS_RESOURCES_CHANNEL/create-message)) now use the `embeds` field (an array of embed objects) instead of `embed`.
952+
- Message routes (like [`POST /channels/{channel.id}/messages`](#DOCS_RESOURCES_MESSAGE/create-message)) now use the `embeds` field (an array of embed objects) instead of `embed`.
953953
- The `summary` field for [applications](#DOCS_RESOURCES_APPLICATION) now returns an empty string for all API versions.
954954
- The `name` and `description` fields for [Achievements](#DOCS_GAME_SDK_ACHIEVEMENTS/data-models-achievement-struct) are now strings, and localization info is now passed in new `name_localizations` and `description_localizations` dictionaries. This change standardizes localization to match [Application Commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/localization). Read details in the [Achievements documentation](#DOCS_GAME_SDK_ACHIEVEMENTS/data-models-achievement-struct).
955955
- Existing attachments must be specified when [`PATCH`ing messages with new attachments](#DOCS_REFERENCE/editing-message-attachments). Any attachments not specified will be removed and replaced with the specified list
@@ -1044,7 +1044,7 @@ You can now include buttons on messages sent by your app, whether they're bot me
10441044

10451045
The addition of message components means new fields and response types:
10461046

1047-
- An optional `components` field has been added to the [message object](#DOCS_RESOURCES_CHANNEL/message-object)
1047+
- An optional `components` field has been added to the [message object](#DOCS_RESOURCES_MESSAGE/message-object)
10481048
- New response types `6` and `7` have been added for [interaction responses](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-response-object-interaction-callback-type), valid only for component-based interactions
10491049

10501050
## API v9
@@ -1128,15 +1128,15 @@ Inline Replies have been added to our documentation. They behave differently in
11281128

11291129
- Inline replies are type `19` in v8, but remain type `0` in v6
11301130
- You can now add a `message_reference` on message create to create a reply
1131-
- A new field `referenced_message` has been added to the [Message Object](#DOCS_RESOURCES_CHANNEL/message-object)
1132-
- A new field `replied_user` has been added to the [Allowed Mentions Object](#DOCS_RESOURCES_CHANNEL/allowed-mentions-object)
1131+
- A new field `referenced_message` has been added to the [Message Object](#DOCS_RESOURCES_MESSAGE/message-object)
1132+
- A new field `replied_user` has been added to the [Allowed Mentions Object](#DOCS_RESOURCES_MESSAGE/allowed-mentions-object)
11331133
- [Message Create](#DOCS_TOPICS_GATEWAY_EVENTS/message-create) gateway event is guaranteed to have a `referenced_message` if the message created is a reply. Otherwise, that field is not guaranteed.
11341134

11351135
## Stickers
11361136

11371137
#### November 13, 2020
11381138

1139-
Stickers are now documented as part of the [message](#DOCS_RESOURCES_CHANNEL/message-object) object.
1139+
Stickers are now documented as part of the [message](#DOCS_RESOURCES_MESSAGE/message-object) object.
11401140

11411141
## Gateway v6 Intent Restrictions
11421142

@@ -1204,7 +1204,7 @@ Documented `permissions_new`, `allow_new`, and `deny_new` as string-serialized p
12041204

12051205
#### May 11, 2020
12061206

1207-
The legacy mention behavior for bots is now removed, and granular control of mentions should use the [Allowed Mentions](#DOCS_RESOURCES_CHANNEL/allowed-mentions-object) API moving forwards.
1207+
The legacy mention behavior for bots is now removed, and granular control of mentions should use the [Allowed Mentions](#DOCS_RESOURCES_MESSAGE/allowed-mentions-object) API moving forwards.
12081208

12091209
## New Properties on Guild Members Chunk Event
12101210

@@ -1218,13 +1218,13 @@ The [Guild Members Chunk](#DOCS_TOPICS_GATEWAY_EVENTS/guild-members-chunk) gatew
12181218

12191219
We've added a way to specify mentions in a more granular form. This change also begins the start of a 60 day deprecation cycle on legacy mention behavior. Read more:
12201220

1221-
- [Allowed mentions object](#DOCS_RESOURCES_CHANNEL/allowed-mentions-object)
1221+
- [Allowed mentions object](#DOCS_RESOURCES_MESSAGE/allowed-mentions-object)
12221222

12231223
## New Invite Events and Reactions Endpoint
12241224

12251225
We've added a new endpoint for deleting all reactions of a specific emoji from a message, as well as some new invite and reaction gateway events. Read more:
12261226

1227-
- [Delete All Reactions for Emoji](#DOCS_RESOURCES_CHANNEL/delete-all-reactions-for-emoji)
1227+
- [Delete All Reactions for Emoji](#DOCS_RESOURCES_MESSAGE/delete-all-reactions-for-emoji)
12281228
- [Invite Create](#DOCS_TOPICS_GATEWAY_EVENTS/invite-create)
12291229
- [Invite Delete](#DOCS_TOPICS_GATEWAY_EVENTS/invite-delete)
12301230
- [Message Reaction Remove Emoji](#DOCS_TOPICS_GATEWAY_EVENTS/message-reaction-remove-emoji)
@@ -1299,7 +1299,7 @@ Additional information around Teams has been added to both the API and the docum
12991299

13001300
#### May 29, 2019
13011301

1302-
Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting). This includes the addition of a few [message types](#DOCS_RESOURCES_CHANNEL/message-object-message-types), as well as some [new fields on guilds](#DOCS_RESOURCES_GUILD/guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change.
1302+
Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting). This includes the addition of a few [message types](#DOCS_RESOURCES_MESSAGE/message-object-message-types), as well as some [new fields on guilds](#DOCS_RESOURCES_GUILD/guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change.
13031303

13041304
## Deprecation of Discord-RPC Rich Presence SDK
13051305

@@ -1349,7 +1349,7 @@ We released server changes that allow guilds to represent an incomplete state of
13491349

13501350
#### February 5, 2018
13511351

1352-
Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](#DOCS_RESOURCES_CHANNEL/message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements.
1352+
Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](#DOCS_RESOURCES_MESSAGE/message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements.
13531353

13541354
## Enhancement: Get Guild Emoji Endpoint
13551355

@@ -1429,7 +1429,7 @@ Audit logs are here! Well, they've been here all along, but now we've got [docum
14291429
- `is_private` removed
14301430
- [`type`](#DOCS_RESOURCES_CHANNEL/channel-object-channel-types) is now an integer
14311431
- `recipient` is now `recipients`, an array of [user](#DOCS_RESOURCES_USER/user-object) objects
1432-
- [Message](#DOCS_RESOURCES_CHANNEL/message-object) Object
1433-
- [`type`](#DOCS_RESOURCES_CHANNEL/message-object-message-types) added to support system messages
1432+
- [Message](#DOCS_RESOURCES_MESSAGE/message-object) Object
1433+
- [`type`](#DOCS_RESOURCES_MESSAGE/message-object-message-types) added to support system messages
14341434
- [Status Update](#DOCS_TOPICS_GATEWAY_EVENTS/update-presence-gateway-presence-update-structure) Object
14351435
- `idle_since` renamed to `since`

docs/Intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Add interactivity to your app with [commands](#DOCS_INTERACTIONS_APPLICATION_COM
1616

1717
#### Customize Servers
1818

19-
Customize Discord servers by using apps to do things like [send messages](#DOCS_RESOURCES_CHANNEL/create-message), modify [channels](#DOCS_RESOURCES_CHANNEL) and [guilds](#DOCS_RESOURCES_GUILD), [integrate with AutoMod](#DOCS_RESOURCES_AUTO_MODERATION), or [connect to voice](#DOCS_TOPICS_VOICE_CONNECTIONS).
19+
Customize Discord servers by using apps to do things like [send messages](#DOCS_RESOURCES_MESSAGE/create-message), modify [channels](#DOCS_RESOURCES_CHANNEL) and [guilds](#DOCS_RESOURCES_GUILD), [integrate with AutoMod](#DOCS_RESOURCES_AUTO_MODERATION), or [connect to voice](#DOCS_TOPICS_VOICE_CONNECTIONS).
2020

2121
Plus, use the [Gateway API](#DOCS_TOPICS_GATEWAY) to respond to [real-time events](#DOCS_TOPICS_GATEWAY_EVENTS/receive-events) happening in a server, like when a reaction is added to a message.
2222

docs/Reference.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -368,9 +368,9 @@ Ensure you use the proper content type (`image/jpeg`, `image/png`, `image/gif`)
368368

369369
### Signed Attachment CDN URLs
370370

371-
Attachments uploaded to Discord's CDN (like user and bot-uploaded images) have signed URLs with a preset expiry time. Discord automatically refreshes attachment CDN URLs that appear within the client, so when your app receives a payload with a signed URL (like when you [fetch a message](#DOCS_RESOURCES_CHANNEL/get-channel-message)), it will be valid.
371+
Attachments uploaded to Discord's CDN (like user and bot-uploaded images) have signed URLs with a preset expiry time. Discord automatically refreshes attachment CDN URLs that appear within the client, so when your app receives a payload with a signed URL (like when you [fetch a message](#DOCS_RESOURCES_MESSAGE/get-channel-message)), it will be valid.
372372

373-
When passing CDN URLs into API fields, like [`url` in an embed image object](#DOCS_RESOURCES_CHANNEL/embed-object-embed-image-structure) and [`avatar_url` for webhooks](#DOCS_RESOURCES_WEBHOOK/execute-webhook-jsonform-params), your app can pass the CDN URL without any parameters as the value and Discord will automatically render and refresh the URL.
373+
When passing CDN URLs into API fields, like [`url` in an embed image object](#DOCS_RESOURCES_MESSAGE/embed-object-embed-image-structure) and [`avatar_url` for webhooks](#DOCS_RESOURCES_WEBHOOK/execute-webhook-jsonform-params), your app can pass the CDN URL without any parameters as the value and Discord will automatically render and refresh the URL.
374374

375375
The [standard CDN endpoints](#DOCS_REFERENCE/image-formatting-cdn-endpoints) listed above are not signed, so they will not expire.
376376

docs/interactions/Application_Commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Application commands are native ways to interact with apps in the Discord client
8888
| ROLE | 8 | |
8989
| MENTIONABLE | 9 | Includes users and roles |
9090
| NUMBER | 10 | Any double between -2^53 and 2^53 |
91-
| ATTACHMENT | 11 | [attachment](#DOCS_RESOURCES_CHANNEL/attachment-object) object |
91+
| ATTACHMENT | 11 | [attachment](#DOCS_RESOURCES_MESSAGE/attachment-object) object |
9292

9393
###### Application Command Option Choice Structure
9494

docs/interactions/Message_Components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ There are several different types of components; this documentation will outline
66

77
## What is a Component
88

9-
Components are a field on the [message object](#DOCS_RESOURCES_CHANNEL/message-object), so you can use them whether you're sending messages or responding to a [slash command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/) or other interaction.
9+
Components are a field on the [message object](#DOCS_RESOURCES_MESSAGE/message-object), so you can use them whether you're sending messages or responding to a [slash command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/) or other interaction.
1010

1111
The top-level `components` field is an array of [Action Row](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/action-rows) components.
1212

0 commit comments

Comments
 (0)