Développeurs

Référence des fonctionnalités de Zinn® Chat

Zinn® Chat enregistre ses actions auprès de l’API WordPress Abilities. Ces mêmes capacités sont des outils MCP sur le propre serveur du site et des routes REST sous /wp-json/wp-abilities/v1. Cette page est générée à partir du propre registre du plugin.

Guide de l’utilisateur : connecter une application d’IA

Zinn®, notre Viking, exulte pendant qu'un assistant IA se connecte aux outils de la plateforme.

Points de terminaison

MCP sur HTTP (diffusible en continu)

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

MCP sur WP-CLI (entrée et sortie standard)

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

REST : lister les capacités

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

REST : exécuter une capacité

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

Authentification et autorisations

Les requêtes HTTP s’authentifient à l’aide d’un mot de passe d’application WordPress (HTTP Basic). La connexion au serveur MCP nécessite la capacité indiquée ci-dessous ; chaque fonctionnalité vérifie ensuite sa propre autorisation, par objet. Les fonctionnalités en lecture seule s’exécutent avec GET et leur entrée dans la chaîne de requête ; les autres avec POST et un corps JSON {« input » : {…}}.

Exemples

# REST : exécuter une capacité
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":{}}}

Toutes les capacités

Généré à partir du fichier abilities.json du plugin, qui est lui-même généré à partir d’un site en cours d’exécution ; un test échoue lorsque les deux ne correspondent pas.

