Ontwikkelaars

Referentie van Zinn® Chat-functionaliteiten

Zinn® Chat registreert zijn acties bij de WordPress Abilities API. Dezelfde vaardigheden zijn MCP-tools op de eigen server van de site en REST-routes onder /wp-json/wp-abilities/v1. Deze pagina is gegenereerd vanuit het eigen register van de plugin.

Gebruikershandleiding: een AI-app verbinden

Zinn®, onze Viking, juicht terwijl een AI-assistent verbinding maakt met de tools van het platform.

Eindpunten

MCP over HTTP (streamable)

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

MCP over WP-CLI (standaard invoer en uitvoer)

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

REST: toon de mogelijkheden

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

REST: voer een functie uit

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

Authenticatie en machtigingen

HTTP-verzoeken verifiëren met een WordPress-applicatiewachtwoord (HTTP Basic). Voor het verbinden met de MCP-server is de hieronder getoonde functionaliteit vereist; elke vaardigheid controleert vervolgens haar eigen permissie, per object. Alleen-lezen-vaardigheden worden uitgevoerd met GET en hun invoer in de query-tekenreeks; de overige met POST en een JSON-body {"input": {…}}.

Voorbeelden

# REST: voer een functie uit
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":{}}}

Alle bevoegdheden

Gegenereerd op basis van abilities.json van de plug-in, die op zijn beurt is gegenereerd vanuit een actieve site; een test mislukt wanneer deze twee niet met elkaar overeenkomen.

