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.

Guia do usuário: conectar um aplicativo de IA

Zinn®, nosso Viking, comemorando enquanto um assistente de IA se conecta às ferramentas da plataforma.

Endpoints

MCP sobre HTTP (streaming)

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

MCP 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-chat

REST: executar uma habilidade

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

Autenticaçã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.

RecursoO que fazEdiçãoRESTPermissãoParâmetros
zinn-chat/answer-ticket
zinn-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 gratuitaPOST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/ask-assistant
zinn-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 gratuitaPOST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission checkquestion: string (obrigatório), language: string
zinn-chat/bulk-update-tickets
zinn-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 ProPOST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (obrigatório), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-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 gratuitaPOST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/close-chat
zinn-chat-close-chat
Fechar um chat
Encerra um chat; o visitante ainda pode solicitar a transcrição.
Edição gratuitaPOST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/create-ticket
zinn-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 gratuitaPOST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission checkemail: string (obrigatório), subject: string (obrigatório), body: string (obrigatório), name: string
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
Excluir uma resposta salva (Pro)
Exclui uma resposta salva.
Edição ProPOST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
Excluir um chamado
Exclui um tíquete e sua conversa permanentemente (somente gerentes).
Edição gratuitaPOST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/draft-kb-article
zinn-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 ProPOST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)ticket: integer (obrigatório)
zinn-chat/draft-kb-from-gaps
zinn-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 ProPOST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)ids: array (obrigatório)
zinn-chat/fill-canned-reply
zinn-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 ProPOST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/get-chat
zinn-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 gratuitaGET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/get-overview
zinn-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 gratuitaGET …/abilities/zinn-chat/get-overview/runzinn_chat_answernenhum
zinn-chat/get-settings
zinn-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 gratuitaGET …/abilities/zinn-chat/get-settings/runzinn_chat_managenenhum
zinn-chat/get-stats
zinn-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 ProGET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission checkdays: integer
zinn-chat/get-ticket
zinn-chat-get-ticket
Ler um ticket
Retorna um ticket com todo o seu histórico de conversa, status, prioridade e responsável.
Edição gratuitaGET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/hand-chat-to-assistant
zinn-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 gratuitaPOST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
Listar respostas salvas (Pro)
Lista as respostas salvas que os agentes podem inserir, com seus atalhos.
Edição ProGET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission checknenhum
zinn-chat/list-chats
zinn-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 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
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 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
Listar perguntas não respondidas (Pro)
Lista as perguntas feitas pelos visitantes que a base de conhecimento não conseguiu responder.
Edição 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
Listar chamados
Lista os chamados de suporte, filtrados por status ou pesquisa, uma página por vez.
Edição 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
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 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
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 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
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 gratuitaPOST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/save-canned-reply
zinn-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 ProPOST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission checkid: integer, title: string (obrigatório), body: string (obrigatório), shortcut: string, department: string
zinn-chat/save-kb-article
zinn-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 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
Pesquise na base de conhecimento (Pro)
Encontra artigos de ajuda para incluir como link em uma resposta (q: a busca).
Edição ProGET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission checkq: string (obrigatório)
zinn-chat/set-conversation-details
zinn-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 ProPOST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obrigatório), department: string, tags: array
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
Marcar perguntas sem resposta (Pro)
Marca perguntas não respondidas como abertas, planejadas ou dispensadas (ids, status).
Edição ProPOST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission checkids: array (obrigatório), status: open|drafted|answered|ignored (obrigatório)
zinn-chat/set-presence
zinn-chat-set-presence
Defina sua disponibilidade
Marca o atendente conectado como disponível ou ausente para novos chats (away: true ou false).
Edição gratuitaPOST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkaway: boolean
zinn-chat/suggest-reply
zinn-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 ProPOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obrigatório)
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
Resumir uma conversa com IA (Pro)
Resume um chat ou chamado em poucas linhas.
Edição ProPOST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obrigatório)
zinn-chat/take-chat
zinn-chat-take-chat
Atender um chat
Atribui um chat em espera ao agente conectado, para que o visitante fale com uma pessoa.
Edição gratuitaPOST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (obrigatório)
zinn-chat/update-settings
zinn-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 gratuitaPOST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (obrigatório)
zinn-chat/update-ticket
zinn-chat-update-ticket
Alterar um chamado
Altera o status, a prioridade ou o responsável de um chamado.
Edição gratuitaPOST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: 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.

