Vývojáři

Referat schopností pluginu Zinn® Chat

Zinn® Chat registruje své akce pomocí WordPress Abilities API. Stejné schopnosti jsou nástroji MCP na vlastním serveru webu a cestami REST pod /wp-json/wp-abilities/v1. Tato stránka je generována z vlastního registru pluginu.

Uživatelská příručka: připojení aplikace s umělou inteligencí

Zinn®, náš Viking, jásá, když se asistent s umělou inteligencí připojuje k nástrojům platformy.

Koncové body

MCP přes HTTP (streamovatelné)

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

MCP přes WP-CLI (standardní vstup a výstup)

wp mcp-adapter serve --server=zinn-chat --user=<login>

REST: vypsat funkce

/wp-json/wp-abilities/v1/abilities?category=zinn-chat

REST: spustit schopnost

/wp-json/wp-abilities/v1/abilities/<name>/run

Autentizace a oprávnění

HTTP požadavky se ověřují pomocí aplikačního hesla WordPress (HTTP Basic). Připojení k serveru MCP vyžaduje níže zobrazenou oprávněnost; každá schopnost pak kontroluje své vlastní oprávnění pro každý objekt. Schopnosti pouze pro čtení běží s metodou GET a vstupem v řetězci dotazu; ostatní s metodou POST a tělem JSON {„input“: {…}}.

Příklady

# REST: spustit schopnost
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":{}}}

Všechny oprávnění

Vygenerováno ze souboru abilities.json v pluginu, který se sám generuje z běžícího webu; test selže, pokud se tyto dva zdroje neshodují.

