Interface CreateMessageOptions

interface CreateMessageOptions {
    allowedMentions?: AllowedMentions;
    attachments?: MessageAttachment[];
    components?: MessageComponent[];
    content?: string;
    embeds?: EmbedOptions[];
    enforceNonce?: boolean;
    files?: File[];
    flags?: number;
    messageReference?: MessageReference;
    nonce?: string | number;
    poll?: MessagePollOptions;
    stickerIDs?: string[];
    tts?: boolean;
}

Properties

allowedMentions? attachments? components? content? embeds? enforceNonce? files? flags? messageReference? nonce? poll? stickerIDs? tts?

Properties

Optional allowedMentions

allowedMentions?: AllowedMentions

An object that specifies the allowed mentions in this message.

Optional attachments

attachments?: MessageAttachment[]

An array of partial attachments related to the sent files.

Optional components

components?: MessageComponent[]

An array of components to send. snake_case keys should be converted to camelCase, or passed through Util#rawMessageComponents. Note that the Contents~MessageFlags.IS_COMPONENTS_V2 | IS_COMPONENTS_V2 flag must be provided to use any of the v2 components, and with this enabled content, embeds, and stickerIDs cannot be used.

Optional content

content?: string

The content of the message.

Optional embeds

embeds?: EmbedOptions[]

An array of embeds to send. snake_case keys should be converted to camelCase, or passed through Util#rawEmbeds.

Optional enforceNonce

enforceNonce?: boolean

If Discord should enforce the unique nonce. This prevents duplicate messages being sent within a few minutes.

Optional files

files?: File[]

The files to send.

Optional flags

flags?: number

The Message Flags to send with the message.

Optional messageReference

messageReference?: MessageReference

Reply to a message.

Optional nonce

nonce?: string | number

A unique number or string used to dedupe this message. enforceNonce must be set to true for Discord to dedupe message sends.

Optional poll

poll?: MessagePollOptions

A poll to send. Messages with a poll cannot be edited.

Note

As of 4/18/24, attachments cannot be sent with polls.

Optional stickerIDs

stickerIDs?: string[]

The IDs of up to 3 stickers from the current guild to send.

Optional tts

tts?: boolean

If the message should be spoken aloud.

Settings

Member Visibility

Theme

On This Page

allowedMentionsattachmentscomponentscontentembedsenforceNoncefilesflagsmessageReferencenoncepollstickerIDstts