CapacitéSon rôleÉditionReposAutorisationParamètres
zinn-chat/answer-ticket
zinn-chat-answer-ticket
Répondre à un ticket
Répond au client par e-mail (text) ou ajoute une note interne (note : true) ; status modifie éventuellement l’état du ticket.
Édition gratuitePOST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/ask-assistant
zinn-chat-ask-assistant
Demandez à l’assistant
Pose une question à l’assistant IA du site et renvoie sa réponse accompagnée de chaque source trouvée.
Édition gratuitePOST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission checkquestion: string (requis), language: string
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
Modifier plusieurs tickets à la fois (Pro)
Modifie l’état, la priorité ou le responsable de 100 tickets (ids) maximum. Chaque ticket subit les mêmes vérifications qu’en cas de modification individuelle ; le résultat liste chacun d’entre eux.
Édition ProPOST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (requis), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-chat-chat-to-ticket
Convertir une discussion en ticket
Ouvre un ticket à partir d’une discussion afin qu’il soit possible d’y répondre par e-mail (requiert l’adresse e-mail du visiteur).
Édition gratuitePOST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/close-chat
zinn-chat-close-chat
Fermer une discussion
Met fin à une discussion ; le visiteur peut toujours demander la transcription.
Édition gratuitePOST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/create-ticket
zinn-chat-create-ticket
Ouvrir un ticket
Ouvre un ticket au nom d’un client (son e-mail, un objet et le premier message).
Édition gratuitePOST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission checkemail: string (requis), subject: string (requis), body: string (requis), name: string
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
Supprimer une réponse enregistrée (Pro)
Supprime une réponse enregistrée.
Édition ProPOST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
Supprimer un ticket
Supprime définitivement un ticket et sa conversation (gestionnaires uniquement).
Édition gratuitePOST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/draft-kb-article
zinn-chat-draft-kb-article
Rédiger un brouillon d’article d’aide à partir d’un ticket (Pro)
Rédige un brouillon d’article de base de connaissances à partir d’un ticket résolu ; il reste à l’état de brouillon jusqu’à ce qu’une personne le publie.
Édition ProPOST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)ticket: integer (requis)
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
Rédiger des ébauches d’articles d’aide pour les questions sans réponse (Pro)
Rédige des brouillons d’articles de base de connaissances répondant aux questions sélectionnées (identifiants) ; ils restent à l’état de brouillon.
Édition ProPOST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)ids: array (requis)
zinn-chat/fill-canned-reply
zinn-chat-fill-canned-reply
Insérer une réponse enregistrée (Pro)
Renvoie le texte d’une réponse enregistrée avec ses espaces réservés remplis pour un chat ou un ticket.
Édition ProPOST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/get-chat
zinn-chat-get-chat
Lire une discussion
Renvoie les messages d’un chat et les détails du visiteur (after : uniquement les messages plus récents que cet identifiant).
Édition gratuiteGET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/get-overview
zinn-chat-get-overview
Consultez la vue d’ensemble du support
Renvoie le nombre de tickets dans chaque statut, le nombre de discussions en attente d’un agent (ainsi que leurs messages non lus), et indique si la discussion, l’assistant et les tickets sont activés.
Édition gratuiteGET …/abilities/zinn-chat/get-overview/runzinn_chat_answerAucun
zinn-chat/get-settings
zinn-chat-get-settings
Lire les réglages du chat
Renvoie tous les paramètres de discussion : le widget, l’assistant, les personnes et les heures d’ouverture, les tickets et les e-mails, l’index du site, la confidentialité et les indésirables.
Édition gratuiteGET …/abilities/zinn-chat/get-settings/runzinn_chat_manageAucun
zinn-chat/get-stats
zinn-chat-get-stats
Consulter les statistiques d’assistance (Pro)
Renvoie le nombre de discussions et de tickets, les temps de réponse et les évaluations pour les N derniers jours (jours).
Édition ProGET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission checkdays: integer
zinn-chat/get-ticket
zinn-chat-get-ticket
Lire un ticket
Renvoie un ticket avec l’intégralité de sa conversation, son état, sa priorité et la personne assignée.
Édition gratuiteGET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/hand-chat-to-assistant
zinn-chat-hand-chat-to-assistant
Transférer à nouveau la discussion à l’assistant
Renvoie une discussion à l’assistant IA, qui répond au visiteur à partir du contenu du site.
Édition gratuitePOST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
Lister les réponses enregistrées (Pro)
Affiche les réponses enregistrées que les agents peuvent insérer, avec leurs raccourcis.
Édition ProGET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission checkAucun
zinn-chat/list-chats
zinn-chat-list-chats
Lister les discussions en direct
Affiche la liste des discussions en attente, en cours et récemment fermées, ainsi que la personne qui gère chacune d’elles.
Édition gratuiteGET …/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
Lister ce que l’assistant sait
Liste le contenu à partir duquel l’assistant répond, avec son état d’indexation, page par page.
Édition gratuiteGET …/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
Lister les questions sans réponse (Pro)
Affiche les questions posées par les visiteurs auxquelles la base de connaissances n’a pas pu répondre.
Édition 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
Lister les tickets
Affiche les tickets de support, filtrés par état ou par recherche, page par page.
Édition gratuiteGET …/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
Reconstruire l’index de recherche de l’assistant
Reconstruit les vecteurs de recherche pour un élément (item_id) ou pour tout (all : true) (gestionnaires uniquement).
Édition gratuitePOST …/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
Relire le contenu dans l’assistant
Relit un élément (item_id) ou tout (all : true) dans l’index de l’assistant (gestionnaires uniquement).
Édition gratuitePOST …/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
Répondre dans un chat
Envoie un message au visiteur (text) ou ajoute une note interne visible uniquement par les agents (note : true).
Édition gratuitePOST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/save-canned-reply
zinn-chat-save-canned-reply
Enregistrer une réponse enregistrée (Pro)
Crée ou modifie une réponse enregistrée (titre, raccourci, corps, service ; id pour en modifier une).
Édition ProPOST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission checkid: integer, title: string (requis), body: string (requis), shortcut: string, department: string
zinn-chat/save-kb-article
zinn-chat-save-kb-article
Rédiger un article d’aide (Pro)
Crée un article de base de connaissances ou en modifie un (id) : titre, contenu, extrait, catégories et état (brouillon, ou publier lorsque vous pouvez publier).
Édition 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
Rechercher dans la base de connaissances (Pro)
Recherche des articles d’aide à lier dans une réponse (q : la recherche).
Édition ProGET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission checkq: string (requis)
zinn-chat/set-conversation-details
zinn-chat-set-conversation-details
Définir le service et les étiquettes d’une conversation (Pro)
Définit le service et les étiquettes d’une discussion ou d’un ticket (kind : discussion ou ticket ; id).
Édition ProPOST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (requis), department: string, tags: array
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
Marquer les questions sans réponse (Pro)
Marque les questions sans réponse comme ouvertes, planifiées ou rejetées (ids, status).
Édition ProPOST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission checkids: array (requis), status: open|drafted|answered|ignored (requis)
zinn-chat/set-presence
zinn-chat-set-presence
Définissez votre disponibilité
Marque l’agent connecté comme disponible ou absent pour les nouvelles discussions (away : true ou false).
Édition gratuitePOST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkaway: boolean
zinn-chat/suggest-reply
zinn-chat-suggest-reply
Rédiger un brouillon de réponse avec l’IA (Pro)
Rédige un brouillon de réponse à une discussion ou à un ticket à partir du contenu du site ; rien n’est envoyé.
Édition ProPOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (requis)
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
Résumer une conversation avec l’IA (Pro)
Résume une discussion ou un ticket en quelques lignes.
Édition ProPOST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (requis)
zinn-chat/take-chat
zinn-chat-take-chat
Prendre un chat
Attribue une discussion en attente à l’agent connecté, afin que le visiteur puisse échanger avec une personne réelle.
Édition gratuitePOST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (requis)
zinn-chat/update-settings
zinn-chat-update-settings
Modifier les paramètres de discussion
Modifie les réglages que vous envoyez (réglages : clé vers valeur) et conserve le reste. Chaque valeur est vérifiée exactement comme sur l’écran des réglages ; get-settings liste les clés.
Édition gratuitePOST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (requis)
zinn-chat/update-ticket
zinn-chat-update-ticket
Modifier un ticket
Modifie l’état, la priorité ou le responsable d’un ticket.
Édition gratuitePOST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: string (requis)