OprávněníCo to děláEdiceRESTOprávněníParametry
zinn-chat/answer-ticket
zinn-chat-answer-ticket
Odpovědět na tiket
Odpovídá zákazníkovi e-mailem (text) nebo přidává interní poznámku (note: true); status volitelně mění stav tiketu.
Bezplatná edicePOST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/ask-assistant
zinn-chat-ask-assistant
Zeptat se asistenta
Položí otázku AI asistentovi webu a vrátí jeho odpověď včetně každého nalezeného zdroje.
Bezplatná edicePOST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission checkquestion: string (povinné), language: string
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
Hromadná úprava tiketů (Pro)
Změní stav, prioritu nebo řešitele až 100 tiketů (podle ID). Každý tiket projde stejnými kontrolami jako při samostatné úpravě; výsledek vypíše každý z nich.
Edice ProPOST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (povinné), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-chat-chat-to-ticket
Změnit chat na tiket
Otevře tiket z chatu, aby jej bylo možné vyřídit e-mailem (vyžaduje e-mailovou adresu návštěvníka).
Bezplatná edicePOST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/close-chat
zinn-chat-close-chat
Zavřít chat
Ukončí chat; návštěvník může stále požádat o přepis.
Bezplatná edicePOST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/create-ticket
zinn-chat-create-ticket
Založit tiket
Otevře tiket jménem zákazníka (jeho e-mail, předmět a první zprávu).
Bezplatná edicePOST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission checkemail: string (povinné), subject: string (povinné), body: string (povinné), name: string
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
Odstranit uloženou odpověď (Pro)
Smaže uloženou odpověď.
Edice ProPOST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
Odstranit tiket
Trvale odstraní tiket včetně celé konverzace (pouze pro manažery).
Bezplatná edicePOST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/draft-kb-article
zinn-chat-draft-kb-article
Napsat nápovědu z tiketu (Pro)
Vytvoří koncept článku znalostní báze z vyřešeného ticketu; dokud jej člověk nezveřejní, zůstává konceptem.
Edice ProPOST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)ticket: integer (povinné)
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
Koncepty článků nápovědy pro nezodpovězené otázky (Pro)
Píše koncepty článků znalostní báze, které odpovídají na vybrané otázky (ids); zůstávají v konceptu.
Edice ProPOST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)ids: array (povinné)
zinn-chat/fill-canned-reply
zinn-chat-fill-canned-reply
Vyplnit uloženou odpověď (Pro)
Vrátí text uložené odpovědi s vyplněnými zástupnými symboly pro jeden chat nebo požadavek.
Edice ProPOST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/get-chat
zinn-chat-get-chat
Přečíst chat
Vrátí zprávy a podrobnosti o návštěvníkovi daného chatu (after: pouze zprávy novější než toto ID).
Bezplatná ediceGET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/get-overview
zinn-chat-get-overview
Přečíst si přehled podpory
Vrací počet tiketů v jednotlivých stavech, počet chatů čekajících na operátora (včetně jejich nepřečtených zpráv) a informaci o tom, zda jsou chat, asistent a tikety zapnuté.
Bezplatná ediceGET …/abilities/zinn-chat/get-overview/runzinn_chat_answeržádné
zinn-chat/get-settings
zinn-chat-get-settings
Přečíst nastavení chatu
Vrátí všechna nastavení chatu: widget, asistenta, lidi a otevírací dobu, tikety a e-mail, index stránek, soukromí a spam.
Bezplatná ediceGET …/abilities/zinn-chat/get-settings/runzinn_chat_managežádné
zinn-chat/get-stats
zinn-chat-get-stats
Přečíst statistiky podpory (Pro)
Vrací čísla chatů a tiketů, doby odezvy a hodnocení za posledních N dnů (dny).
Edice ProGET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission checkdays: integer
zinn-chat/get-ticket
zinn-chat-get-ticket
Přečíst tiket
Vrací jeden tiket včetně celé jeho konverzace, stavu, priority a řešitele.
Bezplatná ediceGET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/hand-chat-to-assistant
zinn-chat-hand-chat-to-assistant
Přenechat chat zpět asistentovi
Vrátí chat s asistentem AI, který odpovídá návštěvníkovi na základě obsahu stránek.
Bezplatná edicePOST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
Seznam uložených odpovědí (Pro)
Zobrazuje seznam uložených odpovědí, které mohou agenti vkládat, včetně jejich zástupců.
Edice ProGET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission checkžádné
zinn-chat/list-chats
zinn-chat-list-chats
Zobrazit živé chaty
Zobrazuje čekající, probíhající a nedávno uzavřené chaty a uvádí, kdo každý z nich vyřizuje.
Bezplatná ediceGET …/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
Zobrazit, co asistent ví
Umožňuje procházet obsah, ze kterého asistent odpovídá, včetně stavu jeho indexování, vždy po jedné stránce.
Bezplatná ediceGET …/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
Zobrazit nezodpovězené otázky (Pro)
Zobrazuje seznam otázek, které návštěvníci položili a na které databáze znalostí nedokázala odpovědět.
Edice 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
Seznam požadavků
Vypisuje lístky podpory filtrované podle stavu nebo hledání, vždy po jedné stránce.
Bezplatná ediceGET …/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
Obnovit vyhledávací index asistenta
Přestaví vyhledávací vektory pro jednu položku (item_id) nebo pro všechno (all: true) (pouze pro správce).
Bezplatná edicePOST …/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
Načíst obsah znovu do asistenta
Znovu načte jednu položku (item_id) nebo vše (all: true) do indexu asistenta (pouze pro správce).
Bezplatná edicePOST …/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
Odpovědět v chatu
Odešle návštěvníkovi zprávu (text) nebo přidá interní poznámku, kterou vidí pouze agenti (note: true).
Bezplatná edicePOST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/save-canned-reply
zinn-chat-save-canned-reply
Uložit uloženou odpověď (Pro)
Vytvoří nebo změní uloženou odpověď (název, zástupce, tělo, oddělení; id pro změnu jedné).
Edice ProPOST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission checkid: integer, title: string (povinné), body: string (povinné), shortcut: string, department: string
zinn-chat/save-kb-article
zinn-chat-save-kb-article
Napsat nápovědní článek (Pro)
Vytvoří článek báze znalostí nebo jej upraví (id): název, obsah, výňatek, kategorie a stav (koncept nebo publikovat, když můžete publikovat).
Edice 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
Prohledat znalostní bázi (Pro)
Vyhledá články nápovědy k odkazování v odpovědi (q: hledaný výraz).
Edice ProGET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission checkq: string (povinné)
zinn-chat/set-conversation-details
zinn-chat-set-conversation-details
Nastavit oddělení a štítky konverzace (Pro)
Nastaví oddělení a štítky chatu nebo ticketu (typ: chat nebo ticket; id).
Edice ProPOST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (povinné), department: string, tags: array
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
Označit nezodpovězené otázky (Pro)
Označuje nezodpovězené otázky jako otevřené, plánované nebo zamítnuté (ID, stav).
Edice ProPOST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission checkids: array (povinné), status: open|drafted|answered|ignored (povinné)
zinn-chat/set-presence
zinn-chat-set-presence
Nastavte svou dostupnost
Nastaví přihlášeného agenta jako dostupného nebo nepřítomného pro nové chaty (away: true nebo false).
Bezplatná edicePOST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkaway: boolean
zinn-chat/suggest-reply
zinn-chat-suggest-reply
Napsat odpověď pomocí AI (Pro)
Připraví návrh odpovědi na chat nebo tiket na základě obsahu webu; nic se neodesílá.
Edice ProPOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (povinné)
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
Shrnout konverzaci s umělou inteligencí (Pro)
Shrne chat nebo tiket v několika řádcích.
Edice ProPOST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (povinné)
zinn-chat/take-chat
zinn-chat-take-chat
Zahájit chat
Přiřadí čekající chat přihlášenému agentovi, takže návštěvník mluví s člověkem.
Bezplatná edicePOST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (povinné)
zinn-chat/update-settings
zinn-chat-update-settings
Změnit nastavení chatu
Změní nastavení, která odešlete (nastavení: klíč na hodnotu), a zachová ostatní. Každá hodnota se kontroluje přesně jako na obrazovce nastavení; get-settings vypíše klíče.
Bezplatná edicePOST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (povinné)
zinn-chat/update-ticket
zinn-chat-update-ticket
Změnit tiket
Změní stav, prioritu nebo řešitele ticketu.
Bezplatná edicePOST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: string (povinné)

