Разработчики
Справочник возможностей Zinn® Chat
Плагин Zinn® Chat регистрирует свои действия в WordPress Abilities API. Те же возможности являются инструментами MCP на собственном сервере сайта и маршрутами REST в /wp-json/wp-abilities/v1. Эта страница генерируется на основе собственного реестра плагина.
Конечные точки
MCP через HTTP (потоковый)
https://example.com/wp-json/zinn-chat/v1/mcpMCP через WP-CLI (стандартные ввод и вывод)
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 плагина, который, в свою очередь, создается на основе работающего сайта; тест завершается с ошибкой, если они не совпадают.
| Возможность | Что делает | Редакция | REST | Разрешение | Параметры |
|---|---|---|---|---|---|
zinn-chat/answer-ticketzinn-chat-answer-ticket | Ответить на тикет Отвечает клиенту по электронной почте (текст) или добавляет внутреннюю заметку (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 | Спросить ассистента Задает сайтовому ИИ-ассистенту вопрос и возвращает его ответ со всеми найденными источниками. | Бесплатный тариф | 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 тикетов (по их id). Каждый тикет проходит те же проверки, что и при отдельном изменении; в результате выводятся данные по каждому из них. | Версия Pro | 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) Удаляет сохраненный ответ. | Версия 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) Создает черновик статьи базы знаний из решенного тикета; он остается черновиком, пока его кто-нибудь не опубликует. | Версия 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) Создает черновики статей базы знаний, отвечающие на выбранные вопросы (ids); они остаются черновиками. | Версия Pro | 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) Возвращает текст сохраненного ответа с заполненными заполнителями для одного чата или тикета. | Версия 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 дней (days). | Версия Pro | 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 | Вернуть чат ассистенту Возвращает чат с ИИ-помощником, который отвечает посетителям на основе содержимого сайта. | Бесплатный тариф | 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) Отображает список сохраненных ответов, которые агенты могут вставлять, с указанием их комбинаций клавиш. | Версия 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) Показывает список вопросов посетителей, на которые база знаний не смогла ответить. | Версия 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 для изменения конкретного). | Версия Pro | 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): заголовок, содержание, отрывок, категории и статус (черновик или опубликовано, когда публикация разрешена). | Версия Pro | 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: поиск). | Версия Pro | 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). | Версия Pro | 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) Помечает оставшиеся без ответа вопросы как открытые, запланированные или отклоненные (идентификаторы, статус). | Версия Pro | 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 | Установите доступность Указывает, доступен ли вошедший в систему агент или отсутствует для новых чатов (away: 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 | Сгенерировать ответ с помощью ИИ (Pro) Составляет проект ответа на чат или тикет на основе содержимого сайта; ничего не отправляется. | Версия 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 | Резюмировать беседу с ИИ (Pro) Суммирует чат или тикет в нескольких строках. | Версия 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 | Фильтровать | Фильтрует полезную нагрузку чата для консоли агента (риф-версия Pro добавляет информацию о посетителе, заметки, предложения из базы знаний). | Нет | Бесплатный тариф |
zinn_chat_agent_pages | Фильтровать | Фильтрует экраны Zinn® Chat, которые может открыть учетная запись агента службы поддержки. | Нет | Версия Pro |
zinn_chat_agent_script_src | Фильтровать | Фильтрует URL-адрес, с которого загружается автономный ИИ-агент чата. | string $src | Бесплатный тариф |
zinn_chat_agent_ticket | Фильтровать | Фильтрует полезную нагрузку тикета для wp-admin (версия Pro добавляет готовые ответы, SLA и предложения из базы знаний). | Нет | Бесплатный тариф |
zinn_chat_answer | Фильтровать | Фильтрует ответ ассистента до его отображения (рифы Pro добавляют сюда свои дополнения). | 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 | Действие | Произошло событие, заслуживающее внимания (здесь отслеживаются push-уведомления). | string $alert, int $id, string $text, string $link | Версия Pro |
zinn_chat_pro_assigned | Действие | Тикет был автоматически назначен оператору. | int $id, int $agent | Версия Pro |
zinn_chat_pro_loaded | Действие | Уровень Pro загружен. | Нет | Версия Pro |
zinn_chat_pro_priority_changed | Действие | Приоритет тикета изменен (целевые показатели SLA следуют за ним). | int $id | Версия Pro |
zinn_chat_pro_sla_breach | Действие | Цель SLA не была достигнута. | int $ticket_id, string $which | Версия Pro |
zinn_chat_pro_ticket_rated | Действие | Клиент оценил решенный тикет (1-5). | int $id, int $score | Версия Pro |
zinn_chat_rated | Действие | Срабатывает после того, как посетитель оценивает беседу, передавая идентификатор беседы и оценку (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` (простой текст, не более 3000 символов); используется не более четырех. | string $language | Бесплатный тариф |
zinn_chat_site_strings | Фильтровать | Фильтрует тексты владельца, предложенные для перевода (Pro добавляет свои упреждающие сообщения). | Нет | Бесплатный тариф |
zinn_chat_system_prompt | Фильтровать | Фильтрует системную подсказку ассистента (Pro: правила личности и передачи управления). | string $rules | Бесплатный тариф |
zinn_chat_team_online | Фильтровать | Определяет, может ли человек ответить сейчас (рифы Pro добавляют сюда рабочие часы). | 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>]`; они поступают в `zinn_chat_ticket_created` как `$fields['extra']`, без предварительной очистки, для проверки тем, кто их добавил. | 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 добавляет собственные переключатели и слова). | Нет | Бесплатный тариф |