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

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

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

Ръководство за потребителя: свързване на AI приложение

Zinn®, нашият викинг, ликува, докато AI асистентът се свързва с инструментите на платформата.

Крайна точка

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 и входните им данни в заявката (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-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
Попитайте асистента
Задава въпрос на AI асистент на сайта и връща неговия отговор с всеки намерен източник.
Безплатно издание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: само съобщения, по-нови от това 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 дни (дни).
Про версия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
Отговор в чат
Изпраща съобщение до посетителя (текст) или добавя вътрешна бележка, която виждат само агентите (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
Напишете чернова на отговор с AI (Pro)
Черornovikва отговор на чат или билет от съдържанието на сайта; нищо не се изпраща.
Про версия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 адреса, от който се зарежда самостоятелният 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 добавя собствени ключове и думи).нямаБезплатно издание