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.
Points de terminaison
MCP sur HTTP (diffusible en continu)
https://example.com/wp-json/zinn-chat/v1/mcpMCP 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-chatREST : exécuter une capacité
/wp-json/wp-abilities/v1/abilities/<name>/runAuthentification 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 | Édition | Repos | Autorisation | Paramètres |
|---|---|---|---|---|---|
zinn-chat/answer-ticketzinn-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 gratuite | POST …/abilities/zinn-chat/answer-ticket/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/ask-assistantzinn-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 gratuite | POST …/abilities/zinn-chat/ask-assistant/run | the REST route's own per-item permission check | question: string (requis), language: string |
zinn-chat/bulk-update-ticketszinn-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 Pro | POST …/abilities/zinn-chat/bulk-update-tickets/run | zinn_chat_answer | ids: array (requis), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer |
zinn-chat/chat-to-ticketzinn-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 gratuite | POST …/abilities/zinn-chat/chat-to-ticket/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/close-chatzinn-chat-close-chat | Fermer une discussion Met fin à une discussion ; le visiteur peut toujours demander la transcription. | Édition gratuite | POST …/abilities/zinn-chat/close-chat/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/create-ticketzinn-chat-create-ticket | Ouvrir un ticket Ouvre un ticket au nom d’un client (son e-mail, un objet et le premier message). | Édition gratuite | POST …/abilities/zinn-chat/create-ticket/run | the REST route's own per-item permission check | email: string (requis), subject: string (requis), body: string (requis), name: string |
zinn-chat/delete-canned-replyzinn-chat-delete-canned-reply | Supprimer une réponse enregistrée (Pro) Supprime une réponse enregistrée. | Édition Pro | POST …/abilities/zinn-chat/delete-canned-reply/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/delete-ticketzinn-chat-delete-ticket | Supprimer un ticket Supprime définitivement un ticket et sa conversation (gestionnaires uniquement). | Édition gratuite | POST …/abilities/zinn-chat/delete-ticket/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/draft-kb-articlezinn-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 Pro | POST …/abilities/zinn-chat/draft-kb-article/run | edit_posts (the REST route's own check) | ticket: integer (requis) |
zinn-chat/draft-kb-from-gapszinn-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 Pro | POST …/abilities/zinn-chat/draft-kb-from-gaps/run | edit_posts (the REST route's own check) | ids: array (requis) |
zinn-chat/fill-canned-replyzinn-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 Pro | POST …/abilities/zinn-chat/fill-canned-reply/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/get-chatzinn-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 gratuite | GET …/abilities/zinn-chat/get-chat/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/get-overviewzinn-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 gratuite | GET …/abilities/zinn-chat/get-overview/run | zinn_chat_answer | Aucun |
zinn-chat/get-settingszinn-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 gratuite | GET …/abilities/zinn-chat/get-settings/run | zinn_chat_manage | Aucun |
zinn-chat/get-statszinn-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 Pro | GET …/abilities/zinn-chat/get-stats/run | the REST route's own per-item permission check | days: integer |
zinn-chat/get-ticketzinn-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 gratuite | GET …/abilities/zinn-chat/get-ticket/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/hand-chat-to-assistantzinn-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 gratuite | POST …/abilities/zinn-chat/hand-chat-to-assistant/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/list-canned-replieszinn-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 Pro | GET …/abilities/zinn-chat/list-canned-replies/run | the REST route's own per-item permission check | Aucun |
zinn-chat/list-chatszinn-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 gratuite | GET …/abilities/zinn-chat/list-chats/run | the REST route's own per-item permission check | view: active|bot|closed|all |
zinn-chat/list-indexed-contentzinn-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 gratuite | GET …/abilities/zinn-chat/list-indexed-content/run | the REST route's own per-item permission check | search: string, status: indexed|pending|error, page: integer |
zinn-chat/list-kb-gapszinn-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 Pro | GET …/abilities/zinn-chat/list-kb-gaps/run | the REST route's own per-item permission check | status: open|drafted|answered|ignored|all, page: integer |
zinn-chat/list-ticketszinn-chat-list-tickets | Lister les tickets Affiche les tickets de support, filtrés par état ou par recherche, page par page. | Édition gratuite | GET …/abilities/zinn-chat/list-tickets/run | the REST route's own per-item permission check | status: active|open|pending|solved|closed|all, search: string, page: integer |
zinn-chat/reembed-contentzinn-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 gratuite | POST …/abilities/zinn-chat/reembed-content/run | the REST route's own per-item permission check | all: boolean, item_id: integer |
zinn-chat/reindex-contentzinn-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 gratuite | POST …/abilities/zinn-chat/reindex-content/run | the REST route's own per-item permission check | all: boolean, item_id: integer |
zinn-chat/reply-chatzinn-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 gratuite | POST …/abilities/zinn-chat/reply-chat/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/save-canned-replyzinn-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 Pro | POST …/abilities/zinn-chat/save-canned-reply/run | the REST route's own per-item permission check | id: integer, title: string (requis), body: string (requis), shortcut: string, department: string |
zinn-chat/save-kb-articlezinn-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 Pro | 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-kbzinn-chat-search-kb | Rechercher dans la base de connaissances (Pro) Recherche des articles d’aide à lier dans une réponse (q : la recherche). | Édition Pro | GET …/abilities/zinn-chat/search-kb/run | the REST route's own per-item permission check | q: string (requis) |
zinn-chat/set-conversation-detailszinn-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 Pro | POST …/abilities/zinn-chat/set-conversation-details/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (requis), department: string, tags: array |
zinn-chat/set-kb-gap-statuszinn-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 Pro | POST …/abilities/zinn-chat/set-kb-gap-status/run | the REST route's own per-item permission check | ids: array (requis), status: open|drafted|answered|ignored (requis) |
zinn-chat/set-presencezinn-chat-set-presence | Définissez votre disponibilité Marque l’agent connecté comme disponible ou absent pour les nouvelles discussions (away : true ou false). | Édition gratuite | POST …/abilities/zinn-chat/set-presence/run | the REST route's own per-item permission check | away: boolean |
zinn-chat/suggest-replyzinn-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 Pro | POST …/abilities/zinn-chat/suggest-reply/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (requis) |
zinn-chat/summarise-conversationzinn-chat-summarise-conversation | Résumer une conversation avec l’IA (Pro) Résume une discussion ou un ticket en quelques lignes. | Édition Pro | POST …/abilities/zinn-chat/summarise-conversation/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (requis) |
zinn-chat/take-chatzinn-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 gratuite | POST …/abilities/zinn-chat/take-chat/run | the REST route's own per-item permission check | id: string (requis) |
zinn-chat/update-settingszinn-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 gratuite | POST …/abilities/zinn-chat/update-settings/run | zinn_chat_manage | settings: object (requis) |
zinn-chat/update-ticketzinn-chat-update-ticket | Modifier un ticket Modifie l’état, la priorité ou le responsable d’un ticket. | Édition gratuite | POST …/abilities/zinn-chat/update-ticket/run | the REST route's own per-item permission check | id: 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.
| Webhook | Genre | Son rôle | Paramètres | Édition |
|---|---|---|---|---|
zinn_chat_admin_pages | Filtrer | Permet de filtrer les écrans d'administration de Zinn® Chat (Pro ajoute ses propres écrans). | Aucun | Édition gratuite |
zinn_chat_agent_chat | Filtrer | Filtre 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_pages | Filtrer | Filtre les écrans de Zinn® Chat qu'un compte d'agent du support peut ouvrir. | Aucun | Édition Pro |
zinn_chat_agent_script_src | Filtrer | Filtre l'URL à partir de laquelle l'agent de chat IA autonome est chargé. | string $src | Édition gratuite |
zinn_chat_agent_ticket | Filtrer | Filtre 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_answer | Filtrer | Filtre la réponse d'un assistant avant son affichage (Pro y ajoute ses options supplémentaires). | string $question | Édition gratuite |
zinn_chat_assistant_answered | Action | L'assistant a répondu à un visiteur. | int $id, string $text | Édition gratuite |
zinn_chat_challenge | Filtrer | Filtre 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_ok | Filtrer | Permet 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_ip | Filtrer | Filtre l'adresse IP du visiteur utilisée pour les limites de taux et les enregistrements. | string $ip | Édition gratuite |
zinn_chat_console_config | Filtrer | Filtre 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_started | Action | Un visiteur a démarré une discussion. | int $id | Édition gratuite |
zinn_chat_conversation_status | Action | Une conversation a changé de statut. | int $id, string $status, string $old | Édition gratuite |
zinn_chat_customer_ticket_url | Filtrer | Filtre le lien envoyé à un client pour son ticket. | string $url | Édition gratuite |
zinn_chat_elements | Filtrer | Filtre les éléments du front-end proposés sous forme de blocs et de modules de constructeur. | Aucun | Édition gratuite |
zinn_chat_email | Filtrer | Filtre un e-mail avant son envoi. Renvoyez un `to` vide pour l'interrompre. | Aucun | Édition gratuite |
zinn_chat_fs_loaded | Action | Se 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_extract | Filtrer | Permet 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_language | Filtrer | Filtre la langue (paramètre régional) d'un article indexé. | string $language, \WP_Post $post | Édition gratuite |
zinn_chat_index_object | Point d’entrée (vous le déclenchez) | Hooks | Aucun | Édition gratuite |
zinn_chat_index_post_types | Filtrer | Filtre les types de publication que l'assistant lit. | Aucun | Édition gratuite |
zinn_chat_indexable | Filtrer | Détermine si un article est indexé. | bool $indexable, \WP_Post $post | Édition gratuite |
zinn_chat_indexed | Action | Un objet a été (ré)indexé. | string $type, int $id | Édition gratuite |
zinn_chat_is_pro | Filtrer | Permet 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_loaded | Action | Zinn® Chat s'est chargé (le point d'extension pour les modules complémentaires). | Aucun | Édition gratuite |
zinn_chat_message_added | Action | Un message a été ajouté à une conversation. | int $id, int $conversation_id, string $role | Édition gratuite |
zinn_chat_order_tracking | Filtrer | Filtre les informations de suivi fournies à l'assistant pour une commande. | \WC_Order $order | Édition gratuite |
zinn_chat_pro_alert | Action | Un é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_assigned | Action | Un ticket a été attribué automatiquement à un agent. | int $id, int $agent | Édition Pro |
zinn_chat_pro_loaded | Action | La couche Pro est chargée. | Aucun | Édition Pro |
zinn_chat_pro_priority_changed | Action | La priorité d'un ticket a changé (les objectifs SLA suivent). | int $id | Édition Pro |
zinn_chat_pro_sla_breach | Action | Un objectif de SLA n'a pas été atteint. | int $ticket_id, string $which | Édition Pro |
zinn_chat_pro_ticket_rated | Action | Un client a évalué un ticket résolu (1-5). | int $id, int $score | Édition Pro |
zinn_chat_rated | Action | S'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_capabilities | Filtrer | Détermine quels rôles reçoivent quelles fonctionnalités de Zinn® Chat. | Aucun | Édition gratuite |
zinn_chat_save_settings | Filtrer | Filtrer les paramètres avant qu'ils ne soient enregistrés (Pro y ajoute ses propres clés). | Aucun | Édition gratuite |
zinn_chat_script_src | Filtrer | Filtre l'URL à partir de laquelle le widget de chat hébergé est chargé (mode connecté). | string $src | Édition gratuite |
zinn_chat_settings_before | Action | Sortie au-dessus du formulaire d'un onglet de paramètres. | string $tab | Édition gratuite |
zinn_chat_settings_fields | Filtrer | Filtre les champs d'un onglet de paramètres (Pro ajoute les siens). | string $tab | Édition gratuite |
zinn_chat_settings_tabs | Filtrer | Filtre les onglets des paramètres. | Aucun | Édition gratuite |
zinn_chat_setup_after | Action | Sortie sous la liste de contrôle de configuration (l'édition gratuite affiche la carte Pro ici). | Aucun | Édition gratuite |
zinn_chat_should_render | Filtrer | Dé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_facts | Filtrer | Filtre 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_strings | Filtrer | Filtre les textes du propriétaire proposés pour la traduction (Pro ajoute ses messages proactifs). | Aucun | Édition gratuite |
zinn_chat_system_prompt | Filtrer | Filtre l'invite système de l'assistant (Pro : règles de personnage et de transfert). | string $rules | Édition gratuite |
zinn_chat_team_online | Filtrer | Détermine si une personne peut répondre maintenant (Pro ajoute les heures d'ouverture ici). | bool $online | Édition gratuite |
zinn_chat_ticket_assigned | Action | An 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_created | Action | Un 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_extra | Filtrer | Filtre 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_fields | Filtrer | Filtre 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_reply | Action | Une 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_status | Action | Un ticket a changé de statut. | int $id, string $status, string $old | Édition gratuite |
zinn_chat_uninstall | Action | Zinn® Chat est en cours de désinstallation (Pro supprime ses propres données ici). | Aucun | Édition gratuite |
zinn_chat_widget_config | Filtrer | Filtre la configuration du lanceur affichée sur la page. | Aucun | Édition gratuite |
zinn_chat_widget_status | Filtrer | Filtre ce que le chat ouvert reçoit (Pro ajoute ses propres commutateurs et mots). | Aucun | Édition gratuite |