文档

更快上手 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 值。