Разработчици
Справка за възможностите на 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 и входните им данни в заявката (query string); останалите с 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 | Попитайте асистента Задава въпрос на 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) Пише чернови на статии от базата знания, отговарящи на избраните въпроси (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: само съобщения, по-нови от това 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 | Отговор в чат Изпраща съобщение до посетителя (текст) или добавя вътрешна бележка, която виждат само агентите (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 | Напишете чернова на отговор с AI (Pro) Черornovikва отговор на чат или билет от съдържанието на сайта; нищо не се изпраща. | Про версия | 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 адреса, от който се зарежда самостоятелният AI агент за чат. | string $src | Безплатно издание |
zinn_chat_agent_ticket | Филтриране | Филтрира полезния товар на тикета за wp-admin (версията Pro добавя готови отговори, SLA и предложения от базaта знания). | няма | Безплатно издание |
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 | Действие | Про слой се зареди. | няма | Про версия |
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 добавя собствени ключове и думи). | няма | Безплатно издание |