Entwickler

Zinn® Chat-Funktionen-Referenz

Zinn® Chat registriert seine Aktionen bei der WordPress Abilities API. Dieselben Berechtigungen sind MCP-Tools auf dem eigenen Server der Website und REST-Routen unter /wp-json/wp-abilities/v1. Diese Seite wird aus der eigenen Registry des Plugins generiert.

Benutzerhandbuch: Verbinden einer KI-App

Endpunkte

MCP über HTTP (streamable)

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

MCP über WP-CLI (Standardeingabe und -ausgabe)

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

REST: Fähigkeiten auflisten

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

REST: Fähigkeit ausführen

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

Authentifizierung und Berechtigungen

HTTP-Anfragen authentifizieren sich mit einem WordPress-Anwendungspasswort (HTTP Basic). Das Verbinden mit dem MCP-Server erfordert die unten gezeigte Berechtigung; jede Funktion prüft anschließend ihre eigene Berechtigung pro Objekt. Schreibgeschützte Funktionen werden mit GET und ihrer Eingabe in der Abfragezeichenfolge ausgeführt; die anderen mit POST und einem JSON-Body {"input": {…}}.

Beispiele

# REST: Fähigkeit ausführen
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 Berechtigungen

Generiert aus der abilities.json des Plugins, die ihrerseits aus einer laufenden Website generiert wird; ein Test schlägt fehl, wenn beide nicht übereinstimmen.

