Preview environment

interface APIMessage

export interface APIMessage

https://discord.com/developers/docs/resources/channel#message-object-message-structure

optional
activity? : APIMessageActivity

Sent with Rich Presence-related chat embedsSee https://discord.com/developers/docs/resources/channel#message-object-message-activity-structure

optional
application_id? : Snowflake

If the message is a response to an Interaction, this is the id of the interaction's application

optional
application? : Partial<APIApplication>

Sent with Rich Presence-related chat embedsSee https://discord.com/developers/docs/resources/application#application-object

attachments : APIAttachment[]

Any attached filesSee https://discord.com/developers/docs/resources/message#attachment-object-attachment-structureThe MESSAGE_CONTENT privileged gateway intent is required for verified applications to receive a non-empty value from this fieldIn 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 gatewaySee https://support-dev.discord.com/hc/articles/4404772028055

author : APIUser

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 propertySee https://discord.com/developers/docs/resources/user#user-object

optional
call? : APIMessageCall

The call associated with the message

channel_id : Snowflake

ID of the channel the message was sent in

Sent if the message contains components like buttons, action rows, or other interactive componentsThe MESSAGE_CONTENT privileged gateway intent is required for verified applications to receive a non-empty value from this fieldIn 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 gatewaySee https://support-dev.discord.com/hc/articles/4404772028055

content : string

Contents of the messageThe MESSAGE_CONTENT privileged gateway intent is required for verified applications to receive a non-empty value from this fieldIn 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 gatewaySee https://support-dev.discord.com/hc/articles/4404772028055

edited_timestamp : string | null

When this message was edited (or null if never)

embeds : APIEmbed[]

Any embedded contentSee https://discord.com/developers/docs/resources/channel#embed-objectThe MESSAGE_CONTENT privileged gateway intent is required for verified applications to receive a non-empty value from this fieldIn 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 gatewaySee https://support-dev.discord.com/hc/articles/4404772028055

optional
flags? : MessageFlags

Message flags combined as a bitfieldSee https://discord.com/developers/docs/resources/channel#message-object-message-flagsSee https://en.wikipedia.org/wiki/Bit_field

ID of the message

optional
interaction_metadata? : APIMessageInteractionMetadata

Sent if the message is sent as a result of an interaction

deprecatedoptional
interaction? : APIMessageInteraction

Sent if the message is a response to an Interaction

optional
mention_channels? : APIChannelMention[]

Channels specifically mentioned in this messageNot 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_channels at allIf no mentions in the message meet these requirements, this field will not be sentSee https://discord.com/developers/docs/resources/channel#channel-mention-object

mention_everyone : boolean

Whether this message mentions everyone

mention_roles : APIRole['id'][]

Roles specifically mentioned in this messageSee https://discord.com/developers/docs/topics/permissions#role-object

mentions : APIUser[]

Users specifically mentioned in the messageThe member field is only present in MESSAGE_CREATE and MESSAGE_UPDATE events from text-based guild channelsSee https://discord.com/developers/docs/resources/user#user-object See https://discord.com/developers/docs/resources/guild#guild-member-object

optional
message_reference? : APIMessageReference

Reference data sent with crossposted messages, replies, pins, and thread starter messagesSee https://discord.com/developers/docs/resources/channel#message-reference-object-message-reference-structure

optional
message_snapshots? : APIMessageSnapshot[]

The message associated with the message_reference. This is a minimal subset of fields in a message (e.g. author is excluded.)

optional
nonce? : number | string

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 : boolean

Whether this message is pinned

optional
poll? : APIPoll

A poll!The MESSAGE_CONTENT privileged gateway intent is required for verified applications to receive a non-empty value from this fieldIn 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 gatewaySee https://support-dev.discord.com/hc/articles/4404772028055

optional
position? : number

A generally increasing integer (there may be gaps or duplicates) that represents the approximate position of the message in a threadIt can be used to estimate the relative position of the message in a thread in company with total_message_sent on parent thread

optional
reactions? : APIReaction[]

Reactions to the messageSee https://discord.com/developers/docs/resources/channel#reaction-object

optional
referenced_message? : APIMessage | null

The message associated with the message_referenceThis 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 deletedSee https://discord.com/developers/docs/resources/channel#message-object

optional
resolved? : APIInteractionDataResolved

Data for users, members, channels, and roles in the message's auto-populated select menusSee https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure

optional
role_subscription_data? : APIMessageRoleSubscriptionData

Data of the role subscription purchase or renewal that prompted this ROLE_SUBSCRIPTION_PURCHASE message

optional
sticker_items? : APIStickerItem[]

Sent if the message contains stickersSee https://discord.com/developers/docs/resources/sticker#sticker-item-object

deprecatedoptional
stickers? : APISticker[]

The stickers sent with the messageSee https://discord.com/developers/docs/resources/sticker#sticker-object

optional
thread? : APIChannel

Sent if a thread was started from this message

timestamp : string

When this message was sent

tts : boolean

Whether this was a TTS message

Type of messageSee https://discord.com/developers/docs/resources/channel#message-object-message-types

optional
webhook_id? : Snowflake

If the message is generated by a webhook, this is the webhook's id