文档

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