Back to Autogpt

Discord Bot Blocks

docs/integrations/block-integrations/discord/bot_blocks.md

0.6.4412.8 KB
Original Source

Discord Bot Blocks

<!-- MANUAL: file_description -->

Blocks for interacting with Discord using bot tokens, including sending messages, managing threads, and reading channel data.

<!-- END MANUAL -->

Create Discord Thread

What it is

Creates a new thread in a Discord channel.

How it works

<!-- MANUAL: how_it_works -->

This block uses the Discord API with a bot token to create a new thread in a specified channel. Threads can be public or private (private requires Boost Level 2+).

Configure auto-archive duration and optionally send an initial message when the thread is created.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
channel_nameChannel ID or channel name to create the thread instrYes
server_nameServer name (only needed if using channel name)strNo
thread_nameThe name of the thread to createstrYes
is_privateWhether to create a private thread (requires Boost Level 2+) or public threadboolNo
auto_archive_durationDuration before the thread is automatically archived"60" | "1440" | "4320" | "10080"No
message_contentOptional initial message to send in the threadstrNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
statusOperation statusstr
thread_idID of the created threadstr
thread_nameName of the created threadstr

Possible use case

<!-- MANUAL: use_case -->

Support Tickets: Create threads for individual support conversations to keep channels organized.

Discussion Topics: Automatically create threads for new topics or announcements.

Project Channels: Spin up discussion threads for specific tasks or features.

<!-- END MANUAL -->

Discord Channel Info

What it is

Resolves Discord channel names to IDs and vice versa.

How it works

<!-- MANUAL: how_it_works -->

This block resolves Discord channel identifiers, converting between channel names and IDs. It queries the Discord API to find the channel and returns comprehensive information including server details.

Useful for workflows that receive channel names but need IDs for other Discord operations.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
channel_identifierChannel name or channel ID to look upstrYes
server_nameServer name (optional, helps narrow down search)strNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
channel_idThe channel's IDstr
channel_nameThe channel's namestr
server_idThe server's IDstr
server_nameThe server's namestr
channel_typeType of channel (text, voice, etc)str

Possible use case

<!-- MANUAL: use_case -->

Dynamic Routing: Look up channel IDs to route messages to user-specified channels by name.

Validation: Verify channel existence before attempting to send messages.

Workflow Setup: Get channel details during workflow configuration.

<!-- END MANUAL -->

Discord User Info

What it is

Gets information about a Discord user by their ID.

How it works

<!-- MANUAL: how_it_works -->

This block retrieves information about a Discord user by their ID. It queries the Discord API and returns profile details including username, display name, avatar, and account creation date.

The user must be visible to your bot (share a server with your bot).

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
user_idThe Discord user ID to get information aboutstrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
user_idThe user's ID (passed through for chaining)str
usernameThe user's usernamestr
display_nameThe user's display namestr
discriminatorThe user's discriminator (if applicable)str
avatar_urlURL to the user's avatarstr
is_botWhether the user is a botbool
created_atWhen the account was createdstr

Possible use case

<!-- MANUAL: use_case -->

User Profiling: Get user details to personalize responses or create user profiles.

Mention Resolution: Look up user information when processing mentions in messages.

Activity Logging: Retrieve user details for logging or analytics purposes.

<!-- END MANUAL -->

Read Discord Messages

What it is

Reads messages from a Discord channel using a bot token.

How it works

<!-- MANUAL: how_it_works -->

The block uses a Discord bot to log into a server and listen for new messages. When a message is received, it extracts the content, channel name, and username of the sender. If the message contains a text file attachment, the block also retrieves and includes the file's content.

<!-- END MANUAL -->

Outputs

OutputDescriptionType
errorError message if the operation failedstr
message_contentThe content of the message receivedstr
message_idThe ID of the messagestr
channel_idThe ID of the channelstr
channel_nameThe name of the channel the message was received fromstr
user_idThe ID of the user who sent the messagestr
usernameThe username of the user who sent the messagestr

Possible use case

<!-- MANUAL: use_case -->

This block could be used to monitor a Discord channel for support requests. When a user posts a message, the block captures it, allowing another part of the system to process and respond to the request.

<!-- END MANUAL -->

Reply To Discord Message

What it is

Replies to a specific Discord message.

How it works

<!-- MANUAL: how_it_works -->

This block sends a reply to a specific Discord message, creating a threaded reply that references the original message. Optionally mention the original author to notify them.