Akce a filtry

Každý háček, který plugin nabízí, včetně popisu z jeho zdrojového kódu. Filtry mění hodnotu; akce vám umožňují spustit kód v daném okamžiku; vstupní body jsou akce, které spouštíte, abyste plugin požádali o provedení nějaké akce.

WebhookDruhCo to děláParametryEdice
zinn_chat_admin_pagesFiltrovatFiltruje administrátorské obrazovky Zinn® Chat (Pro přidává vlastní).žádnéBezplatná edice
zinn_chat_agent_chatFiltrovatFiltruje užitečná data chatu pro konzoli agenta (verze Pro přidává podrobnosti o návštěvníkovi, poznámky a návrhy KB).žádnéBezplatná edice
zinn_chat_agent_pagesFiltrovatFiltruje obrazovky chatu Zinn® Chat, které může účet agenta podpory otevřít.žádnéEdice Pro
zinn_chat_agent_script_srcFiltrovatFiltruje adresu URL, ze které se načítá samostatný agent umělé inteligence pro chat.string $srcBezplatná edice
zinn_chat_agent_ticketFiltrovatFiltruje užitečná data požadavku pro wp-admin (Pro přidává předpřipravené odpovědi, SLA, návrhy KB).žádnéBezplatná edice
zinn_chat_answerFiltrovatFiltruje odpověď asistenta před jejím zobrazením (verze Pro zde přidává své doplňky).string $questionBezplatná edice
zinn_chat_assistant_answeredAkceAsistent odpověděl návštěvníkovi.int $id, string $textBezplatná edice
zinn_chat_challengeFiltrovatFiltruje lidskou kontrolu zobrazenou návštěvníkům (URL skriptu, klíč webu a globální objekt, který skript definuje pomocí metody `render( element, { sitekey, callback } )`).žádnéBezplatná edice
zinn_chat_challenge_okFiltrovatFiltruje, zda návštěvník prošel ověřením lidskosti. Ověření, které nelze potvrdit, musí vrátit hodnotu false (selhat v uzavřeném stavu): formulář, který propustí vše, kdykoliv je služba nedostupná, je formulář, který bot dokáže úspěšně odeslat pomocí načasování.bool $ok, string $ip, string $whereBezplatná edice
zinn_chat_client_ipFiltrovatFiltruje IP adresu návštěvníka používanou pro limity požadavků a záznamy.string $ipBezplatná edice
zinn_chat_console_configFiltrovatFiltruje dodatečnou konfiguraci předanou skriptu konzole operátora; Zinn® Chat Pro zde přidává své funkce.žádnéBezplatná edice
zinn_chat_conversation_startedAkceNávštěvník zahájil chat.int $idBezplatná edice
zinn_chat_conversation_statusAkceKonverzace změнила stav.int $id, string $status, string $oldBezplatná edice
zinn_chat_customer_ticket_urlFiltrovatFiltruje odkaz, který je zákazníkovi odeslán pro jeho tiket.string $urlBezplatná edice
zinn_chat_elementsFiltrovatFiltruje prvky front-endu nabízené jako bloky a moduly tvůrce.žádnéBezplatná edice
zinn_chat_emailFiltrovatFiltruje e-mail před jeho odesláním. Vraťte prázdné `to`, abyste ho zastavili.žádnéBezplatná edice
zinn_chat_fs_loadedAkceSpustí se po načtení SDK licenčního klíče (v hlavním souboru před jakýmkoli kódem Zinn® Chat). Zde se můžete napojit na `zinn_chat_fs()`.žádnéBezplatná edice
zinn_chat_index_extractFiltrovatFiltruje extrahovaný objekt (nebo poskytuje objekt pro vlastní typ objektu).string $type, int $idBezplatná edice
zinn_chat_index_languageFiltrovatFiltruje jazyk (lokalizaci) indexovaného příspěvku.string $language, \WP_Post $postBezplatná edice
zinn_chat_index_objectVstupní bod (spustíte ho)HookyžádnéBezplatná edice
zinn_chat_index_post_typesFiltrovatFiltruje typy příspěvků, které asistent čte.žádnéBezplatná edice
zinn_chat_indexableFiltrovatFiltruje, zda je příspěvek indexován.bool $indexable, \WP_Post $postBezplatná edice
zinn_chat_indexedAkceObjekt byl (re)indexován.string $type, int $idBezplatná edice
zinn_chat_is_proFiltrovatFiltruje, zda se spouštějí funkce Pro (zakoupená licence nebo zkušební verze od Freemius). Kód Pro je dodáván pouze v prémiovém balíčku, takže nemůže doplnit to, co bezplatná verze postrádá.bool $proBezplatná edice
zinn_chat_loadedAkceZinn® Chat se načetl (rozšiřující bod pro doplňky).žádnéBezplatná edice
zinn_chat_message_addedAkceDo konverzace byla přidána zpráva.int $id, int $conversation_id, string $roleBezplatná edice
zinn_chat_order_trackingFiltrovatFiltruje sledovací údaje poskytnuté asistentovi pro objednávku.\WC_Order $orderBezplatná edice
zinn_chat_pro_alertAkceDošlo k události hodné upozornění (zde naslouchají oznámení push).string $alert, int $id, string $text, string $linkEdice Pro
zinn_chat_pro_assignedAkceTicket byl automaticky přiřazen agentovi.int $id, int $agentEdice Pro
zinn_chat_pro_loadedAkceVrstva Pro se načetla.žádnéEdice Pro
zinn_chat_pro_priority_changedAkcePriorita ticketu se změnila (řídí se cíli SLA).int $idEdice Pro
zinn_chat_pro_sla_breachAkceCíl SLA nebyl splněn.int $ticket_id, string $whichEdice Pro
zinn_chat_pro_ticket_ratedAkceZákazník ohodnotil vyřešený tiket (1-5).int $id, int $scoreEdice Pro
zinn_chat_ratedAkceSpustí se poté, co návštěvník ohodnotí konverzaci, spolu s ID konverzace a hodnocením (1 pro užitečné, -1 pro neužitečné).int $conversation_id, int $ratingBezplatná edice
zinn_chat_role_capabilitiesFiltrovatFiltruje, které role získají jednotlivé funkce Zinn® Chat.žádnéBezplatná edice
zinn_chat_save_settingsFiltrovatFiltruje nastavení před jejich uložením (verze Pro zde přidává vlastní klíče).žádnéBezplatná edice
zinn_chat_script_srcFiltrovatFiltruje adresu URL, ze které se načítá widget hostovaného chatu (připojený režim).string $srcBezplatná edice
zinn_chat_settings_beforeAkceVýstup nad formulářem karty nastavení.string $tabBezplatná edice
zinn_chat_settings_fieldsFiltrovatFiltruje pole karty nastavení (verze Pro přidává vlastní).string $tabBezplatná edice
zinn_chat_settings_tabsFiltrovatFiltruje karty nastavení.žádnéBezplatná edice
zinn_chat_setup_afterAkceVýstup v kontrolním seznamu nastavení (bezplatná edice zde zobrazuje kartu Pro).žádnéBezplatná edice
zinn_chat_should_renderFiltrovatFiltruje, zda se chat vykresluje v tomto požadavku (háčky cílení stránek Pro se připojují zde).bool $renderBezplatná edice
zinn_chat_site_factsFiltrovatFiltruje fakta o webu předávaná asistentovi s každou otázkou. Každé z nich tvoří `title`, `url` (na tomto webu) a `text` (prostý text, maximálně 3 000 znaků); použijí se maximálně čtyři.string $languageBezplatná edice
zinn_chat_site_stringsFiltrovatFiltruje texty vlastníka nabízené k překladu (verze Pro přidává své proaktivní zprávy).žádnéBezplatná edice
zinn_chat_system_promptFiltrovatFiltruje systémový prompt asistenta (Pro: personu a pravidla předání).string $rulesBezplatná edice
zinn_chat_team_onlineFiltrovatUrčuje, zda může osoba nyní odpovědět (verze Pro zde přidává pracovní dobu).bool $onlineBezplatná edice
zinn_chat_ticket_assignedAkceAn agent assigned a ticket to an agent (2.14.0: the notification centre tells them).int $id, int $assignee, int $byBezplatná edice
zinn_chat_ticket_createdAkceByl založen tiket. Poštovní klient odtud odesílá potvrzení a upozornění pro tým.int $id, string $tokenBezplatná edice
zinn_chat_ticket_form_extraFiltrovatFiltruje dodatečné značkování na konci formuláře pro hosty (zde probíhá lidská kontrola Pro).string $htmlBezplatná edice
zinn_chat_ticket_form_fieldsFiltrovatFiltruje další pole zobrazená nad zprávou v každém formuláři tiketu (Pro: výběr oddělení). Pojmenujte je `zinn_chat_extra[<key>]`; dorazí do `zinn_chat_ticket_created` jako `$fields['extra']`, neošetřená, k ověření pro toho, kdo je přidal.string $htmlBezplatná edice
zinn_chat_ticket_replyAkceK tiketu byla přidána odpověď. Mailer odtud odesílá e-mail druhé straně.int $id, int $ticket_id, string $authorBezplatná edice
zinn_chat_ticket_statusAkceStav ticketu se změnil.int $id, string $status, string $oldBezplatná edice
zinn_chat_uninstallAkceZinn® Chat se odinstaluje (Pro zde odstraní vlastní data).žádnéBezplatná edice
zinn_chat_widget_configFiltrovatFiltruje konfiguraci spouštěče zobrazenou na stránce.žádnéBezplatná edice
zinn_chat_widget_statusFiltrovatFiltruje to, co otevřený chat přijímá (verze Pro přidává vlastní přepínače a slova).žádnéBezplatná edice