Discord連携APIでは、Discordサーバー(Guild)に対してロール(Role)やチャンネル(Channel)の作成・更新・取得・削除ができます。
共通:認証(必須)
すべてのリクエストで、アクセストークンをHTTPヘッダーに付与してください。アクセストークンの取得方法は「API設定方法」をご確認ください。
Authorization: Bearer {access_token}
ロールAPI(Role)
| 用途 |
メソッド |
エンドポイント |
リクエスト |
主なレスポンス |
| ロール作成 |
POST |
/v1/discord/guilds/{guild_id}/roles |
name / position / permissions |
Discord Role Object |
| ロール更新 |
PUT |
/v1/discord/guilds/{guild_id}/roles/{role_id} |
name / position / permissions |
Discord Role Object |
| ロール取得 |
GET |
/v1/discord/guilds/{guild_id}/roles/{role_id} |
なし |
Discord Role Object |
| ロール削除 |
DELETE |
/v1/discord/guilds/{guild_id}/roles/{role_id} |
なし |
HTTP 204 |
ロール作成・更新のリクエスト項目
| json_key |
json_type |
description |
remarks |
| name |
string |
ロール名 |
|
| position |
integer |
ロールの表示位置 |
|
| permissions |
string[] |
Permission名のリスト |
Discord Permissionsに準拠 |
チャンネルAPI(Channel)
| 用途 |
メソッド |
エンドポイント |
リクエスト |
主なレスポンス |
| チャンネル作成 |
POST |
/v1/discord/guilds/{guild_id}/channels |
type / name / topic / role / user / parent_id |
Discord Channel Object |
| チャンネル更新 |
PUT |
/v1/discord/guilds/{guild_id}/channels/{channel_id} |
type / name / topic / role / user / parent_id |
Discord Channel Object |
| チャンネル取得 |
GET |
/v1/discord/guilds/{guild_id}/channels/{channel_id} |
なし |
Discord Channel Object |
| チャンネル削除 |
DELETE |
/v1/discord/guilds/{guild_id}/channels/{channel_id} |
なし |
HTTP 204 |
チャンネル作成・更新のリクエスト項目
| json_key |
json_type |
description |
remarks |
| type |
integer |
チャンネルタイプ |
Discord Channel Typesに準拠 |
| name |
string |
チャンネル名 |
|
| topic |
string |
チャンネル説明文 |
任意 |
| role |
Permission[] |
チャンネル権限(ロール) |
任意 |
| user |
Permission[] |
チャンネル権限(ユーザー) |
任意 |
| parent_id |
string |
チャンネルの親カテゴリID |
任意。カテゴリ配下にチャンネルを作成する場合に指定 |
Permissionオブジェクト(role / user で使用)
Permissionオブジェクト
| json_key |
json_type |
required |
description |
remarks |
| id |
string |
必須 |
ロール or ユーザー ID |
|
| allow |
string[] |
任意 |
idに許可する権限 |
Permission名のリスト |
| deny |
string[] |
任意 |
idに禁止する権限 |
Permission名のリスト |
| https://discord.com/developers/docs/topics/permissions#permissions |
|
|
|
|
関連情報