The reply appears linked to the original message in Discord's UI, maintaining conversation context.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
channel_idThe channel ID where the message to reply to is locatedstrYes
message_idThe ID of the message to reply tostrYes
reply_contentThe content of the replystrYes
mention_authorWhether to mention the original message authorboolNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
statusOperation statusstr
reply_idID of the reply messagestr

Possible use case

<!-- MANUAL: use_case -->

Conversation Bots: Reply to user questions maintaining conversation context.

Support Responses: Respond to support requests by replying to the original message.

Interactive Commands: Reply to command messages with results or confirmations.

<!-- END MANUAL -->

Send Discord DM

What it is

Sends a direct message to a Discord user using their user ID.

How it works

<!-- MANUAL: how_it_works -->

This block sends a direct message to a Discord user. It opens a DM channel with the user (if not already open) and sends the message. The user must allow DMs from server members or share a server with your bot.

Returns the message ID of the sent DM for tracking purposes.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
user_idThe Discord user ID to send the DM to (e.g., '123456789012345678')strYes
message_contentThe content of the direct message to sendstrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
statusThe status of the operationstr
message_idThe ID of the sent messagestr

Possible use case

<!-- MANUAL: use_case -->

Private Notifications: Send private alerts or notifications to specific users.

Welcome Messages: DM new server members with welcome information.

Verification Systems: Send verification codes or instructions via DM.

<!-- END MANUAL -->

Send Discord Embed

What it is

Sends a rich embed message to a Discord channel.

How it works

<!-- MANUAL: how_it_works -->

This block sends a rich embed message to a Discord channel. Embeds support formatted content with titles, descriptions, colors, images, thumbnails, author sections, footers, and structured fields.

Configure the embed's appearance with colors, images, and multiple fields for organized information display.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
channel_identifierChannel ID or channel name to send the embed tostrYes
server_nameServer name (only needed if using channel name)strNo
titleThe title of the embedstrNo
descriptionThe main content/description of the embedstrNo
colorEmbed color as integer (e.g., 0x00ff00 for green)intNo
thumbnail_urlURL for the thumbnail imagestrNo
image_urlURL for the main embed imagestrNo
author_nameAuthor name to displaystrNo
footer_textFooter textstrNo
fieldsList of field dictionaries with 'name', 'value', and optional 'inline' keysList[Dict[str, Any]]No

Outputs

OutputDescriptionType
errorError message if the operation failedstr
statusOperation statusstr
message_idID of the sent embed messagestr

Possible use case

<!-- MANUAL: use_case -->

Status Updates: Send formatted status updates with colors and structured information.

Data Displays: Present data in organized embed fields for easy reading.

Announcements: Create visually appealing announcements with images and branding.

<!-- END MANUAL -->

Send Discord File

What it is

Sends a file attachment to a Discord channel.

How it works

<!-- MANUAL: how_it_works -->

This block uploads and sends a file attachment to a Discord channel. It supports various file types including images, documents, and other media. Files can be provided as URLs, data URIs, or local paths.

Optionally include a message along with the file attachment.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
channel_identifierChannel ID or channel name to send the file tostrYes
server_nameServer name (only needed if using channel name)strNo
fileThe file to send (URL, data URI, or local path). Supports images, videos, documents, etc.str (file)Yes
filenameName of the file when sent (e.g., 'report.pdf', 'image.png')strNo
message_contentOptional message to send with the filestrNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
statusOperation statusstr
message_idID of the sent messagestr

Possible use case

<!-- MANUAL: use_case -->

Report Sharing: Send generated reports or documents to Discord channels.

Image Posting: Share images from workflows or external sources.

Backup Distribution: Share backup files or exports with team channels.

<!-- END MANUAL -->

Send Discord Message

What it is

Sends a message to a Discord channel using a bot token.

How it works

<!-- MANUAL: how_it_works -->

The block uses a Discord bot to log into a server, locate the specified channel, and send the provided message. If the message is longer than Discord's character limit, it automatically splits the message into smaller chunks and sends them sequentially.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
message_contentThe content of the message to sendstrYes
channel_nameChannel ID or channel name to send the message tostrYes
server_nameServer name (only needed if using channel name)strNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
statusThe status of the operation (e.g., 'Message sent', 'Error')str
message_idThe ID of the sent messagestr
channel_idThe ID of the channel where the message was sentstr

Possible use case

<!-- MANUAL: use_case -->

This block could be used as part of an automated notification system. For example, it could send alerts to a Discord channel when certain events occur in another system, such as when a new user signs up or when a critical error is detected.

<!-- END MANUAL -->