Interface APIMessage

Hierarchy

  • APIMessage

Properties

application?: Partial<APIApplication>
application_id?: string

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

attachments: APIAttachment[]

Any attached files

See https://discord.com/developers/docs/resources/channel#attachment-object

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

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 property

See https://discord.com/developers/docs/resources/user#user-object

The call associated with the message

channel_id: string

ID of the channel the message was sent in

Sent if the message contains components like buttons, action rows, or other interactive components

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

content: string

Contents of the message

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

edited_timestamp: null | string

When this message was edited (or null if never)

embeds: APIEmbed[]

Any embedded content

See https://discord.com/developers/docs/resources/channel#embed-object

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

flags?: MessageFlags
id: string

ID of the message

interaction?: APIMessageInteraction

Sent if the message is a response to an Interaction

Deprecated

In favor of interaction_metadata

interaction_metadata?: APIMessageInteractionMetadata

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

Unstable

mention_channels?: APIChannelMention[]

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

Whether this message mentions everyone

mention_roles: string[]

Roles specifically mentioned in this message

See https://discord.com/developers/docs/topics/permissions#role-object

mentions: APIUser[]

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

message_reference?: APIMessageReference

Reference data sent with crossposted messages, replies, pins, and thread starter messages

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

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.)

nonce?: string | number

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

poll?: APIPoll

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

position?: number

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

reactions?: APIReaction[]
referenced_message?: null | APIMessage

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

Data for users, members, channels, and roles in the message's auto-populated select menus

See https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure

role_subscription_data?: APIMessageRoleSubscriptionData

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

sticker_items?: APIStickerItem[]
stickers?: APISticker[]

Deprecated

Use sticker_items instead

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

webhook_id?: string

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

Generated using TypeDoc