Sviluppatori

Riferimento capacità di Zinn® Chat

Zinn® Chat registra le proprie azioni con WordPress Abilities API. Le stesse capacità sono strumenti MCP sul server del sito e route REST sotto /wp-json/wp-abilities/v1. Questa pagina viene generata dal registro del plugin stesso.

Guida utente: collega un'app di IA

Zinn®, il nostro vichingo, esulta mentre un assistente IA si connette agli strumenti della piattaforma.

Endpoint

MCP su HTTP (streamable)

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

MCP su WP-CLI (standard input e output)

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

REST: elenca le capacità

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

REST: esegui un'abilità

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

Autenticazione e autorizzazioni

Le richieste HTTP si autenticano con una password applicativa WordPress (HTTP Basic). La connessione al server MCP richiede la funzionalità mostrata di seguito; ogni abilità verifica quindi la propria autorizzazione, per singolo oggetto. Le abilità di sola lettura vengono eseguite con GET e il relativo input nella query string; le altre con POST e un corpo JSON {"input": {…}}.

Esempi

# REST: esegui un'abilità
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":{}}}

Tutte le funzionalità

Generato dalle capacità del plugin tramite abilities.json, che a sua volta viene generato da un sito in esecuzione; un test fallisce quando i due non concordano.

AbilitazioneCosa faEdizioneRESTAutorizzazioneParametri
zinn-chat/answer-ticket
zinn-chat-answer-ticket
Rispondi a un ticket
Risponde al cliente via email (text) o aggiunge una nota interna (note: true); status modifica facoltativamente lo stato del ticket.
Edizione gratuitaPOST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/ask-assistant
zinn-chat-ask-assistant
Chiedi all'assistente
Pone una domanda all'assistente IA del sito e restituisce la sua risposta con tutte le fonti trovate.
Edizione gratuitaPOST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission checkquestion: string (obbligatorio), language: string
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
Modifica più ticket contemporaneamente (Pro)
Modifica lo stato, la priorità o l'assegnatario di un massimo di 100 ticket (ids). Ogni ticket viene sottoposto agli stessi controlli di una modifica singola; il risultato li elenca tutti.
Edizione ProPOST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (obbligatorio), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-chat-chat-to-ticket
Converti una chat in un ticket
Apre un ticket da una chat in modo da potervi rispondere via email (richiede l'indirizzo email del visitatore).
Edizione gratuitaPOST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/close-chat
zinn-chat-close-chat
Chiudi una chat
Termina una chat; il visitatore può ancora richiedere la trascrizione.
Edizione gratuitaPOST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/create-ticket
zinn-chat-create-ticket
Apri un ticket
Apre un ticket per conto di un cliente (la sua email, un oggetto e il primo messaggio).
Edizione gratuitaPOST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission checkemail: string (obbligatorio), subject: string (obbligatorio), body: string (obbligatorio), name: string
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
Elimina una risposta salvata (Pro)
Elimina una risposta salvata.
Edizione ProPOST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
Elimina un ticket
Elimina definitivamente un ticket e la sua conversazione (solo per i gestori).
Edizione gratuitaPOST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/draft-kb-article
zinn-chat-draft-kb-article
Crea una bozza di articolo di aiuto da un ticket (Pro)
Scrive una bozza di articolo per la knowledge base da un ticket risolto; rimane una bozza finché qualcuno non la pubblica.
Edizione ProPOST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)ticket: integer (obbligatorio)
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
Crea bozze di articoli di supporto per le domande senza risposta (Pro)
Scrive bozze di articoli della knowledge base che rispondono alle domande selezionate (id); rimangono bozze.
Edizione ProPOST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)ids: array (obbligatorio)
zinn-chat/fill-canned-reply
zinn-chat-fill-canned-reply
Inserisci una risposta salvata (Pro)
Restituisce il testo di una risposta salvata con i segnaposto compilati per una singola chat o ticket.
Edizione ProPOST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/get-chat
zinn-chat-get-chat
Leggi una chat
Restituisce i messaggi di una chat e i dettagli del visitatore (after: solo i messaggi più recenti di questo ID).
Edizione gratuitaGET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/get-overview
zinn-chat-get-overview
Leggi la panoramica del supporto
Restituisce quanti ticket si trovano in ciascuno stato, quante chat sono in attesa di un operatore (e i relativi messaggi non letti) e se la chat, l'assistente e i ticket sono attivati.
Edizione gratuitaGET …/abilities/zinn-chat/get-overview/runzinn_chat_answernessuno
zinn-chat/get-settings
zinn-chat-get-settings
Leggi le impostazioni della chat
Restituisce ogni impostazione della chat: il widget, l'assistente, le persone e gli orari di apertura, i ticket e l'email, l'indice del sito, la privacy e lo spam.
Edizione gratuitaGET …/abilities/zinn-chat/get-settings/runzinn_chat_managenessuno
zinn-chat/get-stats
zinn-chat-get-stats
Leggi le statistiche del supporto (Pro)
Restituisce il numero di chat e ticket, i tempi di risposta e le valutazioni per gli ultimi N giorni (giorni).
Edizione ProGET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission checkdays: integer
zinn-chat/get-ticket
zinn-chat-get-ticket
Leggi un ticket
Restituisce un ticket con l'intera conversazione, lo stato, la priorità e la persona assegnata.
Edizione gratuitaGET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/hand-chat-to-assistant
zinn-chat-hand-chat-to-assistant
Riassegna la chat all'assistente
Restituisce una chat all'assistente IA, che risponde al visitatore in base ai contenuti del sito.
Edizione gratuitaPOST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
Elenca le risposte salvate (Pro)
Elenca le risposte salvate che gli agenti possono inserire, insieme alle relative scorciatoie.
Edizione ProGET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission checknessuno
zinn-chat/list-chats
zinn-chat-list-chats
Elenca le chat dal vivo
Elenca le chat in attesa, in corso e chiuse di recente, indicando chi si occupa di ciascuna.
Edizione gratuitaGET …/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
Elenca cosa sa l'assistente
Elenca i contenuti da cui l'assistente risponde, con il relativo stato di indicizzazione, una pagina alla volta.
Edizione gratuitaGET …/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
Elenca domande senza risposta (Pro)
Elenca le domande poste dai visitatori a cui la knowledge base non ha saputo rispondere.
Edizione 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
Elenca ticket
Elenca i ticket di supporto, filtrati per stato o ricerca, una pagina alla volta.
Edizione gratuitaGET …/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
Ricostruisci l'indice di ricerca dell'assistente
Ricostruisce i vettori di ricerca per un elemento (item_id) o per tutto (all: true) (solo gestori).
Edizione gratuitaPOST …/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
Rileggi il contenuto nell'assistente
Rilegge un elemento (item_id) o tutto (all: true) nell'indice dell'assistente (solo per i gestori).
Edizione gratuitaPOST …/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
Rispondi in chat
Invia un messaggio al visitatore (text) o aggiunge una nota interna visibile solo agli agenti (note: true).
Edizione gratuitaPOST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/save-canned-reply
zinn-chat-save-canned-reply
Salva una risposta salvata (Pro)
Crea o modifica una risposta salvata (titolo, scorciatoia, corpo, reparto; id per modificarne una).
Edizione ProPOST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission checkid: integer, title: string (obbligatorio), body: string (obbligatorio), shortcut: string, department: string
zinn-chat/save-kb-article
zinn-chat-save-kb-article
Scrivi un articolo della guida (Pro)
Crea un articolo della knowledge base o ne modifica uno (id): titolo, contenuto, riassunto, categorie e stato (bozza o pubblica quando puoi pubblicare).
Edizione 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
Cerca nella knowledge base (Pro)
Trova articoli di supporto da collegare in una risposta (q: la ricerca).
Edizione ProGET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission checkq: string (obbligatorio)
zinn-chat/set-conversation-details
zinn-chat-set-conversation-details
Imposta il reparto e i tag di una conversazione (Pro)
Imposta il reparto e i tag di una chat o di un ticket (kind: chat o ticket; id).
Edizione ProPOST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obbligatorio), department: string, tags: array
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
Contrassegna le domande senza risposta (Pro)
Contrassegna le domande senza risposta come aperte, pianificate o archiviate (ids, status).
Edizione ProPOST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission checkids: array (obbligatorio), status: open|drafted|answered|ignored (obbligatorio)
zinn-chat/set-presence
zinn-chat-set-presence
Imposta la tua disponibilità
Contrassegna l'agente che ha effettuato l'accesso come disponibile o assente per nuove chat (away: true o false).
Edizione gratuitaPOST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkaway: boolean
zinn-chat/suggest-reply
zinn-chat-suggest-reply
Scrivi una bozza di risposta con l'IA (Pro)
Prepara una bozza di risposta a una chat o a un ticket dal contenuto del sito; non viene inviato nulla.
Edizione ProPOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obbligatorio)
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
Riassumi una conversazione con l'IA (Pro)
Riassume una chat o un ticket in poche righe.
Edizione ProPOST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obbligatorio)
zinn-chat/take-chat
zinn-chat-take-chat
Accetta una chat
Assegna una chat in attesa all'agente connesso, in modo che il visitatore parli con una persona.
Edizione gratuitaPOST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (obbligatorio)
zinn-chat/update-settings
zinn-chat-update-settings
Modifica le impostazioni della chat
Modifica le impostazioni che invii (impostazioni: chiave in valore) e mantiene il resto. Ogni valore viene controllato esattamente come nella schermata delle impostazioni; get-settings elenca le chiavi.
Edizione gratuitaPOST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (obbligatorio)
zinn-chat/update-ticket
zinn-chat-update-ticket
Modifica un ticket
Modifica lo stato, la priorità o l'assegnatario di un ticket.
Edizione gratuitaPOST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: string (obbligatorio)

