說明文件

更快上手 TicketsX

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

13.20

取得對話紀錄 HTML

GET/<guild_id>/api/transcripts/<ticket_id>/html

下載某張已關閉工單所保存的完整 HTML 對話紀錄。這正是控制台所呈現的那份封存,包含每一則訊息、嵌入內容、附件連結與頭像。需要 `view_transcript_html` 權限(預設關閉)。

查詢參數

名稱型別必填說明
formatstring
選填
設為 raw 可直接取回 HTML 檔案本身,Content-Typetext/html,可直接寫入磁碟或放進 iframe。不填則回傳預設的 JSON 結構,其中同時包含對話紀錄的中繼資料與 HTML。錯誤訊息一律以 JSON 回傳。

這是本 API 中最敏感的讀取操作,因此限制為每個權杖每分鐘 10 次,而且每次呼叫都會寫入你伺服器的操作紀錄。對話紀錄以加密方式保存,每次請求時解密。封存過大時會以 413 拒絕,回應中會提供 transcript_url 讓你改以線上方式檢視。

請求範例:JSON 結構
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  "https://api.ticketsx.xyz/<guild_id>/api/transcripts/<ticket_id>/html"
請求範例:直接儲存檔案
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  -o ticket_42.html \
  "https://api.ticketsx.xyz/<guild_id>/api/transcripts/<ticket_id>/html?format=raw"
回應範例(預設的 JSON)
{
  "transcript": {
    "TicketId": 42,
    "PanelId": 1,
    "PanelName": "Support",
    "AuthorId": "123456789",
    "AuthorUsername": "jane",
    "Rating": 5,
    "RatingCount": 1,
    "CloseReason": "Resolved",
    "CreatedAt": 1732200000,
    "ClosedAt": 1732210000,
    "TranscriptUrl": "https://tickets.example.com/<guild_id>/transcripts/42"
  },
  "content_type": "text/html; charset=utf-8",
  "bytes": 184320,
  "html": "<!DOCTYPE html>..."
}