Actions et filtres

Tous les hooks proposés par le plugin, avec la description de leur code source. Les filtres modifient une valeur ; les actions permettent d’exécuter du code à un moment précis ; les points d’entrée sont des actions que vous déclenchez pour demander au plugin d’effectuer une tâche.

WebhookGenreSon rôleParamètresÉdition
zinn_chat_admin_pagesFiltrerPermet de filtrer les écrans d'administration de Zinn® Chat (Pro ajoute ses propres écrans).AucunÉdition gratuite
zinn_chat_agent_chatFiltrerFiltre la charge utile du chat pour la console des agents (la version Pro ajoute les détails des visiteurs, les notes et les suggestions de la base de connaissances).AucunÉdition gratuite
zinn_chat_agent_pagesFiltrerFiltre les écrans de Zinn® Chat qu'un compte d'agent du support peut ouvrir.AucunÉdition Pro
zinn_chat_agent_script_srcFiltrerFiltre l'URL à partir de laquelle l'agent de chat IA autonome est chargé.string $srcÉdition gratuite
zinn_chat_agent_ticketFiltrerFiltre la charge utile du ticket pour wp-admin (Pro ajoute des réponses types, le SLA, des suggestions de la KB).AucunÉdition gratuite
zinn_chat_answerFiltrerFiltre la réponse d'un assistant avant son affichage (Pro y ajoute ses options supplémentaires).string $questionÉdition gratuite
zinn_chat_assistant_answeredActionL'assistant a répondu à un visiteur.int $id, string $textÉdition gratuite
zinn_chat_challengeFiltrerFiltre la vérification humaine affichée aux visiteurs (URL du script, clé de site et objet global défini par le script avec une méthode `render( element, { sitekey, callback } )`).AucunÉdition gratuite
zinn_chat_challenge_okFiltrerPermet de filtrer si le visiteur a réussi le contrôle anti-robot. Un contrôle qui ne peut pas être vérifié doit renvoyer faux (échec par défaut) : un formulaire qui laisse tout passer lorsque le service est inaccessible est un formulaire qu'un robot peut réussir en jouant sur le timing.bool $ok, string $ip, string $whereÉdition gratuite
zinn_chat_client_ipFiltrerFiltre l'adresse IP du visiteur utilisée pour les limites de taux et les enregistrements.string $ipÉdition gratuite
zinn_chat_console_configFiltrerFiltre la configuration supplémentaire transmise au script de la console opérateur ; Zinn® Chat Pro y ajoute ses fonctionnalités.AucunÉdition gratuite
zinn_chat_conversation_startedActionUn visiteur a démarré une discussion.int $idÉdition gratuite
zinn_chat_conversation_statusActionUne conversation a changé de statut.int $id, string $status, string $oldÉdition gratuite
zinn_chat_customer_ticket_urlFiltrerFiltre le lien envoyé à un client pour son ticket.string $urlÉdition gratuite
zinn_chat_elementsFiltrerFiltre les éléments du front-end proposés sous forme de blocs et de modules de constructeur.AucunÉdition gratuite
zinn_chat_emailFiltrerFiltre un e-mail avant son envoi. Renvoyez un `to` vide pour l'interrompre.AucunÉdition gratuite
zinn_chat_fs_loadedActionSe déclenche une fois que le SDK de licence est chargé (dans le fichier principal, avant tout code Zinn® Chat). Interceptez ici pour dialoguer avec `zinn_chat_fs()`.AucunÉdition gratuite
zinn_chat_index_extractFiltrerPermet de filtrer un objet extrait (ou d'en fournir un pour un type d'objet personnalisé).string $type, int $idÉdition gratuite
zinn_chat_index_languageFiltrerFiltre la langue (paramètre régional) d'un article indexé.string $language, \WP_Post $postÉdition gratuite
zinn_chat_index_objectPoint d’entrée (vous le déclenchez)HooksAucunÉdition gratuite
zinn_chat_index_post_typesFiltrerFiltre les types de publication que l'assistant lit.AucunÉdition gratuite
zinn_chat_indexableFiltrerDétermine si un article est indexé.bool $indexable, \WP_Post $postÉdition gratuite
zinn_chat_indexedActionUn objet a été (ré)indexé.string $type, int $idÉdition gratuite
zinn_chat_is_proFiltrerPermet de filtrer si les fonctionnalités Pro s'exécutent (une licence achetée ou un essai, provenant de Freemius). Le code Pro est fourni uniquement dans le paquet premium, cela ne peut donc pas ajouter ce qui manque à la version gratuite.bool $proÉdition gratuite
zinn_chat_loadedActionZinn® Chat s'est chargé (le point d'extension pour les modules complémentaires).AucunÉdition gratuite
zinn_chat_message_addedActionUn message a été ajouté à une conversation.int $id, int $conversation_id, string $roleÉdition gratuite
zinn_chat_order_trackingFiltrerFiltre les informations de suivi fournies à l'assistant pour une commande.\WC_Order $orderÉdition gratuite
zinn_chat_pro_alertActionUn événement digne d'une alerte s'est produit (les notifications push sont à l'écoute ici).string $alert, int $id, string $text, string $linkÉdition Pro
zinn_chat_pro_assignedActionUn ticket a été attribué automatiquement à un agent.int $id, int $agentÉdition Pro
zinn_chat_pro_loadedActionLa couche Pro est chargée.AucunÉdition Pro
zinn_chat_pro_priority_changedActionLa priorité d'un ticket a changé (les objectifs SLA suivent).int $idÉdition Pro
zinn_chat_pro_sla_breachActionUn objectif de SLA n'a pas été atteint.int $ticket_id, string $whichÉdition Pro
zinn_chat_pro_ticket_ratedActionUn client a évalué un ticket résolu (1-5).int $id, int $scoreÉdition Pro
zinn_chat_ratedActionS'exécute après qu'un visiteur a évalué une conversation, avec l'identifiant de la conversation et la note (1 pour utile, -1 pour inutile).int $conversation_id, int $ratingÉdition gratuite
zinn_chat_role_capabilitiesFiltrerDétermine quels rôles reçoivent quelles fonctionnalités de Zinn® Chat.AucunÉdition gratuite
zinn_chat_save_settingsFiltrerFiltrer les paramètres avant qu'ils ne soient enregistrés (Pro y ajoute ses propres clés).AucunÉdition gratuite
zinn_chat_script_srcFiltrerFiltre l'URL à partir de laquelle le widget de chat hébergé est chargé (mode connecté).string $srcÉdition gratuite
zinn_chat_settings_beforeActionSortie au-dessus du formulaire d'un onglet de paramètres.string $tabÉdition gratuite
zinn_chat_settings_fieldsFiltrerFiltre les champs d'un onglet de paramètres (Pro ajoute les siens).string $tabÉdition gratuite
zinn_chat_settings_tabsFiltrerFiltre les onglets des paramètres.AucunÉdition gratuite
zinn_chat_setup_afterActionSortie sous la liste de contrôle de configuration (l'édition gratuite affiche la carte Pro ici).AucunÉdition gratuite
zinn_chat_should_renderFiltrerDétermine si le chat s'affiche pour cette requête (les crochets de ciblage de page de Pro interviennent ici).bool $renderÉdition gratuite
zinn_chat_site_factsFiltrerFiltre les informations sur le site fournies à l'assistant avec chaque question. Chacune comprend `title`, `url` (sur ce site) et `text` (texte brut, 3 000 caractères au maximum) ; quatre au maximum sont utilisées.string $languageÉdition gratuite
zinn_chat_site_stringsFiltrerFiltre les textes du propriétaire proposés pour la traduction (Pro ajoute ses messages proactifs).AucunÉdition gratuite
zinn_chat_system_promptFiltrerFiltre l'invite système de l'assistant (Pro : règles de personnage et de transfert).string $rulesÉdition gratuite
zinn_chat_team_onlineFiltrerDétermine si une personne peut répondre maintenant (Pro ajoute les heures d'ouverture ici).bool $onlineÉdition gratuite
zinn_chat_ticket_assignedActionAn agent assigned a ticket to an agent (2.14.0: the notification centre tells them).int $id, int $assignee, int $byÉdition gratuite
zinn_chat_ticket_createdActionUn ticket a été ouvert. Le serveur de messagerie envoie la confirmation et l'alerte à l'équipe depuis cet endroit.int $id, string $tokenÉdition gratuite
zinn_chat_ticket_form_extraFiltrerFiltre le balisage supplémentaire à la fin d'un formulaire de billet pour invité (la vérification humaine de Pro s'effectue ici).string $htmlÉdition gratuite
zinn_chat_ticket_form_fieldsFiltrerFiltre les champs supplémentaires affichés au-dessus du message sur chaque formulaire de ticket (Pro : un choix de département). Nommez-les `zinn_chat_extra[<key>]` ; ils parviennent à `zinn_chat_ticket_created` sous la forme `$fields['extra']`, non assainis, pour que celui qui les a ajoutés puisse les valider.string $htmlÉdition gratuite
zinn_chat_ticket_replyActionUne réponse a été ajoutée à un ticket. Mailer envoie un e-mail à l'autre partie à partir d'ici.int $id, int $ticket_id, string $authorÉdition gratuite
zinn_chat_ticket_statusActionUn ticket a changé de statut.int $id, string $status, string $oldÉdition gratuite
zinn_chat_uninstallActionZinn® Chat est en cours de désinstallation (Pro supprime ses propres données ici).AucunÉdition gratuite
zinn_chat_widget_configFiltrerFiltre la configuration du lanceur affichée sur la page.AucunÉdition gratuite
zinn_chat_widget_statusFiltrerFiltre ce que le chat ouvert reçoit (Pro ajoute ses propres commutateurs et mots).AucunÉdition gratuite