說明文件

更快上手 TicketsX

設定指南、完整指令說明、Premium 功能和 REST API 都在這裡。

13.11

更新面板

PATCH/<guild_id>/api/panels/<panel_id>

修改面板的設定:名稱、嵌入訊息、顏色、按鈕樣式,以及是否忽略自動關閉。Discord 中已發布的面板訊息會自動重新整理。需要 `manage_panels` 權限(預設關閉)。

請求本文(所有欄位都是選填,只送出你要修改的部分)

名稱型別必填說明
panel_titlestring|null
選填
嵌入訊息標題(最多 256 個字元)。送出 null 可清空。
panel_descriptionstring|null
選填
嵌入訊息描述(最多 4096 個字元)。送出 null 可清空。
panel_contentstring|null
選填
嵌入訊息上方的純文字(最多 2000 個字元)。送出 null 可清空。
panel_footerstring|null
選填
嵌入訊息頁尾文字(最多 2048 個字元)。送出 null 可清空。
panel_colorstring|null
選填
嵌入訊息顏色,以十六進位字串表示,例如 #5865F2。送出 null 可清空。
panel_image_urlstring|null
選填
嵌入訊息圖片,使用 http(s) 連結。送出 null 可清空。
panel_thumbnail_urlstring|null
選填
嵌入訊息縮圖,使用 http(s) 連結。送出 null 可清空。
panel_namestring
選填
用於工單命名的面板名稱(最多 100 個字元)。僅限單一面板。
button_textstring|null
選填
按鈕標籤(最多 80 個字元)。僅限單一面板。
button_colorstring
選填
按鈕樣式:primarysecondarysuccessdanger。僅限單一面板。
button_emojistring|null
選填
按鈕表情符號(Unicode 或自訂表情符號 ID)。僅限單一面板。
disabledboolean
選填
停用或重新啟用該面板。僅限單一面板。
bypass_auto_closeboolean
選填
即使伺服器開啟了自動關閉,也讓該面板的工單不受影響。僅限單一面板。
dropdown_placeholderstring|null
選填
下拉選單的提示文字(最多 150 個字元)。僅限組合面板。

結構性的設定(面板所在頻道、工單分類、標註身分組、表單、客服團隊)無法透過 API 修改,請在控制台中調整。回應中包含 message_refreshed。如果它是 false(或你修改了組合面板的 dropdown_placeholder),請呼叫「重新發送面板」來更新 Discord 中的訊息。

使用元件版面的面板會以 400 錯誤拒絕 panel_titlepanel_descriptionpanel_contentpanel_footerpanel_colorpanel_image_urlpanel_thumbnail_url。請改在控制台中編輯它們的版面。

請求範例
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"
    }
  }
}