Разработчики

Справочник возможностей Zinn® Chat

Плагин Zinn® Chat регистрирует свои действия в WordPress Abilities API. Те же возможности являются инструментами MCP на собственном сервере сайта и маршрутами REST в /wp-json/wp-abilities/v1. Эта страница генерируется на основе собственного реестра плагина.

Руководство пользователя: подключение ИИ-приложения

Zinn®, наш викинг, ликует, пока ИИ-помощник подключается к инструментам платформы.

Конечные точки

MCP через HTTP (потоковый)

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

MCP через WP-CLI (стандартные ввод и вывод)

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 плагина, который, в свою очередь, создается на основе работающего сайта; тест завершается с ошибкой, если они не совпадают.

ВозможностьЧто делаетРедакцияRESTРазрешениеПараметры
zinn-chat/answer-ticket
zinn-chat-answer-ticket
Ответить на тикет
Отвечает клиенту по электронной почте (текст) или добавляет внутреннюю заметку (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
Спросить ассистента
Задает сайтовому ИИ-ассистенту вопрос и возвращает его ответ со всеми найденными источниками.
Бесплатный тариф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 тикетов (по их id). Каждый тикет проходит те же проверки, что и при отдельном изменении; в результате выводятся данные по каждому из них.
Версия ProPOST …/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)
Удаляет сохраненный ответ.
Версия ProPOST …/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)
Создает черновик статьи базы знаний из решенного тикета; он остается черновиком, пока его кто-нибудь не опубликует.
Версия ProPOST …/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)
Создает черновики статей базы знаний, отвечающие на выбранные вопросы (ids); они остаются черновиками.
Версия ProPOST …/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)
Возвращает текст сохраненного ответа с заполненными заполнителями для одного чата или тикета.
Версия ProPOST …/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 дней (days).
Версия ProGET …/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
Вернуть чат ассистенту
Возвращает чат с ИИ-помощником, который отвечает посетителям на основе содержимого сайта.
Бесплатный тариф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)
Отображает список сохраненных ответов, которые агенты могут вставлять, с указанием их комбинаций клавиш.
Версия ProGET …/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)
Показывает список вопросов посетителей, на которые база знаний не смогла ответить.
Версия ProGET …/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 для изменения конкретного).
Версия ProPOST …/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): заголовок, содержание, отрывок, категории и статус (черновик или опубликовано, когда публикация разрешена).
Версия ProPOST …/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: поиск).
Версия ProGET …/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).
Версия ProPOST …/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)
Помечает оставшиеся без ответа вопросы как открытые, запланированные или отклоненные (идентификаторы, статус).
Версия ProPOST …/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
Установите доступность
Указывает, доступен ли вошедший в систему агент или отсутствует для новых чатов (away: 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
Сгенерировать ответ с помощью ИИ (Pro)
Составляет проект ответа на чат или тикет на основе содержимого сайта; ничего не отправляется.
Версия ProPOST …/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
Резюмировать беседу с ИИ (Pro)
Суммирует чат или тикет в нескольких строках.
Версия ProPOST …/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ФильтроватьФильтрует полезную нагрузку чата для консоли агента (риф-версия 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 добавляет собственные переключатели и слова).НетБесплатный тариф