开发者

Zinn® Chat 功能参考

Zinn® Chat 将其操作注册到 WordPress Abilities API。这些能力既是该网站自身服务器上的 MCP 工具,也是 /wp-json/wp-abilities/v1 下的 REST 路由。此页面由该插件自身的注册表生成。

用户指南:连接人工智能应用

服务端点

通过 HTTP 的 MCP(可流式传输)

https://example.com/wp-json/zinn-chat/v1/mcp

通过 WP-CLI 的 MCP(标准输入和输出)

wp mcp-adapter serve --server=zinn-chat --user=<login>

REST:列出功能

/wp-json/wp-abilities/v1/abilities?category=zinn-chat

REST:运行能力

/wp-json/wp-abilities/v1/abilities/<name>/run

身份验证和权限

HTTP 请求使用 WordPress 应用程序密码(HTTP Basic)进行身份验证。连接到 MCP 服务器需要具备下方显示的权限;然后每个功能会根据每个对象检查其自身的权限。只读功能使用 GET 运行,其输入位于查询字符串中;其他功能使用 POST 和 JSON 主体 {"input": {…}} 运行。

示例

# REST:运行能力
curl -u your-username:your-application-password \
  "https://example.com/wp-json/wp-abilities/v1/abilities/zinn-chat/get-overview/run"
# MCP (JSON-RPC over HTTP, after "initialize")
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"zinn-chat-get-overview","arguments":{}}}

所有功能

由插件的 abilities.json 生成,该文件本身由运行中的站点生成;当两者不一致时测试将失败。