MogelijkheidWat het doetEditieRESTMachtigingParameters
zinn-chat/answer-ticket
zinn-chat-answer-ticket
Beantwoord een ticket
Beantwoordt de klant per e-mail (text) of voegt een interne notitie toe (note: true); status wijzigt optioneel de status van het ticket.
Gratis editiePOST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/ask-assistant
zinn-chat-ask-assistant
Vraag de assistent
Stelt een vraag aan de AI-assistent van de site en retourneert het antwoord met elke gevonden bron.
Gratis editiePOST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission checkquestion: string (verplicht), language: string
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
Wijzig meerdere tickets tegelijk (Pro)
Wijzigt de status, prioriteit of toegewezene van maximaal 100 tickets (ids). Elk ticket doorloopt dezelfde controles als bij een afzonderlijke wijziging; het resultaat toont elk ticket.
Pro-editiePOST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (verplicht), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-chat-chat-to-ticket
Zet een chat om in een ticket
Opent een ticket vanuit een chat zodat deze per e-mail kan worden beantwoord (vereist het e-mailadres van de bezoeker).
Gratis editiePOST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/close-chat
zinn-chat-close-chat
Sluit een chat
Beëindigt een chat; de bezoeker kan nog steeds het transcript aanvragen.
Gratis editiePOST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/create-ticket
zinn-chat-create-ticket
Open een ticket
Opent een ticket namens een klant (diens e-mailadres, een onderwerp en het eerste bericht).
Gratis editiePOST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission checkemail: string (verplicht), subject: string (verplicht), body: string (verplicht), name: string
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
Een opgeslagen antwoord verwijderen (Pro)
Verwijdert een opgeslagen antwoord.
Pro-editiePOST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
Een ticket verwijderen
Verwijdert een ticket en het bijbehorende gesprek definitief (alleen voor beheerders).
Gratis editiePOST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/draft-kb-article
zinn-chat-draft-kb-article
Maak een concept van een hulpartikel vanuit een ticket (Pro)
Schrijft een concept voor een kennisbankartikel vanuit een opgelost ticket; het blijft een concept totdat iemand het publiceert.
Pro-editiePOST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)ticket: integer (verplicht)
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
Concept-hulpartikelen opstellen voor onbeantwoorde vragen (Pro)
Schrijft conceptartikelen voor de kennisbank die de gekozen vragen (id's) beantwoorden; ze blijven concepten.
Pro-editiePOST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)ids: array (verplicht)
zinn-chat/fill-canned-reply
zinn-chat-fill-canned-reply
Een opgeslagen antwoord invoegen (Pro)
Retourneert de tekst van een opgeslagen antwoord met ingevulde tijdelijke aanduidingen voor één chat of ticket.
Pro-editiePOST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/get-chat
zinn-chat-get-chat
Lees een chat
Retourneert berichten en bezoekersgegevens van één chat (after: alleen berichten nieuwer dan deze id).
Gratis editieGET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/get-overview
zinn-chat-get-overview
Lees het ondersteuningsoverzicht
Geeft aan hoeveel tickets zich in elke status bevinden, hoeveel chats er wachten op een persoon (en de ongelezen berichten daarvan) en of de chat, de assistent en tickets zijn ingeschakeld.
Gratis editieGET …/abilities/zinn-chat/get-overview/runzinn_chat_answergeen
zinn-chat/get-settings
zinn-chat-get-settings
Lees de chatinstellingen
Retourneert elke chatinstelling: de widget, de assistent, mensen en openingstijden, tickets en e-mail, de site-index, privacy en spam.
Gratis editieGET …/abilities/zinn-chat/get-settings/runzinn_chat_managegeen
zinn-chat/get-stats
zinn-chat-get-stats
Ondersteuningsstatistieken lezen (Pro)
Retourneert aantallen chats en tickets, reactietijden en beoordelingen voor de afgelopen N dagen (dagen).
Pro-editieGET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission checkdays: integer
zinn-chat/get-ticket
zinn-chat-get-ticket
Ticket lezen
Retourneert één ticket met het hele gesprek, status, prioriteit en toegewezen persoon.
Gratis editieGET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/hand-chat-to-assistant
zinn-chat-hand-chat-to-assistant
Draag de chat weer over aan de assistent
Stuurt een chat terug naar de AI-assistent, die de bezoeker antwoordt op basis van de inhoud van de site.
Gratis editiePOST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
Opgeslagen antwoorden tonen (Pro)
Geeft een overzicht van de opgeslagen antwoorden die agenten kunnen invoegen, met hun sneltoetsen.
Pro-editieGET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission checkgeen
zinn-chat/list-chats
zinn-chat-list-chats
Live chats weergeven
Toont een lijst van wachtende, actieve en recent gesloten chats, inclusief wie elke chat behandelt.
Gratis editieGET …/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
Maak een lijst van wat de assistent weet
Geeft een overzicht van de inhoud waaruit de assistent antwoordt, met de indexeringsstatus, pagina voor pagina.
Gratis editieGET …/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
Onbeantwoorde vragen weergeven (Pro)
Toont de vragen die bezoekers hebben gesteld en waarop de kennisbank geen antwoord kon geven.
Pro-editieGET …/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
Tickets weergeven
Toont supporttickets, gefilterd op status of zoekopdracht, pagina per pagina.
Gratis editieGET …/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
Bouw de zoekindex van de assistent opnieuw op
Bouwt de zoekvectoren opnieuw op voor één item (item_id) of alles (all: true) (alleen beheerders).
Gratis editiePOST …/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
Lees de inhoud opnieuw in de assistent
Leest één item (item_id) of alles (all: true) opnieuw in de index van de assistent (alleen beheerders).
Gratis editiePOST …/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
Reageer in een chat
Verstuurt een bericht naar de bezoeker (text) of voegt een interne notitie toe die alleen agents kunnen zien (note: true).
Gratis editiePOST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/save-canned-reply
zinn-chat-save-canned-reply
Een opgeslagen antwoord opslaan (Pro)
Maakt een opgeslagen antwoord aan of wijzigt dit (titel, snelkoppeling, inhoud, afdeling; id om er een te wijzigen).
Pro-editiePOST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission checkid: integer, title: string (verplicht), body: string (verplicht), shortcut: string, department: string
zinn-chat/save-kb-article
zinn-chat-save-kb-article
Schrijf een hulpartikel (Pro)
Maakt een kennisbankartikel aan of wijzigt er een (id): titel, inhoud, samenvatting, categorieën en status (concept of publiceren wanneer je mag publiceren).
Pro-editiePOST …/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
Doorzoek de kennisbank (Pro)
Vindt hulpartikelen om in een antwoord te linken (q: de zoekopdracht).
Pro-editieGET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission checkq: string (verplicht)
zinn-chat/set-conversation-details
zinn-chat-set-conversation-details
Stel de afdeling en tags van een gesprek in (Pro)
Stelt de afdeling en tags van een chat of ticket in (kind: chat of ticket; id).
Pro-editiePOST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (verplicht), department: string, tags: array
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
Onbeantwoorde vragen markeren (Pro)
Markeert onbeantwoorde vragen als open, gepland of afgewezen (ids, status).
Pro-editiePOST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission checkids: array (verplicht), status: open|drafted|answered|ignored (verplicht)
zinn-chat/set-presence
zinn-chat-set-presence
Stel je beschikbaarheid in
Markeert de ingelogde agent als beschikbaar of afwezig voor nieuwe chats (away: true of false).
Gratis editiePOST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkaway: boolean
zinn-chat/suggest-reply
zinn-chat-suggest-reply
Stel een antwoordconcept op met AI (Pro)
Stelt een conceptantwoord op voor een chat of ticket op basis van de site-inhoud; er wordt niets verzonden.
Pro-editiePOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (verplicht)
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
Vat een gesprek samen met AI (Pro)
Vat een chat of ticket samen in een paar regels.
Pro-editiePOST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (verplicht)
zinn-chat/take-chat
zinn-chat-take-chat
Neem een chat aan
Wijst een wachtende chat toe aan de ingelogde agent, zodat de bezoeker met een echt persoon praat.
Gratis editiePOST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (verplicht)
zinn-chat/update-settings
zinn-chat-update-settings
Wijzig de chatinstellingen
Wijzigt de instellingen die je verstuurt (instellingen: sleutel naar waarde) en behoudt de rest. Elke waarde wordt precies zoals op het instellingenscherm gecontroleerd; get-settings toont de sleutels.
Gratis editiePOST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (verplicht)
zinn-chat/update-ticket
zinn-chat-update-ticket
Wijzig een ticket
Wijzigt de status, prioriteit of toegewezene van een ticket.
Gratis editiePOST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: string (verplicht)

