Skip to main content

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.

接入时优先使用 Shulex 前端 UI 完成渠道创建和维护。客户通常只需要在 UI 中填写第三方系统提供的接口地址和鉴权信息；Webhook 地址也由 UI 展示，复制即可。

​
UI 中填写或查看的配置

配置项是否必填用途接入方怎么处理
渠道名称必填渠道显示名称，对应 accountName在 UI 中填写易识别的名称
工单查询地址必填Shulex 拉取工单详情，对应 queryUrl在 UI 中填写第三方查询接口地址
查询鉴权 Header选填调用 queryUrl 时附带，对应 queryAuthHeader如接口需要鉴权，在 UI 中填写
AI 回复回调地址必填Shulex 回传 AI 回复，对应 replyUrl在 UI 中填写第三方接收回复的接口地址
回复回调鉴权 Header选填调用 replyUrl 与 tagsUrl 时附带，对应 replyAuthHeader如回调接口需要鉴权，在 UI 中填写
标签回调地址选填Shulex 回传流程标签，对应 tagsUrl需要已回复标签或转人工标签时填写
回复格式选填控制 reply 返回 HTML 还是纯文本，对应 replyFormatUI 有该配置时按第三方系统能力选择；默认 HTML
Webhook 地址自动生成第三方系统推送新消息到 Shulex渠道创建后从 UI 复制，不要手动拼接

​
UI 未展示或通常无需客户填写的内容

字段当前链路处理方式
xToken系统生成，并体现在 UI 展示的 Webhook 地址中
channelId系统生成，并体现在 UI 展示的 Webhook 地址中
botId系统自动取账号下第一个 Bot 作为默认 Bot，不支持接入方自定义
replyTimeoutMs默认 10000ms；如 UI 未提供配置入口，按系统默认值处理
repliedTags默认 shulex_ai_replied；如 UI 未提供配置入口，按默认值处理
handoffTags默认 transfer_to_agent；如 UI 未提供配置入口，按默认值处理
webhookSecret / X-Signature当前不支持签名校验

​
配置约束

  • queryUrl / replyUrl / tagsUrl 需使用 HTTPS。
  • localhost / 127.0.0.1 仅用于本地调试。
  • 非本地地址不能指向 loopback、site-local、link-local 等内网地址。
  • queryAuthHeader / replyAuthHeader 禁止包含换行符，避免 Header 注入。

​
鉴权头格式说明

  • 推荐传完整 header：Authorization: Bearer xxx，Shulex 会按冒号拆分为 header name 和 value。
  • 如果只传 value、不含冒号：
    • queryUrl 请求会使用 header name queryAuthHeader
    • replyUrl / tagsUrl 请求会使用 header name replyAuthHeader