开发者

Zinn® Chat 功能参考

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

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

我们的维京人 Zinn® 在 AI 助手连接到平台工具时欢呼。

服务端点

通过 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 checkquestion: string (必填), language: string
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
批量更改多个工单 (Pro)
更改最多 100 个工单(编号)的状态、优先级或经办人。每个工单都经过与单独更改时相同的检查;结果中会列出每一个工单。
专业版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 checkemail: string (必填), subject: string (必填), body: string (必填), name: string
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)ticket: integer (必填)
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
为未解答的问题起草帮助文章 (Pro)
撰写草稿知识库文章以回答所选问题(ID);它们将保持草稿状态。
专业版POST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)ids: array (必填)
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 checkdays: integer
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 checkview: active|bot|closed|all
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 checksearch: string, status: indexed|pending|error, page: integer
zinn-chat/list-kb-gaps
zinn-chat-list-kb-gaps
列出未回答的问题 (Pro)
列出访客提出但知识库未能解答的问题。
专业版GET …/abilities/zinn-chat/list-kb-gaps/runthe REST route's own per-item permission checkstatus: open|drafted|answered|ignored|all, page: integer
zinn-chat/list-tickets
zinn-chat-list-tickets
列出工单
按状态或搜索条件筛选支持工单列表,按页显示。
免费版GET …/abilities/zinn-chat/list-tickets/runthe REST route's own per-item permission checkstatus: active|open|pending|solved|closed|all, search: string, page: integer
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 checkall: boolean, item_id: integer
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 checkall: boolean, item_id: integer
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 checkid: integer, title: string (必填), body: string (必填), shortcut: string, department: string
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 checkq: string (必填)
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 checkkind: ticket|chat, id: integer (必填), department: string, tags: array
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 checkids: array (必填), status: open|drafted|answered|ignored (必填)
zinn-chat/set-presence
zinn-chat-set-presence
设置您的可用性
将已登录的客服人员标记为新聊天可用或离开(离开:true 或 false)。
免费版POST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkaway: boolean
zinn-chat/suggest-reply
zinn-chat-suggest-reply
使用 AI 起草回复 (Pro)
根据网站内容草拟对聊天或工单的回复;不会发送任何内容。
专业版POST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (必填)
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
总结与 AI 的对话 (Pro)
用几行字总结聊天或工单。
专业版POST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (必填)
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 (必填)

操作和筛选器

插件提供的每一个钩子,以及来自其源代码的描述。过滤器用于更改值;动作允许您在特定时刻运行代码;入口点是您触发以要求插件执行某些操作的动作。