Acties en filters

Elke hook die de plugin biedt, met de beschrijving uit de broncode. Filters veranderen een waarde; met acties kunt u op een bepaald moment code uitvoeren; ingangspunten zijn acties die u triggert om de plugin iets te laten doen.

WebhookAardWat het doetParametersEditie
zinn_chat_admin_pagesFilterenFiltert de beheerschermen van Zinn® Chat (Pro voegt eigen schermen toe).geenGratis editie
zinn_chat_agent_chatFilterenFiltert de chat-payload voor de agentconsole (Pro voegt bezoekersdetails, notities en KB-suggesties toe).geenGratis editie
zinn_chat_agent_pagesFilterenFiltert de Zinn® Chat-schermen die een Ondersteuningsagent-account kan openen.geenPro-editie
zinn_chat_agent_script_srcFilterenFiltert de URL waarvan de standalone AI-chatagent wordt geladen.string $srcGratis editie
zinn_chat_agent_ticketFilterenFiltert de ticket-payload voor wp-admin (Pro voegt standaardantwoorden, SLA, KB-suggesties toe).geenGratis editie
zinn_chat_answerFilterenFiltert een assistentantwoord voordat het wordt weergegeven (Pro vo ഇവിടെ extra's aan toe).string $questionGratis editie
zinn_chat_assistant_answeredActieDe assistent heeft een bezoeker geantwoord.int $id, string $textGratis editie
zinn_chat_challengeFilterenFiltert de menselijke controle die aan bezoekers wordt getoond (script-URL, sitesleutel en het globale object dat het script definieert met een `render( element, { sitekey, callback } )`-methode).geenGratis editie
zinn_chat_challenge_okFilterenBepaalt of de bezoeker de menselijke controle heeft doorstaan. Een controle die niet kan worden geverrified, moet false retourneren (fail closed): een formulier dat alles doorlaat wanneer de service onbereikbaar is, is een formulier dat een bot kan laten slagen door middel van timing.bool $ok, string $ip, string $whereGratis editie
zinn_chat_client_ipFilterenFiltert het IP-adres van de bezoeker dat wordt gebruikt voor snelheidslimieten en records.string $ipGratis editie
zinn_chat_console_configFilterenFiltert de extra configuratie die wordt doorgegeven aan het script van de operatorconsole; Zinn® Chat Pro voegt hier zijn functies aan toe.geenGratis editie
zinn_chat_conversation_startedActieEen bezoeker is een chat gestart.int $idGratis editie
zinn_chat_conversation_statusActieEen conversatie heeft van status gewisseld.int $id, string $status, string $oldGratis editie
zinn_chat_customer_ticket_urlFilterenFiltert de link die een klant ontvangt voor zijn of haar ticket.string $urlGratis editie
zinn_chat_elementsFilterenFiltert de front-end elementen die worden aangeboden als blokken en bouwmodules.geenGratis editie
zinn_chat_emailFilterenFiltreert een e-mail voordat deze wordt verzonden. Retourneer een lege `to` om dit te stoppen.geenGratis editie
zinn_chat_fs_loadedActieWordt uitgevoerd zodra de licentie-SDK is geladen (in het hoofdbestand, vóór enige Zinn® Chat-code). Koppel hier om te communiceren met `zinn_chat_fs()`.geenGratis editie
zinn_chat_index_extractFilterenFiltert een geëxtraheerd object (of levert er een voor een aangepast objecttype).string $type, int $idGratis editie
zinn_chat_index_languageFilterenFiltert de taal (landinstelling) van een geïndexeerd bericht.string $language, \WP_Post $postGratis editie
zinn_chat_index_objectInvoerpunt (u vuurt dit af)Hooks.geenGratis editie
zinn_chat_index_post_typesFilterenFiltert de berichttypen die de assistent leest.geenGratis editie
zinn_chat_indexableFilterenFiltert of een bericht wordt geïndexeerd.bool $indexable, \WP_Post $postGratis editie
zinn_chat_indexedActieEen object is opnieuw geïndexeerd.string $type, int $idGratis editie
zinn_chat_is_proFilterenBepaalt of de Pro-functies worden uitgevoerd (een aangeschafte licentie of een proefversie via Freemius). De Pro-code wordt alleen meegeleverd in het premiumpakket, dus dit kan niet toevoegen wat de gratis versie mist.bool $proGratis editie
zinn_chat_loadedActieZinn® Chat is geladen (het extensiepunt voor add-ons).geenGratis editie
zinn_chat_message_addedActieEr is een bericht toegevoegd aan een conversatie.int $id, int $conversation_id, string $roleGratis editie
zinn_chat_order_trackingFilterenFiltert de trackinginformatie die aan de assistent wordt verstrekt voor een bestelling.\WC_Order $orderGratis editie
zinn_chat_pro_alertActieEr heeft zich een meldingwaardige gebeurtenis voorgedaan (pushmeldingen luisteren hier mee).string $alert, int $id, string $text, string $linkPro-editie
zinn_chat_pro_assignedActieEr is automatisch een ticket toegewezen aan een medewerker.int $id, int $agentPro-editie
zinn_chat_pro_loadedActieDe Pro-laag is geladen.geenPro-editie
zinn_chat_pro_priority_changedActieDe prioriteit van een ticket is gewijzigd (SLA-doelstellingen worden hierop aangepast).int $idPro-editie
zinn_chat_pro_sla_breachActieEr is niet voldaan aan een SLA-doelstelling.int $ticket_id, string $whichPro-editie
zinn_chat_pro_ticket_ratedActieEen klant heeft een opgelost ticket beoordeeld (1-5).int $id, int $scorePro-editie
zinn_chat_ratedActieWordt geactiveerd nadat een bezoeker een conversatie beoordeelt, met de conversatie-id en de beoordeling (1 voor nuttig, -1 voor niet).int $conversation_id, int $ratingGratis editie
zinn_chat_role_capabilitiesFilterenBepaalt welke rollen welke Zinn® Chat-functionaliteiten ontvangen.geenGratis editie
zinn_chat_save_settingsFilterenFilter instellingen voordat ze worden opgeslagen (Pro voegt hier eigen sleutels aan toe).geenGratis editie
zinn_chat_script_srcFilterenFiltert de URL waarvan de gehoste chatwidget wordt geladen (verbonden modus).string $srcGratis editie
zinn_chat_settings_beforeActieBoven het formulier van een instellingentabblad weergeven.string $tabGratis editie
zinn_chat_settings_fieldsFilterenFiltert de velden van een instellingentabblad (Pro voegt zijn eigen toe).string $tabGratis editie
zinn_chat_settings_tabsFilterenFiltert de instellingstabbladen.geenGratis editie
zinn_chat_setup_afterActieUitvoer onder de installatiechecklist (de gratis editie toont hier de Pro-kaart).geenGratis editie
zinn_chat_should_renderFilterenBepaalt of de chat wordt weergegeven voor dit verzoek (hier worden de paginagerichte hooks van Pro gekoppeld).bool $renderGratis editie
zinn_chat_site_factsFilterenFiltert de feiten over de site die bij elke vraag aan de assistent worden verstrekt. Elk item bestaat uit `title`, `url` (op deze site) en `text` (platte tekst, maximaal 3.000 tekens); er worden er maximaal vier gebruikt.string $languageGratis editie
zinn_chat_site_stringsFilterenFiltert de voor vertaling aangeboden eigenaarsteksten (Pro voegt zijn proactieve berichten toe).geenGratis editie
zinn_chat_system_promptFilterenFiltert de systeemprompt van de assistent (Pro: persona- en overdrachtsregels).string $rulesGratis editie
zinn_chat_team_onlineFilterenFiltert of iemand nu kan reageren (Pro voegt hier openingstijden toe).bool $onlineGratis editie
zinn_chat_ticket_assignedActieAn agent assigned a ticket to an agent (2.14.0: the notification centre tells them).int $id, int $assignee, int $byGratis editie
zinn_chat_ticket_createdActieEr is een ticket geopend. Demailer verzendt de bevestiging en de teamwaarschuwing vanaf hier.int $id, string $tokenGratis editie
zinn_chat_ticket_form_extraFilterenFiltert extra opmaak aan het einde van een gastticketformulier (de menselijke controle van Pro komt hier).string $htmlGratis editie
zinn_chat_ticket_form_fieldsFilterenFiltert extra velden die op elk ticketformulier boven het bericht worden weergegeven (Pro: een afdelingskeuze). Geef ze de naam `zinn_chat_extra[<key>]`; ze bereiken `zinn_chat_ticket_created` als `$fields['extra']`, ongezuiverd, zodat degene die ze heeft toegevoegd ze kan valideren.string $htmlGratis editie
zinn_chat_ticket_replyActieEr is een reactie toegevoegd aan een ticket. Mailer e-mailt de andere partij vanaf hier.int $id, int $ticket_id, string $authorGratis editie
zinn_chat_ticket_statusActieEen ticket is van status veranderd.int $id, string $status, string $oldGratis editie
zinn_chat_uninstallActieZinn® Chat wordt gedeïnstalleerd (Pro verwijdert hier zijn eigen gegevens).geenGratis editie
zinn_chat_widget_configFilterenFiltert de launcher-configuratie die op de pagina wordt weergegeven.geenGratis editie
zinn_chat_widget_statusFilterenFiltert wat de geopende chat ontvangt (Pro voegt eigen schakelaars en woorden toe).geenGratis editie