說明文件

更快上手 TicketsX

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

13

API 參考

TicketsX 的 REST API 讓你把外部工具接上伺服器的工單系統。你可以用程式建立、關閉與管理工單,不必經過 Discord 介面,也能搜尋整個對話紀錄封存,並取出任何已關閉工單的完整內文或 HTML。

REST API 是 Premium 功能。 只有在伺服器擁有有效 Premium 訂閱期間,才能建立與使用 API 權杖(見價格頁面)。沒有 Premium 的伺服器送出的請求會被拒絕,回傳 402premium_required: true 欄位。如果 Premium 到期,既有權杖會保留但停止運作,直到你重新啟用。這段期間你仍然可以隨時在控制台中列出、停用與撤銷權杖。

基礎 URLhttps://api.ticketsx.xyz
Bearer Token

每個請求都必須在 Authorization 標頭中以 Bearer 權杖的形式帶上 API 權杖。權杖只對單一伺服器有效,而且可以依操作限制權限。

Authorization: Bearer <API_TOKEN>

在下面所有端點路徑中,請把 <guild_id> 換成你的 Discord 伺服器 ID,把 <ticket_id> 換成目標工單的 ID。

所有 POST 請求本文都必須帶 Content-Type: application/json。4xx 回應會包含 JSON 的 error 欄位。401 表示權杖無效、過期或已被撤銷。402 表示伺服器沒有 Premium(回應中還會帶 premium_required: true)。403 表示權杖已停用或缺少所需權限。429 表示觸發了限流(見「限流與安全」),並會帶上以秒為單位的 retry_after 值。