文档

更快上手 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"
    }
  }
}