Berechtigung	Funktionsweise	Ausgabe	Ruhezeit	Berechtigung	Parameter
`zinn-chat/answer-ticket` `zinn-chat-answer-ticket`	Ticket beantworten Antwortet dem Kunden per E-Mail (Text) oder fügt eine interne Notiz hinzu (note: true); der Status ändert optional den Status des Tickets.	Kostenlose Edition	`POST …/abilities/zinn-chat/answer-ticket/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/ask-assistant` `zinn-chat-ask-assistant`	Assistenten fragen Stellt dem KI-Assistenten der Website eine Frage und gibt dessen Antwort samt aller gefundenen Quellen zurück.	Kostenlose Edition	`POST …/abilities/zinn-chat/ask-assistant/run`	the REST route's own per-item permission check	Keine
`zinn-chat/bulk-update-tickets` `zinn-chat-bulk-update-tickets`	Mehrere Tickets auf einmal bearbeiten (Pro) Ändert den Status, die Priorität oder den Bearbeiter von bis zu 100 Tickets (IDs). Jedes Ticket durchläuft dieselben Prüfungen wie bei einer Einzeländerung; das Ergebnis listet jedes einzelne auf.	Pro-Edition	`POST …/abilities/zinn-chat/bulk-update-tickets/run`	zinn_chat_answer	ids: array (Erforderlich), status: open\|pending\|solved\|closed, priority: low\|normal\|high\|urgent, assignee_id: integer
`zinn-chat/chat-to-ticket` `zinn-chat-chat-to-ticket`	Einen Chat in ein Ticket umwandeln Eröffnet ein Ticket aus einem Chat, damit es per E-Mail beantwortet werden kann (benötigt die E-Mail-Adresse des Besuchers).	Kostenlose Edition	`POST …/abilities/zinn-chat/chat-to-ticket/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/close-chat` `zinn-chat-close-chat`	Chat schließen Beendet einen Chat; der Besucher kann weiterhin das Protokoll anfordern.	Kostenlose Edition	`POST …/abilities/zinn-chat/close-chat/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/create-ticket` `zinn-chat-create-ticket`	Ticket öffnen Öffnet ein Ticket im Namen eines Kunden (dessen E-Mail, einen Betreff und die erste Nachricht).	Kostenlose Edition	`POST …/abilities/zinn-chat/create-ticket/run`	the REST route's own per-item permission check	Keine
`zinn-chat/delete-canned-reply` `zinn-chat-delete-canned-reply`	Gespeicherte Antwort löschen (Pro) Löscht eine gespeicherte Antwort.	Pro-Edition	`POST …/abilities/zinn-chat/delete-canned-reply/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/delete-ticket` `zinn-chat-delete-ticket`	Ticket löschen Löscht ein Ticket samt Verlauf unwiderruflich (nur für Manager).	Kostenlose Edition	`POST …/abilities/zinn-chat/delete-ticket/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/draft-kb-article` `zinn-chat-draft-kb-article`	Hilfeartikel aus Ticket erstellen (Pro) Schreibt einen Entwurf für einen Wissensdatenbank-Artikel aus einem gelösten Ticket; dieser bleibt so lange ein Entwurf, bis er von einer Person veröffentlicht wird.	Pro-Edition	`POST …/abilities/zinn-chat/draft-kb-article/run`	edit_posts (the REST route's own check)	Keine
`zinn-chat/draft-kb-from-gaps` `zinn-chat-draft-kb-from-gaps`	Hilfsartikel für unbeantwortete Fragen entwerfen (Pro) Schreibt Entwürfe von Wissensdatenbank-Artikeln, die die ausgewählten Fragen (IDs) beantworten; diese bleiben Entwürfe.	Pro-Edition	`POST …/abilities/zinn-chat/draft-kb-from-gaps/run`	edit_posts (the REST route's own check)	Keine
`zinn-chat/fill-canned-reply` `zinn-chat-fill-canned-reply`	Gespeicherte Antwort einfügen (Pro) Gibt den Text einer gespeicherten Antwort mit ausgefüllten Platzhaltern für einen Chat oder ein Ticket zurück.	Pro-Edition	`POST …/abilities/zinn-chat/fill-canned-reply/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/get-chat` `zinn-chat-get-chat`	Chat lesen Gibt die Nachrichten und Besucherdetails eines Chats zurück (after: nur Nachrichten, die neuer als diese ID sind).	Kostenlose Edition	`GET …/abilities/zinn-chat/get-chat/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/get-overview` `zinn-chat-get-overview`	Support-Übersicht lesen Gibt zurück, wie viele Tickets sich in den einzelnen Status befinden, wie viele Chats auf eine Person warten (sowie deren ungelesene Nachrichten) und ob der Chat, der Assistent und die Tickets aktiviert sind.	Kostenlose Edition	`GET …/abilities/zinn-chat/get-overview/run`	zinn_chat_answer	Keine
`zinn-chat/get-settings` `zinn-chat-get-settings`	Chat-Einstellungen lesen Gibt alle Chat-Einstellungen zurück: das Widget, den Assistenten, Personen und Öffnungszeiten, Tickets und E-Mail, den Seitenindex, Datenschutz und Spam.	Kostenlose Edition	`GET …/abilities/zinn-chat/get-settings/run`	zinn_chat_manage	Keine
`zinn-chat/get-stats` `zinn-chat-get-stats`	Support-Statistiken lesen (Pro) Gibt Chat- und Ticketnummern, Reaktionszeiten und Bewertungen für die letzten N Tage (days) zurück.	Pro-Edition	`GET …/abilities/zinn-chat/get-stats/run`	the REST route's own per-item permission check	Keine
`zinn-chat/get-ticket` `zinn-chat-get-ticket`	Ticket lesen Gibt ein Ticket samt gesamtem Verlauf, Status, Priorität und zugewiesener Person zurück.	Kostenlose Edition	`GET …/abilities/zinn-chat/get-ticket/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/hand-chat-to-assistant` `zinn-chat-hand-chat-to-assistant`	Chat an den Assistenten zurückgeben Gibt einen Chat an den KI-Assistenten zurück, der den Besucher anhand der Website-Inhalte antwortet.	Kostenlose Edition	`POST …/abilities/zinn-chat/hand-chat-to-assistant/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/list-canned-replies` `zinn-chat-list-canned-replies`	Gespeicherte Antworten auflisten (Pro) Listet die gespeicherten Antworten auf, die Agenten einfügen können, einschließlich ihrer Kürzel.	Pro-Edition	`GET …/abilities/zinn-chat/list-canned-replies/run`	the REST route's own per-item permission check	Keine
`zinn-chat/list-chats` `zinn-chat-list-chats`	Live-Chats auflisten Listet wartende, laufende und kürzlich geschlossene Chats auf und zeigt an, wer sie bearbeitet.	Kostenlose Edition	`GET …/abilities/zinn-chat/list-chats/run`	the REST route's own per-item permission check	Keine
`zinn-chat/list-indexed-content` `zinn-chat-list-indexed-content`	Auflisten, was der Assistent weiß Listet den Inhalt auf, aus dem der Assistent antwortet, einschließlich des Indexstatus, jeweils eine Seite.	Kostenlose Edition	`GET …/abilities/zinn-chat/list-indexed-content/run`	the REST route's own per-item permission check	Keine
`zinn-chat/list-kb-gaps` `zinn-chat-list-kb-gaps`	Unbeantwortete Fragen anzeigen (Pro) Listet die Fragen auf, die Besucher gestellt haben und auf die die Wissensdatenbank keine Antwort geben konnte.	Pro-Edition	`GET …/abilities/zinn-chat/list-kb-gaps/run`	the REST route's own per-item permission check	Keine
`zinn-chat/list-tickets` `zinn-chat-list-tickets`	Tickets auflisten Listet Support-Tickets seitenweise auf, gefiltert nach Status oder einer Suche.	Kostenlose Edition	`GET …/abilities/zinn-chat/list-tickets/run`	the REST route's own per-item permission check	Keine
`zinn-chat/reembed-content` `zinn-chat-reembed-content`	Suchindex des Assistenten neu erstellen Erstellt die Suchvektoren für ein einzelnes Element (item_id) oder alles (all: true) neu (nur für Manager).	Kostenlose Edition	`POST …/abilities/zinn-chat/reembed-content/run`	the REST route's own per-item permission check	Keine
`zinn-chat/reindex-content` `zinn-chat-reindex-content`	Inhalt erneut in den Assistenten einlesen Liest ein einzelnes Element (item_id) oder alles (all: true) erneut in den Index des Assistenten ein (nur für Manager).	Kostenlose Edition	`POST …/abilities/zinn-chat/reindex-content/run`	the REST route's own per-item permission check	Keine
`zinn-chat/reply-chat` `zinn-chat-reply-chat`	Im Chat antworten Sendet eine Nachricht an den Besucher (text) oder fügt eine interne Notiz hinzu, die nur Agenten sehen (note: true).	Kostenlose Edition	`POST …/abilities/zinn-chat/reply-chat/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/save-canned-reply` `zinn-chat-save-canned-reply`	Gespeicherte Antwort speichern (Pro) Erstellt oder ändert eine gespeicherte Antwort (Titel, Kürzel, Text, Abteilung; ID zum Ändern).	Pro-Edition	`POST …/abilities/zinn-chat/save-canned-reply/run`	the REST route's own per-item permission check	Keine
`zinn-chat/save-kb-article` `zinn-chat-save-kb-article`	Hilfeartikel schreiben (Pro) Erstellt einen Wissensdatenbank-Artikel oder ändert einen (id): Titel, Inhalt, Auszug, Kategorien und Status (Entwurf oder Veröffentlichung, wenn Sie veröffentlichen dürfen).	Pro-Edition	`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-kb` `zinn-chat-search-kb`	Knowledge Base durchsuchen (Pro) Findet Hilfe-Artikel zum Verlinken in einer Antwort (q: die Suche).	Pro-Edition	`GET …/abilities/zinn-chat/search-kb/run`	the REST route's own per-item permission check	Keine
`zinn-chat/set-conversation-details` `zinn-chat-set-conversation-details`	Weisen Sie der Abteilung und den Tags einer Unterhaltung einen Wert zu (Pro) Legt die Abteilung und die Tags eines Chats oder Tickets fest (Art: chat oder ticket; ID).	Pro-Edition	`POST …/abilities/zinn-chat/set-conversation-details/run`	the REST route's own per-item permission check	Keine
`zinn-chat/set-kb-gap-status` `zinn-chat-set-kb-gap-status`	Unbeantwortete Fragen markieren (Pro) Markiert unbeantwortete Fragen als offen, geplant oder verworfen (IDs, Status).	Pro-Edition	`POST …/abilities/zinn-chat/set-kb-gap-status/run`	the REST route's own per-item permission check	Keine
`zinn-chat/set-presence` `zinn-chat-set-presence`	Verfügbarkeit festlegen Markiert den angemeldeten Agenten für neue Chats als verfügbar oder abwesend (abwesend: true oder false).	Kostenlose Edition	`POST …/abilities/zinn-chat/set-presence/run`	the REST route's own per-item permission check	Keine
`zinn-chat/suggest-reply` `zinn-chat-suggest-reply`	Antwort mit KI entwerfen (Pro) Entwirft eine Antwort auf einen Chat oder ein Ticket aus dem Seiteninhalt; es wird nichts gesendet.	Pro-Edition	`POST …/abilities/zinn-chat/suggest-reply/run`	the REST route's own per-item permission check	Keine
`zinn-chat/summarise-conversation` `zinn-chat-summarise-conversation`	Gespräch mit KI (Pro) zusammenfassen Fasst einen Chat oder ein Ticket in wenigen Zeilen zusammen.	Pro-Edition	`POST …/abilities/zinn-chat/summarise-conversation/run`	the REST route's own per-item permission check	Keine
`zinn-chat/take-chat` `zinn-chat-take-chat`	Chat starten Weist dem angemeldeten Agenten einen wartenden Chat zu, sodass der Besucher mit einer Person spricht.	Kostenlose Edition	`POST …/abilities/zinn-chat/take-chat/run`	the REST route's own per-item permission check	id: string (Erforderlich)
`zinn-chat/update-settings` `zinn-chat-update-settings`	Chat-Einstellungen ändern Ändert die von Ihnen gesendeten Einstellungen (Einstellungen: Schlüssel zu Wert) und behält den Rest bei. Jeder Wert wird genau wie auf dem Einstellungsbildschirm überprüft; get-settings listet die Schlüssel auf.	Kostenlose Edition	`POST …/abilities/zinn-chat/update-settings/run`	zinn_chat_manage	settings: object (Erforderlich)
`zinn-chat/update-ticket` `zinn-chat-update-ticket`	Ticket bearbeiten Ändert den Status, die Priorität oder den Bearbeiter eines Tickets.	Kostenlose Edition	`POST …/abilities/zinn-chat/update-ticket/run`	the REST route's own per-item permission check	id: string (Erforderlich)