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 ele 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); o status altera opcionalmente o status do ticket. | 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 | Perguntar ao assistente Faz uma pergunta ao assistente de IA do site e retorna a 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 | nenhum |
zinn-chat/bulk-update-ticketszinn-chat-bulk-update-tickets | Alterar vários tickets de uma só vez (Pro) Altera o status, a prioridade ou o responsável por até 100 tickets (ids). Cada ticket 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 | Transformar um chat em um chamado Abre um chamado a partir de um chat para que ele 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 | nenhum |
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 ticket Exclui permanentemente um ticket e sua respectiva conversa (somente para 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 | Esboçar um artigo de ajuda a partir de um ticket (Pro) Escreve um rascunho de artigo da base de conhecimento a partir de um ticket 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) | nenhum |
zinn-chat/draft-kb-from-gapszinn-chat-draft-kb-from-gaps | Escrever 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) | nenhum |
zinn-chat/fill-canned-replyzinn-chat-fill-canned-reply | Preencher com uma resposta salva (Pro) Retorna o texto de uma resposta salva com seus espaços reservados 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 um chat Retorna as mensagens de um chat e os detalhes do visitante (after: apenas mensagens mais recentes do 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 | Ler a visão geral do suporte Retorna quantos tickets estão em cada status e quantos chats estão aguardando por uma pessoa (e suas mensagens não lidas), e se o chat, o assistente e os tickets estão ativados. | Edição gratuita | GET …/abilities/zinn-chat/get-overview/run | zinn_chat_answer | nenhum |
zinn-chat/get-settingszinn-chat-get-settings | Ler as configurações do chat Retorna todas as configurações de chat: o widget, o assistente, pessoas e horário de atendimento, 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 tickets, os tempos de resposta e as 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 | nenhum |
zinn-chat/get-ticketzinn-chat-get-ticket | Ler ticket Retorna um ticket com toda a sua 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 um chat para o assistente Retorna um chat para o assistente de IA, que responde ao visitante com base no 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 atendentes podem inserir, juntamente 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 aguardando, em andamento e recentemente encerrados, indicando quem está atendendo cada um. | Edição gratuita | GET …/abilities/zinn-chat/list-chats/run | the REST route's own per-item permission check | nenhum |
zinn-chat/list-indexed-contentzinn-chat-list-indexed-content | Liste o que o assistente sabe Lista o conteúdo que o assistente usa para responder, com o respectivo 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 | nenhum |
zinn-chat/list-kb-gapszinn-chat-list-kb-gaps | Listar perguntas sem resposta (Pro) Lista as perguntas feitas pelos visitantes que a base de conhecimento não pôde responder. | Edição Pro | GET …/abilities/zinn-chat/list-kb-gaps/run | the REST route's own per-item permission check | nenhum |
zinn-chat/list-ticketszinn-chat-list-tickets | Listar tickets Lista tickets 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 | nenhum |
zinn-chat/reembed-contentzinn-chat-reembed-content | Reconstruir o índice de pesquisa do assistente Reconstrói os vetores de busca para um item (item_id) ou para tudo (all: true) (apenas para gerentes). | Edição gratuita | POST …/abilities/zinn-chat/reembed-content/run | the REST route's own per-item permission check | nenhum |
zinn-chat/reindex-contentzinn-chat-reindex-content | Releia o conteúdo para o assistente Releia um único item (item_id) ou tudo (all: true) para o índice do assistente (apenas para gerentes). | Edição gratuita | POST …/abilities/zinn-chat/reindex-content/run | the REST route's own per-item permission check | nenhum |
zinn-chat/reply-chatzinn-chat-reply-chat | Responder no chat Envia uma mensagem para o visitante (text) ou adiciona uma nota interna que apenas os agentes veem (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 | nenhum |
zinn-chat/save-kb-articlezinn-chat-save-kb-article | Escrever um artigo de ajuda (Pro) Cria um artigo de 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 | Pesquisar na base de conhecimento (Pro) Encontra artigos de ajuda para incluir num link em uma resposta (q: a pesquisa). | Edição Pro | GET …/abilities/zinn-chat/search-kb/run | the REST route's own per-item permission check | nenhum |
zinn-chat/set-conversation-detailszinn-chat-set-conversation-details | Definir o departamento e as tags de uma conversa (Pro) Define o departamento e as tags de um chat ou tíquete (tipo: 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 | nenhum |
zinn-chat/set-kb-gap-statuszinn-chat-set-kb-gap-status | Marcar perguntas sem resposta (Pro) Marca as perguntas não respondidas como abertas, planejadas ou descartadas (ids, status). | Edição Pro | POST …/abilities/zinn-chat/set-kb-gap-status/run | the REST route's own per-item permission check | nenhum |
zinn-chat/set-presencezinn-chat-set-presence | Defina sua disponibilidade Marca o agente conectado como disponível ou ausente para novos chats (ausente: true ou false). | Edição gratuita | POST …/abilities/zinn-chat/set-presence/run | the REST route's own per-item permission check | nenhum |
zinn-chat/suggest-replyzinn-chat-suggest-reply | Redigir uma resposta com IA (Pro) Rascunha uma resposta para um chat ou ticket 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 | nenhum |
zinn-chat/summarise-conversationzinn-chat-summarise-conversation | Resumir uma conversa com IA (Pro) Resume um chat ou ticket em poucas linhas. | Edição Pro | POST …/abilities/zinn-chat/summarise-conversation/run | the REST route's own per-item permission check | nenhum |
zinn-chat/take-chatzinn-chat-take-chat | Iniciar um chat Atribui um chat em espera ao atendente 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 o restante. 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 ticket Altera o status, a prioridade ou o responsável por um ticket. | Edição gratuita | POST …/abilities/zinn-chat/update-ticket/run | the REST route's own per-item permission check | id: string (obrigatório) |