权限其功能版本剩余权限参数
zinn-chat/answer-ticket
zinn-chat-answer-ticket
回复工单
通过电子邮件(text)回复客户,或添加内部备注(note: true);状态可选择性地更改工单状态。
免费版POST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/ask-assistant
zinn-chat-ask-assistant
向助手提问
向网站的 AI 助手提问,并返回其答案以及找到的所有来源。
免费版POST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission check无
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
批量更改工单 (Pro)
更改最多100个工单(ID)的状态、优先级或负责人。每个工单都经过与单独更改时相同的检查,结果会列出每一个工单。
专业版POST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (必填), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-chat-chat-to-ticket
将聊天转换为工单
从聊天中开启工单以便通过电子邮件回复(需要访客的电子邮件地址)。
免费版POST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/close-chat
zinn-chat-close-chat
关闭聊天
结束聊天;访客仍可请求获取聊天记录。
免费版POST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/create-ticket
zinn-chat-create-ticket
提交工单
代表客户提交工单(包括客户电子邮件、主题和首条消息)。
免费版POST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission check无
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
删除保存的回复 (Pro)
删除已保存的回复。
专业版POST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
删除工单
永久删除工单及其对话(仅限经理)。
免费版POST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/draft-kb-article
zinn-chat-draft-kb-article
从服务单起草帮助文章 (Pro)
从已解决的工单中撰写知识库文章草稿;在人工发布之前,它将一直保持草稿状态。
专业版POST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)无
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
为未解答的问题起草帮助文章(专业版)
编写回答所选问题(ID)的知识库文章草稿;它们将保持为草稿状态。
专业版POST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)无
zinn-chat/fill-canned-reply
zinn-chat-fill-canned-reply
使用保存的回复 (Pro)
返回已保存回复的文本,其中已为某个聊天或工单填充了占位符。
专业版POST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/get-chat
zinn-chat-get-chat
阅读聊天记录
返回单个聊天的消息和访问者详细信息(after:仅返回此 ID 之后较新的消息)。
免费版GET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/get-overview
zinn-chat-get-overview
阅读支持概览
返回各种状态下的工单数量、等待人工服务的聊天数量(及其未读消息数),以及聊天、助手和工单功能是否已开启。
免费版GET …/abilities/zinn-chat/get-overview/runzinn_chat_answer无
zinn-chat/get-settings
zinn-chat-get-settings
读取聊天设置
返回所有聊天设置:小组件、助手、人员及营业时间、工单与电子邮件、网站索引、隐私与垃圾信息。
免费版GET …/abilities/zinn-chat/get-settings/runzinn_chat_manage无
zinn-chat/get-stats
zinn-chat-get-stats
读取支持统计信息 (Pro)
返回最近 N 天(天数)的聊天和工单数量、响应时间及评分。
专业版GET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission check无
zinn-chat/get-ticket
zinn-chat-get-ticket
查看工单
返回一张工单及其完整的对话、状态、优先级和经办人。
免费版GET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/hand-chat-to-assistant
zinn-chat-hand-chat-to-assistant
将对话移交给助手
返回与 AI 助手的一段对话,它会根据网站内容回答访客的问题。
免费版POST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
已保存回复列表 (Pro)
列出客服人员可以插入的已保存回复及其快捷方式。
专业版GET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission check无
zinn-chat/list-chats
zinn-chat-list-chats
列出实时聊天
列出正在等待、进行中以及最近关闭的聊天,并显示每个聊天的处理人员。
免费版GET …/abilities/zinn-chat/list-chats/runthe REST route's own per-item permission check无
zinn-chat/list-indexed-content
zinn-chat-list-indexed-content
列出助手已知的内容
按页列出助手回答所依据的内容及其索引状态。
免费版GET …/abilities/zinn-chat/list-indexed-content/runthe REST route's own per-item permission check无
zinn-chat/list-kb-gaps
zinn-chat-list-kb-gaps
列出未回答的问题 (专业版)
列出访客提出但知识库未能解答的问题。
专业版GET …/abilities/zinn-chat/list-kb-gaps/runthe REST route's own per-item permission check无
zinn-chat/list-tickets
zinn-chat-list-tickets
工单列表
分页列出支持工单,可按状态或搜索关键词进行筛选。
免费版GET …/abilities/zinn-chat/list-tickets/runthe REST route's own per-item permission check无
zinn-chat/reembed-content
zinn-chat-reembed-content
重建助手的搜索索引
重新生成单个项目 (item_id) 或所有项目 (all: true) 的搜索向量(仅限管理员)。
免费版POST …/abilities/zinn-chat/reembed-content/runthe REST route's own per-item permission check无
zinn-chat/reindex-content
zinn-chat-reindex-content
重新向助手朗读内容
重新将单个项目 (item_id) 或所有项目 (all: true) 读取到助手的索引中(仅限管理者)。
免费版POST …/abilities/zinn-chat/reindex-content/runthe REST route's own per-item permission check无
zinn-chat/reply-chat
zinn-chat-reply-chat
在聊天中回复
向访客发送消息(text),或者添加只有客服可见的内部备注(note: true)。
免费版POST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/save-canned-reply
zinn-chat-save-canned-reply
保存已保存的回复 (Pro)
创建或修改保存的回复(标题、快捷方式、正文、部门;用于修改的 id)。
专业版POST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission check无
zinn-chat/save-kb-article
zinn-chat-save-kb-article
编写帮助文章 (Pro)
创建知识库文章或对其进行修改 (id):标题、内容、摘要、分类和状态(草稿,或者在可以发布时发布)。
专业版POST …/abilities/zinn-chat/save-kb-article/runedit_postsid: integer, title: string, content: string, excerpt: string, categories: array, status: draft|publish
zinn-chat/search-kb
zinn-chat-search-kb
搜索知识库 (Pro)
查找要在回复中链接的帮助文章(q:搜索)。
专业版GET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission check无
zinn-chat/set-conversation-details
zinn-chat-set-conversation-details
设置对话的部门和标签 (Pro)
设置聊天或工单的部门与标签(类型:chat 或 ticket;id)。
专业版POST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission check无
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
标记未回答的问题 (Pro)
将未回答的问题标记为开放、已计划或已忽略(ID、状态)。
专业版POST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission check无
zinn-chat/set-presence
zinn-chat-set-presence
设置您的可用时间
将已登录的客服人员标记为新聊天可用或离开(离开:true 或 false)。
免费版POST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission check无
zinn-chat/suggest-reply
zinn-chat-suggest-reply
使用 AI 起草回复 (Pro)
根据网站内容草拟对聊天或工单的回复;不会发送任何内容。
专业版POST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission check无
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
总结与 AI 的对话 (Pro)
用几行文字总结聊天或工单。
专业版POST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission check无
zinn-chat/take-chat
zinn-chat-take-chat
发起聊天
将等待中的聊天分配给已登录的坐席,以便访客与真人对话。
免费版POST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (必填)
zinn-chat/update-settings
zinn-chat-update-settings
更改聊天设置
修改您发送的设置(设置:键对应值)并保留其余部分。每个值的检查方式与设置屏幕上完全相同;get-settings 用于列出所有键。
免费版POST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (必填)
zinn-chat/update-ticket
zinn-chat-update-ticket
修改工单
更改工单的状态、优先级或经办人。
免费版POST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: string (必填)