APIMessage
Index
Properties
- activity
- application
- application_id
- attachments
- author
- channel_id
- components
- content
- edited_timestamp
- embeds
- flags
- id
- interaction
- mention_channels
- mention_everyone
- mention_roles
- mentions
- message_reference
- message_snapshots
- nonce
- pinned
- poll
- position
- reactions
- referenced_message
- resolved
- sticker_items
- stickers
- thread
- timestamp
- tts
- type
- webhook_id
Properties
optionalactivity
Sent with Rich Presence-related chat embeds
optionalapplication
Sent with Rich Presence-related chat embeds
optionalapplication_id
If the message is a response to an Interaction, this is the id of the interaction’s application
attachments
Any attached files
See https://discord.com/developers/docs/resources/channel#attachment-object
The MESSAGE_CONTENT privileged gateway intent will become required after August 31, 2022 for verified applications to receive a non-empty value from this field
In the Discord Developers Portal, you need to enable the toggle of this intent of your application in Bot > Privileged Gateway Intents
See https://support-dev.discord.com/hc/articles/4404772028055
author
The author of this message (only a valid user in the case where the message is generated by a user or bot user)
If the message is generated by a webhook, the author object corresponds to the webhook’s id,
username, and avatar. You can tell if a message is generated by a webhook by checking for the webhook_id property
See https://discord.com/developers/docs/resources/user#user-object
channel_id
ID of the channel the message was sent in
optionalcomponents
Sent if the message contains components like buttons, action rows, or other interactive components
The MESSAGE_CONTENT privileged gateway intent will become required after August 31, 2022 for verified applications to receive a non-empty value from this field
In the Discord Developers Portal, you need to enable the toggle of this intent of your application in Bot > Privileged Gateway Intents
See https://support-dev.discord.com/hc/articles/4404772028055
content
Contents of the message
The MESSAGE_CONTENT privileged gateway intent will become required after August 31, 2022 for verified applications to receive a non-empty value from this field
In the Discord Developers Portal, you need to enable the toggle of this intent of your application in Bot > Privileged Gateway Intents
See https://support-dev.discord.com/hc/articles/4404772028055
edited_timestamp
When this message was edited (or null if never)
embeds
Any embedded content
See https://discord.com/developers/docs/resources/channel#embed-object
The MESSAGE_CONTENT privileged gateway intent will become required after August 31, 2022 for verified applications to receive a non-empty value from this field
In the Discord Developers Portal, you need to enable the toggle of this intent of your application in Bot > Privileged Gateway Intents
See https://support-dev.discord.com/hc/articles/4404772028055
optionalflags
Message flags combined as a bitfield
id
ID of the message
optionalinteraction
Sent if the message is a response to an Interaction
optionalmention_channels
Channels specifically mentioned in this message
Not all channel mentions in a message will appear in mention_channels.
- Only textual channels that are visible to everyone in a lurkable guild will ever be included
- Only crossposted messages (via Channel Following) currently include
mention_channelsat all
If no mentions in the message meet these requirements, this field will not be sent
See https://discord.com/developers/docs/resources/channel#channel-mention-object
mention_everyone
Whether this message mentions everyone
mention_roles
Roles specifically mentioned in this message
mentions
Users specifically mentioned in the message
The member field is only present in MESSAGE_CREATE and MESSAGE_UPDATE events
from text-based guild channels
See https://discord.com/developers/docs/resources/user#user-object See https://discord.com/developers/docs/resources/guild#guild-member-object
optionalmessage_reference
Reference data sent with crossposted messages, replies, pins, and thread starter messages
optionalmessage_snapshots
The message associated with the message_reference. This is a minimal subset of fields in a message (e.g. author is excluded.)
optionalnonce
A nonce that can be used for optimistic message sending (up to 25 characters)
You will not receive this from further fetches. This is received only once from a MESSAGE_CREATE
event to ensure it got sent
pinned
Whether this message is pinned
optionalpoll
A poll!
The MESSAGE_CONTENT privileged gateway intent is required for verified applications to receive a non-empty value from this field
In the Discord Developers Portal, you need to enable the toggle of this intent of your application in Bot > Privileged Gateway Intents.
You also need to specify the intent bit value (1 << 15) if you are connecting to the gateway
See https://support-dev.discord.com/hc/articles/4404772028055
optionalposition
A generally increasing integer (there may be gaps or duplicates) that represents the approximate position of the message in a thread
It can be used to estimate the relative position of the message in a thread in company with total_message_sent on parent thread
optionalreactions
Reactions to the message
optionalreferenced_message
The message associated with the message_reference
This field is only returned for messages with a type of 19 (REPLY).
If the message is a reply but the referenced_message field is not present,
the backend did not attempt to fetch the message that was being replied to,
so its state is unknown.
If the field exists but is null, the referenced message was deleted
See https://discord.com/developers/docs/resources/channel#message-object
optionalresolved
Data for users, members, channels, and roles in the message’s auto-populated select menus
optionalsticker_items
Sent if the message contains stickers
optionalstickers
The stickers sent with the message
optionalthread
Sent if a thread was started from this message
timestamp
When this message was sent
tts
Whether this was a TTS message
type
optionalwebhook_id
If the message is generated by a webhook, this is the webhook’s id
https://discord.com/developers/docs/resources/channel#message-object-message-structure