钩子类型功能说明参数版本
zinn_chat_admin_pages筛选过滤 Zinn® Chat 管理屏幕(Pro 版会添加其自己的屏幕)。无免费版
zinn_chat_agent_chat筛选过滤坐席控制台的聊天有效负载(专业版添加访客详情、备注、知识库建议)。无免费版
zinn_chat_agent_pages筛选过滤支持人员账户可以打开的 Zinn® Chat 屏幕。无专业版
zinn_chat_agent_script_src筛选过滤加载独立 AI 聊天代理的 URL。string $src免费版
zinn_chat_agent_ticket筛选过滤 wp-admin 的工单有效负载(Pro 版新增预设回复、SLA、KB 建议)。无免费版
zinn_chat_answer筛选过滤助手在显示前的回答(专业版在此添加其额外内容)。string $question免费版
zinn_chat_assistant_answered操作助手已回答访客。int $id, string $text免费版
zinn_chat_challenge筛选过滤显示给访问者的安全验证(脚本 URL、站点密钥以及脚本通过 `render( element, { sitekey, callback } )` 方法定义的全局对象)。无免费版
zinn_chat_challenge_ok筛选过滤访客是否通过了人机验证。无法验证的检查必须返回 false(故障安全关闭):任何在服务不可达时放行所有请求的表单,都是机器人可以通过时间差攻击使其成功的表单。bool $ok, string $ip, string $where免费版
zinn_chat_client_ip筛选过滤用于速率限制和记录的访客 IP 地址。string $ip免费版
zinn_chat_console_config筛选过滤传递给客服控制台脚本的额外配置;Zinn® Chat Pro 在此处添加其功能。无免费版
zinn_chat_conversation_started操作有访客发起了一场聊天。int $id免费版
zinn_chat_conversation_status操作对话状态已更改。int $id, string $status, string $old免费版
zinn_chat_customer_ticket_url筛选过滤发送给客户的工单链接。string $url免费版
zinn_chat_elements筛选过滤作为区块和生成器模块提供的前端元素。无免费版
zinn_chat_email筛选在发送前过滤电子邮件。返回空的 `to` 以阻止发送。无免费版
zinn_chat_fs_loaded操作在许可 SDK 加载后触发(在主文件中,在任何 Zinn® Chat 代码之前)。在此处挂钩以与 `zinn_chat_fs()` 进行交互。无免费版
zinn_chat_index_extract筛选过滤提取的对象(或为自定义对象类型提供一个)。string $type, int $id免费版
zinn_chat_index_language筛选过滤已索引文章的语言(区域设置)。string $language, \WP_Post $post免费版
zinn_chat_index_object入口点(您触发它)钩子无免费版
zinn_chat_index_post_types筛选过滤助手读取的文章类型。无免费版
zinn_chat_indexable筛选过滤文章是否被收录。bool $indexable, \WP_Post $post免费版
zinn_chat_indexed操作一个对象已被(重新)索引。string $type, int $id免费版
zinn_chat_is_pro筛选过滤 Pro 功能是否运行(来自 Freemius 的已购许可证或试用版)。Pro 代码仅随高级版软件包提供,因此这无法添加免费版所缺少的内容。bool $pro免费版
zinn_chat_loaded操作Zinn® Chat 已加载(加载项的扩展点)。无免费版
zinn_chat_message_added操作对话中添加了一条新消息。int $id, int $conversation_id, string $role免费版
zinn_chat_order_tracking筛选过滤发送给助手的订单跟踪信息。\WC_Order $order免费版
zinn_chat_pro_alert操作发生了一个值得发出警报的事件(推送通知在此监听)。string $alert, int $id, string $text, string $link专业版
zinn_chat_pro_assigned操作工单已自动分配给客服人员。int $id, int $agent专业版
zinn_chat_pro_loaded操作专业层已加载。无专业版
zinn_chat_pro_priority_changed操作工单优先级已更改(SLA 目标将随之调整)。int $id专业版
zinn_chat_pro_sla_breach操作未达到SLA目标。int $ticket_id, string $which专业版
zinn_chat_pro_ticket_rated操作客户对已解决的工单进行了评分(1-5分)。int $id, int $score专业版
zinn_chat_rated操作在访客对对话进行评价后触发,包含对话 ID 和评价(1 表示有用,-1 表示没用)。int $conversation_id, int $rating免费版
zinn_chat_role_capabilities筛选筛选哪些角色可以获得哪些 Zinn® Chat 功能。无免费版
zinn_chat_save_settings筛选在存储前过滤设置(Pro 版会在此处添加其自己的键)。无免费版
zinn_chat_script_src筛选过滤托管聊天小组件加载来源的 URL(已连接模式)。string $src免费版
zinn_chat_settings_before操作设置选项卡表单上方。string $tab免费版
zinn_chat_settings_fields筛选过滤设置选项卡的字段(Pro 版本会添加它自己的字段)。string $tab免费版
zinn_chat_settings_tabs筛选过滤设置标签页。无免费版
zinn_chat_setup_after操作在设置检查清单下方(免费版在此处显示 Pro 卡片)。无免费版
zinn_chat_should_render筛选过滤此请求中是否渲染聊天(Pro 的页面定向在此挂钩)。bool $render免费版
zinn_chat_site_facts筛选过滤每个问题提供给助手的关于本站的事实。每条均包含 `title`、`url`(本站内)和 `text`(纯文本,最多 3,000 个字符);最多使用四条。string $language免费版
zinn_chat_site_strings筛选筛选提供翻译的所有者文本(Pro 会添加其主动消息)。无免费版
zinn_chat_system_prompt筛选过滤助手的系统提示(Pro:角色设定和交接规则)。string $rules免费版
zinn_chat_team_online筛选过滤一个人当前是否可以回答(专业版在此处添加营业时间)。bool $online免费版
zinn_chat_ticket_assigned操作An agent assigned a ticket to an agent (2.14.0: the notification centre tells them).int $id, int $assignee, int $by免费版
zinn_chat_ticket_created操作已创建一个工单。邮件程序从此发送确认信和团队警报。int $id, string $token免费版
zinn_chat_ticket_form_extra筛选过滤访客工单表单末尾的多余标记(Pro版的人工检查将放置在此处)。string $html免费版
zinn_chat_ticket_form_fields筛选过滤在每个工单表单的消息上方显示额外字段(Pro 版本:部门选择)。将其命名为 `zinn_chat_extra[<key>]`;它们会作为未经过滤的 `$fields['extra']` 传递给 `zinn_chat_ticket_created`,供添加这些字段的人员进行验证。string $html免费版
zinn_chat_ticket_reply操作工单已添加回复。邮件程序将从此向另一方发送邮件。int $id, int $ticket_id, string $author免费版
zinn_chat_ticket_status操作工单状态已更改。int $id, string $status, string $old免费版
zinn_chat_uninstall操作Zinn® Chat 正在卸载(Pro 会在此处删除其自己的数据)。无免费版
zinn_chat_widget_config筛选过滤页面上打印的启动器配置。无免费版
zinn_chat_widget_status筛选过滤已打开的聊天接收的内容(Pro 版添加其专属的开关和词汇)。无免费版