Розробники
Довідник можливостей 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 плагіна, який у свою чергу згенеровано з працюючого сайту; тест не проходить, якщо вони не збігаються.
| Можливість | Що робить | Видання | ВІДПОЧИНОК | Дозвіл | Параметри |
|---|---|---|---|---|---|
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 тікетів (ідентифікаторів). Кожен тікет проходить такі ж перевірки, як і при зміні окремо; результат містить перелік кожного з них. | Професійна версія | 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) Створює чорнетки статей бази знань, що відповідають на вибрані запитання (ids); вони залишаються чорнетками. | Професійна версія | 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: лише повідомлення, новіші за цей ідентифікатор). | Безкоштовна версія | 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). | Професійна версія | 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) Встановлює відділ і теги чату або тікета (вид: чат або тікет; 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) Позначає безвідповідні запитання як відкриті, заплановані або відхилені (ідентифікатори, статус). | Професійна версія | 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) Створює проєкт відповіді на чат або тікет на основі вмісту сайту; нічого не надсилається. | Професійна версія | 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) Підсумовує чат або тікет у кількох рядках. | Професійна версія | 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, які може відкривати обліковий запис агента підтримки. | жоден | Професійна версія |
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 додає власні перемикачі та слова). | жоден | Безкоштовна версія |