Azioni e filtri

Ogni gancio offerto dal plugin, con la descrizione tratta dal suo codice sorgente. I filtri modificano un valore; le azioni consentono di eseguire codice in un determinato momento; i punti di ingresso sono azioni attivate per richiedere al plugin di eseguire un'operazione.

WebhookGenereCosa faParametriEdizione
zinn_chat_admin_pagesFiltraFiltra le schermate di amministrazione di Zinn® Chat (la versione Pro aggiunge le proprie).nessunoEdizione gratuita
zinn_chat_agent_chatFiltraFiltra il payload della chat per la console degli agenti (la versione Pro aggiunge dettagli dei visitatori, note e suggerimenti della KB).nessunoEdizione gratuita
zinn_chat_agent_pagesFiltraFiltra le schermate di Zinn® Chat che un account di supporto può aprire.nessunoEdizione Pro
zinn_chat_agent_script_srcFiltraFiltra l'URL da cui viene caricato l'agente di chat IA autonomo.string $srcEdizione gratuita
zinn_chat_agent_ticketFiltraFiltra il payload dei ticket per wp-admin (Pro aggiunge risposte predefinite, SLA, suggerimenti KB).nessunoEdizione gratuita
zinn_chat_answerFiltraFiltra la risposta di un assistente prima che venga mostrata (Pro aggiunge qui i suoi extra).string $questionEdizione gratuita
zinn_chat_assistant_answeredAzioneL'assistente ha risposto a un visitatore.int $id, string $textEdizione gratuita
zinn_chat_challengeFiltraFiltra il controllo umano mostrato ai visitatori (URL dello script, chiave del sito e oggetto globale definito dallo script con un metodo `render( element, { sitekey, callback } )`).nessunoEdizione gratuita
zinn_chat_challenge_okFiltraFiltra se il visitatore ha superato il controllo anti-bot. Un controllo che non può essere verificato deve restituire false (fail closed): un modulo che lascia passare qualsiasi cosa ogni volta che il servizio non è raggiungibile è un modulo che un bot può far riuscire sfruttando i tempi di risposta.bool $ok, string $ip, string $whereEdizione gratuita
zinn_chat_client_ipFiltraFiltra l'indirizzo IP del visitatore utilizzato per i limiti di frequenza e i record.string $ipEdizione gratuita
zinn_chat_console_configFiltraFiltra la configurazione extra passata allo script della console dell'operatore; Zinn® Chat Pro aggiunge qui le sue funzionalità.nessunoEdizione gratuita
zinn_chat_conversation_startedAzioneUn visitatore ha iniziato una chat.int $idEdizione gratuita
zinn_chat_conversation_statusAzioneLo stato di una conversazione è cambiato.int $id, string $status, string $oldEdizione gratuita
zinn_chat_customer_ticket_urlFiltraFiltra il link inviato a un cliente per il suo biglietto.string $urlEdizione gratuita
zinn_chat_elementsFiltraFiltra gli elementi del frontend offerti come blocchi e moduli del builder.nessunoEdizione gratuita
zinn_chat_emailFiltraFiltra un'email prima che venga inviata. Restituisci un `to` vuoto per interromperla.nessunoEdizione gratuita
zinn_chat_fs_loadedAzioneSi attiva una volta caricato l'SDK di licenza (nel file principale, prima di qualsiasi codice Zinn® Chat). Eseguire l'hook qui per comunicare con `zinn_chat_fs()`.nessunoEdizione gratuita
zinn_chat_index_extractFiltraFiltra un oggetto estratto (o ne fornisce uno per un tipo di oggetto personalizzato).string $type, int $idEdizione gratuita
zinn_chat_index_languageFiltraFiltra la lingua (localizzazione) di un post indicizzato.string $language, \WP_Post $postEdizione gratuita
zinn_chat_index_objectPunto di ingresso (lo attiva Lei)HooknessunoEdizione gratuita
zinn_chat_index_post_typesFiltraFiltra i tipi di post letti dall'assistente.nessunoEdizione gratuita
zinn_chat_indexableFiltraFiltra se un post viene indicizzato.bool $indexable, \WP_Post $postEdizione gratuita
zinn_chat_indexedAzioneUn oggetto è stato (ri)indicizzato.string $type, int $idEdizione gratuita
zinn_chat_is_proFiltraFiltra se le funzionalità Pro sono attive (una licenza acquistata o una prova, da Freemius). Il codice Pro viene fornito solo nel pacchetto premium, quindi questo non può aggiungere ciò che manca a quello gratuito.bool $proEdizione gratuita
zinn_chat_loadedAzioneZinn® Chat è stato caricato (il punto di estensione per i componenti aggiuntivi).nessunoEdizione gratuita
zinn_chat_message_addedAzioneÈ stato aggiunto un messaggio a una conversazione.int $id, int $conversation_id, string $roleEdizione gratuita
zinn_chat_order_trackingFiltraFiltra le informazioni di tracciamento fornite all'assistente per un ordine.\WC_Order $orderEdizione gratuita
zinn_chat_pro_alertAzioneSi è verificato un evento che merita un avviso (le notifiche push sono in ascolto qui).string $alert, int $id, string $text, string $linkEdizione Pro
zinn_chat_pro_assignedAzioneUn ticket è stato assegnato automaticamente a un agente.int $id, int $agentEdizione Pro
zinn_chat_pro_loadedAzioneIl livello Pro è stato caricato.nessunoEdizione Pro
zinn_chat_pro_priority_changedAzioneLa priorità di un ticket è cambiata (gli obiettivi SLA seguono questa modifica).int $idEdizione Pro
zinn_chat_pro_sla_breachAzioneÈ stato mancato un obiettivo SLA.int $ticket_id, string $whichEdizione Pro
zinn_chat_pro_ticket_ratedAzioneUn cliente ha valutato un ticket risolto (1-5).int $id, int $scoreEdizione Pro
zinn_chat_ratedAzioneSi attiva dopo che un visitatore valuta una conversazione, fornendo l'ID della conversazione e la valutazione (1 per utile, -1 per non utile).int $conversation_id, int $ratingEdizione gratuita
zinn_chat_role_capabilitiesFiltraFiltra quali ruoli ricevono quali funzionalità di Zinn® Chat.nessunoEdizione gratuita
zinn_chat_save_settingsFiltraConfigura i filtri prima che vengano salvati (Pro aggiunge le proprie chiavi qui).nessunoEdizione gratuita
zinn_chat_script_srcFiltraFiltra l'URL da cui viene caricato il widget di chat ospitato (modalità connessa).string $srcEdizione gratuita
zinn_chat_settings_beforeAzioneTesto sopra il modulo di una scheda delle impostazioni.string $tabEdizione gratuita
zinn_chat_settings_fieldsFiltraFiltra i campi di una scheda delle impostazioni (Pro aggiunge i propri).string $tabEdizione gratuita
zinn_chat_settings_tabsFiltraFiltra le schede delle impostazioni.nessunoEdizione gratuita
zinn_chat_setup_afterAzioneOutput sotto la checklist di configurazione (l'edizione gratuita mostra qui la scheda Pro).nessunoEdizione gratuita
zinn_chat_should_renderFiltraFiltra se la chat viene visualizzata in questa richiesta (i ganci di targeting delle pagine di Pro si collegano qui).bool $renderEdizione gratuita
zinn_chat_site_factsFiltraFiltra i dati relativi al sito forniti all'assistente a ogni domanda. Ciascuno è composto da `title`, `url` (su questo sito) e `text` (testo normale, massimo 3.000 caratteri); ne vengono utilizzati al massimo quattro.string $languageEdizione gratuita
zinn_chat_site_stringsFiltraFiltra i testi del proprietario offerti per la traduzione (Pro aggiunge i suoi messaggi proattivi).nessunoEdizione gratuita
zinn_chat_system_promptFiltraFiltra il prompt di sistema dell'assistente (Pro: persona e regole di passaggio).string $rulesEdizione gratuita
zinn_chat_team_onlineFiltraFiltra se una persona può rispondere adesso (Pro aggiunge qui gli orari di apertura).bool $onlineEdizione gratuita
zinn_chat_ticket_assignedAzioneAn agent assigned a ticket to an agent (2.14.0: the notification centre tells them).int $id, int $assignee, int $byEdizione gratuita
zinn_chat_ticket_createdAzioneÈ stato aperto un ticket. Il mailer invia da qui la conferma e l'avviso per il team.int $id, string $tokenEdizione gratuita
zinn_chat_ticket_form_extraFiltraFiltra il markup extra alla fine di un modulo di ticket per ospiti (il controllo umano di Pro viene inserito qui).string $htmlEdizione gratuita
zinn_chat_ticket_form_fieldsFiltraFiltri i campi extra mostrati sopra il messaggio in ogni modulo di ticket (Pro: una scelta di dipartimento). Nominali `zinn_chat_extra[<key>]`; arrivano a `zinn_chat_ticket_created` come `$fields['extra']`, non sanificati, affinché chi li ha aggiunti possa validarli.string $htmlEdizione gratuita
zinn_chat_ticket_replyAzioneÈ stata aggiunta una risposta a un ticket. Mailer invia un'email all'altra parte da qui.int $id, int $ticket_id, string $authorEdizione gratuita
zinn_chat_ticket_statusAzioneUn ticket ha cambiato stato.int $id, string $status, string $oldEdizione gratuita
zinn_chat_uninstallAzioneZinn® Chat è in fase di disinstallazione (Pro rimuove i propri dati qui).nessunoEdizione gratuita
zinn_chat_widget_configFiltraFiltra la configurazione del launcher stampata sulla pagina.nessunoEdizione gratuita
zinn_chat_widget_statusFiltraFiltra ciò che la chat aperta riceve (Pro aggiunge i propri interruttori e parole).nessunoEdizione gratuita