Discord操作 API v2 (2.0.0)

Download OpenAPI specification:

Discord上のカテゴリ・チャンネル・メッセージ・リアクションを操作する汎用API

Category

カテゴリの作成・削除

カテゴリ作成

指定したDiscordサーバーにカテゴリを作成する

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
serverId
required
string

Discord サーバーID

categoryName
required
string [ 1 .. 100 ] characters

作成するカテゴリの名前

Responses

Request samples

Content type
application/json
{
  • "serverId": "123456789012345678",
  • "categoryName": "第1回人狼村"
}

Response samples

Content type
application/json
{
  • "categoryId": "345678901234567890"
}

カテゴリ削除

指定したカテゴリを削除する

Authorizations:
ApiKeyAuth
path Parameters
categoryId
required
string^\d{17,20}$
Example: 345678901234567890

削除するカテゴリのID(Discord snowflake 形式、17〜20桁の数字)

Responses

Response samples

Content type
application/json
{
  • "message": "カテゴリを削除しました",
  • "categoryId": "345678901234567890"
}

Channel

チャンネルの作成・削除

チャンネル作成

指定したカテゴリ配下にテキストチャンネルを作成する。 userIds に配列を渡すと、そのユーザーのみ閲覧できる招待制チャンネルとして作成する。 userIds が null / 未指定 / 空配列 [] のいずれかの場合は、@everyone が閲覧・書き込みできる公開チャンネルとして作成する。

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
userIds
Array of strings or null <= 100 items

チャンネルの閲覧権限を付与するDiscordユーザーIDの配列(最大100件、Discord bulk members.fetch の上限)。 null / 未指定 / 空配列 [] のいずれかの場合は、@everyone に閲覧・書き込みを許可する公開チャンネルとして作成する。

channelName
required
string [ 1 .. 100 ] characters

作成するチャンネルの名前

categoryId
required
string

チャンネルを作成するカテゴリのID

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ],
  • "channelName": "占い師",
  • "categoryId": "345678901234567890"
}

Response samples

Content type
application/json
{
  • "channelId": "456789012345678901"
}

チャンネル削除

指定したチャンネルを削除する

Authorizations:
ApiKeyAuth
path Parameters
channelId
required
string^\d{17,20}$
Example: 456789012345678901

削除するチャンネルのID(Discord snowflake 形式、17〜20桁の数字)

Responses

Response samples

Content type
application/json
{
  • "message": "チャンネルを削除しました",
  • "channelId": "456789012345678901"
}

Message

メッセージの送信

メッセージ送信

指定したチャンネルにテキストメッセージを送信する

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
channelId
required
string

メッセージ送信先のチャンネルID

text
required
string [ 1 .. 2000 ] characters

送信するテキスト

Responses

Request samples

Content type
application/json
{
  • "channelId": "456789012345678901",
  • "text": "ゲームを開始します"
}

Response samples

Content type
application/json
{
  • "messageId": "789012345678901234",
  • "channelId": "456789012345678901"
}

Reaction

リアクションの取得

リアクション取得

指定したメッセージに何らかのリアクションをしたユニークユーザー一覧を取得する。 Bot 自身のリアクションは集計対象から除外される。

Authorizations:
ApiKeyAuth
query Parameters
channelId
required
string
Example: channelId=456789012345678901

メッセージが存在するチャンネルのID

messageId
required
string
Example: messageId=789012345678901234

リアクションを取得するメッセージのID

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}