Skip to main content
Module

x/discord_api_types/v8.ts>APIMessage

Up to date Discord API Typings, versioned by the API version
Go to Latest
interface APIMessage
Re-export
Deprecated
Deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

import { type APIMessage } from "https://deno.land/x/discord_api_types@0.37.2/v8.ts";

Properties

ID of the message

channel_id: Snowflake

ID of the channel the message was sent in

optional
guild_id: Snowflake

ID of the guild the message was sent in

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

optional
member: APIGuildMember

Member properties for this message's author

The member object exists in MESSAGE_CREATE and MESSAGE_UPDATE events from text-based guild channels

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

content: string

Contents of the message

timestamp: string

When this message was sent

edited_timestamp: string | null

When this message was edited (or null if never)

tts: boolean

Whether this was a TTS message

mention_everyone: boolean

Whether this message mentions everyone

mentions: (APIUser & { member?: Omit<APIGuildMember, "user">; })[]

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

mention_roles: APIRole["id"][]

Roles specifically mentioned in this message

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

optional
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

optional
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

optional
webhook_id: Snowflake

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

optional
application: Partial<APIApplication>
optional
application_id: Snowflake

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

optional
message_reference: APIMessageReference

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

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

optional
referenced_message: APIMessage | null

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

optional
interaction: APIMessageInteraction

Sent if the message is a response to an Interaction

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

optional
sticker_items: APIStickerItem[]
optional
deprecated
stickers: APISticker[]