Discord Bot
Visão geral
Seção intitulada “Visão geral”Discord Bot refere-se a programas automatizados em servidores do Discord, capazes de realizar tarefas como moderação, reprodução de música, gerenciamento de membros e engajamento de comunidade. Com a integração no SquadOS, seus agentes podem enviar e editar mensagens em canais, gerenciar membros e papéis, criar canais e eventos, moderar conteúdo, acionar webhooks e muito mais — tudo de forma programática e em tempo real.
- Site oficial: https://discord.com/
- Documentação na Composio: docs.composio.dev/toolkits/discordbot
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.
Você vai precisar autorizar o acesso via conta Discord. A Composio gerencia o fluxo OAuth — você é redirecionado para a tela de autorização do Discord e, ao concluir, retorna conectado.
| Campo | Obrigatório | Descrição |
|---|---|---|
| N/A | N/A | O acesso é autorizado via OAuth 2.0 pelo Discord; não há campos manuais. |
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Discord Bot. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0 com sua conta Discord.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Enviar mensagem para canal
Seção intitulada “Enviar mensagem para canal”DISCORDBOT_CREATE_MESSAGE
Envia uma mensagem para um canal do Discord. Suporta conteúdo de texto, embeds, figurinhas, componentes interativos e respostas. Requer permissão SEND_MESSAGES e ao menos um entre content, embeds, sticker_ids ou components.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal para o qual enviar a mensagem. |
content | string | Não | Conteúdo de texto da mensagem (máx. 2000 caracteres). Obrigatório se embeds, sticker_ids e components estiverem vazios. |
embeds | array | Não | Até 10 objetos embed com título, descrição, url, timestamp, cor, rodapé, imagem, thumbnail, vídeo, autor e campos. |
tts | boolean | Não | Se a mensagem deve ser enviada como texto-para-voz. |
flags | integer | Não | Flags de mensagem (ex: 4 para SUPPRESS_EMBEDS, 64 para EPHEMERAL). |
components | array | Não | Até 5 linhas de componentes interativos (botões, menus de seleção). |
sticker_ids | array | Não | Até 3 IDs de figurinhas acessíveis ao bot. |
allowed_mentions | object | Não | Controla quais menções no conteúdo disparam notificações. |
message_reference | object | Não | Referência para responder a uma mensagem. Requer message_id. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar mensagens do canal
Seção intitulada “Buscar mensagens do canal”DISCORDBOT_LIST_MESSAGES
Recupera mensagens de um canal do Discord, ordenadas da mais recente para a mais antiga. Suporta paginação via parâmetros before/after/around.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal do Discord do qual buscar mensagens. |
limit | integer | Não | Número máximo de mensagens a retornar (1–100, padrão 50). |
before | string | Não | Obtém mensagens anteriores a este ID de mensagem (paginação retroativa). |
after | string | Não | Obtém mensagens posteriores a este ID de mensagem (paginação avançada). |
around | string | Não | Obtém mensagens ao redor deste ID de mensagem. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter mensagem
Seção intitulada “Obter mensagem”DISCORDBOT_GET_MESSAGE
Recupera uma mensagem específica de um canal do Discord pelo ID do canal e ID da mensagem.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal do Discord que contém a mensagem. |
message_id | string | Sim | ID da mensagem a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Editar mensagem
Seção intitulada “Editar mensagem”DISCORDBOT_UPDATE_MESSAGE
Edita uma mensagem enviada anteriormente pelo bot. Informe apenas os campos que deseja alterar; use null ou lista vazia para limpar valores.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal que contém a mensagem a editar. |
message_id | string | Sim | ID da mensagem a editar. Deve ser uma mensagem enviada pelo bot. |
content | string | Não | Novo conteúdo da mensagem (máx. 2000 caracteres). Use string vazia para limpar. |
embeds | array | Não | Até 10 objetos embed. Use lista vazia para remover todos os embeds. |
flags | integer | Não | Flags de mensagem a definir (ex: 4 para SUPPRESS_EMBEDS). |
components | array | Não | Componentes de mensagem (botões, menus de seleção). Use lista vazia para remover. |
attachments | array | Não | Anexos a manter ou atualizar metadados. Omita para manter os existentes; lista vazia remove todos. |
allowed_mentions | object | Não | Controla quais menções disparam notificações. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir mensagem
Seção intitulada “Excluir mensagem”DISCORDBOT_DELETE_MESSAGE
Exclui permanentemente uma mensagem de um canal do Discord. O bot pode excluir suas próprias mensagens ou, com permissão MANAGE_MESSAGES, excluir mensagens de outros usuários.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal que contém a mensagem a excluir. |
message_id | string | Sim | ID da mensagem a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir mensagens em lote
Seção intitulada “Excluir mensagens em lote”DISCORDBOT_BULK_DELETE_MESSAGES
Exclui mensagens em lote em um canal do Discord. Requer permissão MANAGE_MESSAGES. As mensagens devem ter menos de 14 dias. É possível excluir entre 2 e 100 mensagens de uma vez.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal do qual excluir mensagens em lote. |
messages | array | Sim | Lista de IDs de mensagens a excluir (2–100). Todas devem ter menos de 14 dias. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Fixar mensagem
Seção intitulada “Fixar mensagem”DISCORDBOT_PIN_MESSAGE
Fixa uma mensagem em um canal do Discord. Requer permissão MANAGE_MESSAGES. Um canal pode ter no máximo 50 mensagens fixadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal que contém a mensagem a fixar. |
message_id | string | Sim | ID da mensagem a fixar. O canal não pode exceder 50 mensagens fixadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Desafixar mensagem
Seção intitulada “Desafixar mensagem”DISCORDBOT_UNPIN_MESSAGE
Remove a fixação de uma mensagem em um canal do Discord. A mensagem não é excluída, apenas removida da lista de fixadas. Requer permissão MANAGE_MESSAGES.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal que contém a mensagem fixada. |
message_id | string | Sim | ID da mensagem a desafixar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar reação a mensagem
Seção intitulada “Adicionar reação a mensagem”DISCORDBOT_ADD_MY_MESSAGE_REACTION
Adiciona uma reação de emoji do bot a uma mensagem. Requer READ_MESSAGE_HISTORY e ADD_REACTIONS caso nenhum outro usuário tenha reagido com este emoji antes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal que contém a mensagem. |
message_id | string | Sim | ID da mensagem à qual reagir. |
emoji | string | Sim | Emoji para reagir. Para emojis Unicode use o caractere diretamente (ex: ’👍’). Para emojis customizados use o formato ‘nome:id’ (ex: ‘meuemoji:123456789012345678’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Disparar indicador de digitação
Seção intitulada “Disparar indicador de digitação”DISCORDBOT_TRIGGER_TYPING_INDICATOR
Exibe o indicador de digitação do bot em um canal do Discord. O indicador para após 10 segundos ou ao enviar uma mensagem. Use quando estiver preparando uma resposta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | Identificador único do canal do Discord onde o indicador de digitação deve ser exibido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar canal no servidor
Seção intitulada “Criar canal no servidor”DISCORDBOT_CREATE_GUILD_CHANNEL
Cria um novo canal do Discord (texto, voz, categoria, etc.) dentro de um servidor. Requer permissão MANAGE_CHANNELS.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | ID do servidor onde o canal será criado. |
name | string | Sim | Nome do canal (1–100 caracteres). |
type | integer | Não | Tipo do canal (0: GUILD_TEXT, 2: GUILD_VOICE, 4: GUILD_CATEGORY, 5: GUILD_ANNOUNCEMENT, 13: GUILD_STAGE_VOICE, 15: GUILD_FORUM). |
topic | string | Não | Tópico do canal (0–1024 caracteres para texto; 0–4096 para fórum/mídia). |
parent_id | string | Não | ID da categoria pai para este canal. |
position | integer | Não | Posição de ordenação do canal. |
nsfw | boolean | Não | Se o canal possui restrição de idade. |
rate_limit_per_user | integer | Não | Modo lento: segundos que um usuário deve aguardar antes de enviar outra mensagem (0–21600). |
permission_overwrites | array | Não | Objetos de substituição de permissão para o canal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes do canal
Seção intitulada “Obter detalhes do canal”DISCORDBOT_GET_CHANNEL
Recupera metadados detalhados de um canal específico do Discord pelo seu channel_id. Retorna apenas metadados do canal, não conteúdo de mensagens nem listas de membros.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal do Discord a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar thread em canal
Seção intitulada “Criar thread em canal”DISCORDBOT_CREATE_THREAD
Cria uma nova thread em um canal de texto, anúncio, fórum ou mídia.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal no qual a thread será criada. |
name | string | Sim | Nome da thread (1–100 caracteres). |
type | integer | Não | Tipo de thread a criar: 10 para anúncio, 11 para pública, 12 para privada. |
message | object | Não | Mensagem inicial a enviar na thread. Obrigatória para canais de fórum e mídia. |
auto_archive_duration | integer | Não | Duração em minutos para arquivar automaticamente a thread após inatividade. Valores: 60, 1440, 4320, 10080. |
rate_limit_per_user | integer | Não | Segundos que um usuário deve aguardar antes de enviar outra mensagem na thread (0–21600). |
invitable | boolean | Não | Se não moderadores podem adicionar outros não moderadores à thread. Apenas para threads privadas. |
applied_tags | array | Não | Array de IDs de tags a aplicar à thread. Apenas para canais de fórum e mídia. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar webhook no canal
Seção intitulada “Criar webhook no canal”DISCORDBOT_CREATE_WEBHOOK
Cria um novo webhook em um canal específico do Discord. Requer permissão MANAGE_WEBHOOKS.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal no qual criar o webhook. |
name | string | Sim | Nome do webhook (1–80 caracteres). |
avatar | string | Não | URI de imagem codificada em base64 para o avatar do webhook (ex: ‘data:image/png;base64,…’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Executar webhook
Seção intitulada “Executar webhook”DISCORDBOT_EXECUTE_WEBHOOK
Executa um webhook do Discord para enviar mensagens, embeds ou componentes interativos para um canal ou thread.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
webhook_id | string | Sim | ID único do webhook do Discord. |
webhook_token | string | Sim | Token secreto do webhook do Discord. |
content | string | Não | Conteúdo de texto da mensagem (máx. 2000 caracteres). |
embeds | array | Não | Até 10 objetos embed para conteúdo rico. |
username | string | Não | Substituir o nome de usuário padrão do webhook (máx. 80 caracteres). |
avatar_url | string | Não | Substituir o avatar padrão do webhook por uma URL de imagem. |
tts | boolean | Não | Enviar como mensagem de texto-para-voz. |
components | array | Não | Componentes de mensagem (botões, menus de seleção), até 5 linhas de ação. |
thread_id | string | Não | ID de uma thread no canal do webhook para enviar a mensagem. |
thread_name | string | Não | Nome de uma thread a criar ao executar em canal de fórum (máx. 100 caracteres). |
wait | boolean | Não | Se verdadeiro, aguarda confirmação do servidor e retorna objeto de mensagem. Padrão: verdadeiro. |
flags | integer | Não | Bitfield de flags de mensagem (ex: 4 para SUPPRESS_EMBEDS). |
allowed_mentions | object | Não | Controla quais menções de fato notificam os destinatários. |
applied_tags | array | Não | Array de IDs de tags a aplicar a uma thread de fórum (funciona apenas com thread_name). |
poll | object | Não | Objeto de enquete para anexar à mensagem. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes do servidor
Seção intitulada “Obter detalhes do servidor”DISCORDBOT_GET_GUILD
Recupera informações detalhadas de um servidor Discord especificado pelo seu guild_id, incluindo opcionalmente contagens aproximadas de membros e presenças.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único (snowflake ID) do servidor Discord a recuperar. |
with_counts | boolean | Não | Quando verdadeiro, inclui contagens aproximadas de membros e presenças do servidor. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar membro ao servidor
Seção intitulada “Adicionar membro ao servidor”DISCORDBOT_ADD_GUILD_MEMBER
Adiciona um usuário a um servidor do Discord usando seu token de acesso OAuth2 (que deve ter o escopo guilds.join). Retorna o objeto de membro do servidor em 201 Created, ou indica que o usuário já é membro em 204.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único (snowflake ID) do servidor ao qual adicionar o usuário. |
user_id | string | Sim | Identificador único (snowflake ID) do usuário a adicionar. |
access_token | string | Sim | Token de acesso OAuth2 do usuário com escopo guilds.join. |
nick | string | Não | Apelido a definir para o usuário neste servidor. Máximo 32 caracteres. |
roles | array | Não | Lista de IDs de papéis a atribuir ao usuário ao entrar. |
mute | boolean | Não | Se o usuário deve ser silenciado no servidor nos canais de voz. |
deaf | boolean | Não | Se o usuário deve ser ensurdecido no servidor nos canais de voz. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar membros do servidor
Seção intitulada “Listar membros do servidor”DISCORDBOT_LIST_GUILD_MEMBERS
Recupera uma lista de membros de um servidor do Discord. Requer intent GUILD_MEMBERS. Suporta paginação via parâmetros limit e after.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único (snowflake ID) do servidor Discord do qual recuperar membros. |
limit | integer | Não | Número máximo de membros a retornar (1–1000). Padrão: 1. |
after | string | Não | ID de usuário para deslocamento de paginação; busca membros com IDs maiores que este valor. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar membros por nome
Seção intitulada “Pesquisar membros por nome”DISCORDBOT_SEARCH_GUILD_MEMBERS
Pesquisa membros em um servidor Discord específico correspondendo uma string de consulta a nomes de usuário e apelidos. Retorna objetos de membro correspondentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único (snowflake ID) do servidor Discord a pesquisar. |
query | string | Sim | String de consulta a corresponder com nomes de usuário ou apelidos. A busca é baseada em prefixo (ex: ‘adm’ corresponde a ‘admin’). |
limit | integer | Não | Número máximo de membros a retornar (1–1000). Padrão: 1. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Banir usuário do servidor
Seção intitulada “Banir usuário do servidor”DISCORDBOT_BAN_USER_FROM_GUILD
Bane permanentemente um usuário de um servidor Discord, opcionalmente excluindo suas mensagens recentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | ID do servidor do qual banir o usuário. |
user_id | string | Sim | ID do usuário a banir. |
delete_message_seconds | integer | Não | Número de segundos (0–604800) de mensagens passadas do usuário a excluir. Padrão: 0. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Remover banimento de usuário
Seção intitulada “Remover banimento de usuário”DISCORDBOT_UNBAN_USER_FROM_GUILD
Revoga o banimento de um usuário de um servidor Discord, permitindo que ele entre novamente. Requer permissão BAN_MEMBERS.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | ID do servidor do qual remover o banimento. |
user_id | string | Sim | ID do usuário a desbanir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atribuir papel a membro
Seção intitulada “Atribuir papel a membro”DISCORDBOT_ADD_GUILD_MEMBER_ROLE
Atribui um papel a um membro do servidor. Requer permissão MANAGE_ROLES e o papel deve ser inferior na hierarquia ao papel mais alto do bot. Retorna 204 em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único (snowflake ID) do servidor Discord onde o membro e o papel existem. |
user_id | string | Sim | Identificador único (snowflake ID) do usuário Discord ao qual o papel será atribuído. |
role_id | string | Sim | Identificador único (snowflake ID) do papel Discord a ser atribuído ao membro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar papel no servidor
Seção intitulada “Criar papel no servidor”DISCORDBOT_CREATE_GUILD_ROLE
Cria um novo papel em um servidor Discord com nome, permissões, cor, hoist, mencionabilidade e ícone personalizáveis. Requer permissão MANAGE_ROLES. Os campos icon e unicode_emoji são mutuamente exclusivos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único (snowflake ID) do servidor Discord onde o papel será criado. |
name | string | Não | Nome do novo papel. Se omitido, o Discord usa ‘new role’ como padrão. |
color | integer | Não | Valor RGB da cor do papel como inteiro (ex: vermelho é 16711680). Padrão: 0 (sem cor). |
hoist | boolean | Não | Se verdadeiro, exibe o papel separadamente na lista de membros. Padrão: falso. |
mentionable | boolean | Não | Se verdadeiro, este papel pode ser mencionado por outros. Padrão: falso. |
permissions | string | Não | Inteiro bit a bit para permissões do papel combinadas de flags de permissão do Discord. |
icon | string | Não | Hash de uma imagem customizada para o ícone do papel. Mutuamente exclusivo com unicode_emoji. |
unicode_emoji | string | Não | Emoji Unicode padrão para o ícone do papel. Mutuamente exclusivo com icon. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar convite para canal
Seção intitulada “Criar convite para canal”DISCORDBOT_CREATE_CHANNEL_INVITE
Cria um novo link de convite para um canal do Discord. Requer permissão CREATE_INSTANT_INVITE.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_id | string | Sim | ID do canal para o qual criar um convite. |
max_age | integer | Não | Duração do convite em segundos antes de expirar, ou 0 para nunca. Deve ser 0–604800. Padrão: 86400 (24 horas). |
max_uses | integer | Não | Número máximo de vezes que este convite pode ser usado, ou 0 para ilimitado. Padrão: 0. |
temporary | boolean | Não | Se este convite concede apenas associação temporária. Padrão: falso. |
unique | boolean | Não | Se verdadeiro, não reutiliza um convite similar. Útil para criar muitos convites únicos de uso único. |
target_type | integer | Não | Tipo de destino para convite de canal de voz: 1 para Stream, 2 para Aplicação Incorporada. |
target_user_id | string | Não | ID do usuário cuja transmissão exibir. Obrigatório se target_type for 1. |
target_application_id | string | Não | ID da aplicação incorporada a abrir. Obrigatório se target_type for 2. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar evento agendado no servidor
Seção intitulada “Criar evento agendado no servidor”DISCORDBOT_CREATE_GUILD_SCHEDULED_EVENT
Cria um novo evento agendado em um servidor Discord. Eventos podem ser hospedados em canais de palco, canais de voz ou locais externos. STAGE_INSTANCE/VOICE requerem channel_id, enquanto EXTERNAL requer entity_metadata com localização e scheduled_end_time.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único (snowflake ID) do servidor Discord onde o evento será criado. |
name | string | Sim | Nome do evento agendado (1–100 caracteres). |
entity_type | integer | Sim | Tipo de entidade: 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL. |
scheduled_start_time | string | Sim | Hora de início do evento (timestamp ISO8601, ex: ‘2024-12-31T20:00:00’). |
channel_id | string | Não | ID do canal onde o evento será hospedado. Obrigatório para tipos STAGE_INSTANCE e VOICE. Deve ser nulo para EXTERNAL. |
description | string | Não | Descrição do evento agendado (1–1000 caracteres). |
privacy_level | integer | Não | Nível de privacidade do evento. Use 2 para GUILD_ONLY (acessível apenas a membros do servidor). |
scheduled_end_time | string | Não | Hora de encerramento do evento (timestamp ISO8601). Obrigatório para tipo EXTERNAL. |
entity_metadata | object | Não | Metadados adicionais para o evento agendado do servidor. |
image | string | Não | Imagem de capa como URI de dados base64 (ex: ‘data:image/png;base64,…’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Sair do servidor
Seção intitulada “Sair do servidor”DISCORDBOT_LEAVE_GUILD
Faz o bot sair de um servidor Discord especificado. Esta ação é irreversível e o bot precisa ser convidado novamente para voltar.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
guild_id | string | Sim | Identificador único do servidor Discord (server) que o bot deseja deixar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Testar autenticação do token do bot
Seção intitulada “Testar autenticação do token do bot”DISCORDBOT_TEST_AUTH
Valida o token do bot Discord configurado buscando o usuário bot autenticado atual. Use ao diagnosticar erros 401 repetidos para determinar se o problema é um token inválido (este endpoint retorna 401) ou falta de associação ao servidor/permissões/channel_id incorreto (este endpoint retorna 200 mas outras operações falham).
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |