开发者
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-chatREST:运行能力
/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-ticketzinn-chat-answer-ticket | 回复工单 通过电子邮件(text)回复客户,或添加内部备注(note: true);状态可选择性地更改工单状态。 | 免费版 | POST …/abilities/zinn-chat/answer-ticket/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/ask-assistantzinn-chat-ask-assistant | 咨询助理 向网站的 AI 助手提问,并返回其答案以及找到的所有来源。 | 免费版 | POST …/abilities/zinn-chat/ask-assistant/run | the REST route's own per-item permission check | question: string (必填), language: string |
zinn-chat/bulk-update-ticketszinn-chat-bulk-update-tickets | 批量更改多个工单 (Pro) 更改最多 100 个工单(编号)的状态、优先级或经办人。每个工单都经过与单独更改时相同的检查;结果中会列出每一个工单。 | 专业版 | POST …/abilities/zinn-chat/bulk-update-tickets/run | zinn_chat_answer | ids: array (必填), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer |
zinn-chat/chat-to-ticketzinn-chat-chat-to-ticket | 将聊天转化为工单 从聊天中创建工单以便通过电子邮件回复(需要访客的电子邮件地址)。 | 免费版 | POST …/abilities/zinn-chat/chat-to-ticket/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/close-chatzinn-chat-close-chat | 关闭聊天 结束聊天;访客仍可索取聊天记录。 | 免费版 | POST …/abilities/zinn-chat/close-chat/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/create-ticketzinn-chat-create-ticket | 提交工单 代表客户提交工单(包括其电子邮件、主题和第一条消息)。 | 免费版 | POST …/abilities/zinn-chat/create-ticket/run | the REST route's own per-item permission check | email: string (必填), subject: string (必填), body: string (必填), name: string |
zinn-chat/delete-canned-replyzinn-chat-delete-canned-reply | 删除已保存的回复 (Pro) 删除已保存的回复。 | 专业版 | POST …/abilities/zinn-chat/delete-canned-reply/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/delete-ticketzinn-chat-delete-ticket | 删除工单 永久删除工单及其对话(仅限经理)。 | 免费版 | POST …/abilities/zinn-chat/delete-ticket/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/draft-kb-articlezinn-chat-draft-kb-article | 从工单草拟帮助文章 (Pro) 根据已解决的工单起草知识库文章草稿;在人工发布之前,它将一直保持为草稿状态。 | 专业版 | POST …/abilities/zinn-chat/draft-kb-article/run | edit_posts (the REST route's own check) | ticket: integer (必填) |
zinn-chat/draft-kb-from-gapszinn-chat-draft-kb-from-gaps | 为未解答的问题起草帮助文章 (Pro) 撰写草稿知识库文章以回答所选问题(ID);它们将保持草稿状态。 | 专业版 | POST …/abilities/zinn-chat/draft-kb-from-gaps/run | edit_posts (the REST route's own check) | ids: array (必填) |
zinn-chat/fill-canned-replyzinn-chat-fill-canned-reply | 填写保存的回复 (Pro) 返回已保存回复的文本,其中包含针对单个聊天或工单填充的占位符。 | 专业版 | POST …/abilities/zinn-chat/fill-canned-reply/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/get-chatzinn-chat-get-chat | 阅读聊天 返回某个聊天的消息和访客详细信息(after:仅返回此 ID 之后较新的消息)。 | 免费版 | GET …/abilities/zinn-chat/get-chat/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/get-overviewzinn-chat-get-overview | 阅读支持概述 返回每个状态下的工单数量、正在等待人工服务的聊天数量(及其未读消息数),以及聊天、助理和工单功能是否已开启。 | 免费版 | GET …/abilities/zinn-chat/get-overview/run | zinn_chat_answer | 无 |
zinn-chat/get-settingszinn-chat-get-settings | 读取聊天设置 返回所有聊天设置:小部件、助理、人员和营业时间、工单与电子邮件、网站索引、隐私与垃圾信息。 | 免费版 | GET …/abilities/zinn-chat/get-settings/run | zinn_chat_manage | 无 |
zinn-chat/get-statszinn-chat-get-stats | 查看支持统计信息 (Pro) 返回最近 N 天(天)的聊天和工单数量、响应时间以及评分。 | 专业版 | GET …/abilities/zinn-chat/get-stats/run | the REST route's own per-item permission check | days: integer |
zinn-chat/get-ticketzinn-chat-get-ticket | 阅读工单 返回一张工单及其完整的对话内容、状态、优先级和经办人。 | 免费版 | GET …/abilities/zinn-chat/get-ticket/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/hand-chat-to-assistantzinn-chat-hand-chat-to-assistant | 将聊天转回给助手 将聊天发送至 AI 助手,由其根据网站内容回答访客的问题。 | 免费版 | POST …/abilities/zinn-chat/hand-chat-to-assistant/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/list-canned-replieszinn-chat-list-canned-replies | 查看已保存的回复 (Pro) 列出客服人員可插入的已儲存回覆及其捷徑。 | 专业版 | GET …/abilities/zinn-chat/list-canned-replies/run | the REST route's own per-item permission check | 无 |
zinn-chat/list-chatszinn-chat-list-chats | 列出实时聊天 列出等待中、进行中和最近关闭的聊天,以及每个聊天的处理人员。 | 免费版 | GET …/abilities/zinn-chat/list-chats/run | the REST route's own per-item permission check | view: active|bot|closed|all |
zinn-chat/list-indexed-contentzinn-chat-list-indexed-content | 列出助手已知的信息 按分页列出助手回答所依据的内容及其索引状态。 | 免费版 | GET …/abilities/zinn-chat/list-indexed-content/run | the REST route's own per-item permission check | search: string, status: indexed|pending|error, page: integer |
zinn-chat/list-kb-gapszinn-chat-list-kb-gaps | 列出未回答的问题 (Pro) 列出访客提出但知识库未能解答的问题。 | 专业版 | GET …/abilities/zinn-chat/list-kb-gaps/run | the REST route's own per-item permission check | status: open|drafted|answered|ignored|all, page: integer |
zinn-chat/list-ticketszinn-chat-list-tickets | 列出工单 按状态或搜索条件筛选支持工单列表,按页显示。 | 免费版 | GET …/abilities/zinn-chat/list-tickets/run | the REST route's own per-item permission check | status: active|open|pending|solved|closed|all, search: string, page: integer |
zinn-chat/reembed-contentzinn-chat-reembed-content | 重建助手的搜索索引 重建单个项目 (item_id) 或所有项目 (all: true) 的搜索向量(仅限管理员)。 | 免费版 | POST …/abilities/zinn-chat/reembed-content/run | the REST route's own per-item permission check | all: boolean, item_id: integer |
zinn-chat/reindex-contentzinn-chat-reindex-content | 将内容重新读给助手听 重新将单个项目 (item_id) 或所有内容 (all: true) 读取到助理的索引中(仅限经理)。 | 免费版 | POST …/abilities/zinn-chat/reindex-content/run | the REST route's own per-item permission check | all: boolean, item_id: integer |
zinn-chat/reply-chatzinn-chat-reply-chat | 在聊天中回复 向访客发送消息 (text),或者仅添加客服可见的内部备注 (note: true)。 | 免费版 | POST …/abilities/zinn-chat/reply-chat/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/save-canned-replyzinn-chat-save-canned-reply | 保存已保存的回复 (Pro) 创建或修改已保存的回复(标题、快捷方式、正文、部门;用于修改单个回复的 id)。 | 专业版 | POST …/abilities/zinn-chat/save-canned-reply/run | the REST route's own per-item permission check | id: integer, title: string (必填), body: string (必填), shortcut: string, department: string |
zinn-chat/save-kb-articlezinn-chat-save-kb-article | 编写帮助文章 (Pro) 创建一篇知识库文章,或更改一篇文章 (id):标题、内容、摘要、分类和状态(草稿,或者在可以发布时发布)。 | 专业版 | POST …/abilities/zinn-chat/save-kb-article/run | edit_posts | id: integer, title: string, content: string, excerpt: string, categories: array, status: draft|publish |
zinn-chat/search-kbzinn-chat-search-kb | 搜索知识库 (Pro) 查找用于在回复中链接的帮助文章(q:搜索)。 | 专业版 | GET …/abilities/zinn-chat/search-kb/run | the REST route's own per-item permission check | q: string (必填) |
zinn-chat/set-conversation-detailszinn-chat-set-conversation-details | 设置会话的部门和标签 (Pro) 设置聊天或工单的部门及标签(类型:chat 或 ticket;id)。 | 专业版 | POST …/abilities/zinn-chat/set-conversation-details/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (必填), department: string, tags: array |
zinn-chat/set-kb-gap-statuszinn-chat-set-kb-gap-status | 标记未回答的问题 (Pro) 将未回答的问题标记为“开放”、“已计划”或“已忽略”(ID、状态)。 | 专业版 | POST …/abilities/zinn-chat/set-kb-gap-status/run | the REST route's own per-item permission check | ids: array (必填), status: open|drafted|answered|ignored (必填) |
zinn-chat/set-presencezinn-chat-set-presence | 设置您的可用性 将已登录的客服人员标记为新聊天可用或离开(离开:true 或 false)。 | 免费版 | POST …/abilities/zinn-chat/set-presence/run | the REST route's own per-item permission check | away: boolean |
zinn-chat/suggest-replyzinn-chat-suggest-reply | 使用 AI 起草回复 (Pro) 根据网站内容草拟对聊天或工单的回复;不会发送任何内容。 | 专业版 | POST …/abilities/zinn-chat/suggest-reply/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (必填) |
zinn-chat/summarise-conversationzinn-chat-summarise-conversation | 总结与 AI 的对话 (Pro) 用几行字总结聊天或工单。 | 专业版 | POST …/abilities/zinn-chat/summarise-conversation/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (必填) |
zinn-chat/take-chatzinn-chat-take-chat | 开启聊天 将等待中的聊天分配给已登录的坐席,以便访客与真人对话。 | 免费版 | POST …/abilities/zinn-chat/take-chat/run | the REST route's own per-item permission check | id: string (必填) |
zinn-chat/update-settingszinn-chat-update-settings | 更改聊天设置 更改您发送的设置(设置:键对应值)并保留其余部分。每个值的检查方式与设置屏幕上完全相同;get-settings 用于列出键。 | 免费版 | POST …/abilities/zinn-chat/update-settings/run | zinn_chat_manage | settings: object (必填) |
zinn-chat/update-ticketzinn-chat-update-ticket | 修改工单 更改工单的状态、优先级或处理人。 | 免费版 | POST …/abilities/zinn-chat/update-ticket/run | the REST route's own per-item permission check | id: 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 版添加其专属的开关和词汇)。 | 无 | 免费版 |