WebhookTipoO que fazParâmetrosEdição
zinn_chat_admin_pagesFiltrarFiltra as telas de administração do Zinn® Chat (o Pro adiciona as suas próprias).nenhumEdição gratuita
zinn_chat_agent_chatFiltrarFiltra o payload do chat para o console do agente (o plano Pro adiciona detalhes do visitante, notas e sugestões da base de conhecimento).nenhumEdição gratuita
zinn_chat_agent_pagesFiltrarFiltra as telas do Zinn® Chat que uma conta de agente de Suporte pode abrir.nenhumEdição Pro
zinn_chat_agent_script_srcFiltrarFiltra a URL de onde o agente de chat de IA independente é carregado.string $srcEdição gratuita
zinn_chat_agent_ticketFiltrarFiltra a carga útil do ticket para o wp-admin (o Pro adiciona respostas prontas, SLA, sugestões de KB).nenhumEdição gratuita
zinn_chat_answerFiltrarFiltra a resposta de um assistente antes de ser exibida (o Pro adiciona seus extras aqui).string $questionEdição gratuita
zinn_chat_assistant_answeredAçãoO assistente respondeu a um visitante.int $id, string $textEdição gratuita
zinn_chat_challengeFiltrarFiltra 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 } )`).nenhumEdição gratuita
zinn_chat_challenge_okFiltrarFiltra 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 $whereEdição gratuita
zinn_chat_client_ipFiltrarFiltra o endereço IP do visitante usado para limites de taxa e registros.string $ipEdição gratuita
zinn_chat_console_configFiltrarFiltra a configuração extra repassada para o script do console do operador; o Zinn® Chat Pro adiciona seus recursos aqui.nenhumEdição gratuita
zinn_chat_conversation_startedAçãoUm visitante iniciou um chat.int $idEdição gratuita
zinn_chat_conversation_statusAçãoO status de uma conversa foi alterado.int $id, string $status, string $oldEdição gratuita
zinn_chat_customer_ticket_urlFiltrarFiltra o link que é enviado ao cliente para o seu ticket.string $urlEdição gratuita
zinn_chat_elementsFiltrarFiltra os elementos do front-end oferecidos como blocos e módulos do construtor.nenhumEdição gratuita
zinn_chat_emailFiltrarFiltra um e-mail antes de ele ser enviado. Retorne um `to` vazio para interrompê-lo.nenhumEdição gratuita
zinn_chat_fs_loadedAçãoDis 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()`.nenhumEdição gratuita
zinn_chat_index_extractFiltrarFiltra um objeto extraído (ou fornece um para um tipo de objeto personalizado).string $type, int $idEdição gratuita
zinn_chat_index_languageFiltrarFiltra o idioma (localidade) de uma postagem indexada.string $language, \WP_Post $postEdição gratuita
zinn_chat_index_objectPonto de entrada (você o aciona)WebhooksnenhumEdição gratuita
zinn_chat_index_post_typesFiltrarFiltra os tipos de post que o assistente lê.nenhumEdição gratuita
zinn_chat_indexableFiltrarFiltra se uma postagem é indexada.bool $indexable, \WP_Post $postEdição gratuita
zinn_chat_indexedAçãoUm objeto foi (re)indexado.string $type, int $idEdição gratuita
zinn_chat_is_proFiltrarFiltra 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 $proEdição gratuita
zinn_chat_loadedAçãoZinn® Chat foi carregado (o ponto de extensão para complementos).nenhumEdição gratuita
zinn_chat_message_addedAçãoUma mensagem foi adicionada a uma conversa.int $id, int $conversation_id, string $roleEdição gratuita
zinn_chat_order_trackingFiltrarFiltra as informações de rastreamento fornecidas ao assistente para um pedido.\WC_Order $orderEdição gratuita
zinn_chat_pro_alertAçãoOcorreu um evento digno de alerta (as notificações push escutam aqui).string $alert, int $id, string $text, string $linkEdição Pro
zinn_chat_pro_assignedAçãoUm ticket foi atribuído a um atendente automaticamente.int $id, int $agentEdição Pro
zinn_chat_pro_loadedAçãoA camada Pro foi carregada.nenhumEdição Pro
zinn_chat_pro_priority_changedAçãoA prioridade de um chamado foi alterada (as metas de SLA seguem essa alteração).int $idEdição Pro
zinn_chat_pro_sla_breachAçãoUma meta de SLA não foi cumprida.int $ticket_id, string $whichEdição Pro
zinn_chat_pro_ticket_ratedAçãoUm cliente avaliou um chamado resolvido (1-5).int $id, int $scoreEdição Pro
zinn_chat_ratedAçãoDisparado 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 $ratingEdição gratuita
zinn_chat_role_capabilitiesFiltrarFiltra quais funções recebem quais recursos do Zinn® Chat.nenhumEdição gratuita
zinn_chat_save_settingsFiltrarFiltra as configurações antes de serem armazenadas (o Pro adiciona suas próprias chaves aqui).nenhumEdição gratuita
zinn_chat_script_srcFiltrarFiltra a URL de onde o widget de chat hospedado é carregado (modo conectado).string $srcEdição gratuita
zinn_chat_settings_beforeAçãoSaída acima do formulário de uma aba de configurações.string $tabEdição gratuita
zinn_chat_settings_fieldsFiltrarFiltra os campos de uma aba de configurações (o Pro adiciona os seus próprios).string $tabEdição gratuita
zinn_chat_settings_tabsFiltrarFiltra as guias de configurações.nenhumEdição gratuita
zinn_chat_setup_afterAçãoSaída sob a lista de verificação de configuração (a edição gratuita exibe o cartão Pro aqui).nenhumEdição gratuita
zinn_chat_should_renderFiltrarFiltra se o chat é renderizado nesta solicitação (os ganchos de direcionamento de página do Pro entram aqui).bool $renderEdição gratuita
zinn_chat_site_factsFiltrarFiltra 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 $languageEdição gratuita
zinn_chat_site_stringsFiltrarFiltra os textos do proprietário oferecidos para tradução (o Pro adiciona suas mensagens proativas).nenhumEdição gratuita
zinn_chat_system_promptFiltrarFiltra o prompt do sistema do assistente (Pro: regras de persona e transferência).string $rulesEdição gratuita
zinn_chat_team_onlineFiltrarFiltra se uma pessoa pode responder agora (o Pro adiciona o horário comercial aqui).bool $onlineEdição gratuita
zinn_chat_ticket_assignedAçãoAn agent assigned a ticket to an agent (2.14.0: the notification centre tells them).int $id, int $assignee, int $byEdição gratuita
zinn_chat_ticket_createdAçãoUm 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 $tokenEdição gratuita
zinn_chat_ticket_form_extraFiltrarFiltra marcação extra no final de um formulário de ticket de convidado (a verificação humana do Pro vai aqui).string $htmlEdição gratuita
zinn_chat_ticket_form_fieldsFiltrarFiltra 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 $htmlEdição gratuita
zinn_chat_ticket_replyAçãoUma resposta foi adicionada a um chamado. O Mailer envia e-mails para a outra parte a partir daqui.int $id, int $ticket_id, string $authorEdição gratuita
zinn_chat_ticket_statusAçãoUm chamado teve o status alterado.int $id, string $status, string $oldEdição gratuita
zinn_chat_uninstallAçãoO Zinn® Chat está sendo desinstalado (o Pro remove seus próprios dados aqui).nenhumEdição gratuita
zinn_chat_widget_configFiltrarFiltra a configuração do inicializador exibida na página.nenhumEdição gratuita
zinn_chat_widget_statusFiltrarFiltra o que o chat aberto recebe (o Pro adiciona seus próprios seletores e palavras).nenhumEdição gratuita