Desenvolvedores
Referência de capacidades de Zinn® Chat
Zinn® Chat registra suas ações na WordPress Abilities API. As mesmas habilidades são ferramentas de MCP no próprio servidor do site e rotas REST em /wp-json/wp-abilities/v1. Esta página é gerada a partir do registro do próprio plugin.
Endpoints
MCP sobre HTTP (streaming)
https://example.com/wp-json/zinn-chat/v1/mcpMCP sobre WP-CLI (entrada e saída padrão)
wp mcp-adapter serve --server=zinn-chat --user=<login>REST: listar as habilidades
/wp-json/wp-abilities/v1/abilities?category=zinn-chatREST: executar uma habilidade
/wp-json/wp-abilities/v1/abilities/<name>/runAutenticação e permissões
As solicitações HTTP autenticam-se com uma senha de aplicativo do WordPress (HTTP Basic). A conexão com o servidor MCP precisa do recurso mostrado abaixo; cada habilidade verifica então a sua própria permissão, por objeto. As habilidades somente leitura são executadas com GET e sua entrada na string de consulta; as demais, com POST e um corpo JSON {"input": {…}}.
Exemplos
# REST: executar uma habilidade
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":{}}}Todos os recursos
Gerado a partir do arquivo abilities.json do plugin, que por sua vez é gerado a partir de um site em execução; um teste falha quando os dois discordam.
| Recurso | O que faz | Edição | REST | Permissão | Parâmetros |
|---|---|---|---|---|---|
zinn-chat/answer-ticketzinn-chat-answer-ticket | Responder a um chamado Responde ao cliente por e-mail (text) ou adiciona uma nota interna (note: true); status altera opcionalmente o status do tíquete. | Edição gratuita | POST …/abilities/zinn-chat/answer-ticket/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/ask-assistantzinn-chat-ask-assistant | Pergunte ao assistente Faz uma pergunta ao assistente de IA do site e retorna sua resposta com todas as fontes encontradas. | Edição gratuita | POST …/abilities/zinn-chat/ask-assistant/run | the REST route's own per-item permission check | question: string (obrigatório), language: string |
zinn-chat/bulk-update-ticketszinn-chat-bulk-update-tickets | Altere vários tíquetes de uma vez (Pro) Altera o status, a prioridade ou o responsável de até 100 tíquetes (ids). Cada tíquete passa pelas mesmas verificações de quando é alterado individualmente; o resultado lista cada um deles. | Edição Pro | POST …/abilities/zinn-chat/bulk-update-tickets/run | zinn_chat_answer | ids: array (obrigatório), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer |
zinn-chat/chat-to-ticketzinn-chat-chat-to-ticket | Converter um chat em chamado Abre um chamado a partir de um chat para que possa ser respondido por e-mail (necessita do endereço de e-mail do visitante). | Edição gratuita | POST …/abilities/zinn-chat/chat-to-ticket/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/close-chatzinn-chat-close-chat | Fechar um chat Encerra um chat; o visitante ainda pode solicitar a transcrição. | Edição gratuita | POST …/abilities/zinn-chat/close-chat/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/create-ticketzinn-chat-create-ticket | Abrir um chamado Abre um chamado em nome de um cliente (o e-mail dele, um assunto e a primeira mensagem). | Edição gratuita | POST …/abilities/zinn-chat/create-ticket/run | the REST route's own per-item permission check | email: string (obrigatório), subject: string (obrigatório), body: string (obrigatório), name: string |
zinn-chat/delete-canned-replyzinn-chat-delete-canned-reply | Excluir uma resposta salva (Pro) Exclui uma resposta salva. | Edição Pro | POST …/abilities/zinn-chat/delete-canned-reply/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/delete-ticketzinn-chat-delete-ticket | Excluir um chamado Exclui um tíquete e sua conversa permanentemente (somente gerentes). | Edição gratuita | POST …/abilities/zinn-chat/delete-ticket/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/draft-kb-articlezinn-chat-draft-kb-article | Rascunhar um artigo de ajuda a partir de um chamado (Pro) Escreve um rascunho de artigo da base de conhecimento a partir de um tíquete resolvido; ele permanece como rascunho até que alguém o publique. | Edição Pro | POST …/abilities/zinn-chat/draft-kb-article/run | edit_posts (the REST route's own check) | ticket: integer (obrigatório) |
zinn-chat/draft-kb-from-gapszinn-chat-draft-kb-from-gaps | Crie rascunhos de artigos de ajuda para perguntas sem resposta (Pro) Escreve rascunhos de artigos da base de conhecimento respondendo às perguntas escolhidas (IDs); eles permanecem como rascunhos. | Edição Pro | POST …/abilities/zinn-chat/draft-kb-from-gaps/run | edit_posts (the REST route's own check) | ids: array (obrigatório) |
zinn-chat/fill-canned-replyzinn-chat-fill-canned-reply | Preencher uma resposta salva (Pro) Retorna o texto de uma resposta salva com seus marcadores preenchidos para um chat ou chamado. | Edição Pro | POST …/abilities/zinn-chat/fill-canned-reply/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/get-chatzinn-chat-get-chat | Ler uma conversa Retorna as mensagens e os detalhes do visitante de um chat (after: apenas mensagens mais recentes que este ID). | Edição gratuita | GET …/abilities/zinn-chat/get-chat/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/get-overviewzinn-chat-get-overview | Leia a visão geral do suporte Retorna quantos tíquetes estão em cada status, quantos chats estão aguardando um atendente (e suas mensagens não lidas) e se o chat, o assistente e os tíquetes estão ativados. | Edição gratuita | GET …/abilities/zinn-chat/get-overview/run | zinn_chat_answer | nenhum |
zinn-chat/get-settingszinn-chat-get-settings | Leia as configurações de chat Retorna todas as configurações de chat: o widget, o assistente, pessoas e horário de funcionamento, tickets e e-mail, o índice do site, privacidade e spam. | Edição gratuita | GET …/abilities/zinn-chat/get-settings/run | zinn_chat_manage | nenhum |
zinn-chat/get-statszinn-chat-get-stats | Ler estatísticas de suporte (Pro) Retorna o número de chats e tíquetes, tempos de resposta e avaliações dos últimos N dias (dias). | Edição 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 | Ler um ticket Retorna um ticket com todo o seu histórico de conversa, status, prioridade e responsável. | Edição gratuita | GET …/abilities/zinn-chat/get-ticket/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/hand-chat-to-assistantzinn-chat-hand-chat-to-assistant | Devolver o chat ao assistente Retorna uma conversa ao assistente de IA, que responde ao visitante a partir do conteúdo do site. | Edição gratuita | POST …/abilities/zinn-chat/hand-chat-to-assistant/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/list-canned-replieszinn-chat-list-canned-replies | Listar respostas salvas (Pro) Lista as respostas salvas que os agentes podem inserir, com seus atalhos. | Edição Pro | GET …/abilities/zinn-chat/list-canned-replies/run | the REST route's own per-item permission check | nenhum |
zinn-chat/list-chatszinn-chat-list-chats | Listar chats ao vivo Lista os chats em espera, em andamento e encerrados recentemente, com a informação de quem está atendendo cada um. | Edição gratuita | 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 | Liste o que o assistente sabe Lista o conteúdo a partir do qual o assistente responde, com seu status de indexação, uma página por vez. | Edição gratuita | 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 | Listar perguntas não respondidas (Pro) Lista as perguntas feitas pelos visitantes que a base de conhecimento não conseguiu responder. | Edição 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 | Listar chamados Lista os chamados de suporte, filtrados por status ou pesquisa, uma página por vez. | Edição gratuita | 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 | Reconstruir o índice de busca do assistente Reconstrói os vetores de pesquisa para um item (item_id) ou para tudo (all: true) (apenas gerentes). | Edição gratuita | 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 | Releia o conteúdo no assistente Lê novamente um item (item_id) ou tudo (all: true) para o índice do assistente (apenas gerentes). | Edição gratuita | 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 | Responder em um chat Envia uma mensagem para o visitante (text) ou adiciona uma nota interna visível apenas para os agentes (note: true). | Edição gratuita | POST …/abilities/zinn-chat/reply-chat/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/save-canned-replyzinn-chat-save-canned-reply | Salvar uma resposta salva (Pro) Cria ou altera uma resposta salva (título, atalho, corpo, departamento; id para alterar uma). | Edição Pro | POST …/abilities/zinn-chat/save-canned-reply/run | the REST route's own per-item permission check | id: integer, title: string (obrigatório), body: string (obrigatório), shortcut: string, department: string |
zinn-chat/save-kb-articlezinn-chat-save-kb-article | Escrever um artigo de ajuda (Pro) Cria um artigo da base de conhecimento ou altera um (id): título, conteúdo, resumo, categorias e status (rascunho ou publicar quando você puder publicar). | Edição 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 | Pesquise na base de conhecimento (Pro) Encontra artigos de ajuda para incluir como link em uma resposta (q: a busca). | Edição Pro | GET …/abilities/zinn-chat/search-kb/run | the REST route's own per-item permission check | q: string (obrigatório) |
zinn-chat/set-conversation-detailszinn-chat-set-conversation-details | Defina o departamento e as tags de uma conversa (Pro) Define o departamento e as tags de um chat ou tíquete (kind: chat ou tíquete; id). | Edição Pro | POST …/abilities/zinn-chat/set-conversation-details/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (obrigatório), department: string, tags: array |
zinn-chat/set-kb-gap-statuszinn-chat-set-kb-gap-status | Marcar perguntas sem resposta (Pro) Marca perguntas não respondidas como abertas, planejadas ou dispensadas (ids, status). | Edição Pro | POST …/abilities/zinn-chat/set-kb-gap-status/run | the REST route's own per-item permission check | ids: array (obrigatório), status: open|drafted|answered|ignored (obrigatório) |
zinn-chat/set-presencezinn-chat-set-presence | Defina sua disponibilidade Marca o atendente conectado como disponível ou ausente para novos chats (away: true ou false). | Edição gratuita | 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 | Elabore um rascunho de resposta com IA (Pro) Cria um rascunho de resposta para um chat ou chamado a partir do conteúdo do site; nada é enviado. | Edição Pro | POST …/abilities/zinn-chat/suggest-reply/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (obrigatório) |
zinn-chat/summarise-conversationzinn-chat-summarise-conversation | Resumir uma conversa com IA (Pro) Resume um chat ou chamado em poucas linhas. | Edição Pro | POST …/abilities/zinn-chat/summarise-conversation/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (obrigatório) |
zinn-chat/take-chatzinn-chat-take-chat | Atender um chat Atribui um chat em espera ao agente conectado, para que o visitante fale com uma pessoa. | Edição gratuita | POST …/abilities/zinn-chat/take-chat/run | the REST route's own per-item permission check | id: string (obrigatório) |
zinn-chat/update-settingszinn-chat-update-settings | Alterar as configurações do chat Altera as configurações que você envia (configurações: chave para valor) e mantém as restantes. Cada valor é verificado exatamente como na tela de configurações; get-settings lista as chaves. | Edição gratuita | POST …/abilities/zinn-chat/update-settings/run | zinn_chat_manage | settings: object (obrigatório) |
zinn-chat/update-ticketzinn-chat-update-ticket | Alterar um chamado Altera o status, a prioridade ou o responsável de um chamado. | Edição gratuita | POST …/abilities/zinn-chat/update-ticket/run | the REST route's own per-item permission check | id: string (obrigatório) |
Ações e filtros
Cada hook que o plugin oferece, com a descrição do seu código-fonte. Os filtros alteram um valor; as ações permitem executar código em um determinado momento; os pontos de entrada são ações que você dispara para solicitar que o plugin faça algo.
| Webhook | Tipo | O que faz | Parâmetros | Edição |
|---|---|---|---|---|
zinn_chat_admin_pages | Filtrar | Filtra as telas de administração do Zinn® Chat (o Pro adiciona as suas próprias). | nenhum | Edição gratuita |
zinn_chat_agent_chat | Filtrar | Filtra o payload do chat para o console do agente (o plano Pro adiciona detalhes do visitante, notas e sugestões da base de conhecimento). | nenhum | Edição gratuita |
zinn_chat_agent_pages | Filtrar | Filtra as telas do Zinn® Chat que uma conta de agente de Suporte pode abrir. | nenhum | Edição Pro |
zinn_chat_agent_script_src | Filtrar | Filtra a URL de onde o agente de chat de IA independente é carregado. | string $src | Edição gratuita |
zinn_chat_agent_ticket | Filtrar | Filtra a carga útil do ticket para o wp-admin (o Pro adiciona respostas prontas, SLA, sugestões de KB). | nenhum | Edição gratuita |
zinn_chat_answer | Filtrar | Filtra a resposta de um assistente antes de ser exibida (o Pro adiciona seus extras aqui). | string $question | Edição gratuita |
zinn_chat_assistant_answered | Ação | O assistente respondeu a um visitante. | int $id, string $text | Edição gratuita |
zinn_chat_challenge | Filtrar | Filtra a verificação humana exibida aos visitantes (URL do script, chave do site e o objeto global que o script define com um método `render( element, { sitekey, callback } )`). | nenhum | Edição gratuita |
zinn_chat_challenge_ok | Filtrar | Filtra se o visitante passou na verificação humana. Uma verificação que não puder ser validada deve retornar falso (falha restritiva): um formulário que deixa tudo passar sempre que o serviço estiver inacessível é um formulário que um bot pode fazer ser bem-sucedido por meio de tempo. | bool $ok, string $ip, string $where | Edição gratuita |
zinn_chat_client_ip | Filtrar | Filtra o endereço IP do visitante usado para limites de taxa e registros. | string $ip | Edição gratuita |
zinn_chat_console_config | Filtrar | Filtra a configuração extra repassada para o script do console do operador; o Zinn® Chat Pro adiciona seus recursos aqui. | nenhum | Edição gratuita |
zinn_chat_conversation_started | Ação | Um visitante iniciou um chat. | int $id | Edição gratuita |
zinn_chat_conversation_status | Ação | O status de uma conversa foi alterado. | int $id, string $status, string $old | Edição gratuita |
zinn_chat_customer_ticket_url | Filtrar | Filtra o link que é enviado ao cliente para o seu ticket. | string $url | Edição gratuita |
zinn_chat_elements | Filtrar | Filtra os elementos do front-end oferecidos como blocos e módulos do construtor. | nenhum | Edição gratuita |
zinn_chat_email | Filtrar | Filtra um e-mail antes de ele ser enviado. Retorne um `to` vazio para interrompê-lo. | nenhum | Edição gratuita |
zinn_chat_fs_loaded | Ação | Dis dispara assim que o SDK de licenciamento for carregado (no arquivo principal, antes de qualquer código do Zinn® Chat). Conecte-se aqui para interagir com `zinn_chat_fs()`. | nenhum | Edição gratuita |
zinn_chat_index_extract | Filtrar | Filtra um objeto extraído (ou fornece um para um tipo de objeto personalizado). | string $type, int $id | Edição gratuita |
zinn_chat_index_language | Filtrar | Filtra o idioma (localidade) de uma postagem indexada. | string $language, \WP_Post $post | Edição gratuita |
zinn_chat_index_object | Ponto de entrada (você o aciona) | Webhooks | nenhum | Edição gratuita |
zinn_chat_index_post_types | Filtrar | Filtra os tipos de post que o assistente lê. | nenhum | Edição gratuita |
zinn_chat_indexable | Filtrar | Filtra se uma postagem é indexada. | bool $indexable, \WP_Post $post | Edição gratuita |
zinn_chat_indexed | Ação | Um objeto foi (re)indexado. | string $type, int $id | Edição gratuita |
zinn_chat_is_pro | Filtrar | Filtra se os recursos Pro são executados (uma licença adquirida ou uma avaliação, do Freemius). O código Pro é fornecido apenas no pacote premium, portanto, isso não pode adicionar o que falta no gratuito. | bool $pro | Edição gratuita |
zinn_chat_loaded | Ação | Zinn® Chat foi carregado (o ponto de extensão para complementos). | nenhum | Edição gratuita |
zinn_chat_message_added | Ação | Uma mensagem foi adicionada a uma conversa. | int $id, int $conversation_id, string $role | Edição gratuita |
zinn_chat_order_tracking | Filtrar | Filtra as informações de rastreamento fornecidas ao assistente para um pedido. | \WC_Order $order | Edição gratuita |
zinn_chat_pro_alert | Ação | Ocorreu um evento digno de alerta (as notificações push escutam aqui). | string $alert, int $id, string $text, string $link | Edição Pro |
zinn_chat_pro_assigned | Ação | Um ticket foi atribuído a um atendente automaticamente. | int $id, int $agent | Edição Pro |
zinn_chat_pro_loaded | Ação | A camada Pro foi carregada. | nenhum | Edição Pro |
zinn_chat_pro_priority_changed | Ação | A prioridade de um chamado foi alterada (as metas de SLA seguem essa alteração). | int $id | Edição Pro |
zinn_chat_pro_sla_breach | Ação | Uma meta de SLA não foi cumprida. | int $ticket_id, string $which | Edição Pro |
zinn_chat_pro_ticket_rated | Ação | Um cliente avaliou um chamado resolvido (1-5). | int $id, int $score | Edição Pro |
zinn_chat_rated | Ação | Disparado após um visitante avaliar uma conversa, com o ID da conversa e a avaliação (1 para útil, -1 para não útil). | int $conversation_id, int $rating | Edição gratuita |
zinn_chat_role_capabilities | Filtrar | Filtra quais funções recebem quais recursos do Zinn® Chat. | nenhum | Edição gratuita |
zinn_chat_save_settings | Filtrar | Filtra as configurações antes de serem armazenadas (o Pro adiciona suas próprias chaves aqui). | nenhum | Edição gratuita |
zinn_chat_script_src | Filtrar | Filtra a URL de onde o widget de chat hospedado é carregado (modo conectado). | string $src | Edição gratuita |
zinn_chat_settings_before | Ação | Saída acima do formulário de uma aba de configurações. | string $tab | Edição gratuita |
zinn_chat_settings_fields | Filtrar | Filtra os campos de uma aba de configurações (o Pro adiciona os seus próprios). | string $tab | Edição gratuita |
zinn_chat_settings_tabs | Filtrar | Filtra as guias de configurações. | nenhum | Edição gratuita |
zinn_chat_setup_after | Ação | Saída sob a lista de verificação de configuração (a edição gratuita exibe o cartão Pro aqui). | nenhum | Edição gratuita |
zinn_chat_should_render | Filtrar | Filtra se o chat é renderizado nesta solicitação (os ganchos de direcionamento de página do Pro entram aqui). | bool $render | Edição gratuita |
zinn_chat_site_facts | Filtrar | Filtra os fatos sobre o site fornecidos ao assistente a cada pergunta. Cada um contém `title`, `url` (neste site) e `text` (texto simples, no máximo 3.000 caracteres); no máximo quatro são usados. | string $language | Edição gratuita |
zinn_chat_site_strings | Filtrar | Filtra os textos do proprietário oferecidos para tradução (o Pro adiciona suas mensagens proativas). | nenhum | Edição gratuita |
zinn_chat_system_prompt | Filtrar | Filtra o prompt do sistema do assistente (Pro: regras de persona e transferência). | string $rules | Edição gratuita |
zinn_chat_team_online | Filtrar | Filtra se uma pessoa pode responder agora (o Pro adiciona o horário comercial aqui). | bool $online | Edição gratuita |
zinn_chat_ticket_assigned | Ação | An agent assigned a ticket to an agent (2.14.0: the notification centre tells them). | int $id, int $assignee, int $by | Edição gratuita |
zinn_chat_ticket_created | Ação | Um chamado foi aberto. O serviço de e-mail envia a confirmação e o alerta para a equipe a partir daqui. | int $id, string $token | Edição gratuita |
zinn_chat_ticket_form_extra | Filtrar | Filtra marcação extra no final de um formulário de ticket de convidado (a verificação humana do Pro vai aqui). | string $html | Edição gratuita |
zinn_chat_ticket_form_fields | Filtrar | Filtra campos extras exibidos acima da mensagem em cada formulário de chamado (Pro: uma escolha de departamento). Nomeie-os como `zinn_chat_extra[<key>]`; eles chegam a `zinn_chat_ticket_created` como `$fields['extra']`, sem higienização, para quem os adicionou validar. | string $html | Edição gratuita |
zinn_chat_ticket_reply | Ação | Uma resposta foi adicionada a um chamado. O Mailer envia e-mails para a outra parte a partir daqui. | int $id, int $ticket_id, string $author | Edição gratuita |
zinn_chat_ticket_status | Ação | Um chamado teve o status alterado. | int $id, string $status, string $old | Edição gratuita |
zinn_chat_uninstall | Ação | O Zinn® Chat está sendo desinstalado (o Pro remove seus próprios dados aqui). | nenhum | Edição gratuita |
zinn_chat_widget_config | Filtrar | Filtra a configuração do inicializador exibida na página. | nenhum | Edição gratuita |
zinn_chat_widget_status | Filtrar | Filtra o que o chat aberto recebe (o Pro adiciona seus próprios seletores e palavras). | nenhum | Edição gratuita |