> ## Documentation Index
> Fetch the complete documentation index at: https://beaver.voc.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# index

# Custom Ticket Open API

> Shulex Intelli 自定义工单 AI 能力对接文档

**当前版本**：v1.2<br />**更新日期**：2026-07-16

本文档面向希望接入 Shulex Intelli AI 回复能力的第三方工单系统，说明 Custom Ticket 的 Webhook 触发、工单查询、AI 回复、流程标签和 AI Summary 能力。

<CardGroup cols={3}>
  <Card title="文档介绍" icon="book-open" href="/api/ticket-ai/introduction/overview">
    了解整体流程、渠道配置、超时与幂等、常见问题及版本变更。
  </Card>

  <Card title="对外 API 说明" icon="arrow-right-to-bracket" href="/api/ticket-ai/open-api/webhook">
    第三方调用 Shulex 的 Webhook 与 AI Summary 接口。
  </Card>

  <Card title="三方实现接口" icon="arrow-right-from-bracket" href="/api/ticket-ai/third-party-api/query">
    第三方提供给 Shulex 的查询、回复和标签回调接口。
  </Card>
</CardGroup>

## 快速开始

<Steps>
  <Step title="在 Shulex UI 创建 Custom Ticket 渠道">
    填写 `queryUrl`、`replyUrl`，按需填写 `tagsUrl`、鉴权 Header 和标签配置。
  </Step>

  <Step title="复制 UI 中生成的 Webhook 地址">
    将地址配置到第三方系统；新消息触发时传入 `ticketId`，并建议同时传入 `messageId`。
  </Step>

  <Step title="实现第三方接口">
    按文档实现 [工单查询](/api/ticket-ai/third-party-api/query)、[AI 回复回调](/api/ticket-ai/third-party-api/reply) 与可选的 [标签回调](/api/ticket-ai/third-party-api/tags)。
  </Step>
</Steps>

<Info>
  查看 [变更记录](/api/ticket-ai/introduction/changelog) 了解版本差异与兼容性说明。
</Info>