13.11
パネルを更新
PATCH
/<guild_id>/api/panels/<panel_id>パネルの設定を変更します。名前、埋め込みメッセージ、色、ボタンの見た目、自動クローズを適用しないかどうかを扱えます。Discord に投稿されているパネルのメッセージは自動で更新されます。`manage_panels` の権限が必要です(初期状態ではオフ)。
リクエストボディ(すべて任意。変更したい項目だけ送ってください)
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| panel_title | string|null | 任意 | 埋め込みのタイトル(最大 256 文字)。null を送ると消去します。 |
| panel_description | string|null | 任意 | 埋め込みの説明(最大 4096 文字)。null を送ると消去します。 |
| panel_content | string|null | 任意 | 埋め込みの上に表示するプレーンテキスト(最大 2000 文字)。null を送ると消去します。 |
| panel_footer | string|null | 任意 | 埋め込みのフッターの文(最大 2048 文字)。null を送ると消去します。 |
| panel_color | string|null | 任意 | 埋め込みの色。16 進数の文字列で指定します(例: #5865F2)。null を送ると消去します。 |
| panel_image_url | string|null | 任意 | 埋め込みの画像。http(s) の URL で指定します。null を送ると消去します。 |
| panel_thumbnail_url | string|null | 任意 | 埋め込みのサムネイル。http(s) の URL で指定します。null を送ると消去します。 |
| panel_name | string | 任意 | チケットの名前付けに使うパネル名(最大 100 文字)。単一パネルのみ。 |
| button_text | string|null | 任意 | ボタンのラベル(最大 80 文字)。単一パネルのみ。 |
| button_color | string | 任意 | ボタンのスタイル: primary、secondary、success、danger。単一パネルのみ。 |
| button_emoji | string|null | 任意 | ボタンの絵文字(Unicode またはカスタム絵文字の ID)。単一パネルのみ。 |
| disabled | boolean | 任意 | パネルを無効にする、または再び有効にします。単一パネルのみ。 |
| bypass_auto_close | boolean | 任意 | サーバーで自動クローズが有効でも、このパネルのチケットを対象外にします。単一パネルのみ。 |
| dropdown_placeholder | string|null | 任意 | ドロップダウンのプレースホルダー(最大 150 文字)。複合パネルのみ。 |
構成にかかわる設定(パネルのチャンネル、チケットのカテゴリ、メンションするロール、フォーム、サポートチーム)は API からは変更できません。これらはダッシュボードで操作してください。応答には message_refreshed が含まれます。false の場合(または複合パネルで dropdown_placeholder を変更した場合)は、「パネルを再送信」を呼び出して Discord のメッセージを更新してください。
コンポーネントのレイアウトを使うパネルでは、panel_title、panel_description、panel_content、panel_footer、panel_color、panel_image_url、panel_thumbnail_url を指定すると 400 エラーになります。レイアウトはダッシュボードで編集してください。
リクエストの例
curl -X PATCH \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{"panel_title":"Contact Support","panel_color":"#57F287","button_text":"Get Help","button_color":"success"}' \
https://api.ticketsx.xyz/<guild_id>/api/panels/<panel_id>応答の例
{
"message": "Panel updated",
"message_refreshed": true,
"panel": {
"PanelId": 1,
"Type": "single",
"PanelName": "Support",
"PanelMessage": {
"PanelTitle": "Contact Support",
"PanelColor": "#57F287",
"ButtonText": "Get Help",
"ButtonColor": "success"
}
}
}