Розробники

Довідник можливостей 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 плагіна, який у свою чергу згенеровано з працюючого сайту; тест не проходить, якщо вони не збігаються.

МожливістьЩо робитьВиданняВІДПОЧИНОКДозвілПараметри
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 тікетів (ідентифікаторів). Кожен тікет проходить такі ж перевірки, як і при зміні окремо; результат містить перелік кожного з них.
Професійна версія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)
Створює чорнетки статей бази знань, що відповідають на вибрані запитання (ids); вони залишаються чорнетками.
Професійна версія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: лише повідомлення, новіші за цей ідентифікатор).
Безкоштовна версія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).
Професійна версія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)
Встановлює відділ і теги чату або тікета (вид: чат або тікет; 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)
Позначає безвідповідні запитання як відкриті, заплановані або відхилені (ідентифікатори, статус).
Професійна версія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
Встановити доступність
Позначає ввійшовшого агента доступним або відсутнім для нових чатів (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)
Створює проєкт відповіді на чат або тікет на основі вмісту сайту; нічого не надсилається.
Професійна версія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
Підсумувати розмову з ШІ (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ФільтруватиФільтрує корисне навантаження чату для консолі агента (Pro додає деталі відвідувача, нотатки, пропозиції Бази знань).жоденБезкоштовна версія
zinn_chat_agent_pagesФільтруватиФільтрує екрани Zinn® Chat, які може відкривати обліковий запис агента підтримки.жоденПрофесійна версія
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Професійна версія
zinn_chat_pro_assignedДіяТікет було автоматично призначено агенту.int $id, int $agentПрофесійна версія
zinn_chat_pro_loadedДіяШару Pro завантажено.жоденПрофесійна версія
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ДіяВикликається після того, як відвідувач оцінює розмову, передаючи ідентифікатор розмови та оцінку (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 додає власні перемикачі та слова).жоденБезкоштовна версія